mfem::SundialsSolver Class Reference

A base class for the MFEM classes wrapping SUNDIALS' solvers. More...

#include <sundials.hpp>

Inheritance diagram for mfem::SundialsSolver:

Public Member Functions
void *	SundialsMem () const
	Access the underlying SUNDIALS object. More...
int	GetFlag () const
	Return the flag returned by the last call to a SUNDIALS function. More...

Protected Member Functions
bool	Parallel () const
bool	Parallel () const
The constructors are protected
	SundialsSolver ()
	SundialsSolver (void *mem)

Static Protected Member Functions
static int	ODEMult (realtype t, const N_Vector y, N_Vector ydot, void *td_oper)
	Callback function used in CVODESolver and ARKODESolver. More...

Protected Attributes
void *	sundials_mem
	Pointer to the SUNDIALS mem object. More...
int	flag
	Flag returned by the last call to SUNDIALS. More...
N_Vector	y
	Auxiliary N_Vector. More...

Static Protected Attributes
static const double	default_rel_tol = 1e-4
static const double	default_abs_tol = 1e-9

Detailed Description

A base class for the MFEM classes wrapping SUNDIALS' solvers.

This class defines some common data and functions used by the SUNDIALS solvers, e.g the common sundials_mem pointer and return flag.

Definition at line 87 of file sundials.hpp.

Constructor & Destructor Documentation

mfem::SundialsSolver::SundialsSolver ( )

inlineprotected

Definition at line 111 of file sundials.hpp.

mfem::SundialsSolver::SundialsSolver ( void *  mem )

inlineprotected

Definition at line 112 of file sundials.hpp.

Member Function Documentation

int mfem::SundialsSolver::GetFlag ( ) const

inline

Return the flag returned by the last call to a SUNDIALS function.

Definition at line 120 of file sundials.hpp.

int mfem::SundialsSolver::ODEMult ( realtype  t, const N_Vector  y, N_Vector  ydot, void *  td_oper  )

staticprotected

Callback function used in CVODESolver and ARKODESolver.

Definition at line 157 of file sundials.cpp.

bool mfem::SundialsSolver::Parallel ( ) const

inlineprotected

Definition at line 95 of file sundials.hpp.

bool mfem::SundialsSolver::Parallel ( ) const

inlineprotected

Definition at line 98 of file sundials.hpp.

void* mfem::SundialsSolver::SundialsMem ( ) const

inline

Access the underlying SUNDIALS object.

Definition at line 117 of file sundials.hpp.

Member Data Documentation

const double mfem::SundialsSolver::default_abs_tol = 1e-9

staticprotected

Definition at line 102 of file sundials.hpp.

const double mfem::SundialsSolver::default_rel_tol = 1e-4

staticprotected

Definition at line 101 of file sundials.hpp.

int mfem::SundialsSolver::flag

mutableprotected

Flag returned by the last call to SUNDIALS.

Definition at line 91 of file sundials.hpp.

void* mfem::SundialsSolver::sundials_mem

protected

Pointer to the SUNDIALS mem object.

Definition at line 90 of file sundials.hpp.

N_Vector mfem::SundialsSolver::y

protected

Auxiliary N_Vector.

Definition at line 93 of file sundials.hpp.

---

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

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