flow360.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)

---

type: Literal['ramp'] = 'ramp'

initial: Annotated[float, Gt(gt=0)] | None = None

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

final: Annotated[float, Gt(gt=0)] | None = None

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

ramp_steps: Annotated[int, Gt(gt=0)] | None = None

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.

classmethod default_unsteady()

returns default unsteady Ramp CFL settings

classmethod default_steady()

returns default steady Ramp CFL settings