SUNDIALS::LSRKStepperSSP< VectorType >::AdditionalData Class Reference

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

Detailed Description

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

Additional parameters for the LSRKStepperSSP class.

Definition at line 1690 of file arkode_stepper.h.

Public Member Functions
	AdditionalData (const std::string &method_name="", const unsigned int num_stages=0)
void	add_parameters (ParameterHandler &prm)

Public Attributes
std::string	method_name
unsigned int	num_stages

Constructor & Destructor Documentation

AdditionalData()

template<typename VectorType = Vector<double>>

SUNDIALS::LSRKStepperSSP< VectorType >::AdditionalData::AdditionalData ( const std::string &  method_name = "", const unsigned int  num_stages = 0  )

inline

Constructor with a complete set of default values.

Parameters

method_name	Name of the SSP method to use. If empty, SUNDIALS selects the default (SSP(10,4)). Must be a name recognised by LSRKStepSetSSPMethodByName (e.g., "ARKODE_LSRK_SSP_S_2", "ARKODE_LSRK_SSP_S_3", "ARKODE_LSRK_SSP_10_4").
num_stages	Number of SSP stages to use for variable-stage methods (ARKODE_LSRK_SSP_S_2 and ARKODE_LSRK_SSP_S_3). A value of 0 leaves the stage count at the SUNDIALS default. Forwarded to LSRKStepSetNumSSPStages.

Definition at line 1705 of file arkode_stepper.h.

Member Function Documentation

add_parameters()

template<typename VectorType >

void SUNDIALS::LSRKStepperSSP< 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.

Definition at line 1814 of file arkode_stepper.h.

Member Data Documentation

method_name

template<typename VectorType = Vector<double>>

std::string SUNDIALS::LSRKStepperSSP< VectorType >::AdditionalData::method_name

Name of the SSP method. If empty, SUNDIALS selects the default (SSP(10,4)).

Definition at line 1723 of file arkode_stepper.h.

num_stages

template<typename VectorType = Vector<double>>

unsigned int SUNDIALS::LSRKStepperSSP< VectorType >::AdditionalData::num_stages

Number of SSP stages. Only meaningful for variable-stage methods (ARKODE_LSRK_SSP_S_2, ARKODE_LSRK_SSP_S_3). 0 means SUNDIALS default. Forwarded to LSRKStepSetNumSSPStages.

Definition at line 1730 of file arkode_stepper.h.

---

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

• include/deal.II/sundials/arkode_stepper.h