LiquidOperatingCondition#

class LiquidOperatingCondition[source]#

Bases: Flow360BaseModel

Operating condition for simulation of water as the only material.

Example

>>> fl.LiquidOperatingCondition(
...     velocity_magnitude=10 * fl.u.m / fl.u.s,
...     alpha=-90 * fl.u.deg,
...     beta=0 * fl.u.deg,
...     material=fl.Water(name="Water"),
...     reference_velocity_magnitude=5 * fl.u.m / fl.u.s,
... )

Attributes

alpha: AngleType#

The angle of attack.

Default:

0 * degree

beta: AngleType#

The side slip angle.

Default:

0 * degree

velocity_magnitude: Expression | VelocityType.NonNegative, optional#

Incoming flow velocity magnitude. Used as reference velocity magnitude when reference_velocity_magnitude is not specified. Cannot change once specified.

Default:

None

reference_velocity_magnitude: VelocityType.Positive, optional#

Reference velocity magnitude. Is required when velocity_magnitude is 0. Used as the velocity scale for nondimensionalization.

Default:

None

material: Water#

Type of liquid material used.

Default:

Water()

Additional Constructors

classmethod from_file(filename)#

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)#

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 
to_file(filename, **kwargs)#

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')