Struct SundialsImplicitIntegrator::IntegratorOptions#

Defined in File Integrator.h

Nested Relationships#

This struct is a nested type of Class SundialsImplicitIntegrator.

Inheritance Relationships#

Base Type#

public Karana::Integrators::SundialsIntegrator::IntegratorOptions (Struct SundialsIntegrator::IntegratorOptions)

Derived Types#

public Karana::Integrators::ArkImplicitIntegrator::IntegratorOptions (Struct ArkImplicitIntegrator::IntegratorOptions)
public Karana::Integrators::CVodeIntegrator::IntegratorOptions (Struct CVodeIntegrator::IntegratorOptions)

Struct Documentation#

struct IntegratorOptions : public Karana::Integrators::SundialsIntegrator::IntegratorOptions

Struct with options for this integrator

Subclassed by Karana::Integrators::ArkImplicitIntegrator::IntegratorOptions, Karana::Integrators::CVodeIntegrator::IntegratorOptions

Public Members

double anderson_damping = 1

Anderson damping in (0, 1] used for implicit integrators with fixed-point solves.

This is used to potentially speed up internal iterations by reusing past iterates (within the same time step). A value of 1 indicates no damping, and smaller values imply a “stronger” damping.

int anderson_length = 0: Number of past iterates to consider with Anderson acceleration.

unsigned int max_nl_iters = 3: Maximum number of nonlinear iterations before we try a smaller step size.

long linear_setup_frequency = 0

Number of integration steps between implicit linear-solver setups.

This option applies to CVODE Newton and ARKODE implicit solvers. A value of zero selects the backend’s SUNDIALS default.

long jacobian_eval_frequency = 0

Number of integration steps between implicit Jacobian evaluations.