`SteadyStateSolver`#

class ansys.chemkin.core.steadystatesolver.SteadyStateSolver#: Common steady-state solver controlling parameters.

Overview#

Methods

`set_max_pseudo_transient_call`	Set max number of the pseudo transient operation.
`set_max_timestep_iteration`	Set max number of iterations per time step.
`set_max_search_iteration`	Set the maximum number of iterations.
`set_initial_timesteps`	Set the number of pseudo time steps to be performed.
`set_species_floor`	Set the minimum species fraction value allowed.
`set_temperature_ceiling`	Set the maximum temperature value allowed.
`set_species_reset_value`	Set the positive reset value for any negative species fraction.
`set_max_pseudo_timestep_size`	Set max time step sizes allowed by the pseudo time stepping.
`set_min_pseudo_timestep_size`	Set min time step size of the pseudo time stepping operation.
`set_pseudo_timestep_age`	Set min number of time steps before time step size increase.
`set_jacobian_age`	Set the number of searches before Jacobian matrix evaluation.
`set_pseudo_jacobian_age`	Set the number of time steps before Jacobian matrix evaluation.
`set_damping_option`	Turn ON or OFF the damping option of the steady-state solver.
`set_legacy_option`	Turn ON or OFF the legacy steady-state solver.
`set_print_level`	Set the text output level of the steady-state solver.
`set_pseudo_timestepping_parameters`	Set pseudo time stepping parameters.

Properties

`steady_state_tolerances`	Get tolerance for the steady-state search algorithm.
`time_stepping_tolerances`	Get tolerance for the pseudo time stepping solution algorithm.

Attributes

Import detail#

from ansys.chemkin.core.steadystatesolver import SteadyStateSolver

Property detail#

property SteadyStateSolver.steady_state_tolerances: tuple[float, float]#: Get tolerance for the steady-state search algorithm.

property SteadyStateSolver.time_stepping_tolerances: tuple[float, float]#: Get tolerance for the pseudo time stepping solution algorithm.

Attribute detail#

SteadyStateSolver.ss_absolute_tolerance = 1e-09#

SteadyStateSolver.ss_relative_tolerance = 0.0001#

SteadyStateSolver.ss_maxiteration = 100#

SteadyStateSolver.ss_jacobianage = 20#

SteadyStateSolver.maxpseudotransient = 100#

SteadyStateSolver.numbinitialpseudosteps = 0#

SteadyStateSolver.maxTbound = 5000.0#

SteadyStateSolver.speciesfloor = -1e-14#

SteadyStateSolver.species_positive = 0.0#

SteadyStateSolver.use_legacy_technique = False#

SteadyStateSolver.ss_damping = 1#

SteadyStateSolver.absolute_perturbation = 0.0#

SteadyStateSolver.relative_perturbation = 0.0#

SteadyStateSolver.tr_absolute_tolerance = 1e-09#

SteadyStateSolver.tr_relative_tolerance = 0.0001#

SteadyStateSolver.tr_maxiteration = 25#

SteadyStateSolver.timestepsizeage = 25#

SteadyStateSolver.tr_minstepsize = 1e-10#

SteadyStateSolver.tr_maxstepsize = 0.01#

SteadyStateSolver.tr_upfactor = 2.0#

SteadyStateSolver.tr_downfactor = 2.2#

SteadyStateSolver.tr_jacobianage = 20#

SteadyStateSolver.tr_stride_fixT = 1e-06#

SteadyStateSolver.tr_numbsteps_fixT = 100#

SteadyStateSolver.tr_stride_ENRG = 1e-06#

SteadyStateSolver.tr_numbsteps_ENRG = 100#

SteadyStateSolver.print_level = 1#

SteadyStateSolver.ss_solverkeywords: dict[str, int | float | str | bool]#

Method detail#

SteadyStateSolver.set_max_pseudo_transient_call(maxtime: int)#: Set max number of the pseudo transient operation.

SteadyStateSolver.set_max_timestep_iteration(maxiteration: int)#: Set max number of iterations per time step.

SteadyStateSolver.set_max_search_iteration(maxiteration: int)#: Set the maximum number of iterations.

SteadyStateSolver.set_initial_timesteps(initsteps: int)#: Set the number of pseudo time steps to be performed.

SteadyStateSolver.set_species_floor(floor_value: float)#: Set the minimum species fraction value allowed.

SteadyStateSolver.set_temperature_ceiling(ceilingvalue: float)#: Set the maximum temperature value allowed.

SteadyStateSolver.set_species_reset_value(resetvalue: float)#: Set the positive reset value for any negative species fraction.

SteadyStateSolver.set_max_pseudo_timestep_size(dtmax: float)#: Set max time step sizes allowed by the pseudo time stepping.

SteadyStateSolver.set_min_pseudo_timestep_size(dtmin: float)#: Set min time step size of the pseudo time stepping operation.

SteadyStateSolver.set_pseudo_timestep_age(age: int)#: Set min number of time steps before time step size increase.

SteadyStateSolver.set_jacobian_age(age: int)#: Set the number of searches before Jacobian matrix evaluation.

SteadyStateSolver.set_pseudo_jacobian_age(age: int)#: Set the number of time steps before Jacobian matrix evaluation.

SteadyStateSolver.set_damping_option(status: bool)#: Turn ON or OFF the damping option of the steady-state solver.

SteadyStateSolver.set_legacy_option(option: bool)#: Turn ON or OFF the legacy steady-state solver.

SteadyStateSolver.set_print_level(level: int)#: Set the text output level of the steady-state solver.

SteadyStateSolver.set_pseudo_timestepping_parameters(numb_steps: int = 100, step_size: float = 1e-06, stage: int = 1)#: Set pseudo time stepping parameters.

`ss_absolute_tolerance`
`ss_relative_tolerance`
`ss_maxiteration`
`ss_jacobianage`
`maxpseudotransient`
`numbinitialpseudosteps`
`maxTbound`
`speciesfloor`
`species_positive`
`use_legacy_technique`
`ss_damping`
`absolute_perturbation`
`relative_perturbation`
`tr_absolute_tolerance`
`tr_relative_tolerance`
`tr_maxiteration`
`timestepsizeage`
`tr_minstepsize`
`tr_maxstepsize`
`tr_upfactor`
`tr_downfactor`
`tr_jacobianage`
`tr_stride_fixT`
`tr_numbsteps_fixT`
`tr_stride_ENRG`
`tr_numbsteps_ENRG`
`print_level`
`ss_solverkeywords`

SteadyStateSolver#

Overview#

Import detail#

Property detail#

Attribute detail#

Method detail#

`SteadyStateSolver`#