create

class ansys.fluent.core.generated.solver.settings_261.create(name=None, parent=None)

Bases: CommandWithPositionalArgs

Create a new Generalized Force object.

Parameters:

namestr

Name of the new Generalized Force object.

ct_idint

Cell thread ID associated with the force object. Must be a valid cell thread ID from the available list.

wt_idList

List of wall thread IDs on which to map the displacement profile.

autofillbool

Use automatic filling function to read uploaded mode shape profile.

mode_shape_profstr

Mesh displacement profile name.

cmplxbool

Whether the mode shape is complex or real.

dispx_typestr

Type of X displacement.

dispx_udfbool

Whether to use UDF profile for X displacement.

dispx_profstr

Profile name for X displacement.

dispx_fieldstr

Field name for X displacement. When UDF is selected, must be a valid UDF name.

dispx_valuereal

Constant value for X displacement.

dispy_typestr

Type of Y displacement.

dispy_udfbool

Whether to use UDF profile for Y displacement.

dispy_profstr

Profile name for Y displacement.

dispy_fieldstr

Field name for Y displacement. When UDF is selected, must be a valid UDF name.

dispy_valuereal

Constant value for Y displacement.

dispz_typestr

Type of Z displacement.

dispz_udfbool

Whether to use UDF profile for Z displacement.

dispz_profstr

Profile name for Z displacement.

dispz_fieldstr

Field name for Z displacement. When UDF is selected, must be a valid UDF name.

dispz_valuereal

Constant value for Z displacement.

imagx_typestr

Type of X imaginary.

imagx_udfbool

Whether to use UDF profile for X imaginary displacement.

imagx_profstr

Profile name for X imaginary.

imagx_fieldstr

Field name for X imaginary. When UDF is selected, must be a valid UDF name.

imagx_valuereal

Constant value for X imaginary.

imagy_typestr

Type of Y imaginary.

imagy_udfbool

Whether to use UDF profile for Y imaginary displacement.

imagy_profstr

Profile name for Y imaginary.

imagy_fieldstr

Field name for Y imaginary. When UDF is selected, must be a valid UDF name.

imagy_valuereal

Constant value for Y imaginary.

imagz_typestr

Type of Z imaginary.

imagz_udfbool

Whether to use UDF profile for Z imaginary displacement.

imagz_profstr

Profile name for Z imaginary.

imagz_fieldstr

Field name for Z imaginary. When UDF is selected, must be a valid UDF name.

imagz_valuereal

Constant value for Z imaginary.

normbool

Whether the mode shape is normalized.

scalar_fieldint

Scalar field index.

fourier_decompbool

Whether the Fourier decomposition of the chosen scalar field is used.

ibfreqint

Base frequency index for Fourier coefficient. Selected from allowed indices for the cell zone.

harmonicint

Harmonic selected from available harmonics for the cell zone and frequency index.

Arguments

Argument	Summary
name	Name of the new Generalized Force object.
ct_id	Cell thread ID associated with the force object. Must be a valid cell thread ID from the available list.
wt_id	List of wall thread IDs on which to map the displacement profile.
autofill	Use automatic filling function to read uploaded mode shape profile.
mode_shape_prof	Mesh displacement profile name.
cmplx	Whether the mode shape is complex or real.
dispx_type	Type of X displacement.
dispx_udf	Whether to use UDF profile for X displacement.
dispx_prof	Profile name for X displacement.
dispx_field	Field name for X displacement. When UDF is selected, must be a valid UDF name.
dispx_value	Constant value for X displacement.
dispy_type	Type of Y displacement.
dispy_udf	Whether to use UDF profile for Y displacement.
dispy_prof	Profile name for Y displacement.
dispy_field	Field name for Y displacement. When UDF is selected, must be a valid UDF name.
dispy_value	Constant value for Y displacement.
dispz_type	Type of Z displacement.
dispz_udf	Whether to use UDF profile for Z displacement.
dispz_prof	Profile name for Z displacement.
dispz_field	Field name for Z displacement. When UDF is selected, must be a valid UDF name.
dispz_value	Constant value for Z displacement.
imagx_type	Type of X imaginary.
imagx_udf	Whether to use UDF profile for X imaginary displacement.
imagx_prof	Profile name for X imaginary.
imagx_field	Field name for X imaginary. When UDF is selected, must be a valid UDF name.
imagx_value	Constant value for X imaginary.
imagy_type	Type of Y imaginary.
imagy_udf	Whether to use UDF profile for Y imaginary displacement.
imagy_prof	Profile name for Y imaginary.
imagy_field	Field name for Y imaginary. When UDF is selected, must be a valid UDF name.
imagy_value	Constant value for Y imaginary.
imagz_type	Type of Z imaginary.
imagz_udf	Whether to use UDF profile for Z imaginary displacement.
imagz_prof	Profile name for Z imaginary.
imagz_field	Field name for Z imaginary. When UDF is selected, must be a valid UDF name.
imagz_value	Constant value for Z imaginary.
norm	Whether the mode shape is normalized.
scalar_field	Scalar field index.
fourier_decomp	Whether the Fourier decomposition of the chosen scalar field is used.
ibfreq	Base frequency index for Fourier coefficient. Selected from allowed indices for the cell zone.
harmonic	Harmonic selected from available harmonics for the cell zone and frequency index.

Included in:

Parent	Summary
objects	Manage Generalized Forces objects.