VolIndex Class Reference

Volume of Fluid Index. More...

#include <VolIndex.H>

Inheritance diagram for VolIndex:

Public Member Functions
	VolIndex ()
virtual	~VolIndex ()
bool	operator== (const VolIndex &a_vofin) const
const IntVect &	gridIndex () const
int	cellIndex () const
bool	isDefined () const
void	define (const VolIndex &a_vofin)
	VolIndex (const IntVect &a_ix, const int &a_vofID)
void	define (const IntVect &a_ix, const int &a_vofID)
bool	operator< (const VolIndex &rhs) const
bool	operator!= (const VolIndex &rhs) const
void	shift (const IntVect &a_iv)
	for stencil gymnastics More...
int	linearSize () const
void	linearOut (void *const a_outBuf) const
void	linearIn (const void *const inBuf)
Public Member Functions inherited from BaseIndex
	BaseIndex ()
virtual	~BaseIndex ()

Static Public Member Functions
static int	initializeOffsets ()

Static Public Attributes
static size_t	iv_offset
static size_t	index_offset

Private Attributes
IntVect	m_iv
int	m_cellIndex
bool	m_isDefined

Detailed Description

Volume of Fluid Index.

VolIndex is a very lightweight object to be used to distinguish between volumes of fluid in a cell. We use VolIndex for array indexing. Non-trivial constructors are all private because only EBISBox is supposed to make valid volume indicies.

Constructor & Destructor Documentation

VolIndex() [1/2]

VolIndex::VolIndex ( )

inline

~VolIndex()

virtual VolIndex::~VolIndex ( )

virtual

VolIndex() [2/2]

VolIndex::VolIndex ( const IntVect &  a_ix, const int &  a_vofID  )

inline

Member Function Documentation

operator==()

bool VolIndex::operator== ( const VolIndex &  a_vofin ) const

inline

References m_cellIndex, and m_iv.

gridIndex()

const IntVect & VolIndex::gridIndex ( ) const

inline

References m_iv.

Referenced by BaseEBCellFAB< Real >::assign(), MiniIVFAB< Real >::copy(), BaseEBCellFAB< Real >::dataType(), BaseEBCellFAB< Real >::fill(), MiniIVFAB< Real >::forall(), BaseIVFAB< Real >::getIndex(), MiniIVFAB< Real >::linearOut(), BaseEBCellFAB< Real >::offset(), BaseEBCellFAB< Real >::operator()(), and EBAMRPoissonOp::StencilIndexComparator::operator()().

cellIndex()

int VolIndex::cellIndex ( ) const

inline

References m_cellIndex.

Referenced by BaseIVFAB< Real >::getIndex(), and EBAMRPoissonOp::StencilIndexComparator::operator()().

isDefined()

bool VolIndex::isDefined ( ) const

inline

References m_isDefined.

define() [1/2]

void VolIndex::define

(

const VolIndex &

a_vofin

)

define() [2/2]

void VolIndex::define ( const IntVect &  a_ix, const int &  a_vofID  )

inline

References m_cellIndex, m_isDefined, and m_iv.

operator<()

bool VolIndex::operator< ( const VolIndex &  rhs ) const

inline

References IntVect::lexLT(), m_cellIndex, and m_iv.

operator!=()

bool VolIndex::operator!= ( const VolIndex &  rhs ) const

inline

linearSize()

int VolIndex::linearSize

(

)

const

/name linearization routines

Referenced by IrregTag::Entry::linearIn(), IrregTag::Entry::linearOut(), and IrregTag::Entry::linearSize().

linearOut()

void VolIndex::linearOut

(

void *const

a_outBuf

)

const

Referenced by IrregTag::Entry::linearOut().

linearIn()

void VolIndex::linearIn

(

const void *const

inBuf

)

Referenced by IrregTag::Entry::linearIn().

initializeOffsets()

static int VolIndex::initializeOffsets ( )

static

shift()

void VolIndex::shift ( const IntVect &  a_iv )

inline

for stencil gymnastics

References m_iv.

Member Data Documentation

iv_offset

size_t VolIndex::iv_offset

static

index_offset

size_t VolIndex::index_offset

static

m_iv

IntVect VolIndex::m_iv

private

Referenced by define(), gridIndex(), operator<(), operator==(), and shift().

m_cellIndex

int VolIndex::m_cellIndex

private

Referenced by cellIndex(), define(), operator<(), and operator==().

m_isDefined

bool VolIndex::m_isDefined

private

Referenced by define(), and isDefined().

---

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

• VolIndex.H