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

#include <source/patchdata/side/SideIndex.h>

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

[legend]List of all members.

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

---

Detailed Description

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

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

See also:

hier::Index

pdat::SideData

pdat::SideGeometry

pdat::SideIterator

---

Member Enumeration Documentation

template<int DIM>

anonymous enum

Enumerator:

X
Y
Z
Lower
Upper

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::SideIndex< DIM >::SideIndex

(

)

[inline]

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

template<int DIM>

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

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

template<int DIM>

SAMRAI::pdat::SideIndex< DIM >::SideIndex

(

const SideIndex< DIM > &

rhs

)

[inline]

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

template<int DIM>

SAMRAI::pdat::SideIndex< DIM >::~SideIndex

(

)

[inline]

The side index destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

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

(

const SideIndex< DIM > &

rhs

)

[inline]

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

template<int DIM>

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

(

)

const [inline]

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

template<int DIM>

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

(

const int

axis

)

[inline]

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

template<int DIM>

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

(

const int

side

)

const [inline]

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Plus operator for a side index and an integer vector.

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

template<int DIM>

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

(

const int

rhs

)

[inline]

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

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

template<int DIM>

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

(

const int

rhs

)

const [inline]

Plus operator for a side index and an integer.

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Minus operator for a side index and an integer vector.

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

template<int DIM>

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

(

const int

rhs

)

[inline]

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

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

template<int DIM>

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

(

const int

rhs

)

const [inline]

Minus operator for a side index and an integer.

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

[inline]

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

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

template<int DIM>

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

(

const hier::IntVector< DIM > &

rhs

)

const [inline]

Times operator for a side index and an integer vector.

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

template<int DIM>

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

(

const int

rhs

)

[inline]

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

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

template<int DIM>

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

(

const int

rhs

)

const [inline]

Times operator for a side index and an integer.

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

template<int DIM>

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

(

const SideIndex< DIM > &

rhs

)

const [inline]

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

template<int DIM>

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

(

const SideIndex< DIM > &

rhs

)

const [inline]

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

---