sundials.hpp File Reference

Go to the source code of this file.

Classes
class	mfem::SundialsMemHelper
class	mfem::Sundials
	Singleton class for SUNContext and SundialsMemHelper objects. More...
class	mfem::SundialsNVector
	Vector interface for SUNDIALS N_Vectors. More...
class	mfem::SundialsSolver
	Base class for interfacing with SUNDIALS packages. More...
class	mfem::CVODESolver
	Interface to the CVODE library – linear multi-step methods. More...
class	mfem::CVODESSolver
class	mfem::ARKStepSolver
	Interface to ARKode's ARKStep module – additive Runge-Kutta methods. More...
class	mfem::KINSolver
	Interface to the KINSOL library – nonlinear solver methods. More...

Namespaces
namespace	mfem

Typedefs
using	ARKODE_ERKTableID = int
using	ARKODE_DIRKTableID = int
using	SUNContext = void*
typedef realtype	sunrealtype
	'sunrealtype' was first introduced in v6.0.0
typedef booleantype	sunbooleantype
	'sunbooleantype' was first introduced in v6.0.0

Enumerations
enum	{ SUN_PREC_NONE , SUN_PREC_LEFT , SUN_PREC_RIGHT , SUN_PREC_BOTH }
	New constant names introduced in v6.0.0. More...
enum	{ SUN_SUCCESS = 0 }
	The enum constant SUN_SUCCESS was added in v7 as a replacement of various *_SUCCESS macros that were removed in v7. More...

Variables
constexpr ARKODE_ERKTableID	ARKODE_ERK_NONE = -1
constexpr ARKODE_DIRKTableID	ARKODE_DIRK_NONE = -1
constexpr ARKODE_ERKTableID	ARKODE_FEHLBERG_13_7_8 = FEHLBERG_13_7_8

Typedef Documentation

ARKODE_DIRKTableID

using ARKODE_DIRKTableID = int

Definition at line 66 of file sundials.hpp.

ARKODE_ERKTableID

using ARKODE_ERKTableID = int

(DEPRECATED) Map SUNDIALS version >= 6 datatypes and constants to version < 6 for backwards compatibility

Definition at line 65 of file sundials.hpp.

sunbooleantype

typedef booleantype sunbooleantype

'sunbooleantype' was first introduced in v6.0.0

Definition at line 78 of file sundials.hpp.

SUNContext

using SUNContext = void*

(DEPRECATED) There is no SUNContext in SUNDIALS version < 6 so set it to arbitrary type for more compact backwards compatibility

Definition at line 73 of file sundials.hpp.

sunrealtype

typedef realtype sunrealtype

'sunrealtype' was first introduced in v6.0.0

Definition at line 76 of file sundials.hpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

New constant names introduced in v6.0.0.

Enumerator
SUN_PREC_NONE
SUN_PREC_LEFT
SUN_PREC_RIGHT
SUN_PREC_BOTH

Definition at line 81 of file sundials.hpp.

anonymous enum

anonymous enum

The enum constant SUN_SUCCESS was added in v7 as a replacement of various *_SUCCESS macros that were removed in v7.

Enumerator
SUN_SUCCESS

Definition at line 95 of file sundials.hpp.

Variable Documentation

ARKODE_DIRK_NONE

ARKODE_DIRKTableID ARKODE_DIRK_NONE = -1

constexpr

Definition at line 68 of file sundials.hpp.

ARKODE_ERK_NONE

ARKODE_ERKTableID ARKODE_ERK_NONE = -1

constexpr

Definition at line 67 of file sundials.hpp.

ARKODE_FEHLBERG_13_7_8

ARKODE_ERKTableID ARKODE_FEHLBERG_13_7_8 = FEHLBERG_13_7_8

constexpr

Definition at line 69 of file sundials.hpp.