Reference documentation for deal.II version Git b0c9756717 2021-05-17 18:12:11 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Classes | Functions
SUNDIALS::internal Namespace Reference

Classes

struct  LinearSolverContent
 
class  LinearSolverWrapper
 
class  NVectorView
 

Functions

template<typename VectorType >
VectorTypeunwrap_nvector (N_Vector v)
 
template<typename VectorType >
const VectorTypeunwrap_nvector_const (N_Vector v)
 
N_Vector N_VNewEmpty ()
 
void N_VFreeEmpty (N_Vector v)
 
int N_VCopyOps (N_Vector w, N_Vector v)
 
SUNLinearSolver SUNLinSolNewEmpty ()
 
void SUNLinSolFreeEmpty (SUNLinearSolver solver)
 

Function Documentation

◆ unwrap_nvector()

template<typename VectorType >
VectorType* SUNDIALS::internal::unwrap_nvector ( N_Vector  v)

Retrieve the underlying vector attached to N_Vector v. This call will only succeed if the underlying vector is not const. Use unwrap_nvector_const() for this case.

Note
Users must ensure that they ask for the correct VectorType when calling this function and there are no type-safety checks in place.
Template Parameters
VectorTypeType of the vector that is stored in v
Parameters
vVector to unwrap
Returns
The vector that is stored inside v

◆ unwrap_nvector_const()

template<typename VectorType >
const VectorType* SUNDIALS::internal::unwrap_nvector_const ( N_Vector  v)

Retrieve the underlying vector attached to N_Vector v as a constant pointer.

Note
Users must ensure that they ask for the correct VectorType when calling this function and there are no type-safety checks in place.
Template Parameters
VectorTypeType of the vector that is stored in v
Parameters
vVector to unwrap
Returns
The vector that is stored inside v

◆ N_VNewEmpty()

N_Vector SUNDIALS::internal::N_VNewEmpty ( )

Definition at line 41 of file sundials_backport.h.

◆ N_VFreeEmpty()

void SUNDIALS::internal::N_VFreeEmpty ( N_Vector  v)

Definition at line 132 of file sundials_backport.h.

◆ N_VCopyOps()

int SUNDIALS::internal::N_VCopyOps ( N_Vector  w,
N_Vector  v 
)

Definition at line 149 of file sundials_backport.h.

◆ SUNLinSolNewEmpty()

SUNLinearSolver SUNDIALS::internal::SUNLinSolNewEmpty ( )
inline

Create a new SUNLinearSolver structure without any content and operations set to nullptr.

Definition at line 45 of file sunlinsol_newempty.h.

◆ SUNLinSolFreeEmpty()

void SUNDIALS::internal::SUNLinSolFreeEmpty ( SUNLinearSolver  solver)
inline

Free the memory associated with solver which was previously allocated with a call to SUNLinSolNewEmpty().

Note
A call to this function does not deallocate the content field.
Parameters
solverThe solver memory to free

Definition at line 84 of file sunlinsol_newempty.h.