MassFlowRate

class MassFlowRate

Bases: Flow360BaseModel

MassFlowRate class to specify the mass flow rate for Inflow or Outflow boundary condition via Inflow.spec/Outflow.spec.

Example

>>> fl.MassFlowRate(
...     value = 123 * fl.u.lb / fl.u.s,
...     ramp_steps = 100,
... )

---

Attributes

value: MassFlowRateType.NonNegative

The mass flow rate.

ramp_steps: int, optional

Number of pseudo steps before reaching MassFlowRate.value within 1 physical step.

Default:

None

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')