flow360.AdaptiveCFL

class AdaptiveCFL

Bases: Flow360BaseModel

AdaptiveCFL class for Adaptive CFL setting of time stepping.

Example

• Set up Adaptive CFL with convergence limiting factor:

  >>> fl.AdaptiveCFL(convergence_limiting_factor=0.5)
  

• Set up Adaptive CFL with max relative change:

  >>> fl.AdaptiveCFL(
  ...     min=1,
  ...     max=100000,
  ...     max_relative_change=50
  ... )
  

---

type: Literal['adaptive'] = 'adaptive'

min: Annotated[float, Gt(gt=0)] = 0.1

The minimum allowable value for Adaptive CFL. Default value is 0.1 for both steady and unsteady simulations.

Constraints:

• gt = 0

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

The maximum allowable value for Adaptive CFL. In steady simulations default value is 1e4. In unsteady simulations default value is 1e6.

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

The maximum allowable relative change of CFL (%) at each pseudo step. In unsteady simulations, the value of AdaptiveCFL.max_relative_change is updated automatically depending on how well the solver converges in each physical step. In steady simulations default value is 1. In unsteady simulations default value is 50.

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

This factor specifies the level of conservativeness when using Adaptive CFL. Smaller values correspond to a more conservative limitation on the value of CFL. In steady simulations default value is 0.25. In unsteady simulations default value is 1.

classmethod default_unsteady()

returns default unsteady Adaptive CFL settings

classmethod default_steady()

returns default steady Adaptive CFL settings