TimedDataIterator Class Reference

#include <TimedDataIterator.H>

Inheritance diagram for TimedDataIterator:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~TimedDataIterator ()
virtual bool ok () const
 return true if this iterator is still in its Layout
virtual void operator++ ()
 move the iterator to the next Box in the layout
void clearTime ()
 sets m_time values to zero
Vector< unsigned long long > & getTime ()
 gets current time data
Vector< BoxgetBoxes ()
const Vector< unsigned long
long > & 
getTime () const
 gets current time data in microseconds
void enableTime ()
 enables timing. does not set to zero. use clear time for that
void disableTime ()
 turns off timing
void mergeTime ()
 After you are finished timing your local elements, call mergeTimes to fill-in off-processor times.

Private Member Functions

void defineTime ()
 TimedDataIterator ()
 TimedDataIterator (const BoxLayout &boxlayout, const int *layoutID)

Private Attributes

int m_size
Vector< unsigned long long > m_time
bool m_timeEnabled
bool m_timeDefined
unsigned long long m_startTime
int m_ibox

Friends

class BoxLayout
class DisjointBoxLayout


Constructor & Destructor Documentation

virtual TimedDataIterator::~TimedDataIterator (  )  [inline, virtual]

TimedDataIterator::TimedDataIterator (  )  [private]

TimedDataIterator::TimedDataIterator ( const BoxLayout boxlayout,
const int *  layoutID 
) [private]


Member Function Documentation

virtual bool TimedDataIterator::ok (  )  const [virtual]

return true if this iterator is still in its Layout

Reimplemented from LayoutIterator.

virtual void TimedDataIterator::operator++ (  )  [virtual]

move the iterator to the next Box in the layout

Reimplemented from LayoutIterator.

void TimedDataIterator::clearTime (  ) 

sets m_time values to zero

Vector<unsigned long long>& TimedDataIterator::getTime (  )  [inline]

gets current time data

References m_time.

Vector<Box> TimedDataIterator::getBoxes (  )  [inline]

const Vector<unsigned long long>& TimedDataIterator::getTime (  )  const [inline]

gets current time data in microseconds

References m_time.

void TimedDataIterator::enableTime (  )  [inline]

enables timing. does not set to zero. use clear time for that

References defineTime(), and m_timeEnabled.

void TimedDataIterator::disableTime (  )  [inline]

turns off timing

References m_timeEnabled.

void TimedDataIterator::mergeTime (  ) 

After you are finished timing your local elements, call mergeTimes to fill-in off-processor times.

void TimedDataIterator::defineTime (  )  [private]

Referenced by enableTime().


Friends And Related Function Documentation

friend class BoxLayout [friend]

Reimplemented from DataIterator.

friend class DisjointBoxLayout [friend]

Reimplemented from DataIterator.


Member Data Documentation

Vector<unsigned long long> TimedDataIterator::m_time [private]

Referenced by getTime().

Referenced by disableTime(), and enableTime().

unsigned long long TimedDataIterator::m_startTime [private]


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

Generated on Wed Oct 18 04:03:56 2017 for Chombo + EB by  doxygen 1.5.5