mfem::Sundials Class Reference

Singleton class for SUNContext and SundialsMemHelper objects. More...

#include <sundials.hpp>

Public Member Functions
	Sundials (Sundials &other)=delete
	Disable copy construction.
void	operator= (const Sundials &other)=delete
	Disable copy assignment.

Static Public Member Functions
static void	Init ()
	Initializes SUNContext and SundialsMemHelper objects. Should be called at the beginning of the calling program (after Mpi::Init if applicable)
static void	Finalize ()
	Finalize sundials (called automatically at program exit if Sundials::Init() has been called).
static SUNContext &	GetContext ()
	Provides access to the SUNContext object.
static SundialsMemHelper &	GetMemHelper ()
	Provides access to the SundialsMemHelper object.

Detailed Description

Singleton class for SUNContext and SundialsMemHelper objects.

Definition at line 175 of file sundials.hpp.

Constructor & Destructor Documentation

Sundials()

mfem::Sundials::Sundials ( Sundials & other )

delete

Disable copy construction.

Member Function Documentation

Finalize()

void mfem::Sundials::Finalize ( )

static

Finalize sundials (called automatically at program exit if Sundials::Init() has been called).

Multiple calls to Sundials::Finalize() have no effect. This function can be called manually to more precisely control when sundials is finalized.

Definition at line 226 of file sundials.cpp.

GetContext()

SUNContext & mfem::Sundials::GetContext ( )

static

Provides access to the SUNContext object.

Definition at line 185 of file sundials.cpp.

GetMemHelper()

SundialsMemHelper & mfem::Sundials::GetMemHelper ( )

static

Provides access to the SundialsMemHelper object.

Definition at line 190 of file sundials.cpp.

Init()

void mfem::Sundials::Init ( )

static

Initializes SUNContext and SundialsMemHelper objects. Should be called at the beginning of the calling program (after Mpi::Init if applicable)

Multiple calls to Sundials::Init() have no effect.

Definition at line 174 of file sundials.cpp.

operator=()

void mfem::Sundials::operator= ( const Sundials & other )

delete

Disable copy assignment.

---

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

• linalg/sundials.hpp
• linalg/sundials.cpp