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

#include <source/patchdata/face/FaceIndex.h>

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

[legend]List of all members.

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

---

Detailed Description

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

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

See also:

hier::Index

pdat::FaceData

pdat::FaceGeometry

pdat::FaceIterator

---

Member Enumeration Documentation

template<int DIM>

anonymous enum

Enumerator:

X
Y
Z
Lower
Upper

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::FaceIndex< DIM >::FaceIndex

(

)

[inline]

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

template<int DIM>

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

Construct a face index from a regular index, axis, and face. The axis can be one of FaceIndex<DIM>::X (0), FaceIndex<DIM>::Y (1), or FaceIndex<DIM>::Z (2). The face argument can be one of the constants FaceIndex<DIM>::Lower (0) or FaceIndex<DIM>::Upper (1).

template<int DIM>

SAMRAI::pdat::FaceIndex< DIM >::FaceIndex

(

const FaceIndex< DIM > &

rhs

)

[inline]

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

template<int DIM>

SAMRAI::pdat::FaceIndex< DIM >::~FaceIndex

(

)

[inline]

The face index destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

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

(

const FaceIndex< DIM > &

rhs

)

[inline]

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

template<int DIM>

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

(

)

const [inline]

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

template<int DIM>

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

(

const int

axis

)

[inline]

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

template<int DIM>

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

(

const int

face

)

const [inline]

Convert the face index into the index on the left hand face (argument face == 0) or the right hand face (argument face == 1).

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Plus operator for a face index and an integer vector.

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

template<int DIM>

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

(

const int

rhs

)

[inline]

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

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

template<int DIM>

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

(

const int

rhs

)

const [inline]

Plus operator for a face index and an integer.

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Minus operator for a face index and an integer vector.

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

template<int DIM>

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

(

const int

rhs

)

[inline]

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

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

template<int DIM>

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

(

const int

rhs

)

const [inline]

Minus operator for a face index and an integer.

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Times operator for a face index and an integer vector.

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

template<int DIM>

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

(

const int

rhs

)

[inline]

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

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

template<int DIM>

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

(

const int

rhs

)

const [inline]

Times operator for a face index and an integer.

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

template<int DIM>

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

(

const FaceIndex< DIM > &

rhs

)

const [inline]

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

template<int DIM>

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

(

const FaceIndex< DIM > &

rhs

)

const [inline]

Returns true if two face 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/face/FaceIndex.h
• source/patchdata/face/FaceIndex.I

---