create_displacement

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

Bases: Command

Create a new 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.

complexbool

Whether mode shape is complex.

x_displacement_typestr

Type: “constant” or “profile”.

x_displacement_profilestr

Profile name for X displacement (when type is “profile”).

x_displacement_fieldstr

Field name within the profile for X displacement.

x_displacementreal

X displacement constant value.

y_displacement_typestr

Type: “constant” or “profile”.

y_displacement_profilestr

Profile name for Y displacement (when type is “profile”).

y_displacement_fieldstr

Field name within the profile for Y displacement.

y_displacementreal

Y displacement constant value.

z_displacement_typestr

Type: “constant” or “profile”.

z_displacement_profilestr

Profile name for Z displacement (when type is “profile”).

z_displacement_fieldstr

Field name within the profile for Z displacement.

z_displacementreal

Z displacement constant value.

x_imaginary_displacement_typestr

Type: “constant” or “profile”.

x_imaginary_displacement_profilestr

Profile name for X imaginary displacement (when type is “profile”).

x_imaginary_displacement_fieldstr

Field name within the profile for X imaginary displacement.

x_imaginary_displacementreal

X imaginary displacement constant value. Used when complex mode shape is enabled.

y_imaginary_displacement_typestr

Type: “constant” or “profile”.

y_imaginary_displacement_profilestr

Profile name for Y imaginary displacement (when type is “profile”).

y_imaginary_displacement_fieldstr

Field name within the profile for Y imaginary displacement.

y_imaginary_displacementreal

Y imaginary displacement constant value. Used when complex mode shape is enabled.

z_imaginary_displacement_typestr

Type: “constant” or “profile”.

z_imaginary_displacement_profilestr

Profile name for Z imaginary displacement (when type is “profile”).

z_imaginary_displacement_fieldstr

Field name within the profile for Z imaginary displacement.

z_imaginary_displacementreal

Z imaginary displacement constant value. Used when complex mode shape is enabled.

frequency_typestr

Type: “constant” or “profile”.

frequency_profilestr

Profile name for frequency (when type is “profile”).

frequency_fieldstr

Field name within the profile for frequency.

frequencyreal

Frequency constant value.

normalizedbool

Whether the profile is normalized.

amplitude_typestr

Type: “constant” or “profile”.

amplitude_profilestr

Profile name for amplitude (when type is “profile”).

amplitude_fieldstr

Field name within the profile for amplitude.

amplitudereal

Amplitude constant value.

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_typestr

Type: “constant” or “profile”.

passage_number_profilestr

Profile name for passage number (when type is “profile”).

passage_number_fieldstr

Field name within the profile for passage number.

passage_numberreal

Passage number constant value.

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.
complex	Whether mode shape is complex.
x_displacement_type	Type: “constant” or “profile”.
x_displacement_profile	Profile name for X displacement (when type is “profile”).
x_displacement_field	Field name within the profile for X displacement.
x_displacement	X displacement constant value.
y_displacement_type	Type: “constant” or “profile”.
y_displacement_profile	Profile name for Y displacement (when type is “profile”).
y_displacement_field	Field name within the profile for Y displacement.
y_displacement	Y displacement constant value.
z_displacement_type	Type: “constant” or “profile”.
z_displacement_profile	Profile name for Z displacement (when type is “profile”).
z_displacement_field	Field name within the profile for Z displacement.
z_displacement	Z displacement constant value.
x_imaginary_displacement_type	Type: “constant” or “profile”.
x_imaginary_displacement_profile	Profile name for X imaginary displacement (when type is “profile”).
x_imaginary_displacement_field	Field name within the profile for X imaginary displacement.
x_imaginary_displacement	X imaginary displacement constant value. Used when complex mode shape is enabled.
y_imaginary_displacement_type	Type: “constant” or “profile”.
y_imaginary_displacement_profile	Profile name for Y imaginary displacement (when type is “profile”).
y_imaginary_displacement_field	Field name within the profile for Y imaginary displacement.
y_imaginary_displacement	Y imaginary displacement constant value. Used when complex mode shape is enabled.
z_imaginary_displacement_type	Type: “constant” or “profile”.
z_imaginary_displacement_profile	Profile name for Z imaginary displacement (when type is “profile”).
z_imaginary_displacement_field	Field name within the profile for Z imaginary displacement.
z_imaginary_displacement	Z imaginary displacement constant value. Used when complex mode shape is enabled.
frequency_type	Type: “constant” or “profile”.
frequency_profile	Profile name for frequency (when type is “profile”).
frequency_field	Field name within the profile for frequency.
frequency	Frequency constant value.
normalized	Whether the profile is normalized.
amplitude_type	Type: “constant” or “profile”.
amplitude_profile	Profile name for amplitude (when type is “profile”).
amplitude_field	Field name within the profile for amplitude.
amplitude	Amplitude constant value.
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_type	Type: “constant” or “profile”.
passage_number_profile	Profile name for passage number (when type is “profile”).
passage_number_field	Field name within the profile for passage number.
passage_number	Passage number constant value.
aerodamping	Enable aerodamping monitors.

Included in:

Parent	Summary
periodic_displacements	‘periodic_displacements’ child.