flow360.UserVariable

class UserVariable

Bases: Variable

Class representing a user-defined symbolic variable

name: str [Required]

type_name: Literal['UserVariable'] = 'UserVariable'

in_units(new_unit=None)

Requesting the output of the variable to be in the given (new_unit) units.

Parameters:

new_unit (str | Literal['SI_unit_system', 'CGS_unit_system', 'Imperial_unit_system'] | ~unyt.unit_object.Unit | None)

property value

Get the value of the variable from the global context.