SAMRAI::hier::Index< DIM > Class Template Reference

#include <source/hierarchy/boxes/Index.h>

Inheritance diagram for SAMRAI::hier::Index< DIM >:

[legend]List of all members.

Public Member Functions
	Index ()
	Index (const int i)
	Index (const int i, const int j)
	Index (const int i, const int j, const int k)
	Index (const tbox::Array< int > i)
	Index (const Index< DIM > &rhs)
Index< DIM > &	operator= (const Index< DIM > &rhs)
	~Index ()
Index< DIM > &	operator+= (const IntVector< DIM > &rhs)
Index< DIM >	operator+ (const IntVector< DIM > &rhs) const
Index< DIM > &	operator+= (const int rhs)
Index< DIM >	operator+ (const int rhs) const
Index< DIM > &	operator-= (const IntVector< DIM > &rhs)
Index< DIM >	operator- (const IntVector< DIM > &rhs) const
Index< DIM > &	operator-= (const int rhs)
Index< DIM >	operator- (const int rhs) const
Index< DIM > &	operator *= (const IntVector< DIM > &rhs)
Index< DIM >	operator * (const IntVector< DIM > &rhs) const
Index< DIM > &	operator *= (const int rhs)
Index< DIM >	operator * (const int rhs) const
Index< DIM > &	operator/= (const IntVector< DIM > &rhs)
Index< DIM >	operator/ (const IntVector< DIM > &rhs) const
Index< DIM > &	operator/= (const int rhs)
Index< DIM >	operator/ (const int rhs) const

---

Detailed Description

template<int DIM>
class SAMRAI::hier::Index< DIM >

Class Index<DIM> implements a simple n-dimensional integer vector in the AMR index space. Index is used as lower and upper bounds when creating a box and also when iterating over the cells in a box. An index is essentially an integer vector but it carries along the notion of indexing into AMR's abstract index space.

Class Index<DIM> is translated into classes Index1, Index2, and Index3 after being passed through a preprocessor.

See also:

hier::Box

hier::BoxIterator

hier::IntVector

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::hier::Index< DIM >::Index (   )  [inline]

The default constructor for Index creates an uninitialized index.

template<int DIM> SAMRAI::hier::Index< DIM >::Index (  const int  i  )  [inline]

Construct an index with all components equal to the argument.

template<int DIM> SAMRAI::hier::Index< DIM >::Index (  const int  i, const int  j )  [inline]

Construct a two-dimensional index with the value (i,j).

template<int DIM> SAMRAI::hier::Index< DIM >::Index (  const int  i, const int  j, const int  k )  [inline]

Construct a three-dimensional index with the value (i,j,k).

template<int DIM> SAMRAI::hier::Index< DIM >::Index (  const tbox::Array< int >  i  )  [inline]

Construct an n-dimensional index with the values copied from the integer tbox::Array i of size n.

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

The copy constructor creates an index equal to the argument.

template<int DIM> SAMRAI::hier::Index< DIM >::~Index (   )  [inline]

The index destructor does nothing interesting.

---

Member Function Documentation

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

The assignment operator sets the index equal to the argument.

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

Plus-equals operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

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

Plus operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

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

Plus-equals operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >. Reimplemented in SAMRAI::pdat::CellIndex< DIM >, SAMRAI::pdat::EdgeIndex< DIM >, SAMRAI::pdat::FaceIndex< DIM >, SAMRAI::pdat::NodeIndex< DIM >, and SAMRAI::pdat::SideIndex< DIM >.

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

Plus operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >. Reimplemented in SAMRAI::pdat::CellIndex< DIM >, SAMRAI::pdat::EdgeIndex< DIM >, SAMRAI::pdat::FaceIndex< DIM >, SAMRAI::pdat::NodeIndex< DIM >, and SAMRAI::pdat::SideIndex< DIM >.

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

Minus-equals operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

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

Minus operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

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

Minus-equals operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >. Reimplemented in SAMRAI::pdat::CellIndex< DIM >, SAMRAI::pdat::EdgeIndex< DIM >, SAMRAI::pdat::FaceIndex< DIM >, SAMRAI::pdat::NodeIndex< DIM >, and SAMRAI::pdat::SideIndex< DIM >.

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

Minus operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >. Reimplemented in SAMRAI::pdat::CellIndex< DIM >, SAMRAI::pdat::EdgeIndex< DIM >, SAMRAI::pdat::FaceIndex< DIM >, SAMRAI::pdat::NodeIndex< DIM >, and SAMRAI::pdat::SideIndex< DIM >.

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

Times-equals operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

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

Times operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

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

Times-equals operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >. Reimplemented in SAMRAI::pdat::CellIndex< DIM >, SAMRAI::pdat::EdgeIndex< DIM >, SAMRAI::pdat::FaceIndex< DIM >, SAMRAI::pdat::NodeIndex< DIM >, and SAMRAI::pdat::SideIndex< DIM >.

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

Times operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >. Reimplemented in SAMRAI::pdat::CellIndex< DIM >, SAMRAI::pdat::EdgeIndex< DIM >, SAMRAI::pdat::FaceIndex< DIM >, SAMRAI::pdat::NodeIndex< DIM >, and SAMRAI::pdat::SideIndex< DIM >.

template<int DIM> Index< DIM > & SAMRAI::hier::Index< DIM >::operator/= (  const IntVector< DIM > &  rhs  )  [inline]

Assign-quotient operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

template<int DIM> Index< DIM > SAMRAI::hier::Index< DIM >::operator/ (  const IntVector< DIM > &  rhs  )  const [inline]

Quotient operator for an index and an integer vector. Reimplemented from SAMRAI::hier::IntVector< DIM >.

template<int DIM> Index< DIM > & SAMRAI::hier::Index< DIM >::operator/= (  const int  rhs  )  [inline]

Assign-quotient operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >.

template<int DIM> Index< DIM > SAMRAI::hier::Index< DIM >::operator/ (  const int  rhs  )  const [inline]

Quotient operator for an index and an integer. Reimplemented from SAMRAI::hier::IntVector< DIM >.

---

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

• source/hierarchy/boxes/Index.h
• source/hierarchy/boxes/Index.I

---