BoxLayoutData< T > Class Template Reference

#include <BoxLayoutData.H>

Inheritance diagram for BoxLayoutData< T >:

Inheritance graph
[legend]

List of all members.


Detailed Description

template<class T>
class BoxLayoutData< T >

Data on a BoxLayout.

A collection of Box-oriented objects. The arrangement of Boxes is given by the underlying BoxLayout object. BoxLayoutData attempt to prevent users from maniupulating the template class T to become out of synch with the boxes in the BoxLayout. Caveat emptor.

All access to the data in a BoxLayoutData is forced to be data-parallel, by use of the DataIterator.

class T must provide the following methods:

In sequential codes, many of these functions will not be called, but in the general parallel case, they all will be.

Public Member Functions

 BoxLayoutData ()
virtual ~BoxLayoutData ()
 BoxLayoutData (const BoxLayout &boxes, int comps, const DataFactory< T > &factory=DefaultDataFactory< T >())
virtual void define (const BoxLayout &boxes, int comps, const DataFactory< T > &factory=DefaultDataFactory< T >())
virtual void define (const BoxLayoutData< T > &da, const DataFactory< T > &factory=DefaultDataFactory< T >())
virtual void define (const BoxLayoutData< T > &da, const Interval &comps, const DataFactory< T > &factory=DefaultDataFactory< T >())
virtual void define (const BoxLayout &boxes)
 overridden and throws an error.
int nComp () const
Interval interval () const
void generalCopyTo (const BoxLayout &a_destGrids, LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_interval, const ProblemDomain &a_domain, const DataFactory< T > &factory=DefaultDataFactory< T >()) const
 General data copying operation.
void generalCopyTo (const BoxLayout &a_destGrids, LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_interval, const ProblemDomain &a_domain, const Copier &a_copier, const DataFactory< T > &factory=DefaultDataFactory< T >()) const
void addTo (const Interval &a_srcComps, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const ProblemDomain &a_domain) const
void addTo (const Interval &a_srcComps, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const ProblemDomain &a_domain, const Copier &a_copier) const
virtual void apply (void(*a_Function)(const Box &box, int comps, T &t))
virtual bool isDefined () const
virtual void clear ()

Static Public Attributes

static int s_verbosity = 0

Protected Member Functions

void setVector (const BoxLayoutData< T > &da, const Interval &srcComps, const Interval &destComps)
void allocateGhostVector (const DataFactory< T > &factory, const IntVect &ghost=IntVect::Zero)
void makeItSo (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=CopyLDOperator< T >()) const
void makeItSoBegin (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=CopyLDOperator< T >()) const
void makeItSoLocalCopy (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=CopyLDOperator< T >()) const
void makeItSoLocalCopyNoOMP (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=CopyLDOperator< T >()) const
void makeItSoLocalCopyThread (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=CopyLDOperator< T >()) const
void makeItSoEnd (BoxLayoutData< T > &a_dest, const Interval &a_destComps, const LDOperator< T > &a_op=CopyLDOperator< T >()) const
void completePendingSends () const
void allocateBuffers (const BoxLayoutData< T > &a_src, const Interval &a_srcComps, const BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op) const
void writeSendDataFromMeIntoBuffers (const BoxLayoutData< T > &a_src, const Interval &a_srcComps, const LDOperator< T > &a_op) const
void writeSendDataFromMeIntoBuffersThread (const BoxLayoutData< T > &a_src, const Interval &a_srcComps, const LDOperator< T > &a_op) const
void writeSendDataFromMeIntoBuffersNoOMP (const BoxLayoutData< T > &a_src, const Interval &a_srcComps, const LDOperator< T > &a_op) const
void postSendsFromMe () const
void postReceivesToMe () const
void unpackReceivesToMe (BoxLayoutData< T > &a_dest, const Interval &a_destComps, const LDOperator< T > &a_op) const
void unpackReceivesToMeThread (BoxLayoutData< T > &a_dest, const Interval &a_destComps, const LDOperator< T > &a_op) const
void unpackReceivesToMeNoOMP (BoxLayoutData< T > &a_dest, const Interval &a_destComps, const LDOperator< T > &a_op) const
void unpackReceivesToMe_append (LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_destComps, int ncomp, const DataFactory< T > &factory, const LDOperator< T > &a_op) const
void unpackReceivesToMe_appendThread (LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_destComps, int ncomp, const DataFactory< T > &factory, const LDOperator< T > &a_op) const
void unpackReceivesToMe_appendNoOMP (LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_destComps, int ncomp, const DataFactory< T > &factory, const LDOperator< T > &a_op) const
bool doingJustCopy (const LDOperator< T > &a_op) const

Protected Attributes

int m_comps
bool m_isdefined
Parallel messaging members


CopierBufferm_buff

Friends

class LevelData< T >


Constructor & Destructor Documentation

template<class T>
BoxLayoutData< T >::BoxLayoutData (  )  [inline]

template<class T>
BoxLayoutData< T >::~BoxLayoutData (  )  [inline, virtual]

template<class T>
BoxLayoutData< T >::BoxLayoutData ( const BoxLayout boxes,
int  comps,
const DataFactory< T > &  factory = DefaultDataFactory<T>() 
) [inline]


Member Function Documentation

template<class T>
void BoxLayoutData< T >::define ( const BoxLayout boxes,
int  comps,
const DataFactory< T > &  factory = DefaultDataFactory<T>() 
) [inline, virtual]

template<class T>
void BoxLayoutData< T >::define ( const BoxLayoutData< T > &  da,
const DataFactory< T > &  factory = DefaultDataFactory<T>() 
) [inline, virtual]

template<class T>
void BoxLayoutData< T >::define ( const BoxLayoutData< T > &  da,
const Interval comps,
const DataFactory< T > &  factory = DefaultDataFactory<T>() 
) [inline, virtual]

template<class T>
void BoxLayoutData< T >::define ( const BoxLayout boxes  )  [inline, virtual]

template<class T>
int BoxLayoutData< T >::nComp (  )  const [inline]

template<class T>
Interval BoxLayoutData< T >::interval (  )  const [inline]

template<class T>
void BoxLayoutData< T >::generalCopyTo ( const BoxLayout a_destGrids,
LayoutData< Vector< RefCountedPtr< T > > > &  a_dest,
const Interval a_interval,
const ProblemDomain a_domain,
const DataFactory< T > &  factory = DefaultDataFactory<T>() 
) const [inline]

General data copying operation.

Parameters:
a_destGrids BoxLayout for the destination data holder
a_dest return argument. upon completion contains a Vector of T objects for each Box in a_destGrids that overlaps this->boxLayout()
a_interval range of components to source
a_domain ProblemDomain that this grid and a_destGrids reside on.
factory optional data factory for template classes that have non-trivial construction

References Copier::define(), LayoutData< T >::m_boxLayout, and IntVect::Zero.

template<class T>
void BoxLayoutData< T >::generalCopyTo ( const BoxLayout a_destGrids,
LayoutData< Vector< RefCountedPtr< T > > > &  a_dest,
const Interval a_interval,
const ProblemDomain a_domain,
const Copier a_copier,
const DataFactory< T > &  factory = DefaultDataFactory<T>() 
) const [inline]

template<class T>
void BoxLayoutData< T >::addTo ( const Interval a_srcComps,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const ProblemDomain a_domain 
) const [inline]

Special version of generalCopyTo that performs increment-on-intersection of the destination instead of replacement

References Copier::define(), LayoutData< T >::m_boxLayout, and IntVect::Zero.

template<class T>
void BoxLayoutData< T >::addTo ( const Interval a_srcComps,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const ProblemDomain a_domain,
const Copier a_copier 
) const [inline]

Special version of generalCopyTo that performs increment-on-intersection of the destination instead of replacement. This version lets the user send in a pre-built Copier.

References CH_TIME, and BoxLayoutData< T >::makeItSo().

template<class T>
void BoxLayoutData< T >::apply ( void(*)(const Box &box, int comps, T &t)  a_Function  )  [inline, virtual]

template<class T>
bool BoxLayoutData< T >::isDefined (  )  const [inline, virtual]

template<class T>
void BoxLayoutData< T >::clear (  )  [inline, virtual]

template<class T>
void BoxLayoutData< T >::setVector ( const BoxLayoutData< T > &  da,
const Interval srcComps,
const Interval destComps 
) [inline, protected]

template<class T>
void BoxLayoutData< T >::allocateGhostVector ( const DataFactory< T > &  factory,
const IntVect ghost = IntVect::Zero 
) [inline, protected]

template<class T>
void BoxLayoutData< T >::makeItSo ( const Interval a_srcComps,
const BoxLayoutData< T > &  a_src,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const Copier a_copier,
const LDOperator< T > &  a_op = CopyLDOperator<T>() 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::makeItSoBegin ( const Interval a_srcComps,
const BoxLayoutData< T > &  a_src,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const Copier a_copier,
const LDOperator< T > &  a_op = CopyLDOperator<T>() 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::makeItSoLocalCopy ( const Interval a_srcComps,
const BoxLayoutData< T > &  a_src,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const Copier a_copier,
const LDOperator< T > &  a_op = CopyLDOperator<T>() 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::makeItSoLocalCopyNoOMP ( const Interval a_srcComps,
const BoxLayoutData< T > &  a_src,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const Copier a_copier,
const LDOperator< T > &  a_op = CopyLDOperator<T>() 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::makeItSoLocalCopyThread ( const Interval a_srcComps,
const BoxLayoutData< T > &  a_src,
BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const Copier a_copier,
const LDOperator< T > &  a_op = CopyLDOperator<T>() 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::makeItSoEnd ( BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const LDOperator< T > &  a_op = CopyLDOperator<T>() 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::completePendingSends (  )  const [inline, protected]

template<class T>
void BoxLayoutData< T >::allocateBuffers ( const BoxLayoutData< T > &  a_src,
const Interval a_srcComps,
const BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const Copier a_copier,
const LDOperator< T > &  a_op 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::writeSendDataFromMeIntoBuffers ( const BoxLayoutData< T > &  a_src,
const Interval a_srcComps,
const LDOperator< T > &  a_op 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::writeSendDataFromMeIntoBuffersThread ( const BoxLayoutData< T > &  a_src,
const Interval a_srcComps,
const LDOperator< T > &  a_op 
) const [protected]

template<class T>
void BoxLayoutData< T >::writeSendDataFromMeIntoBuffersNoOMP ( const BoxLayoutData< T > &  a_src,
const Interval a_srcComps,
const LDOperator< T > &  a_op 
) const [protected]

template<class T>
void BoxLayoutData< T >::postSendsFromMe (  )  const [inline, protected]

template<class T>
void BoxLayoutData< T >::postReceivesToMe (  )  const [inline, protected]

template<class T>
void BoxLayoutData< T >::unpackReceivesToMe ( BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const LDOperator< T > &  a_op 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::unpackReceivesToMeThread ( BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const LDOperator< T > &  a_op 
) const [protected]

template<class T>
void BoxLayoutData< T >::unpackReceivesToMeNoOMP ( BoxLayoutData< T > &  a_dest,
const Interval a_destComps,
const LDOperator< T > &  a_op 
) const [protected]

template<class T>
void BoxLayoutData< T >::unpackReceivesToMe_append ( LayoutData< Vector< RefCountedPtr< T > > > &  a_dest,
const Interval a_destComps,
int  ncomp,
const DataFactory< T > &  factory,
const LDOperator< T > &  a_op 
) const [inline, protected]

template<class T>
void BoxLayoutData< T >::unpackReceivesToMe_appendThread ( LayoutData< Vector< RefCountedPtr< T > > > &  a_dest,
const Interval a_destComps,
int  ncomp,
const DataFactory< T > &  factory,
const LDOperator< T > &  a_op 
) const [protected]

template<class T>
void BoxLayoutData< T >::unpackReceivesToMe_appendNoOMP ( LayoutData< Vector< RefCountedPtr< T > > > &  a_dest,
const Interval a_destComps,
int  ncomp,
const DataFactory< T > &  factory,
const LDOperator< T > &  a_op 
) const [protected]

template<class T>
bool BoxLayoutData< T >::doingJustCopy ( const LDOperator< T > &  a_op  )  const [inline, protected]


Friends And Related Function Documentation

template<class T>
friend class LevelData< T > [friend]


Member Data Documentation

template<class T>
int BoxLayoutData< T >::s_verbosity = 0 [inline, static]

template<class T>
int BoxLayoutData< T >::m_comps [protected]

template<class T>
bool BoxLayoutData< T >::m_isdefined [protected]

template<class T>
CopierBuffer* BoxLayoutData< T >::m_buff [mutable, protected]


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

Generated on Fri Aug 18 04:03:51 2017 for Chombo + EB by  doxygen 1.5.5