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

#include <source/patchdata/edge/EdgeIndex.h>

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

[legend]List of all members.

Public Types
enum	{   X = 0, Y = 1, Z = 2, Lower = 0,   Upper = 1, LowerLeft = 0, LowerRight = 1, UpperLeft = 2,   UpperRight = 3 }
Public Member Functions
	EdgeIndex ()
	EdgeIndex (const hier::Index< DIM > &rhs, const int axis, const int edge)
	EdgeIndex (const EdgeIndex< DIM > &rhs)
EdgeIndex< DIM > &	operator= (const EdgeIndex< DIM > &rhs)
	~EdgeIndex ()
int	getAxis () const
void	setAxis (const int axis)
hier::Index< DIM >	toCell (const int edge) const
EdgeIndex< DIM > &	operator+= (const hier::IntVector< DIM > &rhs)
EdgeIndex< DIM >	operator+ (const hier::IntVector< DIM > &rhs) const
EdgeIndex< DIM > &	operator+= (const int rhs)
EdgeIndex< DIM >	operator+ (const int rhs) const
EdgeIndex< DIM > &	operator-= (const hier::IntVector< DIM > &rhs)
EdgeIndex< DIM >	operator- (const hier::IntVector< DIM > &rhs) const
EdgeIndex< DIM > &	operator-= (const int rhs)
EdgeIndex< DIM >	operator- (const int rhs) const
EdgeIndex< DIM > &	operator *= (const hier::IntVector< DIM > &rhs)
EdgeIndex< DIM >	operator * (const hier::IntVector< DIM > &rhs) const
EdgeIndex< DIM > &	operator *= (const int rhs)
EdgeIndex< DIM >	operator * (const int rhs) const
bool	operator== (const EdgeIndex< DIM > &rhs) const
bool	operator!= (const EdgeIndex< DIM > &rhs) const

---

Detailed Description

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

Class EdgeIndex<DIM> implements a simple n-dimensional integer vector for edge centered variables. Edge indices contain an integer index location in AMR index space along with the designated edge axis (X=0, Y=1, or Z=2). See the edge box geometry class for more information about the mapping between the AMR index space and the edge indices.

See also:

hier::Index

pdat::EdgeData

pdat::EdgeGeometry

pdat::EdgeIterator

---

Member Enumeration Documentation

template<int DIM>

anonymous enum

Enumerator:

X
Y
Z
Lower
Upper
LowerLeft
LowerRight
UpperLeft
UpperRight

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::EdgeIndex< DIM >::EdgeIndex

(

)

[inline]

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

template<int DIM>

SAMRAI::pdat::EdgeIndex< DIM >::EdgeIndex	(	const hier::Index< DIM > &	rhs,
		const int	axis,
		const int	edge
	)			[inline]

Construct a edge index from a regular index, axis, and edge. The axis can be one of EdgeIndex<DIM>::X (0), EdgeIndex<DIM>::Y (1), or EdgeIndex<DIM>::Z (2). The edge argument can be one of the constants EdgeIndex<DIM>::LowerLeft (0), EdgeIndex<DIM>::LowerRight(1), EdgeIndex<DIM>::UpperLeft (2) or EdgeIndex<DIM>::UpperRight(3).

template<int DIM>

SAMRAI::pdat::EdgeIndex< DIM >::EdgeIndex

(

const EdgeIndex< DIM > &

rhs

)

[inline]

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

template<int DIM>

SAMRAI::pdat::EdgeIndex< DIM >::~EdgeIndex

(

)

[inline]

The edge index destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator=

(

const EdgeIndex< DIM > &

rhs

)

[inline]

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

template<int DIM>

int SAMRAI::pdat::EdgeIndex< DIM >::getAxis

(

)

const [inline]

Get the axis for which this edge index is defined (X=0, Y=1, Z=2).

template<int DIM>

void SAMRAI::pdat::EdgeIndex< DIM >::setAxis

(

const int

axis

)

[inline]

Set the edge axis (X=0, Y=1, Z=2).

template<int DIM>

hier::Index< DIM > SAMRAI::pdat::EdgeIndex< DIM >::toCell

(

const int

edge

)

const [inline]

For dimension 2, converts the edge index into the index on the lower side (argument edge = 0) or the upper side (argument edge = 1) of the edge. For dimension 3, converts the edge index into the index on the lower left (argument edge == 0), the lower right (argument edge == 1), the upper left (argument edge == 2), or the upper right (argument edge == 3) of thw edge.

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator+=

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > SAMRAI::pdat::EdgeIndex< DIM >::operator+

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Plus operator for a edge index and an integer vector.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator+=

(

const int

rhs

)

[inline]

Plus-equals operator for a edge index and an integer.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > SAMRAI::pdat::EdgeIndex< DIM >::operator+

(

const int

rhs

)

const [inline]

Plus operator for a edge index and an integer.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator-=

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > SAMRAI::pdat::EdgeIndex< DIM >::operator-

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Minus operator for a edge index and an integer vector.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator-=

(

const int

rhs

)

[inline]

Minus-equals operator for a edge index and an integer.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > SAMRAI::pdat::EdgeIndex< DIM >::operator-

(

const int

rhs

)

const [inline]

Minus operator for a edge index and an integer.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator *=

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > SAMRAI::pdat::EdgeIndex< DIM >::operator *

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Times operator for a edge index and an integer vector.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > & SAMRAI::pdat::EdgeIndex< DIM >::operator *=

(

const int

rhs

)

[inline]

Times-equals operator for a edge index and an integer.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

EdgeIndex< DIM > SAMRAI::pdat::EdgeIndex< DIM >::operator *

(

const int

rhs

)

const [inline]

Times operator for a edge index and an integer.

Reimplemented from SAMRAI::hier::Index< DIM >.

template<int DIM>

bool SAMRAI::pdat::EdgeIndex< DIM >::operator==

(

const EdgeIndex< DIM > &

rhs

)

const [inline]

Returns true if two edge index objects are equal. All components and the corresponding edge axes must be the same for equality.

template<int DIM>

bool SAMRAI::pdat::EdgeIndex< DIM >::operator!=

(

const EdgeIndex< DIM > &

rhs

)

const [inline]

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

---

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

• source/patchdata/edge/EdgeIndex.h
• source/patchdata/edge/EdgeIndex.I

---