RampCFL

class RampCFL

Bases: Flow360BaseModel

RampCFL class for the Ramp CFL setting of time stepping.

Example

>>> fl.RampCFL(initial=1, final=200, ramp_steps=200)

---

Attributes

initial: float, optional

Initial CFL for solving pseudo time step. In steady simulations default value is 5. In unsteady simulations default value is 1.

Default:

None

final: float, optional

Final CFL for solving pseudo time step. In steady simulations default value is 200. In unsteady simulations default value is 1e6.

Default:

None

ramp_steps: int, optional

Number of pseudo steps before reaching RampCFL.final within 1 physical step. In steady simulations default value is 40. In unsteady simulations default value is 30.

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

classmethod default_unsteady()

returns default unsteady Ramp CFL settings

classmethod default_steady()

returns default steady Ramp CFL settings

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