UniformGridLayoutView< Dim, Dim2 > Class Template Reference

UniformGridLayoutView is a Layout class that provides a view of an existing UniformGridLayout object. More...

#include <UniformGridLayout.h>

Inheritance diagram for UniformGridLayoutView< Dim, Dim2 >:

Inheritance graph
[legend]
Collaboration diagram for UniformGridLayoutView< Dim, Dim2 >:

Collaboration graph
[legend]

List of all members.

Public Types

enum  { dimensions = Dim }
enum  { dim = Dim }
enum  { dim2 = Dim2 }
typedef
UniformGridLayoutViewData< Dim,
Dim2 > 
LayoutData_t
typedef LayoutData_t::Domain_t Domain_t
typedef LayoutData_t::BaseDomain_t BaseDomain_t
typedef LayoutData_t::Context_t Context_t
typedef LayoutData_t::ID_t ID_t
typedef LayoutData_t::Layout_t Layout_t
typedef
LayoutData_t::AllocatedDomain_t 
AllocatedDomain_t
typedef LayoutData_t::Value_t Value_t
typedef LayoutData_t::List_t List_t
typedef LayoutData_t::Indexer_t Indexer_t
typedef LayoutData_t::GuardLayers_t GuardLayers_t
typedef UniformGridLayoutView
< Dim, Dim2 > 
This_t
typedef UniformGridLayoutView
< Dim, Dim2 > 
ViewLayout_t
typedef LayoutBaseView< Dim,
Dim2, LayoutData_t
Base_t
typedef DerefIterator< Value_titerator
typedef ConstDerefIterator
< Value_t
const_iterator

Public Member Functions

 UniformGridLayoutView ()
template<class DT >
 UniformGridLayoutView (const Layout_t &layout, const Domain< Dim2, DT > &dom)
template<class DT >
 UniformGridLayoutView (const Layout_t &layout, const SliceDomain< DT > &dom)
template<class DT >
 UniformGridLayoutView (const ViewLayout_t &layout, const Domain< Dim, DT > &dom)
template<int OldViewDim, class DT >
 UniformGridLayoutView (const UniformGridLayoutView< OldViewDim, Dim2 > &layout, const SliceDomain< DT > &dom)
 UniformGridLayoutView (const This_t &model)
This_toperator= (const This_t &model)
 ~UniformGridLayoutView ()
template<class Ostream >
void print (Ostream &ostr) const

Friends

class UniformGridLayoutView
class UniformGridLayoutViewData


Detailed Description

template<int Dim, int Dim2>
class UniformGridLayoutView< Dim, Dim2 >

UniformGridLayoutView is a Layout class that provides a view of an existing UniformGridLayout object.

Dim is the logical dimension of the layout. Dim2 is the dimension of the UniformGridLayout contained within.

To construct a UniformGridLayoutView, you need an existing UniformGridLayout or a UniformGridLayoutView and the subdomain that is being viewed. This class does not have a useful default constructor since it is based on an existing UniformGridLayout.

Once created, UniformGridLayoutView has the same interface as Layout (see Layout.h). It also provides this extra interface:

int globalID(const Loc<Dim> &pos) : return the globalID of the node that contains the point.


Member Typedef Documentation

template<int Dim, int Dim2>
typedef UniformGridLayoutViewData<Dim, Dim2> UniformGridLayoutView< Dim, Dim2 >::LayoutData_t

template<int Dim, int Dim2>
typedef LayoutData_t::Domain_t UniformGridLayoutView< Dim, Dim2 >::Domain_t

template<int Dim, int Dim2>
typedef LayoutData_t::BaseDomain_t UniformGridLayoutView< Dim, Dim2 >::BaseDomain_t

template<int Dim, int Dim2>
typedef LayoutData_t::Context_t UniformGridLayoutView< Dim, Dim2 >::Context_t

template<int Dim, int Dim2>
typedef LayoutData_t::ID_t UniformGridLayoutView< Dim, Dim2 >::ID_t

template<int Dim, int Dim2>
typedef LayoutData_t::Layout_t UniformGridLayoutView< Dim, Dim2 >::Layout_t

template<int Dim, int Dim2>
typedef LayoutData_t::AllocatedDomain_t UniformGridLayoutView< Dim, Dim2 >::AllocatedDomain_t

template<int Dim, int Dim2>
typedef LayoutData_t::Value_t UniformGridLayoutView< Dim, Dim2 >::Value_t

template<int Dim, int Dim2>
typedef LayoutData_t::List_t UniformGridLayoutView< Dim, Dim2 >::List_t

template<int Dim, int Dim2>
typedef LayoutData_t::Indexer_t UniformGridLayoutView< Dim, Dim2 >::Indexer_t

template<int Dim, int Dim2>
typedef LayoutData_t::GuardLayers_t UniformGridLayoutView< Dim, Dim2 >::GuardLayers_t

template<int Dim, int Dim2>
typedef UniformGridLayoutView<Dim, Dim2> UniformGridLayoutView< Dim, Dim2 >::This_t

template<int Dim, int Dim2>
typedef UniformGridLayoutView<Dim, Dim2> UniformGridLayoutView< Dim, Dim2 >::ViewLayout_t

template<int Dim, int Dim2>
typedef LayoutBaseView<Dim,Dim2,LayoutData_t> UniformGridLayoutView< Dim, Dim2 >::Base_t

template<int Dim, int Dim2>
typedef DerefIterator<Value_t> UniformGridLayoutView< Dim, Dim2 >::iterator

template<int Dim, int Dim2>
typedef ConstDerefIterator<Value_t> UniformGridLayoutView< Dim, Dim2 >::const_iterator


Member Enumeration Documentation

template<int Dim, int Dim2>
anonymous enum

Enumerator:
dimensions 

template<int Dim, int Dim2>
anonymous enum

Enumerator:
dim 

template<int Dim, int Dim2>
anonymous enum

Enumerator:
dim2 


Constructor & Destructor Documentation

template<int Dim, int Dim2>
UniformGridLayoutView< Dim, Dim2 >::UniformGridLayoutView (  )  [inline]

template<int Dim, int Dim2>
template<class DT >
UniformGridLayoutView< Dim, Dim2 >::UniformGridLayoutView ( const Layout_t layout,
const Domain< Dim2, DT > &  dom 
) [inline]

template<int Dim, int Dim2>
template<class DT >
UniformGridLayoutView< Dim, Dim2 >::UniformGridLayoutView ( const Layout_t layout,
const SliceDomain< DT > &  dom 
) [inline]

template<int Dim, int Dim2>
template<class DT >
UniformGridLayoutView< Dim, Dim2 >::UniformGridLayoutView ( const ViewLayout_t layout,
const Domain< Dim, DT > &  dom 
) [inline]

template<int Dim, int Dim2>
template<int OldViewDim, class DT >
UniformGridLayoutView< Dim, Dim2 >::UniformGridLayoutView ( const UniformGridLayoutView< OldViewDim, Dim2 > &  layout,
const SliceDomain< DT > &  dom 
) [inline]

template<int Dim, int Dim2>
UniformGridLayoutView< Dim, Dim2 >::UniformGridLayoutView ( const This_t model  )  [inline]

template<int Dim, int Dim2>
UniformGridLayoutView< Dim, Dim2 >::~UniformGridLayoutView (  )  [inline]


Member Function Documentation

template<int Dim, int Dim2>
This_t& UniformGridLayoutView< Dim, Dim2 >::operator= ( const This_t model  )  [inline]

template<int Dim, int Dim2>
template<class Ostream >
void UniformGridLayoutView< Dim, Dim2 >::print ( Ostream &  ostr  )  const [inline]

Referenced by operator<<().


Friends And Related Function Documentation

template<int Dim, int Dim2>
friend class UniformGridLayoutView [friend]

template<int Dim, int Dim2>
friend class UniformGridLayoutViewData [friend]


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

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