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

Detailed Description

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

Additional parameters that can be passed to the ARKStepper class.

Definition at line 407 of file arkode_stepper.h.

Public Member Functions
	AdditionalData (const unsigned int order=0, const unsigned int maximum_non_linear_iterations=10, const bool implicit_function_is_linear=false, const bool implicit_function_is_time_independent=false, const bool mass_is_time_independent=false, const int anderson_acceleration_subspace=3, const std::string &implicit_butcher_table="", const std::string &explicit_butcher_table="")

void	add_parameters (ParameterHandler &prm)

Public Attributes
unsigned int	order

unsigned int	maximum_non_linear_iterations

bool	implicit_function_is_linear

bool	implicit_function_is_time_independent

bool	mass_is_time_independent

int	anderson_acceleration_subspace

std::string	implicit_butcher_table

std::string	explicit_butcher_table

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename VectorType >

SUNDIALS::ARKStepper< VectorType >::AdditionalData::AdditionalData	(	const unsigned int	order = `0`,
		const unsigned int	maximum_non_linear_iterations = `10`,
		const bool	implicit_function_is_linear = `false`,
		const bool	implicit_function_is_time_independent = `false`,
		const bool	mass_is_time_independent = `false`,
		const int	anderson_acceleration_subspace = `3`,
		const std::string &	implicit_butcher_table = `""`,
		const std::string &	explicit_butcher_table = `""`
	)

explicit

Initialization parameters for ARKStepper.

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 can't be set to a nonzero value if either of the parameters `implicit_butcher_table` or `explicit_butcher_table` is set to a non-empty string.
maximum_non_linear_iterations	Maximum number of nonlinear iterations
implicit_function_is_linear	Specifies that the implicit portion of the problem is linear
implicit_function_is_time_independent	Specifies that the implicit portion of the problem is linear and time independent
mass_is_time_independent	Specifies that the mass pre-factor is independent of time
anderson_acceleration_subspace	The number of vectors to use for Anderson acceleration within the packaged SUNDIALS solver.
implicit_butcher_table	Name of the implicit (DIRK) Butcher table. The default is an empty string. If both `implicit_butcher_table` and `explicit_butcher_table` are left as empty strings, then ARKStep will default to the method corresponding to the specified order (or the default order if `order` is set to 0). If `implicit_butcher_table` is left empty but `explicit_butcher_table` is set to a non-empty string, that means no implicit table is selected, which is equivalent to passing `"ARKODE_DIRK_NONE"` to SUNDIALS. If `implicit_butcher_table` is set to a non-empty string, then the method corresponding to the specified table will be used. This option is supported if SUNDIALS version 6.4.0 or later is used.
explicit_butcher_table	Name of the explicit (ERK) Butcher table. The default is an empty string. If both `implicit_butcher_table` and `explicit_butcher_table` are left as empty strings, then ARKStep will default to the method corresponding to the specified order (or the default order if `order` is set to 0). If `explicit_butcher_table` is left empty but `implicit_butcher_table` is set to a non-empty string, that means no explicit table is selected, which is equivalent to passing `"ARKODE_ERK_NONE"` to SUNDIALS. If `explicit_butcher_table` is set to a non-empty string, then the method corresponding to the specified table will be used. This option is supported if SUNDIALS version 6.4.0 or later is used.

Definition at line 1034 of file arkode_stepper.h.

Member Function Documentation

◆ add_parameters()

template<typename VectorType >

void SUNDIALS::ARKStepper< 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 1058 of file arkode_stepper.h.