Class SundialsIntegratorVars

• Defined in File Integrator.h

Inheritance Relationships

Base Type

• public Karana::Core::BaseVars (Class BaseVars)

Derived Type

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

Class Documentation

class SundialsIntegratorVars : public Karana::Core::BaseVars

The Vars for the SundialsIntegrator class.

Subclassed by Karana::Integrators::CVodeIntegratorVars

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