#include <deal.II/sundials/arkode.h>

Detailed Description

template<typename VectorType = Vector<double>>
class SUNDIALS::ARKode< VectorType >

Interface to SUNDIALS additive Runge-Kutta methods (ARKode).

The class ARKode is a wrapper to SUNDIALS adaptive-step time integration modules for stiff, nonstiff and mixed stiff/nonstiff systems of ordinary differential equations (ODEs). This class provides access to general underlying infrastructure of ARKODE, controls the main time marching loop, output, reinitializaiton, exception handling. The class ARKode does not implement any time integration strategies itself. Instead, it employs one of the available stepper classes, which are basically wrappers around the corresponding ARKODE steppers. Currently, ARKStepper and ERKStepper are available: ARKStepper provides interfaces to ARKODE's additive Runge-Kutta steppers (supporting implicit, explicit, and mixed methods), while ERKStepper wraps the explicit-only ERKStep module for non-stiff problems. LSRKStepper provides access to the LSRKStep STS (Stabilized explicit Runge-Kutta) and SSP (Strong-Stability-Preserving) family of low-storage Runge-Kutta methods. The documentation of the ARKStepper, ERKStepper, and LSRKStepper classes also shows examples of how this class can be used. Users can also provide their own steppers or implement wrappers around, e.g., SPRKStep or MRIStep modules of ARKODE.

The integrator settings are primarily customized by setting up fields of ARKode::AdditionalData passed to the constructors. For most of the cases, it is advised to set at least the end time up to which the time integrator should run and the initial time step size.

The following functions can be provided to tune the behavior of ARKode:

custom_setup() to set up additional ARKODE settings,
solver_should_restart() to control whether the solver has to be reconstructed at the current time step,
solver_should_resize() to adapt the solver to a changed vector size without losing the time stepping history,
get_local_tolerances() to set up individual tolerances for the vector components being integrated by ARKODE,
output_step() to produce output at fixed steps.

Forward declare ARKode class.

Definition at line 101 of file arkode.h.

Classes
class	AdditionalData

struct	FunctionProxy

Public Member Functions
	ARKode (const AdditionalData &data=AdditionalData())

	ARKode (const AdditionalData &data, const MPI_Comm mpi_comm)

	ARKode (ARKodeStepper< VectorType > &stepper, const AdditionalData &data=AdditionalData())

	ARKode (ARKodeStepper< VectorType > &stepper, const AdditionalData &data, const MPI_Comm mpi_comm)

	~ARKode ()

unsigned int	solve_ode (VectorType &solution)

unsigned int	solve_ode_incrementally (VectorType &solution, const double intermediate_time, const bool reset_solver=false)

void	reset (const double t, const double h, const VectorType &y)

void	resize (const double t, const double hscale, const VectorType &y)

void *	get_arkode_memory () const

Public Attributes
FunctionProxy< void(const double t, const VectorType &y, VectorType &explicit_f)>	explicit_function

FunctionProxy< void(const double t, const VectorType &y, VectorType &res)>	implicit_function

FunctionProxy< void(const double t, const VectorType &v, VectorType &Mv)>	mass_times_vector

FunctionProxy< void(const double t)>	mass_times_setup

FunctionProxy< void(const VectorType &v, VectorType &Jv, const double t, const VectorType &y, const VectorType &fy)>	jacobian_times_vector

FunctionProxy< void(const double t, const VectorType &y, const VectorType &fy)>	jacobian_times_setup

FunctionProxy< void(SundialsOperator< VectorType > &op, SundialsPreconditioner< VectorType > &prec, VectorType &x, const VectorType &b, double tol)>	solve_linearized_system

FunctionProxy< void(SundialsOperator< VectorType > &op, SundialsPreconditioner< VectorType > &prec, VectorType &x, const VectorType &b, double tol)>	solve_mass

FunctionProxy< void(const double t, const VectorType &y, const VectorType &fy, const VectorType &r, VectorType &z, const double gamma, const double tol, const int lr)>	jacobian_preconditioner_solve

FunctionProxy< void(const double t, const VectorType &y, const VectorType &fy, const int jok, int &jcur, const double gamma)>	jacobian_preconditioner_setup

FunctionProxy< void(const double t, const VectorType &r, VectorType &z, const double tol, const int lr)>	mass_preconditioner_solve

FunctionProxy< void(const double t)>	mass_preconditioner_setup

std::function< void(const double t, const VectorType &sol, const unsigned int step_number)>	output_step

std::function< bool(const double t, VectorType &sol)>	solver_should_restart

std::function< double(const double t, VectorType &sol)>	solver_should_resize

std::function< VectorType &()>	get_local_tolerances

std::function< void(void *arkode_mem)>	custom_setup

Private Member Functions
unsigned int	do_evolve_time (VectorType &solution, ::DiscreteTime &time, const bool do_reset)

void	set_functions_to_trigger_an_assert ()

void	set_tolerances ()

void	initialize_context ()

void	attach_stepper ()

Static Private Member Functions
static ::ExceptionBase &	ExcFunctionNotProvided (std::string arg1)

Private Attributes
AdditionalData	data

std::unique_ptr< ARKStepper< VectorType > >	ark_stepper_storage {nullptr}

ARKodeStepper< VectorType > &	stepper

internal::SharedSUNContext	arkode_ctx

MPI_Comm	mpi_communicator

double	last_end_time

std::exception_ptr	pending_exception

Constructor & Destructor Documentation

◆ ARKode() [1/4]

template<typename VectorType = Vector<double>>

SUNDIALS::ARKode< VectorType >::ARKode ( const AdditionalData & data = AdditionalData() )

Constructor, with class parameters set by the AdditionalData object.

Parameters

data	ARKode configuration data

Note: With SUNDIALS 6 and later this constructor sets up logging objects to only work on the present processor (i.e., results are only communicated over MPI_COMM_SELF).

◆ ARKode() [2/4]

template<typename VectorType = Vector<double>>

SUNDIALS::ARKode< VectorType >::ARKode	(	const AdditionalData &	data,
		const MPI_Comm	mpi_comm
	)

Constructor receiving the additional data and MPI communicator.

Parameters

data	ARKode configuration data
mpi_comm	MPI Communicator over which logging operations are computed. Only used in SUNDIALS 6 and newer.

◆ ARKode() [3/4]

template<typename VectorType = Vector<double>>

SUNDIALS::ARKode< VectorType >::ARKode	(	ARKodeStepper< VectorType > &	stepper,
		const AdditionalData &	data = `AdditionalData()`
	)

Constructor receiving the stepper and optionally the additional data.

Parameters

stepper	ARKodeStepper object
data	ARKode configuration data

Note: With SUNDIALS 6 and later this constructor sets up logging objects to only work on the present processor (i.e., results are only communicated over MPI_COMM_SELF).

◆ ARKode() [4/4]

template<typename VectorType = Vector<double>>

SUNDIALS::ARKode< VectorType >::ARKode	(	ARKodeStepper< VectorType > &	stepper,
		const AdditionalData &	data,
		const MPI_Comm	mpi_comm
	)

Constructor receiving the stepper, additional data, and MPI communicator.

Parameters

stepper	ARKodeStepper object
data	ARKode configuration data
mpi_comm	MPI Communicator over which logging operations are computed. Only used in SUNDIALS 6 and newer.

◆ ~ARKode()

template<typename VectorType = Vector<double>>

SUNDIALS::ARKode< VectorType >::~ARKode ( )

Destructor.

Member Function Documentation

◆ solve_ode()

template<typename VectorType = Vector<double>>

unsigned int SUNDIALS::ARKode< VectorType >::solve_ode ( VectorType & solution )

Integrate the initial value problem. This function returns the final number of computed steps.

Parameters

solution On input, this vector contains the initial condition. On output, it contains the solution at the final time.

◆ solve_ode_incrementally()

template<typename VectorType = Vector<double>>

unsigned int SUNDIALS::ARKode< VectorType >::solve_ode_incrementally	(	VectorType &	solution,
		const double	intermediate_time,
		const bool	reset_solver = `false`
	)

Integrate the initial value problem. Compared to the function above, this function allows to specify an intermediate_time for the next solution. Repeated calls of this function must use monotonously increasing values for intermediate_time. The last solution state is saved internally along with the intermediate_time and will be reused as initial condition for the next call.

Users may find this function useful when integrating ARKode into an outer time loop of their own, especially when output_step() is too restrictive.

Note: intermediate_time may be larger than AdditionalData::final_time, which is ignored by this function.

Parameters

solution	The final solution. If the solver restarts, either because it is the first ever solve or the flag `reset_solver` is set, the vector is also used as initial condition.
intermediate_time	The time for the incremental solution step. Must be greater than the last time that was used in a previous call to this function.
reset_solver	Optional flag to recreate all internal objects which may be desirable for spatial adaptivity methods. If set to `true`, reset() is called before solving the ODE, which sets `solution` as initial condition. This will not reset the stored time from previous calls to this function.

◆ reset()

template<typename VectorType = Vector<double>>

void SUNDIALS::ARKode< VectorType >::reset	(	const double	t,
		const double	h,
		const VectorType &	y
	)

Clear internal memory and start with clean objects. This function is called when the simulation starts and when the user returns true to a call to solver_should_restart().

By default solver_should_restart() returns false. If the user needs to implement, for example, local adaptivity in space, he or she may assign a different function to solver_should_restart() that performs all mesh changes, transfers the solution to the new mesh, and returns true.

Parameters

t	The new starting time
h	The new starting time step
y	The new initial solution

◆ resize()

template<typename VectorType = Vector<double>>

void SUNDIALS::ARKode< VectorType >::resize	(	const double	t,
		const double	hscale,
		const VectorType &	y
	)

Adapt the internal objects to a solution vector of a different size while preserving the time stepping history (step size, adaptivity state and step counters). This function is called when the user returns a positive value from a call to solver_should_resize().

Compared to reset(), the SUNDIALS context is kept and the stepper is resized in place via ARKodeResize(). The tolerances are applied again.

Parameters

t	The current time
hscale	Factor by which the upcoming time step is rescaled
y	The current solution with the new size

◆ get_arkode_memory()

template<typename VectorType = Vector<double>>

void * SUNDIALS::ARKode< VectorType >::get_arkode_memory ( ) const

Provides user access to the internally used ARKODE memory.

This functionality is intended for users who wish to query additional information directly from the ARKODE integrator, refer to the ARKODE manual for the various ARKStepGet... functions. The ARKStepSet... functions should not be called since this might lead to conflicts with various settings that are performed by this ARKode object.

Note: If custom settings of ARKODE functionality (that are not achievable via the interface of this class) are required, the function custom_setup() should be used.

Returns: pointer to the ARKODE memory block that can be passed to SUNDIALS functions

◆ do_evolve_time()

template<typename VectorType = Vector<double>>

unsigned int SUNDIALS::ARKode< VectorType >::do_evolve_time	(	VectorType &	solution,
		::DiscreteTime &	time,
		const bool	do_reset
	)

private

Internal routine to call ARKode repeatedly.

◆ set_functions_to_trigger_an_assert()

template<typename VectorType = Vector<double>>

void SUNDIALS::ARKode< VectorType >::set_functions_to_trigger_an_assert ( )

private

This function is executed at construction time to set the std::function above to trigger an assert if they are not implemented.

◆ set_tolerances()

template<typename VectorType = Vector<double>>

void SUNDIALS::ARKode< VectorType >::set_tolerances ( )

private

Apply the tolerances from AdditionalData or get_local_tolerances() to the ARKODE memory of the stepper.

◆ initialize_context()

template<typename VectorType = Vector<double>>

void SUNDIALS::ARKode< VectorType >::initialize_context ( )

private

This function is executed at construction time to initialize the SUNContext object.

◆ attach_stepper()

template<typename VectorType = Vector<double>>

void SUNDIALS::ARKode< VectorType >::attach_stepper ( )

private

Attach the stepper to this object, see ARKodeStepper::attach().

Member Data Documentation

◆ explicit_function

template<typename VectorType = Vector<double>>

FunctionProxy< void(const double t, const VectorType &y, VectorType &explicit_f)> SUNDIALS::ARKode< VectorType >::explicit_function

A function object that users may supply and that is intended to compute the explicit part of the IVP right hand side. Sets \(explicit_f = f_E(t, y)\).

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::explicit_function instead.

Definition at line 516 of file arkode.h.

◆ implicit_function

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t, const VectorType &y, VectorType &res)> SUNDIALS::ARKode< VectorType >::implicit_function

A function object that users may supply and that is intended to compute the implicit part of the IVP right hand side. Sets \(implicit_f = f_I(t, y)\).

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::implicit_function instead.

Definition at line 531 of file arkode.h.

◆ mass_times_vector

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t, const VectorType &v, VectorType &Mv)> SUNDIALS::ARKode< VectorType >::mass_times_vector

A function object that users may supply and that is intended to compute the product of the mass matrix with a given vector v. This function will be called by ARKode (possibly several times) after mass_times_setup() has been called at least once. ARKode tries to do its best to call mass_times_setup() the minimum amount of times.

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::mass_times_vector instead.

Definition at line 548 of file arkode.h.

◆ mass_times_setup

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t)> SUNDIALS::ARKode< VectorType >::mass_times_setup

A function object that users may supply and that is intended to set up the mass matrix. This function is called by ARKode any time a mass matrix update is required. The user should compute the mass matrix (or update all the variables that allow the application of the mass matrix). This function is guaranteed to be called by ARKode at least once, before any call to mass_times_vector().

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::mass_times_vector_setup instead.

Definition at line 565 of file arkode.h.

◆ jacobian_times_vector

template<typename VectorType = Vector<double>>

FunctionProxy<void(const VectorType &v, VectorType &Jv, const double t, const VectorType &y, const VectorType &fy)> SUNDIALS::ARKode< VectorType >::jacobian_times_vector

A function object that users may supply and that is intended to compute the product of the Jacobian matrix with a given vector v. The Jacobian here refers to \(J=\frac{\partial f_I}{\partial y}\), i.e., the Jacobian of the user-specified implicit_function.

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::jacobian_times_vector instead.

Definition at line 585 of file arkode.h.

◆ jacobian_times_setup

template<typename VectorType = Vector<double>>

FunctionProxy< void(const double t, const VectorType &y, const VectorType &fy)> SUNDIALS::ARKode< VectorType >::jacobian_times_setup

A function object that users may supply and that is intended to set up all data necessary for the application of jacobian_times_vector().

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::jacobian_times_vector_setup instead.

Definition at line 600 of file arkode.h.

◆ solve_linearized_system

template<typename VectorType = Vector<double>>

FunctionProxy<void(SundialsOperator<VectorType> &op, SundialsPreconditioner<VectorType> &prec, VectorType &x, const VectorType &b, double tol)> SUNDIALS::ARKode< VectorType >::solve_linearized_system

A LinearSolveFunction object that users may supply and that is intended to solve the linearized system \(Ax=b\), where \(A = M-\gamma J\) is the Jacobian of the nonlinear residual.

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::solve_linearized_system instead.

Definition at line 619 of file arkode.h.

◆ solve_mass

template<typename VectorType = Vector<double>>

FunctionProxy<void(SundialsOperator<VectorType> &op, SundialsPreconditioner<VectorType> &prec, VectorType &x, const VectorType &b, double tol)> SUNDIALS::ARKode< VectorType >::solve_mass

A LinearSolveFunction object that users may supply and that is intended to solve the mass system \(Mx=b\).

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::solve_mass instead.

Definition at line 637 of file arkode.h.

◆ jacobian_preconditioner_solve

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t, const VectorType &y, const VectorType &fy, const VectorType &r, VectorType &z, const double gamma, const double tol, const int lr)> SUNDIALS::ARKode< VectorType >::jacobian_preconditioner_solve

A function object that users may supply to either pass a preconditioner to a SUNDIALS built-in solver or to apply a custom preconditioner within the user's own linear solve specified in solve_linearized_system().

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::jacobian_preconditioner_solve instead.

Definition at line 659 of file arkode.h.

◆ jacobian_preconditioner_setup

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t, const VectorType &y, const VectorType &fy, const int jok, int &jcur, const double gamma)> SUNDIALS::ARKode< VectorType >::jacobian_preconditioner_setup

A function object that users may supply to set up a preconditioner specified in jacobian_preconditioner_solve().

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::jacobian_preconditioner_setup instead.

Definition at line 678 of file arkode.h.

◆ mass_preconditioner_solve

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t, const VectorType &r, VectorType &z, const double tol, const int lr)> SUNDIALS::ARKode< VectorType >::mass_preconditioner_solve

A function object that users may supply to either pass a preconditioner to a SUNDIALS built-in solver or to apply a custom preconditioner within the user's own linear solve specified in solve_mass().

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::mass_preconditioner_solve instead.

Definition at line 697 of file arkode.h.

◆ mass_preconditioner_setup

template<typename VectorType = Vector<double>>

FunctionProxy<void(const double t)> SUNDIALS::ARKode< VectorType >::mass_preconditioner_setup

A function object that users may supply to set up a preconditioner specified in mass_preconditioner_setup().

Note: This member represents a local proxy wrapper around the corresponding property of ARKStepper and should be used only if ARKStepper is provided to ARKode as a stepper. If this requirement is violated, an exception is triggered upon access to this field.

Deprecated:: Specify ARKStepper::mass_preconditioner_solve instead.

Definition at line 710 of file arkode.h.

◆ output_step

template<typename VectorType = Vector<double>>

std::function<void(const double t, const VectorType &sol, const unsigned int step_number)> SUNDIALS::ARKode< VectorType >::output_step

A function object that users may supply and that is intended to postprocess the solution. This function is called by ARKode at fixed time increments (every output_period time units), and it is passed a polynomial interpolation of the solution, computed using the current ARK order and the (internally stored) previously computed solution steps.

Note: It is well possible that internally ARKode computes a time step which is much larger than the output_period step, and therefore calls this function consecutively several times by simply performing all intermediate interpolations. There is no relationship between how many times this function is called and how many time steps have actually been computed.

Definition at line 729 of file arkode.h.

◆ solver_should_restart

template<typename VectorType = Vector<double>>

std::function<bool(const double t, VectorType &sol)> SUNDIALS::ARKode< VectorType >::solver_should_restart

A function object that users may supply and that is intended to evaluate whether the solver should be restarted (for example because the number of degrees of freedom has changed).

This function is supposed to perform all operations that are necessary in sol to make sure that the resulting vectors are consistent, and of the correct final size.

For example, one may decide that a local refinement is necessary at time t. This function should then return true, and change the dimension of sol to reflect the new dimension. Since ARKode does not know about the new dimension, an internal reset is necessary.

The default implementation simply returns false, i.e., no restart is performed during the evolution.

Definition at line 748 of file arkode.h.

◆ solver_should_resize

template<typename VectorType = Vector<double>>

std::function<double(const double t, VectorType &sol)> SUNDIALS::ARKode< VectorType >::solver_should_resize

A function object that users may supply and that is intended to adapt the solver to a change of the size of the solution vector (for example after mesh refinement) without discarding the time stepping history.

Like solver_should_restart(), this function is supposed to perform all operations in sol that are necessary to make it consistent and of the correct final size. It returns the factor by which the upcoming time step should be rescaled (use 1.0 to keep it), in which case resize() is called. Returning zero means that no resize is required. Like solver_should_restart(), it is called repeatedly until it returns zero.

This function is checked before solver_should_restart(). Use the latter if the dynamics change so much that the time stepping history should be discarded.

By default this function is not set, i.e., no resize is performed.

Definition at line 768 of file arkode.h.

◆ get_local_tolerances

template<typename VectorType = Vector<double>>

std::function<VectorType &()> SUNDIALS::ARKode< VectorType >::get_local_tolerances

A function object that users may supply and that is intended to return a vector whose components are the weights used by ARKode to compute the vector norm. The implementation of this function is optional, and it is used only if implemented.

Definition at line 776 of file arkode.h.

◆ custom_setup

template<typename VectorType = Vector<double>>

std::function<void(void *arkode_mem)> SUNDIALS::ARKode< VectorType >::custom_setup

A function object that users may supply and which is intended to perform custom settings on the supplied arkode_mem object. Refer to the SUNDIALS documentation for valid options.

For instance, the following code sets Lagrange interpolants to be used for dense output (interpolation of solution output values) and implicit method predictors:

ode.custom_setup = [&](void *arkode_mem) {
  ARKodeSetInterpolantType(arkode_mem, ARK_INTERP_LAGRANGE);
};

Note: This function will be called at the end of all other set up right before the actual time evolution is started or continued with solve_ode(). This function is also called when the solver is restarted, see solver_should_restart(). Consult the SUNDIALS manual to see which options are still available at this point.

Parameters

arkode_mem pointer to the ARKODE memory block which can be used for custom calls to ARKodeSet... methods.

Definition at line 802 of file arkode.h.

◆ data

template<typename VectorType = Vector<double>>

AdditionalData SUNDIALS::ARKode< VectorType >::data

private

ARKode configuration data.

Definition at line 853 of file arkode.h.

◆ ark_stepper_storage

template<typename VectorType = Vector<double>>

std::unique_ptr<ARKStepper<VectorType> > SUNDIALS::ARKode< VectorType >::ark_stepper_storage {nullptr}

private

Internal stepper object if a constructor without a stepper was invoked. The need for this object arises due to interface backward compatibility requirement.

Definition at line 860 of file arkode.h.

◆ stepper

template<typename VectorType = Vector<double>>

ARKodeStepper<VectorType>& SUNDIALS::ARKode< VectorType >::stepper

private

Stepper object.

Definition at line 865 of file arkode.h.

◆ arkode_ctx

template<typename VectorType = Vector<double>>

internal::SharedSUNContext SUNDIALS::ARKode< VectorType >::arkode_ctx

private

A context object associated with the ARKode solver. It is shared with the stepper, so it is freed after the last of them is gone.

Definition at line 872 of file arkode.h.

◆ mpi_communicator

template<typename VectorType = Vector<double>>

MPI_Comm SUNDIALS::ARKode< VectorType >::mpi_communicator

private

MPI communicator. Only used for SUNDIALS' logging routines - the actual solve routines will use the communicator provided by the vector class.

Definition at line 879 of file arkode.h.

◆ last_end_time

template<typename VectorType = Vector<double>>

double SUNDIALS::ARKode< VectorType >::last_end_time

private

The final time in the last call to solve_ode().

Definition at line 884 of file arkode.h.

◆ pending_exception

template<typename VectorType = Vector<double>>

std::exception_ptr SUNDIALS::ARKode< VectorType >::pending_exception

mutableprivate

A pointer to any exception that may have been thrown in user-defined call-backs and that we have to deal after the KINSOL function we call has returned.

Definition at line 891 of file arkode.h.

The documentation for this class was generated from the following file:

include/deal.II/sundials/arkode.h

Detailed Description

Classes

Public Member Functions

Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ ARKode() [1/4]

◆ ARKode() [2/4]

◆ ARKode() [3/4]

◆ ARKode() [4/4]

◆ ~ARKode()

Member Function Documentation

◆ solve_ode()

◆ solve_ode_incrementally()

◆ reset()

◆ resize()

◆ get_arkode_memory()

◆ do_evolve_time()

◆ set_functions_to_trigger_an_assert()

◆ set_tolerances()

◆ initialize_context()

◆ attach_stepper()

Member Data Documentation

◆ explicit_function

◆ implicit_function

◆ mass_times_vector

◆ mass_times_setup

◆ jacobian_times_vector

◆ jacobian_times_setup

◆ solve_linearized_system

◆ solve_mass

◆ jacobian_preconditioner_solve

◆ jacobian_preconditioner_setup

◆ mass_preconditioner_solve

◆ mass_preconditioner_setup

◆ output_step

◆ solver_should_restart

◆ solver_should_resize

◆ get_local_tolerances

◆ custom_setup

◆ data

◆ ark_stepper_storage

◆ stepper

◆ arkode_ctx

◆ mpi_communicator

◆ last_end_time

◆ pending_exception