Chombo + EB  3.2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
VolIndex Class Reference

Volume of Fluid Index. More...

#include <VolIndex.H>

Inheritance diagram for VolIndex:
Inheritance graph
[legend]

Public Member Functions

 VolIndex ()
 
virtual ~VolIndex ()
 
bool operator== (const VolIndex &a_vofin) const
 
const IntVectgridIndex () 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::VolIndex ( )
inline
virtual VolIndex::~VolIndex ( )
virtual
VolIndex::VolIndex ( const IntVect a_ix,
const int &  a_vofID 
)
inline

Member Function Documentation

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

References m_cellIndex, and m_iv.

const IntVect & VolIndex::gridIndex ( ) const
inline
int VolIndex::cellIndex ( ) const
inline
bool VolIndex::isDefined ( ) const
inline

References m_isDefined.

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

References m_cellIndex, m_isDefined, and m_iv.

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

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

bool VolIndex::operator!= ( const VolIndex rhs) const
inline
int VolIndex::linearSize ( ) const
void VolIndex::linearOut ( void *const  a_outBuf) const
void VolIndex::linearIn ( const void *const  inBuf)
static int VolIndex::initializeOffsets ( )
static
void VolIndex::shift ( const IntVect a_iv)
inline

for stencil gymnastics

References m_iv.

Member Data Documentation

size_t VolIndex::iv_offset
static
size_t VolIndex::index_offset
static
IntVect VolIndex::m_iv
private
int VolIndex::m_cellIndex
private
bool VolIndex::m_isDefined
private

Referenced by define(), and isDefined().


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