Unsteady

class Unsteady

Bases: Flow360BaseModel

Unsteady class for specifying unsteady simulation.

Example

>>> fl.Unsteady(
...     CFL=fl.AdaptiveCFL(
...         convergence_limiting_factor=0.5
...     ),
...     step_size=0.01 * fl.u.s,
...     steps=120,
...     max_pseudo_steps=35,
... )

---

Attributes

max_pseudo_steps: int

Maximum pseudo steps within one physical step.

Default:

20

steps: int

Number of physical steps.

step_size: Expression | TimeType.Positive

Time step size in physical step marching,

CFL: RampCFL | AdaptiveCFL

CFL settings within each physical step.

Default:

AdaptiveCFL()

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