---

FaceIndex Class Reference

#include <FaceIndex.H>

Collaboration diagram for FaceIndex:

[legend]List of all members.

Public Methods
	FaceIndex (const VolIndex &a_vof1, const VolIndex &a_vof2, const int &a_direction)
void	define (const VolIndex &a_vof1, const VolIndex &a_vof2, const int &a_direction)
	FaceIndex ()
	FaceIndex (const FaceIndex &a_facein)
void	define (const FaceIndex &a_facein)
	~FaceIndex ()
FaceIndex &	operator= (const FaceIndex &a_facein)
bool	operator== (const FaceIndex &a_facein) const
bool	operator!= (const FaceIndex &a_facein) const
const int &	direction () const
const bool &	isDefined () const
const bool &	isBoundary () const
const int &	cellIndex (const Side::LoHiSide &a_sd) const
const IntVect &	gridIndex (const Side::LoHiSide &a_sd) const
VolIndex	getVoF (const Side::LoHiSide &a_sd) const
Static Public Methods
int	initializeOffsets ()
Static Public Attributes
size_t	lo_offset
size_t	hi_offset
size_t	rest_offset
Private Attributes
IntVect	m_loiv
	the intvect of the low vof
IntVect	m_hiiv
	the intvect of the high vof
int	m_loIndex
int	m_hiIndex
int	m_direction
	direction of the face.
bool	m_isDefined
bool	m_isBoundary

---

Detailed Description

FaceIndex is a very lightweight object used to distinguish faces. It has two VolIndex (s) and a direction and a way to access them.

---

Constructor & Destructor Documentation

FaceIndex::FaceIndex (  const VolIndex &    a_vof1, const VolIndex &    a_vof2, const int &    a_direction )

if both cellindexes of the vofs are >= 0, then the face is interior. otherwise the face is a boundary face.

FaceIndex::FaceIndex (    )

FaceIndex::FaceIndex (  const FaceIndex &    a_facein )

FaceIndex::~FaceIndex (    )

---

Member Function Documentation

const int& FaceIndex::cellIndex (  const Side::LoHiSide &    a_sd )  const

return cell index of the vof on the a_sd side. returns -1 if that side of the face is outside the domain (boundary face case).

void FaceIndex::define (  const FaceIndex &    a_facein )

void FaceIndex::define (  const VolIndex &    a_vof1, const VolIndex &    a_vof2, const int &    a_direction )

if both cellindexes of the vofs are >= 0, then the face is interior. otherwise the face is a boundary face.

const int& FaceIndex::direction (    )  const

VolIndex FaceIndex::getVoF (  const Side::LoHiSide &    a_sd )  const

manufactures the appropriate volindex.

const IntVect& FaceIndex::gridIndex (  const Side::LoHiSide &    a_sd )  const

return grid index of the vof on the a_sd side. may be inside or ouside domain.

int FaceIndex::initializeOffsets (    )  [static]

const bool& FaceIndex::isBoundary (    )  const

const bool& FaceIndex::isDefined (    )  const

bool FaceIndex::operator!= (  const FaceIndex &    a_facein )  const

FaceIndex& FaceIndex::operator= (  const FaceIndex &    a_facein )

bool FaceIndex::operator== (  const FaceIndex &    a_facein )  const

---

Member Data Documentation

size_t FaceIndex::hi_offset [static]

size_t FaceIndex::lo_offset [static]

int FaceIndex::m_direction [private]

direction of the face.

int FaceIndex::m_hiIndex [private]

The index of the high vof. This = -1 if the face is set to be a boundary face on the high side of the domain.

IntVect FaceIndex::m_hiiv [private]

the intvect of the high vof

bool FaceIndex::m_isBoundary [private]

true if the face is constructed using the boundary face constructor

bool FaceIndex::m_isDefined [private]

true if one of the define functions has been called.

int FaceIndex::m_loIndex [private]

The index of the low vof. This = -1 if the face is set to be a boundary face on the low side of the domain.

IntVect FaceIndex::m_loiv [private]

the intvect of the low vof

size_t FaceIndex::rest_offset [static]

---

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

• FaceIndex.H

---