Struct CVodeIntegrator::IntegratorOptions

Struct CVodeIntegrator::IntegratorOptions#

Nested Relationships#

This struct is a nested type of Class CVodeIntegrator.

Inheritance Relationships#

Base Type#

Struct Documentation#

struct IntegratorOptions : public Karana::Math::Integrator::IntegratorOptions

Struct with options for this integrator

Public Functions

IntegratorOptions() = default
IntegratorOptions(const IntegratorOptions &p)

Copy constructor.

Parameters:

p – The IntegratorOptions to copy values from.

IntegratorOptions &operator=(const IntegratorOptions &p)

Assignment operator.

Parameters:

p – The IntegratorOptions to copy values from.

Returns:

A reference to the newly assigned IntegratorOptions.

virtual ~IntegratorOptions()

Public Members

double rtol = 1e-4

The desired relative tolerance used to control the integrator error.

double atol = 1e-8

The desired absolute tolerance used to control the integrator error.

Vec atol_vec

The desired absolute tolerance vector used to control the integrator error. This can be used rather than a scalar tolerance to set different values for different states.

long max_num_steps = 1e6

The maximum number of steps the solver can take before throwing a too much work error.

unsigned int anderson_accel = 0

Anderson acceleration used with the FixedPoint solver.

NLSOLVER nlsolver = NLSOLVER::FIXEDPOINT

The Nonlinear solver type to use.

METHOD method = METHOD::ADAMS

The solver method to use.

bool use_jacobian = false

set to true to have the integrator use Jacobians (experimental)

Contents