TreeIntVectSet Class Reference

#include <TreeIntVectSet.H>

Collaboration diagram for TreeIntVectSet:

Collaboration graph

List of all members.

Detailed Description

IntVectSet implementation based on tree representation.

For explanations of these functions please look at IntVectSet class when the documentation doesn't appear here.

See also:

 Further details of how non-recursive TreeNode design works:

 (for a 2D tree)

          + -- 0

            (a)+ - 0
               1   +
                   1  <------you are here

               + - + - 0
                   0   1
                   0   1
                   0   0

 for the node indicated, the 'index' vector  would contain

 index=[ 0      1    3  ...............]
 parents=[&m_tree &a   ..................]

or directly refered to as m_tree.nodes[1].nodes[3]

 the tree indicates a covering of an index space in either
 1 or 0.   1 is stored in the tree by pointing at the static
 'full' data member, 0 is stored as a 0.

 every 'nodes' member of a TreeNode object can be either

  0, &full, or a pointer .

  The interpretation of the tree depends on what m_spanBox is.
    nodes[i] indicates whether the i'th quadrant of the parent
    Box is full, empty, or needs to be parsed deeper.


Public Member Functions

 TreeIntVectSet ()
 TreeIntVectSet (const Box &)
 TreeIntVectSet (const TreeIntVectSet &a_sivs)
 ~TreeIntVectSet ()
void define (const Box &)
void define (const TreeIntVectSet &a_sivs)
void swap (TreeIntVectSet &a_other)
 trade internals of two objects
TreeIntVectSetoperator= (const TreeIntVectSet &a_sivs)
TreeIntVectSetoperator|= (const TreeIntVectSet &a_sivs)
TreeIntVectSetoperator|= (const IntVect &a_iv)
TreeIntVectSetoperator|= (const Box &a_box)
TreeIntVectSetoperator &= (const TreeIntVectSet &s_sivs)
TreeIntVectSetoperator &= (const Box &a_box)
TreeIntVectSetoperator &= (const ProblemDomain &a_domain)
TreeIntVectSetoperator-= (const TreeIntVectSet &a_sivs)
TreeIntVectSetoperator-= (const IntVect &a_iv)
TreeIntVectSetoperator-= (const Box &a_box)
bool operator== (const TreeIntVectSet &lhs) const
 returns true if
bool operator< (const TreeIntVectSet &a_sivs) const
Vector< BoxcreateBoxes () const
 Returns Vector<Box> representation of this IntVectSet.
void createBoxes (Vector< Box > &boxes, int &size) const
 Returns Vector<Box> representation of this IntVectSet.
bool contains (const IntVect &iv) const
bool contains (const Box &box) const
TreeIntVectSet chop (int idir, int chop_pnt)
void chop (int dir, int chop_pnt, TreeIntVectSet &a_hi)
void grow (int igrow)
void grow (int idir, int igrow)
void refine (int iref=2)
 fast if iref is power of 2
void coarsen (int iref=2)
 fast if iref is power of 2
void shift (const IntVect &iv)
 slow operation
void clear ()
void nestingRegion (int a_radius, const Box &a_domain, int granularity)
void nestingRegion (int a_radius, const ProblemDomain &a_domain, int granularity)
const BoxminBox () const
bool isEmpty () const
int numPts () const
void compact () const
void recalcMinBox () const
Linearization routines

int linearSize () const
void linearIn (const void *const inBuf)
void linearOut (void *const a_outBuf) const

Private Member Functions

void trimCoarsen (int icoarse)
void growTree ()
void remove (const Box &box, TreeIntVectSet *resdiual)
void transfer (TreeNode &node, const Box &a_box)

Static Private Member Functions

static void quadrantBox (const Box &inputBox, int quadrant, Box &outputQuadrant)
static void clearTree (TreeNode &tree)
static void expandNode (TreeNode &node)
static int oppositeQuadrant (int index)
static bool nextIntVect (const Box &box, IntVect &iv)
static void nextNode (int &currentDepth)
static void cloneNode (const TreeNode &src, TreeNode &dest)

Private Attributes

TreeNode m_tree
Box m_minBox
Box m_spanBox
int m_depth

Static Private Attributes

static Pool treeNodePoolObject
static PooltreeNodePool
static Vector< int > index
static Vector< int > bufferOffset
static Vector< TreeNode * > parents
static Vector< Boxboxes
static TreeNode full


class TreeIntVectSetIterator
class MeshRefine
struct Flag
class IntVectSet
void dumpTree (const TreeIntVectSet *set)

Constructor & Destructor Documentation

TreeIntVectSet::TreeIntVectSet (  )  [inline]

References m_depth, and m_tree.

TreeIntVectSet::TreeIntVectSet ( const Box a_box  )  [inline]

References define().

TreeIntVectSet::TreeIntVectSet ( const TreeIntVectSet a_sivs  )  [inline]

References define().

TreeIntVectSet::~TreeIntVectSet (  )  [inline]

References clearTree(), and m_tree.

Member Function Documentation

void TreeIntVectSet::define ( const Box  ) 

Referenced by TreeIntVectSet().

void TreeIntVectSet::define ( const TreeIntVectSet a_sivs  ) 

void TreeIntVectSet::swap ( TreeIntVectSet a_other  ) 

trade internals of two objects

TreeIntVectSet& TreeIntVectSet::operator= ( const TreeIntVectSet a_sivs  ) 

TreeIntVectSet& TreeIntVectSet::operator|= ( const TreeIntVectSet a_sivs  ) 


TreeIntVectSet & TreeIntVectSet::operator|= ( const IntVect a_iv  )  [inline]

TreeIntVectSet& TreeIntVectSet::operator|= ( const Box a_box  ) 

TreeIntVectSet& TreeIntVectSet::operator &= ( const TreeIntVectSet s_sivs  ) 


TreeIntVectSet& TreeIntVectSet::operator &= ( const Box a_box  ) 


TreeIntVectSet& TreeIntVectSet::operator &= ( const ProblemDomain a_domain  ) 


TreeIntVectSet& TreeIntVectSet::operator-= ( const TreeIntVectSet a_sivs  ) 


TreeIntVectSet & TreeIntVectSet::operator-= ( const IntVect a_iv  )  [inline]


TreeIntVectSet& TreeIntVectSet::operator-= ( const Box a_box  ) 


bool TreeIntVectSet::operator== ( const TreeIntVectSet lhs  )  const

returns true if

bool TreeIntVectSet::operator< ( const TreeIntVectSet a_sivs  )  const

Primary sorting criterion: numPts(). Secondary sorting criterion: lexigraphical ordering of the IntVects, taken in the order traversed by TreeIntVectSetIterator. In a total tie, returns false.

Vector<Box> TreeIntVectSet::createBoxes (  )  const

Returns Vector<Box> representation of this IntVectSet.

Returns Vector<Box> representation of this IntVectSet.

void TreeIntVectSet::createBoxes ( Vector< Box > &  boxes,
int &  size 
) const

Returns Vector<Box> representation of this IntVectSet.

Returns Vector<Box> representation of this IntVectSet.

bool TreeIntVectSet::contains ( const IntVect iv  )  const

bool TreeIntVectSet::contains ( const Box box  )  const

TreeIntVectSet TreeIntVectSet::chop ( int  idir,
int  chop_pnt 

somewhat expensive, but shouldn't be ;-)

See also:

void TreeIntVectSet::chop ( int  dir,
int  chop_pnt,
TreeIntVectSet a_hi 

a proper faster chop function that does it all in-place and saves the giant memory cost.

void TreeIntVectSet::grow ( int  igrow  ) 

See also:
IntVectSet::grow expensive

void TreeIntVectSet::grow ( int  idir,
int  igrow 


void TreeIntVectSet::refine ( int  iref = 2  ) 

fast if iref is power of 2

fast if iref is power of 2

void TreeIntVectSet::coarsen ( int  iref = 2  ) 

fast if iref is power of 2

fast if iref is power of 2

void TreeIntVectSet::shift ( const IntVect iv  ) 

slow operation

void TreeIntVectSet::clear (  ) 

void TreeIntVectSet::nestingRegion ( int  a_radius,
const Box a_domain,
int  granularity 

void TreeIntVectSet::nestingRegion ( int  a_radius,
const ProblemDomain a_domain,
int  granularity 

const Box & TreeIntVectSet::minBox (  )  const [inline]

References m_minBox.

bool TreeIntVectSet::isEmpty (  )  const

int TreeIntVectSet::numPts (  )  const

void TreeIntVectSet::compact (  )  const

void TreeIntVectSet::recalcMinBox (  )  const

int TreeIntVectSet::linearSize (  )  const

void TreeIntVectSet::linearIn ( const void *const   inBuf  ) 

void TreeIntVectSet::linearOut ( void *const   a_outBuf  )  const

void TreeIntVectSet::trimCoarsen ( int  icoarse  )  [private]

static void TreeIntVectSet::quadrantBox ( const Box inputBox,
int  quadrant,
Box outputQuadrant 
) [static, private]

static void TreeIntVectSet::clearTree ( TreeNode &  tree  )  [static, private]

Referenced by ~TreeIntVectSet().

static void TreeIntVectSet::expandNode ( TreeNode &  node  )  [static, private]

void TreeIntVectSet::growTree (  )  [private]

void TreeIntVectSet::remove ( const Box box,
TreeIntVectSet resdiual 
) [private]

void TreeIntVectSet::transfer ( TreeNode &  node,
const Box a_box 
) [private]

static int TreeIntVectSet::oppositeQuadrant ( int  index  )  [static, private]

static bool TreeIntVectSet::nextIntVect ( const Box box,
IntVect iv 
) [static, private]

void TreeIntVectSet::nextNode ( int &  currentDepth  )  [inline, static, private]

References index.

static void TreeIntVectSet::cloneNode ( const TreeNode &  src,
TreeNode &  dest 
) [static, private]

Friends And Related Function Documentation

friend class TreeIntVectSetIterator [friend]

friend class MeshRefine [friend]

friend struct Flag [friend]

friend class IntVectSet [friend]

void dumpTree ( const TreeIntVectSet set  )  [friend]

Member Data Documentation

TreeNode TreeIntVectSet::m_tree [private]

Referenced by TreeIntVectSet(), and ~TreeIntVectSet().

Referenced by minBox().

int TreeIntVectSet::m_depth [private]

Referenced by TreeIntVectSet().

Pool* TreeIntVectSet::treeNodePool [static, private]

Vector<int> TreeIntVectSet::index [static, private]

Vector<int> TreeIntVectSet::bufferOffset [static, private]

Vector<TreeNode*> TreeIntVectSet::parents [static, private]

Vector<Box> TreeIntVectSet::boxes [static, private]

TreeNode TreeIntVectSet::full [static, private]

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

Generated on Tue Apr 14 14:24:01 2009 for Chombo + EB by  doxygen 1.5.5