SpeciesTransportSolver#

class SpeciesTransportSolver[source]#

Bases: GenericSolverSettings

SpeciesTransportSolver class for transporting the species of ThermalState.material (a Gas): the runtime solves N-1 mass-fraction transport equations and forms composition-dependent thermodynamics and transport. The numerics settings apply when the gas has two or more species.

Example

>>> fl.SpeciesTransportSolver(
...     turbulent_schmidt_number=0.9,
...     absolute_tolerance=1e-10,
...     linear_solver=fl.LinearSolver(max_iterations=20),
... )

Attributes

absolute_tolerance: float#
Default:

1e-10

relative_tolerance: float#

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.

Default:

0

order_of_accuracy: Literal[1, 2]#

Order of accuracy in space.

Default:

2

equation_evaluation_frequency: int#

Frequency at which to update the species transport equations.

Default:

4

linear_solver: LinearSolver#

Linear solver settings, see LinearSolver documentation.

Default:

LinearSolver()

turbulent_schmidt_number: float#

Turbulent Schmidt number Sc_t used to form the turbulent species diffusivity D_t = mu_t / (rho * Sc_t). Distinct from the laminar Schmidt number Sc on each Species (Sc_t is a turbulence-closure modelling constant, not a molecular property).

Default:

0.7

diffusion_model: Literal['constantSchmidt']#

Mass-diffusion closure. Currently, only constant-Schmidt Fickian diffusion is supported.

Default:

'constantSchmidt'

CFL_multiplier: float#

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

Default:

1.0

update_jacobian_frequency: int#

Frequency at which the jacobian is updated.

Default:

4

max_force_jac_update_physical_steps: int#

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

Default:

0