Class ArkExplicitIntegrator

Class ArkExplicitIntegrator#

Defined in File Integrator.h

Nested Relationships#

Nested Types#

Struct ArkExplicitIntegrator::IntegratorOptions

Inheritance Relationships#

Base Type#

public Karana::Integrators::SundialsIntegrator (Class SundialsIntegrator)

Class Documentation#

class ArkExplicitIntegrator : public Karana::Integrators::SundialsIntegrator #

The multistep ArkODE explicit integrator from the SUNDIALS suite.

Public Types

enum class METHOD#

the solver type to use

Values:

enumerator HUEN_EULER#

enumerator ZONNEVELD#

enumerator CASH_KARP#

enumerator DORMAND_PRINCE#

enumerator FEHLBERG78#

Public Functions

ArkExplicitIntegrator(const IntegratorType &integrator_type, size_t nstates, DerivativeFunction f, const ArkExplicitIntegrator::IntegratorOptions *options = nullptr)#

Constructor.

Parameters:

nstates – The number of states to integrate.
f – The derivative function to calculate the derivative of the states.
integrator_type – The type of ark integrator to use.
options – The integrator options.

~ArkExplicitIntegrator()#

virtual const kc::ks_ptr<Integrator::IntegratorOptions> getOptions() const override#

Get the options associated with the integrator.

Returns:: The options associated with the integrator.

virtual km::Vec getErrorContributions() const override#

Get the error contribution for each state.

Returns:: A vector with the error contribution for each state.

Public Members

const std::map<METHOD, ARKODE_ERKTableID> butcher_table_id{{METHOD::HUEN_EULER, ARKODE_HEUN_EULER_2_1_2}, {METHOD::ZONNEVELD, ARKODE_ZONNEVELD_5_3_4}, {METHOD::CASH_KARP, ARKODE_CASH_KARP_6_4_5}, {METHOD::DORMAND_PRINCE, ARKODE_DORMAND_PRINCE_7_4_5}, {METHOD::FEHLBERG78, ARKODE_FEHLBERG_13_7_8}}#: map with the Butcher table number (from arkode_butcher_erk.h) for the different integrator choices. The numbers are the integrator stages/embedding order/order

Protected Functions

virtual void _initialize() final override#: Initialize the implementation-specific data structures.

virtual void _freeMemory() final override#: Free all memory, both common and implementation-specific. Must call _freeCommonMemory() to clear shared data structures.

virtual void _applyTolerances() final override#: Copy tolerances from internal options into implementation data structures.

virtual void _reInit() final override#: Reinitialize internal implementation state for a soft reset.

virtual void _advanceTo(double t_end) final override#

Advances implementation to a target time; called by parent class.

Parameters:: t_end –

Protected Attributes

void *_arkode_mem#: The Arkode memory.

kc::ks_ptr<ArkExplicitIntegrator::IntegratorOptions> _opts#: Arkode-specific integrator options.

struct IntegratorOptions : public Karana::Integrators::SundialsIntegrator::IntegratorOptions #

Struct with options for this integrator