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

Detailed Description

template<typename VectorType = Vector<double>>
class SUNDIALS::ERKStepper< VectorType >::AdditionalData

Additional parameters that can be passed to the ERKStepper class.

ERKStep uses purely explicit Runge-Kutta methods and therefore does not require any parameters related to implicit solvers, nonlinear iterations, or mass matrices.

Definition at line 1155 of file arkode_stepper.h.

Public Member Functions
	AdditionalData (const unsigned int order=0, const std::string &explicit_butcher_table="")

void	add_parameters (ParameterHandler &prm)

Public Attributes
unsigned int	order

std::string	explicit_butcher_table

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename VectorType >

SUNDIALS::ERKStepper< VectorType >::AdditionalData::AdditionalData	(	const unsigned int	order = `0`,
		const std::string &	explicit_butcher_table = `""`
	)

Initialization parameters for ERKStepper.

Parameters

order	Desired order of accuracy for the time integration. If set to 0 the default order for the chosen method is used. This parameter is mutually exclusive with `explicit_butcher_table`.
explicit_butcher_table	Name of the explicit (ERK) Butcher table. An empty string leaves the table unset (SUNDIALS default). Must be a name recognised by ERKStep (e.g., `"ARKODE_BOGACKI_SHAMPINE_4_2_3"`, `"ARKODE_FEHLBERG_13_7_8"`). This parameter is mutually exclusive with `order`.

Definition at line 1302 of file arkode_stepper.h.

Member Function Documentation

◆ add_parameters()

template<typename VectorType >

void SUNDIALS::ERKStepper< VectorType >::AdditionalData::add_parameters ( ParameterHandler & prm )

Add all AdditionalData() parameters to the given ParameterHandler object. When the parameters are parsed from a file, the internal parameters are automatically updated.

The options you pass at construction time are set as default values in the ParameterHandler object prm. You can later modify them by parsing a parameter file using prm. The values of the parameter will be updated whenever the content of prm is updated.

Make sure that this class lives longer than prm. Undefined behavior will occur if you destroy this class, and then parse a parameter file using prm.

Definition at line 1313 of file arkode_stepper.h.

Member Data Documentation

◆ order

template<typename VectorType = Vector<double>>

unsigned int SUNDIALS::ERKStepper< VectorType >::AdditionalData::order

Desired order of accuracy for the time integration. If set to 0 the default order for the chosen method is used.

This option is mutually exclusive with explicit_butcher_table: either the order is specified, or a specific Butcher table is chosen, but not both.

Definition at line 1198 of file arkode_stepper.h.

◆ explicit_butcher_table

template<typename VectorType = Vector<double>>

std::string SUNDIALS::ERKStepper< VectorType >::AdditionalData::explicit_butcher_table

Name of the explicit (ERK) Butcher table to use. An empty string leaves the table unset (SUNDIALS default).

Must be a name recognised by ERKStep (e.g., "ARKODE_BOGACKI_SHAMPINE_4_2_3", "ARKODE_FEHLBERG_13_7_8"). This option is mutually exclusive with order.

Definition at line 1208 of file arkode_stepper.h.

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

include/deal.II/sundials/arkode_stepper.h