Class CVodeIntegratorVars

• Defined in File Integrator.h

Inheritance Relationships

Base Type

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

Class Documentation

class CVodeIntegratorVars : public Karana::Integrators::SundialsImplicitIntegratorVars

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<int>> last_order

Integration method order used during last step.

kc::ks_ptr<Karana::Core::Var<long int>> num_stab_lim_order_reductions

BDF stability-limit order reductions; -1 when detection is disabled. Toggling detection may reset or reduce this count.

kc::ks_ptr<Karana::Core::Var<int>> curr_order

Order selected for the next CVODE step; zero immediately after initialization/reset.

kc::ks_ptr<Karana::Core::Var<double>> curr_gamma

Current CVODE gamma coefficient in I - gamma J. Returns -1.0 (unavailable) before the first accepted step after initialization or reset.

kc::ks_ptr<Karana::Core::Var<long int>> num_quasi_rhs_evals

Extra RHS evaluations performed by quasi-Newton; -1 when not selected.

kc::ks_ptr<Karana::Core::Var<long int>> num_quasi_full_refreshes

Complete finite-difference refreshes performed by quasi-Newton; -1 when not selected.

kc::ks_ptr<Karana::Core::Var<long int>> num_quasi_partial_refreshes

Motion-ranked partial refreshes performed by quasi-Newton; -1 when not selected.

kc::ks_ptr<Karana::Core::Var<long int>> num_quasi_probes

Fixed-time secant probes performed by quasi-Newton; -1 when not selected.

kc::ks_ptr<Karana::Core::Var<long int>> num_quasi_refreshed_columns

Finite-difference columns refreshed by quasi-Newton; -1 when not selected.

kc::ks_ptr<Karana::Core::Var<long int>> stall_count

Detected stall advances since hard reset; -1 while stall monitoring is inactive.

kc::ks_ptr<Karana::Core::Var<long int>> last_advance_steps

Accepted steps in the last monitored advance; -1 while monitoring is inactive.

kc::ks_ptr<Karana::Core::Var<long int>> last_advance_rhs_evals

RHS evaluations in the last monitored advance; -1 while monitoring is inactive.

kc::ks_ptr<Karana::Core::Var<long int>> last_advance_error_test_failures

Error-test failures in the last monitored advance; -1 while monitoring is inactive.

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.