edit_displacement

class ansys.fluent.core.generated.solver.settings_271.edit_displacement(name=None, parent=None)

Bases: Command

Edit an existing periodic displacement object.

Parameters:

displacement_namestr

Name of the periodic displacement.

autofillbool

When enabled, automatically populate displacement fields from a mode-shape profile.

mode_shape_profilestr

Name of the mode-shape profile for autofill.

realbool

Whether mode shape is real[y] or complex[n].

mode_shape_profile_cmplxstr

Name of the mode-shape profile for autofill.

x_displacement_use_profilebool

If yes, X displacement is defined via a profile.

x_displacement_use_udfbool

If yes, X displacement uses a UDF profile.

x_displacement_typestr

Type: constant, profile, or udf.

x_displacement_profilestr

Profile name for X displacement.

x_displacement_fieldstr

Field name within the profile for X displacement.

x_displacementreal

The number for constant value, or an expression string.

y_displacement_use_profilebool

If yes, Y displacement is defined via a profile.

y_displacement_use_udfbool

If yes, Y displacement uses a UDF profile.

y_displacement_typestr

Type: constant, profile, or udf.

y_displacement_profilestr

Profile name for Y displacement.

y_displacement_fieldstr

Field name within the profile for Y displacement.

y_displacementreal

The number for constant value, or an expression string.

z_displacement_use_profilebool

If yes, Z displacement is defined via a profile.

z_displacement_use_udfbool

If yes, Z displacement uses a UDF profile.

z_displacement_typestr

Type: constant, profile, or udf.

z_displacement_profilestr

Profile name for Z displacement.

z_displacement_fieldstr

Field name within the profile for Z displacement.

z_displacementreal

The number for constant value, or an expression string.

x_imaginary_displacement_use_profilebool

If yes, X imaginary displacement is defined via a profile.

x_imaginary_displacement_use_udfbool

If yes, X imaginary displacement uses a UDF profile.

x_imaginary_displacement_typestr

Type: constant, profile, or udf.

x_imaginary_displacement_profilestr

Profile name for X imaginary displacement.

x_imaginary_displacement_fieldstr

Field name within the profile for X imaginary displacement.

x_imaginary_displacementreal

The number for constant value, or an expression string.

y_imaginary_displacement_use_profilebool

If yes, Y imaginary displacement is defined via a profile.

y_imaginary_displacement_use_udfbool

If yes, Y imaginary displacement uses a UDF profile.

y_imaginary_displacement_typestr

Type: constant, profile, or udf.

y_imaginary_displacement_profilestr

Profile name for Y imaginary displacement.

y_imaginary_displacement_fieldstr

Field name within the profile for Y imaginary displacement.

y_imaginary_displacementreal

The number for constant value, or an expression string.

z_imaginary_displacement_use_profilebool

If yes, Z imaginary displacement is defined via a profile.

z_imaginary_displacement_use_udfbool

If yes, Z imaginary displacement uses a UDF profile.

z_imaginary_displacement_typestr

Type: constant, profile, or udf.

z_imaginary_displacement_profilestr

Profile name for Z imaginary displacement.

z_imaginary_displacement_fieldstr

Field name within the profile for Z imaginary displacement.

z_imaginary_displacementreal

The number for constant value, or an expression string.

frequency_use_profilebool

If yes, frequency is defined via a profile.

frequency_use_udfbool

If yes, frequency uses a UDF profile.

frequency_typestr

Type: constant, profile, or udf.

frequency_profilestr

Profile name for frequency.

frequency_fieldstr

Field name within the profile for frequency.

frequencyreal

The number for constant value, or an expression string.

normalizedbool

Whether the profile is normalized.

amplitude_use_profilebool

If yes, amplitude is defined via a profile.

amplitude_use_udfbool

If yes, amplitude uses a UDF profile.

amplitude_typestr

Type: constant, profile, or udf.

amplitude_profilestr

Profile name for amplitude.

amplitude_fieldstr

Field name within the profile for amplitude.

amplitudereal

The number for constant value, or an expression string.

methodint

Mode propagation option: 0=None, 1=Travelling Wave, 2=Influence Coefficient.

nodal_diameterint

Nodal diameter value.

forwardbool

Travelling direction: #t=Forward, #f=Backward.

passage_number_use_profilebool

If yes, passage number is defined via a profile.

passage_number_use_udfbool

If yes, passage number uses a UDF profile.

passage_number_typestr

Type: constant, profile, or udf.

passage_number_profilestr

Profile name for passage number.

passage_number_fieldstr

Field name within the profile for passage number.

passage_numberreal

The number for constant value, or an expression string.

aerodampingbool

Enable aerodamping monitors.

Arguments

Argument	Summary
displacement_name	Name of the periodic displacement.
autofill	When enabled, automatically populate displacement fields from a mode-shape profile.
mode_shape_profile	Name of the mode-shape profile for autofill.
real	Whether mode shape is real[y] or complex[n].
mode_shape_profile_cmplx	Name of the mode-shape profile for autofill.
x_displacement_use_profile	If yes, X displacement is defined via a profile.
x_displacement_use_udf	If yes, X displacement uses a UDF profile.
x_displacement_type	Type: constant, profile, or udf.
x_displacement_profile	Profile name for X displacement.
x_displacement_field	Field name within the profile for X displacement.
x_displacement	The number for constant value, or an expression string.
y_displacement_use_profile	If yes, Y displacement is defined via a profile.
y_displacement_use_udf	If yes, Y displacement uses a UDF profile.
y_displacement_type	Type: constant, profile, or udf.
y_displacement_profile	Profile name for Y displacement.
y_displacement_field	Field name within the profile for Y displacement.
y_displacement	The number for constant value, or an expression string.
z_displacement_use_profile	If yes, Z displacement is defined via a profile.
z_displacement_use_udf	If yes, Z displacement uses a UDF profile.
z_displacement_type	Type: constant, profile, or udf.
z_displacement_profile	Profile name for Z displacement.
z_displacement_field	Field name within the profile for Z displacement.
z_displacement	The number for constant value, or an expression string.
x_imaginary_displacement_use_profile	If yes, X imaginary displacement is defined via a profile.
x_imaginary_displacement_use_udf	If yes, X imaginary displacement uses a UDF profile.
x_imaginary_displacement_type	Type: constant, profile, or udf.
x_imaginary_displacement_profile	Profile name for X imaginary displacement.
x_imaginary_displacement_field	Field name within the profile for X imaginary displacement.
x_imaginary_displacement	The number for constant value, or an expression string.
y_imaginary_displacement_use_profile	If yes, Y imaginary displacement is defined via a profile.
y_imaginary_displacement_use_udf	If yes, Y imaginary displacement uses a UDF profile.
y_imaginary_displacement_type	Type: constant, profile, or udf.
y_imaginary_displacement_profile	Profile name for Y imaginary displacement.
y_imaginary_displacement_field	Field name within the profile for Y imaginary displacement.
y_imaginary_displacement	The number for constant value, or an expression string.
z_imaginary_displacement_use_profile	If yes, Z imaginary displacement is defined via a profile.
z_imaginary_displacement_use_udf	If yes, Z imaginary displacement uses a UDF profile.
z_imaginary_displacement_type	Type: constant, profile, or udf.
z_imaginary_displacement_profile	Profile name for Z imaginary displacement.
z_imaginary_displacement_field	Field name within the profile for Z imaginary displacement.
z_imaginary_displacement	The number for constant value, or an expression string.
frequency_use_profile	If yes, frequency is defined via a profile.
frequency_use_udf	If yes, frequency uses a UDF profile.
frequency_type	Type: constant, profile, or udf.
frequency_profile	Profile name for frequency.
frequency_field	Field name within the profile for frequency.
frequency	The number for constant value, or an expression string.
normalized	Whether the profile is normalized.
amplitude_use_profile	If yes, amplitude is defined via a profile.
amplitude_use_udf	If yes, amplitude uses a UDF profile.
amplitude_type	Type: constant, profile, or udf.
amplitude_profile	Profile name for amplitude.
amplitude_field	Field name within the profile for amplitude.
amplitude	The number for constant value, or an expression string.
method	Mode propagation option: 0=None, 1=Travelling Wave, 2=Influence Coefficient.
nodal_diameter	Nodal diameter value.
forward	Travelling direction: #t=Forward, #f=Backward.
passage_number_use_profile	If yes, passage number is defined via a profile.
passage_number_use_udf	If yes, passage number uses a UDF profile.
passage_number_type	Type: constant, profile, or udf.
passage_number_profile	Profile name for passage number.
passage_number_field	Field name within the profile for passage number.
passage_number	The number for constant value, or an expression string.
aerodamping	Enable aerodamping monitors.

Included in:

Parent	Summary
periodic_displacements	‘periodic_displacements’ child.