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

Detailed Description

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

Additional parameters that can be passed to the ARKode class.

Definition at line 153 of file arkode.h.

Public Member Functions
	AdditionalData (const double initial_time, const double final_time, const double initial_step_size, const double output_period, const double minimum_step_size, const unsigned int maximum_order=5, 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 double absolute_tolerance=1e-6, const double relative_tolerance=1e-5)

	AdditionalData (const double initial_time=0.0, const double final_time=1.0, const double initial_step_size=1e-2, const double output_period=1e-1, const double minimum_step_size=1e-6, const double absolute_tolerance=1e-6, const double relative_tolerance=1e-5)

void	add_parameters (ParameterHandler &prm)

Public Attributes
double	initial_time

double	final_time

double	initial_step_size

double	minimum_step_size

double	absolute_tolerance

double	relative_tolerance

unsigned int	maximum_order

double	output_period

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

Constructor & Destructor Documentation

◆ AdditionalData() [1/2]

template<typename VectorType >

SUNDIALS::ARKode< VectorType >::AdditionalData::AdditionalData	(	const double	initial_time,
		const double	final_time,
		const double	initial_step_size,
		const double	output_period,
		const double	minimum_step_size,
		const unsigned int	maximum_order = `5`,
		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 double	absolute_tolerance = `1e-6`,
		const double	relative_tolerance = `1e-5`
	)

Initialization parameters for ARKode. Some parameters are provided for interface backward compatibility and have been effectively moved to the AKRStepper additional parameters.

Global parameters:

Parameters

initial_time	Initial time
final_time	Final time
initial_step_size	Initial step size
output_period	Desired time interval between each output

Run-control parameters:

Parameters

minimum_step_size	Minimum step size
maximum_order	Maximum ARK order
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.

Error parameters:

Parameters

absolute_tolerance	Absolute error tolerance
relative_tolerance	Relative error tolerance

Definition at line 857 of file arkode.h.

◆ AdditionalData() [2/2]

template<typename VectorType >

SUNDIALS::ARKode< VectorType >::AdditionalData::AdditionalData	(	const double	initial_time = `0.0`,
		const double	final_time = `1.0`,
		const double	initial_step_size = `1e-2`,
		const double	output_period = `1e-1`,
		const double	minimum_step_size = `1e-6`,
		const double	absolute_tolerance = `1e-6`,
		const double	relative_tolerance = `1e-5`
	)

Initialization parameters for ARKode.

Global parameters:

Parameters

initial_time	Initial time
final_time	Final time
initial_step_size	Initial step size
output_period	Desired time interval between each output

Running parameters:

Parameters

minimum_step_size Minimum step size

Error parameters:

Parameters

absolute_tolerance	Absolute error tolerance
relative_tolerance	Relative error tolerance

Definition at line 893 of file arkode.h.

Member Function Documentation

◆ add_parameters()

template<typename VectorType >

void SUNDIALS::ARKode< 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 923 of file arkode.h.