MFEM  v4.6.0
Finite element discretization library
Public Member Functions | Static Public Member Functions | List of all members
mfem::SundialsMemHelper Class Reference

#include <sundials.hpp>

Public Member Functions

 SundialsMemHelper ()=default
 Default constructor – object must be moved to. More...
 
 SundialsMemHelper (SUNContext context)
 
 SundialsMemHelper (SundialsMemHelper &&that_helper)
 Implement move assignment. More...
 
 SundialsMemHelper (const SundialsMemHelper &that_helper)=delete
 Disable copy construction. More...
 
 ~SundialsMemHelper ()
 
SundialsMemHelperoperator= (const SundialsMemHelper &)=delete
 Disable copy assignment. More...
 
SundialsMemHelperoperator= (SundialsMemHelper &&rhs)
 Implement move assignment. More...
 
 operator SUNMemoryHelper () const
 Typecasting to SUNDIALS' SUNMemoryHelper type. More...
 
 SundialsMemHelper ()=default
 
 SundialsMemHelper (SUNContext context)
 

Static Public Member Functions

static int SundialsMemHelper_Alloc (SUNMemoryHelper helper, SUNMemory *memptr, size_t memsize, SUNMemoryType mem_type #if(SUNDIALS_VERSION_MAJOR >=6), void *queue #endif)
 
static int SundialsMemHelper_Dealloc (SUNMemoryHelper helper, SUNMemory sunmem #if(SUNDIALS_VERSION_MAJOR >=6), void *queue #endif)
 

Detailed Description

Definition at line 81 of file sundials.hpp.

Constructor & Destructor Documentation

◆ SundialsMemHelper() [1/6]

mfem::SundialsMemHelper::SundialsMemHelper ( )
default

Default constructor – object must be moved to.

◆ SundialsMemHelper() [2/6]

mfem::SundialsMemHelper::SundialsMemHelper ( SUNContext  context)

Require a SUNContext as an argument (rather than calling Sundials::GetContext) to avoid undefined behavior during the construction of the Sundials singleton.

Definition at line 220 of file sundials.cpp.

◆ SundialsMemHelper() [3/6]

mfem::SundialsMemHelper::SundialsMemHelper ( SundialsMemHelper &&  that_helper)

Implement move assignment.

Definition at line 232 of file sundials.cpp.

◆ SundialsMemHelper() [4/6]

mfem::SundialsMemHelper::SundialsMemHelper ( const SundialsMemHelper that_helper)
delete

Disable copy construction.

◆ ~SundialsMemHelper()

mfem::SundialsMemHelper::~SundialsMemHelper ( )
inline

Definition at line 101 of file sundials.hpp.

◆ SundialsMemHelper() [5/6]

mfem::SundialsMemHelper::SundialsMemHelper ( )
default

◆ SundialsMemHelper() [6/6]

mfem::SundialsMemHelper::SundialsMemHelper ( SUNContext  context)
inline

Definition at line 138 of file sundials.hpp.

Member Function Documentation

◆ operator SUNMemoryHelper()

mfem::SundialsMemHelper::operator SUNMemoryHelper ( ) const
inline

Typecasting to SUNDIALS' SUNMemoryHelper type.

Definition at line 110 of file sundials.hpp.

◆ operator=() [1/2]

SundialsMemHelper& mfem::SundialsMemHelper::operator= ( const SundialsMemHelper )
delete

Disable copy assignment.

◆ operator=() [2/2]

SundialsMemHelper & mfem::SundialsMemHelper::operator= ( SundialsMemHelper &&  rhs)

Implement move assignment.

Definition at line 238 of file sundials.cpp.

◆ SundialsMemHelper_Alloc()

int mfem::SundialsMemHelper::SundialsMemHelper_Alloc ( SUNMemoryHelper  helper,
SUNMemory *  memptr,
size_t  memsize,
SUNMemoryType mem_type #  ifSUNDIALS_VERSION_MAJOR >=6,
void *queue #  endif 
)
static

Definition at line 245 of file sundials.cpp.

◆ SundialsMemHelper_Dealloc()

int mfem::SundialsMemHelper::SundialsMemHelper_Dealloc ( SUNMemoryHelper  helper,
SUNMemory sunmem #  ifSUNDIALS_VERSION_MAJOR >=6,
void *queue #  endif 
)
static

Definition at line 285 of file sundials.cpp.


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