Class CVodeIntegratorVars

• Defined in File Integrator.h

Inheritance Relationships

Base Type

• public Karana::Integrators::SundialsIntegratorVars (Class SundialsIntegratorVars)

Class Documentation

class CVodeIntegratorVars : public Karana::Integrators::SundialsIntegratorVars

The Vars for the CVodeIntegrator class.

Public Functions

CVodeIntegratorVars(const kc::ks_ptr<const CVodeIntegrator> &integ)

CVodeIntegratorVars constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

integ – The integrator associated with this CVodeIntegratorVars.

~CVodeIntegratorVars() = default

Destructor.

virtual kc::NestedVars getAllVars() const override

Get all the Vars that this VarHolder has.

Returns:

A map of Vars, where the Var name is the key and the Var is the value.

Public Members

kc::ks_ptr<Karana::Core::Var_T<int>> last_order

Integration method order used during last step.

kc::ks_ptr<Karana::Core::Var_T<long int>> num_steps

Cumulative number of internal steps taken by the solver.

kc::ks_ptr<Karana::Core::Var_T<long int>> num_rhs_evals

Cumulative number of RHS calls taken by the solver.

kc::ks_ptr<Karana::Core::Var_T<long int>> num_nonlin_iters

Cumulative number of nonlinear iterations.

kc::ks_ptr<Karana::Core::Var_T<long int>> num_lin_iters

Cumulative number of linear iterations.

kc::ks_ptr<Karana::Core::Var_T<long int>> num_jac_evals

Number of calls made to the CVLS Jacobian approximation function.

kc::ks_ptr<Karana::Core::Var_T<long int>> num_lin_rhs_evals

Number of RHS/derivative calls used to estimate jacobians.

Public Static Functions

static kc::ks_ptr<CVodeIntegratorVars> create(const kc::ks_ptr<const CVodeIntegrator> &integ)

Create an instance of the CVodeIntegratorVars.

Parameters:

integ – The CVode integrator associated with this CVodeIntegratorVars.

Returns:

A pointer to the newly created instance of CVodeIntegratorVars.