SAMRAI::pdat::CellIndex< DIM > Class Template Reference

#include <source/patchdata/cell/CellIndex.h>

Inheritance diagram for SAMRAI::pdat::CellIndex< DIM >:

[legend]List of all members.

Public Member Functions
	CellIndex ()
	CellIndex (const hier::Index< DIM > &rhs)
	CellIndex (const CellIndex< DIM > &rhs)
CellIndex< DIM > &	operator= (const CellIndex< DIM > &rhs)
	~CellIndex ()
CellIndex< DIM > &	operator+= (const hier::IntVector< DIM > &rhs)
CellIndex< DIM >	operator+ (const hier::IntVector< DIM > &rhs) const
CellIndex< DIM > &	operator+= (const int rhs)
CellIndex< DIM >	operator+ (const int rhs) const
CellIndex< DIM > &	operator-= (const hier::IntVector< DIM > &rhs)
CellIndex< DIM >	operator- (const hier::IntVector< DIM > &rhs) const
CellIndex< DIM > &	operator-= (const int rhs)
CellIndex< DIM >	operator- (const int rhs) const
CellIndex< DIM > &	operator *= (const hier::IntVector< DIM > &rhs)
CellIndex< DIM >	operator * (const hier::IntVector< DIM > &rhs) const
CellIndex< DIM > &	operator *= (const int rhs)
CellIndex< DIM >	operator * (const int rhs) const
bool	operator== (const CellIndex< DIM > &rhs) const
bool	operator!= (const CellIndex< DIM > &rhs) const

---

Detailed Description

template<int DIM>
class SAMRAI::pdat::CellIndex< DIM >

Class CellIndex<DIM> implements a simple n-dimensional integer vector for cell centered variables. Cell indices contain an integer index location in AMR index space and are identical to the AMR indices.

See also:

hier::Index

pdat::CellData

pdat::CellGeometry

pdat::CellIterator

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::pdat::CellIndex< DIM >::CellIndex (   )  [inline]

The default constructor for a cell index creates an uninitialized index.

template<int DIM> SAMRAI::pdat::CellIndex< DIM >::CellIndex (  const hier::Index< DIM > &  rhs  )  [inline]

Construct a cell index from a regular AMR index.

template<int DIM> SAMRAI::pdat::CellIndex< DIM >::CellIndex (  const CellIndex< DIM > &  rhs  )  [inline]

The copy constructor creates a cell index equal to the argument.

template<int DIM> SAMRAI::pdat::CellIndex< DIM >::~CellIndex (   )  [inline]

The cell index destructor does nothing interesting.

---

Member Function Documentation

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator= (  const CellIndex< DIM > &  rhs  )  [inline]

The assignment operator sets the cell index equal to the argument.

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator+= (  const hier::IntVector< DIM > &  rhs  )  [inline]

Plus-equals operator for a cell index and an integer vector.

template<int DIM> CellIndex< DIM > SAMRAI::pdat::CellIndex< DIM >::operator+ (  const hier::IntVector< DIM > &  rhs  )  const [inline]

Plus operator for a cell index and an integer vector.

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator+= (  const int  rhs  )  [inline]

Plus-equals operator for a cell index and an integer. Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM> CellIndex< DIM > SAMRAI::pdat::CellIndex< DIM >::operator+ (  const int  rhs  )  const [inline]

Plus operator for a cell index and an integer. Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator-= (  const hier::IntVector< DIM > &  rhs  )  [inline]

Minus-equals operator for a cell index and an integer vector.

template<int DIM> CellIndex< DIM > SAMRAI::pdat::CellIndex< DIM >::operator- (  const hier::IntVector< DIM > &  rhs  )  const [inline]

Minus operator for a cell index and an integer vector.

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator-= (  const int  rhs  )  [inline]

Minus-equals operator for a cell index and an integer. Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM> CellIndex< DIM > SAMRAI::pdat::CellIndex< DIM >::operator- (  const int  rhs  )  const [inline]

Minus operator for a cell index and an integer. Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator *= (  const hier::IntVector< DIM > &  rhs  )  [inline]

Times-equals operator for a cell index and an integer vector.

template<int DIM> CellIndex< DIM > SAMRAI::pdat::CellIndex< DIM >::operator * (  const hier::IntVector< DIM > &  rhs  )  const [inline]

Times operator for a cell index and an integer vector.

template<int DIM> CellIndex< DIM > & SAMRAI::pdat::CellIndex< DIM >::operator *= (  const int  rhs  )  [inline]

Times-equals operator for a cell index and an integer. Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM> CellIndex< DIM > SAMRAI::pdat::CellIndex< DIM >::operator * (  const int  rhs  )  const [inline]

Times operator for a cell index and an integer. Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM> bool SAMRAI::pdat::CellIndex< DIM >::operator== (  const CellIndex< DIM > &  rhs  )  const [inline]

Returns true if two cell index objects are equal. All components must be the same for equality.

template<int DIM> bool SAMRAI::pdat::CellIndex< DIM >::operator!= (  const CellIndex< DIM > &  rhs  )  const [inline]

Returns true if two cell index objects are not equal. Any of the components may be different for inequality.

---

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

• source/patchdata/cell/CellIndex.h
• source/patchdata/cell/CellIndex.I

---