LayoutBaseData< Dim > Class Template Reference

Data container for LayoutBase class. More...

#include <LayoutBase.h>

Inheritance diagram for LayoutBaseData< Dim >:

Inheritance graph
[legend]

List of all members.

Classes

struct  GCFillInfo

Public Types

typedef Interval< Dim > Domain_t
typedef Interval< Dim > BaseDomain_t
typedef int Context_t
typedef Unique::Value_t ID_t
typedef Node< Domain_tValue_t
typedef std::vector< Value_t * > List_t
typedef GuardLayers< Dim > GuardLayers_t
typedef GCFillInfo GCFillInfo_t
typedef std::vector
< GCFillInfo >::const_iterator 
FillIterator_t

Public Member Functions

 LayoutBaseData ()
 LayoutBaseData (bool hasIG, bool hasEG, GuardLayers_t eg, GuardLayers_t ig, Domain_t d, Domain_t id)
 ~LayoutBaseData ()
const Domain_tdomain (int i) const
 Shortcut for allocatedDomain(int).
const Domain_townedDomain (int i) const
 The domain for patch i without internal guards.
const Domain_tallocatedDomain (int i) const
 The domain for patch i with internal guards.
const GuardLayers_tinternalGuards () const
const GuardLayers_texternalGuards () const
List_tnodeListGlobal ()
List_tnodeListLocal ()
List_tnodeListRemote ()
bool initialized () const
 Check if we've been initialized. Used in touches.
int first (int d) const
 first is the inner domain starting point
int firsts (int d) const
 firsts is the domain (external guard region included) starting point
const Loc< Dim > & blocks () const
 number of blocks along each axis.
Guard-cell related functions.
Iterators into the fill list.

These are MultiPatch's interface to the information needed to fill guard cells, which is cached here in the layout.

FillIterator_t beginFillList () const
FillIterator_t endFillList () const

Public Attributes

ID_t ID_m
 Our ID value, which is simply a unique value.
Domain_t domain_m
 The global domain of this LayoutBase, including external guards.
Domain_t innerdomain_m
 The global domain, excluding external guards.
List_t all_m
 The list of all, local, and remote subdomains.
List_t local_m
List_t remote_m
bool hasInternalGuards_m
 Do we have internal guards?
bool hasExternalGuards_m
 Do we have external guards?
GuardLayers_t internalGuards_m
 The internal guard cell sizes:.
GuardLayers_t externalGuards_m
 The external guard cell sizes:.
std::vector< GCFillInfogcFillList_m
 Cached guard-cell filling info.
int firste_m [Dim]
 The initial points for the domain, including external guards.
int firsti_m [Dim]
 the initial points for the inner domain, excluding external guards.
Loc< Dim > blocks_m
 for UGL and GL, the number of blocks along each axis


Detailed Description

template<int Dim>
class LayoutBaseData< Dim >

Data container for LayoutBase class.

Member Typedef Documentation

template<int Dim>
typedef Interval<Dim> LayoutBaseData< Dim >::Domain_t

template<int Dim>
typedef Interval<Dim> LayoutBaseData< Dim >::BaseDomain_t

template<int Dim>
typedef int LayoutBaseData< Dim >::Context_t

template<int Dim>
typedef Unique::Value_t LayoutBaseData< Dim >::ID_t

template<int Dim>
typedef Node<Domain_t> LayoutBaseData< Dim >::Value_t

template<int Dim>
typedef std::vector<Value_t *> LayoutBaseData< Dim >::List_t

template<int Dim>
typedef GuardLayers<Dim> LayoutBaseData< Dim >::GuardLayers_t

template<int Dim>
typedef GCFillInfo LayoutBaseData< Dim >::GCFillInfo_t

template<int Dim>
typedef std::vector<GCFillInfo>::const_iterator LayoutBaseData< Dim >::FillIterator_t


Constructor & Destructor Documentation

template<int Dim>
LayoutBaseData< Dim >::LayoutBaseData (  )  [inline]

template<int Dim>
LayoutBaseData< Dim >::LayoutBaseData ( bool  hasIG,
bool  hasEG,
GuardLayers_t  eg,
GuardLayers_t  ig,
Domain_t  d,
Domain_t  id 
) [inline]

template<int Dim>
LayoutBaseData< Dim >::~LayoutBaseData (  )  [inline]


Member Function Documentation

template<int Dim>
const Domain_t& LayoutBaseData< Dim >::domain ( int  i  )  const [inline]

Shortcut for allocatedDomain(int).

template<int Dim>
const Domain_t& LayoutBaseData< Dim >::ownedDomain ( int  i  )  const [inline]

The domain for patch i without internal guards.

template<int Dim>
const Domain_t& LayoutBaseData< Dim >::allocatedDomain ( int  i  )  const [inline]

The domain for patch i with internal guards.

template<int Dim>
const GuardLayers_t& LayoutBaseData< Dim >::internalGuards (  )  const [inline]

template<int Dim>
const GuardLayers_t& LayoutBaseData< Dim >::externalGuards (  )  const [inline]

template<int Dim>
List_t& LayoutBaseData< Dim >::nodeListGlobal (  )  [inline]

template<int Dim>
List_t& LayoutBaseData< Dim >::nodeListLocal (  )  [inline]

template<int Dim>
List_t& LayoutBaseData< Dim >::nodeListRemote (  )  [inline]

template<int Dim>
bool LayoutBaseData< Dim >::initialized (  )  const [inline]

Check if we've been initialized. Used in touches.

template<int Dim>
int LayoutBaseData< Dim >::first ( int  d  )  const [inline]

first is the inner domain starting point

template<int Dim>
int LayoutBaseData< Dim >::firsts ( int  d  )  const [inline]

firsts is the domain (external guard region included) starting point

template<int Dim>
const Loc<Dim>& LayoutBaseData< Dim >::blocks (  )  const [inline]

number of blocks along each axis.

Reimplemented in GridLayoutData< Dim >.

template<int Dim>
FillIterator_t LayoutBaseData< Dim >::beginFillList (  )  const [inline]

Reimplemented in GridLayoutData< Dim >.

template<int Dim>
FillIterator_t LayoutBaseData< Dim >::endFillList (  )  const [inline]

Reimplemented in GridLayoutData< Dim >.


Member Data Documentation

template<int Dim>
ID_t LayoutBaseData< Dim >::ID_m

Our ID value, which is simply a unique value.

template<int Dim>
Domain_t LayoutBaseData< Dim >::domain_m

The global domain of this LayoutBase, including external guards.

template<int Dim>
Domain_t LayoutBaseData< Dim >::innerdomain_m

The global domain, excluding external guards.

template<int Dim>
List_t LayoutBaseData< Dim >::all_m

template<int Dim>
List_t LayoutBaseData< Dim >::local_m

template<int Dim>
List_t LayoutBaseData< Dim >::remote_m

template<int Dim>
bool LayoutBaseData< Dim >::hasInternalGuards_m

Do we have internal guards?

template<int Dim>
bool LayoutBaseData< Dim >::hasExternalGuards_m

Do we have external guards?

template<int Dim>
GuardLayers_t LayoutBaseData< Dim >::internalGuards_m

The internal guard cell sizes:.

Referenced by LayoutBaseData< Dim >::internalGuards().

template<int Dim>
GuardLayers_t LayoutBaseData< Dim >::externalGuards_m

The external guard cell sizes:.

Referenced by LayoutBaseData< Dim >::externalGuards().

template<int Dim>
std::vector<GCFillInfo> LayoutBaseData< Dim >::gcFillList_m

Cached guard-cell filling info.

Referenced by LayoutBaseData< Dim >::beginFillList(), and LayoutBaseData< Dim >::endFillList().

template<int Dim>
int LayoutBaseData< Dim >::firste_m[Dim]

The initial points for the domain, including external guards.

Referenced by LayoutBaseData< Dim >::firsts().

template<int Dim>
int LayoutBaseData< Dim >::firsti_m[Dim]

the initial points for the inner domain, excluding external guards.

Referenced by LayoutBaseData< Dim >::first().

template<int Dim>
Loc<Dim> LayoutBaseData< Dim >::blocks_m

for UGL and GL, the number of blocks along each axis

Referenced by LayoutBaseData< Dim >::blocks().


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

Generated on Wed Mar 16 06:20:17 2011 for FreePOOMA by  doxygen 1.5.9