user_vector_variable_child#

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

Bases: Group

‘child_object_type’ of user_vector_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.

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_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.

x_expression

A CFX Expression Language expression defining X component of a vector variable.

y_expression

A CFX Expression Language expression defining Y component of a vector variable.

z_expression

A CFX Expression Language expression defining Z component of a vector variable.

Included in:

Parent

Summary

user_vector_variable

‘user_vector_variable’ child.