IBAMR  IBAMR version 0.19.
Public Member Functions | Protected Attributes | List of all members
IBTK::SAMRAIScopedVectorCopy< TYPE > Class Template Reference

#include <ibtk/SAMRAIScopedVectorCopy.h>

Inheritance diagram for IBTK::SAMRAIScopedVectorCopy< TYPE >:
Inheritance graph
[legend]

Public Member Functions

 SAMRAIScopedVectorCopy (const SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > > &vector, const std::string &name="")
 
 SAMRAIScopedVectorCopy (const SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > &vector, const std::string &name="")
 
 operator SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > & ()
 
 operator SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > > ()
 
std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > > > getComponentVectors () const
 

Protected Attributes

SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > > d_vector
 

Detailed Description

template<typename TYPE>
class IBTK::SAMRAIScopedVectorCopy< TYPE >

Wrapper class around a SAMRAIVectorReal with RAII semantics. Creates a new copy of an input vector.

Note
The name of this class is analogous to the meaning of copy in PETSc's VecCopy() function.

Constructor & Destructor Documentation

◆ SAMRAIScopedVectorCopy() [1/2]

template<typename TYPE >
IBTK::SAMRAIScopedVectorCopy< TYPE >::SAMRAIScopedVectorCopy ( const SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > > &  vector,
const std::string &  name = "" 
)

Constructor. Sets up a vector equivalent to vector.

◆ SAMRAIScopedVectorCopy() [2/2]

template<typename TYPE >
IBTK::SAMRAIScopedVectorCopy< TYPE >::SAMRAIScopedVectorCopy ( const SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > &  vector,
const std::string &  name = "" 
)

Constructor. Sets up a vector equivalent to vector.

Member Function Documentation

◆ operator SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > &()

template<typename TYPE >
IBTK::SAMRAIScopedVectorDuplicate< TYPE >::operator SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > &
inherited

Conversion operator to a SAMRAI vector.

◆ operator SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > >()

template<typename TYPE >
IBTK::SAMRAIScopedVectorDuplicate< TYPE >::operator SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > >
inherited

Conversion operator to non-owning pointer to a SAMRAI vector.

Note
This operator should only be used with APIs which expect a pointer to a vector. Since this pointer is non-owning it is not an implementation of reference-counting to this object.

◆ getComponentVectors()

template<typename TYPE >
std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, TYPE > > > IBTK::SAMRAIScopedVectorDuplicate< TYPE >::getComponentVectors
inherited

Get the components of the vectors.

Member Data Documentation

◆ d_vector

template<typename TYPE >
SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, TYPE> > IBTK::SAMRAIScopedVectorDuplicate< TYPE >::d_vector
protectedinherited

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