flow360.TransitionModelSolver#

class TransitionModelSolver[source]#

Bases: GenericSolverSettings

TransitionModelSolver class for setting up transition model solver. For more information on setting up the numerical parameters for the transition model solver, refer to the transition model solver knowledge base.

Warning

N_crit and turbulence_intensity_percent cannot be specified at the same time.

Example

>>> fl.TransitionModelSolver(
...     linear_solver=fl.LinearSolver(max_iterations=50),
...     absolute_tolerance=1e-8,
...     update_jacobian_frequency=1,
...     equation_evaluation_frequency=1,
...     turbulence_intensity_percent=0.04,
... )
type_name: Literal['AmplificationFactorTransport'] = 'AmplificationFactorTransport'#
CFL_multiplier: PositiveFloat = 2.0#

Factor to the CFL definitions defined in the Time Stepping section.

Constraints:
  • gt = 0

absolute_tolerance: PositiveFloat = 1e-07#

Tolerance for the transition model residual, below which the solver progresses to the next physical step (unsteady) or completes the simulation (steady).

Constraints:
  • gt = 0

equation_evaluation_frequency: PositiveInt = 4#

Frequency at which to update the transition equation.

Constraints:
  • gt = 0

turbulence_intensity_percent: pd.confloat(ge=0.03, le=2.5) | None = None#

Turbulence Intensity, Range from [0.03-2.5]. Only valid when N_crit is not specified.

N_crit: pd.confloat(ge=1.0, le=11.0) | None = None#

Critical Amplification Factor, Range from [1-11]. Only valid when turbulence_intensity_percent is not specified.

update_jacobian_frequency: PositiveInt = 4#

Frequency at which the jacobian is updated.

Constraints:
  • gt = 0

max_force_jac_update_physical_steps: NonNegativeInt = 0#

For physical steps less than the input value, the jacobian matrix is updated every pseudo-step overriding the update_jacobian_frequency value.

Constraints:
  • ge = 0

reconstruction_gradient_limiter: pd.confloat(ge=0.0, le=2.0) | None = 1.0#

The strength of gradient limiter used in reconstruction of solution variables at the faces (specified in the range [0.0, 2.0]). 0.0 corresponds to setting the gradient equal to zero, and 2.0 means no limiting.

trip_regions: EntityList[Box] | None = None#

A list of Box entities defining the trip zones.

linear_solver: LinearSolver = LinearSolver(max_iterations=20, absolute_tolerance=None, relative_tolerance=None)#

Linear solver settings, see LinearSolver documentation.

relative_tolerance: NonNegativeFloat = 0#

Tolerance to the relative residual, below which the solver goes to the next physical step. Relative residual is defined as the ratio of the current pseudoStep’s residual to the maximum residual present in the first 10 pseudoSteps within the current physicalStep. NOTE: relativeTolerance is ignored in steady simulations and only absoluteTolerance is used as the convergence criterion.

Constraints:
  • ge = 0

order_of_accuracy: Literal[1, 2] = 2#

Order of accuracy in space.