DataIterator Class Reference

#include <DataIterator.H>

Inheritance diagram for DataIterator:

Public Member Functions
virtual	~DataIterator ()
	DataIterator ()
	DataIterator (const BoxLayout &a_layout)
const DataIndex &	operator() () const
	return the index that this iterator is at More...
DataIndex	i () const
	return a copy of the index that this iterator is at More...
int	size () const
DataIndex	operator[] (int ivec) const
void	clearTime ()
	load balancing function. no-op in serial More...
void	clearPeak ()
	load balancing function. no-op in serial More...
Vector< unsigned long long >	getTime () const
	load balancing function. no-op in serial More...
Vector< unsigned long long >	getPeak () const
Vector< Box >	getBoxes ()
void	enableTime ()
	load balancing function. no-op in serial More...
void	enablePeak ()
void	disableTime ()
	load balancing function. no-op in serial More...
void	disablePeak ()
void	mergeTime ()
	load balancing function. no-op in serial More...
void	mergePeak ()
Public Member Functions inherited from LayoutIterator
	LayoutIterator ()
	a null constructed LayoutIterator will return false on ok() More...
virtual	~LayoutIterator ()
const LayoutIndex &	operator() () const
	return the index that this iterator is at More...
LayoutIndex	i () const
	return a copy of the index that this iterator is at More...
virtual void	operator++ ()
	move the iterator to the next Box in the layout More...
void	incr ()
	move the iterator to the next Box in the layout More...
virtual bool	ok () const
	return true if this iterator is still in its Layout More...
void	begin ()
	initialize this iterator to the first Box in its Layout More...
void	reset ()
	same as begin() More...
void	end ()
	move this iterator to after the last Box in the layout More...
const LayoutIndex &	operator[] (int ivec) const
LayoutIndex &	operator[] (int ivec)

Protected Member Functions
	DataIterator (const BoxLayout &boxlayout, const int *layoutID)
Protected Member Functions inherited from LayoutIterator
	LayoutIterator (const BoxLayout &a_boxlayout, const int *a_layoutID)

Friends
class	BoxLayout
class	DisjointBoxLayout
class	TimedDataIterator

Additional Inherited Members
Protected Attributes inherited from LayoutIterator
BoxLayout	m_layout
RefCountedPtr< Vector < LayoutIndex > >	m_indicies
unsigned int	m_current

Constructor & Destructor Documentation

virtual DataIterator::~DataIterator ( )

inlinevirtual

DataIterator::DataIterator ( )

inline

DataIterator::DataIterator ( const BoxLayout &  a_layout )

inline

References BoxLayout::dataIterator().

DataIterator::DataIterator ( const BoxLayout &  boxlayout, const int *  layoutID  )

inlineprotected

Member Function Documentation

const DataIndex& DataIterator::operator() ( ) const

inline

return the index that this iterator is at

Aborts if the iterator is not ok()

References LayoutIterator::operator()().

Referenced by i().

DataIndex DataIterator::i ( ) const

inline

return a copy of the index that this iterator is at

Aborts if the iterator is not ok()

References operator()().

int DataIterator::size ( ) const

inline

References LayoutIterator::m_layout, and BoxLayout::size().

Referenced by LayoutData< T >::allocate(), BoxLayoutData< T >::allocateGhostVector(), LevelData< T >::apply(), BoxLayoutData< T >::apply(), LevelDataOps< T >::axby(), LevelData< T >::copyTo(), LevelDataOps< T >::dotProduct(), LevelDataOps< T >::incr(), LevelData< T >::localCopyTo(), LevelDataOps< T >::mDotProduct(), LevelDataOps< T >::mult(), LevelDataOps< T >::plus(), PetscSolver< T >::putChomboInPetsc(), PetscSolver< T >::putPetscInChombo(), LevelDataOps< T >::scale(), LevelDataOps< T >::setToZero(), LevelDataOps< T >::setVal(), BoxLayoutData< T >::setVector(), PetscSolver< T >::solve_mfree_private(), PetscSolver< T >::solve_private(), and write().

DataIndex DataIterator::operator[] ( int  ivec ) const

inline

void DataIterator::clearTime ( )

inline

load balancing function. no-op in serial

void DataIterator::clearPeak ( )

inline

load balancing function. no-op in serial

Vector<unsigned long long> DataIterator::getTime ( ) const

inline

load balancing function. no-op in serial

References LayoutIterator::m_layout, and BoxLayout::size().

Vector<unsigned long long> DataIterator::getPeak ( ) const

inline

References LayoutIterator::m_layout, and BoxLayout::size().

Vector<Box> DataIterator::getBoxes ( )

inline

References BoxLayout::boxArray(), and LayoutIterator::m_layout.

void DataIterator::enableTime ( )

inline

load balancing function. no-op in serial

void DataIterator::enablePeak ( )

inline

void DataIterator::disableTime ( )

inline

load balancing function. no-op in serial

void DataIterator::disablePeak ( )

inline

void DataIterator::mergeTime ( )

inline

load balancing function. no-op in serial

void DataIterator::mergePeak ( )

inline

Friends And Related Function Documentation

friend class BoxLayout

friend

friend class DisjointBoxLayout

friend

friend class TimedDataIterator

friend

---

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

• DataIterator.H