LayoutBaseData< Dim > Class Template Reference

Data container for LayoutBase class. More...

#include <LayoutBase.h>

Inheritance diagram for LayoutBaseData< Dim >:

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_t >	Value_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_t &	domain (int i) const
	Shortcut for allocatedDomain(int).
const Domain_t &	ownedDomain (int i) const
	The domain for patch i without internal guards.
const Domain_t &	allocatedDomain (int i) const
	The domain for patch i with internal guards.
const GuardLayers_t &	internalGuards () const
const GuardLayers_t &	externalGuards () const
List_t &	nodeListGlobal ()
List_t &	nodeListLocal ()
List_t &	nodeListRemote ()
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< GCFillInfo >	gcFillList_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

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

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

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

typedef int LayoutBaseData< Dim >::Context_t

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

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

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

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

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

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

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

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

Reimplemented in GridLayoutData< Dim >, SparseTileLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

typedef GCFillInfo LayoutBaseData< Dim >::GCFillInfo_t

Reimplemented in SparseTileLayoutData< Dim >, GridLayoutData< Dim >, and UniformGridLayoutData< Dim >.

template<int Dim>

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

Reimplemented in SparseTileLayoutData< Dim >, GridLayoutData< Dim >, and UniformGridLayoutData< Dim >.

---

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).

References LayoutBaseData< Dim >::all_m, and PAssert.

template<int Dim>

const Domain_t& LayoutBaseData< Dim >::ownedDomain

(

int

i

)

const [inline]

The domain for patch i without internal guards.

References LayoutBaseData< Dim >::all_m, and PAssert.

template<int Dim>

const Domain_t& LayoutBaseData< Dim >::allocatedDomain

(

int

i

)

const [inline]

The domain for patch i with internal guards.

References LayoutBaseData< Dim >::all_m, and PAssert.

template<int Dim>

const GuardLayers_t& LayoutBaseData< Dim >::internalGuards

(

)

const [inline]

References LayoutBaseData< Dim >::internalGuards_m.

template<int Dim>

const GuardLayers_t& LayoutBaseData< Dim >::externalGuards

(

)

const [inline]

References LayoutBaseData< Dim >::externalGuards_m.

template<int Dim>

List_t& LayoutBaseData< Dim >::nodeListGlobal

(

)

[inline]

References LayoutBaseData< Dim >::all_m.

template<int Dim>

List_t& LayoutBaseData< Dim >::nodeListLocal

(

)

[inline]

References LayoutBaseData< Dim >::local_m.

template<int Dim>

List_t& LayoutBaseData< Dim >::nodeListRemote

(

)

[inline]

References LayoutBaseData< Dim >::remote_m.

template<int Dim>

bool LayoutBaseData< Dim >::initialized

(

)

const [inline]

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

References LayoutBaseData< Dim >::all_m.

template<int Dim>

int LayoutBaseData< Dim >::first

(

int

d

)

const [inline]

first is the inner domain starting point

References LayoutBaseData< Dim >::firsti_m.

template<int Dim>

int LayoutBaseData< Dim >::firsts

(

int

d

)

const [inline]

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

References LayoutBaseData< Dim >::firste_m.

template<int Dim>

const Loc<Dim>& LayoutBaseData< Dim >::blocks

(

)

const [inline]

number of blocks along each axis.

Reimplemented in GridLayoutData< Dim >.

References LayoutBaseData< Dim >::blocks_m.

template<int Dim>

FillIterator_t LayoutBaseData< Dim >::beginFillList

(

)

const [inline]

Reimplemented in GridLayoutData< Dim >.

References LayoutBaseData< Dim >::gcFillList_m.

template<int Dim>

FillIterator_t LayoutBaseData< Dim >::endFillList

(

)

const [inline]

Reimplemented in GridLayoutData< Dim >.

References LayoutBaseData< Dim >::gcFillList_m.

---

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

The list of all, local, and remote subdomains.

Referenced by LayoutBaseData< Dim >::allocatedDomain(), LayoutBaseData< Dim >::domain(), LayoutBaseData< Dim >::initialized(), LayoutBaseData< Dim >::nodeListGlobal(), LayoutBaseData< Dim >::ownedDomain(), and UniformGridLayoutData< Dim >::~UniformGridLayoutData().

template<int Dim>

List_t LayoutBaseData< Dim >::local_m

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

template<int Dim>

List_t LayoutBaseData< Dim >::remote_m

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

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(), GridLayoutData< Dim >::beginFillList(), LayoutBaseData< Dim >::endFillList(), and GridLayoutData< 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 GridLayoutData< Dim >::blocks(), and LayoutBaseData< Dim >::blocks().

---

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

• LayoutBase.h