---

VolIndex Class Reference

Volume of Fluid Index. More...

#include <VolIndex.H>

Collaboration diagram for VolIndex:

[legend]List of all members.

Public Methods
	VolIndex ()
	~VolIndex ()
VolIndex &	operator= (const VolIndex &a_vofin)
bool	operator== (const VolIndex &a_vofin) const
const IntVect &	gridIndex () const
const int &	cellIndex () const
bool	isDefined () const
	VolIndex (const VolIndex &a_vofin)
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)
Static Public Methods
int	initializeOffsets ()
Static Public Attributes
size_t	iv_offset
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::VolIndex (    )

VolIndex::~VolIndex (    )

VolIndex::VolIndex (  const VolIndex &    a_vofin )

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

---

Member Function Documentation

const int& VolIndex::cellIndex (    )  const

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

void VolIndex::define (  const VolIndex &    a_vofin )

const IntVect& VolIndex::gridIndex (    )  const

int VolIndex::initializeOffsets (    )  [static]

bool VolIndex::isDefined (    )  const

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

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

---

Member Data Documentation

size_t VolIndex::index_offset [static]

size_t VolIndex::iv_offset [static]

int VolIndex::m_cellIndex [private]

bool VolIndex::m_isDefined [private]

IntVect VolIndex::m_iv [private]

---

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

• VolIndex.H

---