user_scalar_variable_child

class ansys.cfx.core.generated.post_processing.settings_261.user_scalar_variable_child.user_scalar_variable_child(name: str | None = None, parent=None)

Bases: Group

‘child_object_type’ of user_scalar_variable.

Attributes

Attribute	Summary
boundary_values	Sets the type of boundary values to be presented for this variable (Conservative or Hybrid).
calculate_global_range	If toggled on, the global range of the user variable will be calculated.
component_index	Specifies vector component to be used for the variable.
expression	A CFX Expression Language expression.
recipe	Contains instructions on how to build a value list for the variable.
user_units	Specifies the preferred units to display this variable in if different from the default units setting. To use the default units, this parameter must be empty (blank).
variable	The name of the variable used to create the object. Should be set equal to the name of a currently defined VARIABLE object.
variable_to_copy	The name of the variable used to create the object. Should be set equal to the name of a currently defined VARIABLE object.
variable_to_gradient	The name of the scalar variable used to calculate gradient upon.

Included in:

Parent	Summary
user_scalar_variable	‘user_scalar_variable’ child.