Class SundialsIntegratorVars

Class SundialsIntegratorVars#

Inheritance Relationships#

Base Type#

Derived Types#

Class Documentation#

class SundialsIntegratorVars : public Karana::Core::BaseVars#

The Vars for the SundialsIntegrator class.

Subclassed by Karana::Integrators::ArkExplicitIntegratorVars, Karana::Integrators::SundialsImplicitIntegratorVars

Public Functions

SundialsIntegratorVars(const kc::ks_ptr<const SundialsIntegrator> &integ)#

SundialsIntegratorVars 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 SundialsIntegratorVars.

virtual ~SundialsIntegratorVars() = 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<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_err_test_fails#

Cumulative number of error test failures due to too large of step size.

kc::ks_ptr<Karana::Core::Var_T<double>> last_step#

Last successful step size.

kc::ks_ptr<Karana::Core::Var_T<double>> curr_step#

Current step size to try on next advance call.

Public Static Functions

static kc::ks_ptr<SundialsIntegratorVars> create(const kc::ks_ptr<const SundialsIntegrator> &body)#

Create an instance of the SundialsIntegratorVars.

Parameters:

body – The body associated with this SundialsIntegratorVars.

Returns:

A pointer to the newly created instance of SundialsIntegratorVars.

Contents