GenericReferenceCondition

class GenericReferenceCondition

Bases: MultiConstructorBaseModel

Operating condition defines the physical (non-geometrical) reference values for the problem.

Example

• Define GenericReferenceCondition with from_mach():

  >>> fl.GenericReferenceCondition.from_mach(
  ...     mach=0.2,
  ...     thermal_state=ThermalState(),
  ... )
  

• Define GenericReferenceCondition with velocity_magnitude:

  >>> fl.GenericReferenceCondition(velocity_magnitude=40 * fl.u.m / fl.u.s)
  

---

Attributes

velocity_magnitude: Expression | VelocityType.Positive, optional

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

Default:

None

thermal_state: ThermalState

Reference and freestream thermal state. Defaults to US standard atmosphere at sea level.

Default:

ThermalState()

Properties

mach: float

Computes Mach number.

Additional Constructors

classmethod from_mach(mach, thermal_state=ThermalState())

Constructs a reference condition from Mach number and thermal state.

Parameters:

• mach (Annotated[float, Gt(gt=0)])

• thermal_state (ThermalState)

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