SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM > Class Template Reference

#include <source/solvers/vectors/PVodeTrio_SAMRAIVector.h>

Inheritance diagram for SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >:

[legend]List of all members.

Static Public Member Functions
static PVodeTrioAbstractVector *	createPVodeTrioVector (tbox::Pointer< SAMRAIVectorReal< DIM, double > > samrai_vec)
static void	destroyPVodeTrioVector (PVodeTrioAbstractVector *pvode_trio_vec)
static tbox::Pointer< SAMRAIVectorReal< DIM, double > >	getSAMRAIVector (PVodeTrioAbstractVector *pvode_trio_vec)
Protected Member Functions
	PVodeTrio_SAMRAIVector (tbox::Pointer< SAMRAIVectorReal< DIM, double > > samrai_vector)
virtual	~PVodeTrio_SAMRAIVector ()

---

Detailed Description

template<int DIM>
class SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >

Class PVodeTrio_SAMRAIVector<DIM> wraps a real-valued SAMRAI vector (see SAMRAIVectorReal class) object so that it may be used with the PVodeTrio solver packages. This class is derived from the abstract base class PVodeTrioAbstractVector, which defines a { C++} interface for PVodeTrio vectors. It also maintains a pointer to a SAMRAI vector object. A SAMRAI vector is defined as a collection of patch data components living on some subset of levels in a structured AMR mesh hierarchy.

Observe that there are only three public member functions in this class They are used to create and destroy PVodeTrio vector objects (i.e., "N_Vector"s), and to obtain the SAMRAI vector associated with the PVodeTrio vector. In particular, note that the constructor and destructor of this class are protected members. The construction and destruction of instances of this class may occur only through the static member functions that create and destroy PVodeTrio vector objects.

Finally, we remark that this class provides vectors of type { double}, which is the default for PVodeTrio.

See also:

solv::PVodeTrioAbstractVector

solv::SAMRAIVectorReal

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >::PVodeTrio_SAMRAIVector (  tbox::Pointer< SAMRAIVectorReal< DIM, double > >  samrai_vector  )  [protected]

template<int DIM> SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >::~PVodeTrio_SAMRAIVector (   )  [protected, virtual]

---

Member Function Documentation

template<int DIM> PVodeTrioAbstractVector * SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >::createPVodeTrioVector (  tbox::Pointer< SAMRAIVectorReal< DIM, double > >  samrai_vec  )  [static]

Create and return a new PVodeTrio vector object. The SAMRAI vector object is wrapped so that it may be manipulated within PVodeTrio as an N_Vector (which is typedef'd to PVodeTrioAbstractVector* in the abstract PVodeTrio vector interface). It is important to note that this function does not allocate storage for the vector data. Data must be allocated through the SAMRAI vector object directly. For output of the data through "N_VPrint" calls, the output stream to which the SAMRAI vector object writes will be used.

template<int DIM> void SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >::destroyPVodeTrioVector (  PVodeTrioAbstractVector *  pvode_trio_vec  )  [static]

Destroy a given PVodeTrio vector object. It is important to note that this function does not deallocate storage for the vector data. Vector data must be deallocated hrough the SAMRAI vector object.

template<int DIM> tbox::Pointer< SAMRAIVectorReal< DIM, double > > SAMRAI::solv::PVodeTrio_SAMRAIVector< DIM >::getSAMRAIVector (  PVodeTrioAbstractVector *  pvode_trio_vec  )  [static]

Return pointer to the SAMRAI vector object associated with the given PVodeTrio vector.

---

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

• source/solvers/vectors/PVodeTrio_SAMRAIVector.h
• source/solvers/vectors/PVodeTrio_SAMRAIVector.C
• source/solvers/vectors/PVodeTrio_SAMRAIVector.I

---