FreePOOMA  2.4.1
Public Types | Public Member Functions | Friends
GridLayoutView< Dim, Dim2 > Class Template Reference

GridLayoutView is a Layout class that provides a view of an existing GridLayout object. More...

#include <GridLayout.h>

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

List of all members.

Public Types

enum  { dimensions = Dim }
enum  { dim = Dim }
enum  { dim2 = Dim2 }
typedef GridLayoutViewData
< 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 GridLayoutView< Dim, Dim2 > This_t
typedef GridLayoutView< 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

 GridLayoutView ()
template<class DT >
 GridLayoutView (const Layout_t &layout, const Domain< Dim2, DT > &dom)
template<class DT >
 GridLayoutView (const Layout_t &layout, const SliceDomain< DT > &dom)
template<class DT >
 GridLayoutView (const ViewLayout_t &layout, const Domain< Dim, DT > &dom)
template<int OldViewDim, class DT >
 GridLayoutView (const GridLayoutView< OldViewDim, Dim2 > &layout, const SliceDomain< DT > &dom)
 GridLayoutView (const This_t &model)
This_toperator= (const This_t &model)
 ~GridLayoutView ()
template<class Ostream >
void print (Ostream &ostr) const
void computeSubdomains () const
 Fill our subdomain lists.

Friends

class GridLayoutView
class GridLayoutViewData

Detailed Description

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

GridLayoutView is a Layout class that provides a view of an existing GridLayout object.

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

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

Once created, GridLayoutView 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 GridLayoutViewData<Dim, Dim2> GridLayoutView< Dim, Dim2 >::LayoutData_t
template<int Dim, int Dim2>
typedef LayoutData_t::Domain_t GridLayoutView< Dim, Dim2 >::Domain_t
template<int Dim, int Dim2>
typedef LayoutData_t::BaseDomain_t GridLayoutView< Dim, Dim2 >::BaseDomain_t
template<int Dim, int Dim2>
typedef LayoutData_t::Context_t GridLayoutView< Dim, Dim2 >::Context_t
template<int Dim, int Dim2>
typedef LayoutData_t::ID_t GridLayoutView< Dim, Dim2 >::ID_t
template<int Dim, int Dim2>
typedef LayoutData_t::Layout_t GridLayoutView< Dim, Dim2 >::Layout_t
template<int Dim, int Dim2>
typedef LayoutData_t::AllocatedDomain_t GridLayoutView< Dim, Dim2 >::AllocatedDomain_t
template<int Dim, int Dim2>
typedef LayoutData_t::Value_t GridLayoutView< Dim, Dim2 >::Value_t
template<int Dim, int Dim2>
typedef LayoutData_t::List_t GridLayoutView< Dim, Dim2 >::List_t
template<int Dim, int Dim2>
typedef LayoutData_t::Indexer_t GridLayoutView< Dim, Dim2 >::Indexer_t
template<int Dim, int Dim2>
typedef LayoutData_t::GuardLayers_t GridLayoutView< Dim, Dim2 >::GuardLayers_t
template<int Dim, int Dim2>
typedef GridLayoutView<Dim, Dim2> GridLayoutView< Dim, Dim2 >::This_t
template<int Dim, int Dim2>
typedef GridLayoutView<Dim, Dim2> GridLayoutView< Dim, Dim2 >::ViewLayout_t
template<int Dim, int Dim2>
typedef LayoutBaseView<Dim, Dim2, LayoutData_t> GridLayoutView< Dim, Dim2 >::Base_t
template<int Dim, int Dim2>
typedef DerefIterator<Value_t> GridLayoutView< Dim, Dim2 >::iterator
template<int Dim, int Dim2>
typedef ConstDerefIterator<Value_t> GridLayoutView< 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>
GridLayoutView< Dim, Dim2 >::GridLayoutView ( ) [inline]
template<int Dim, int Dim2>
template<class DT >
GridLayoutView< Dim, Dim2 >::GridLayoutView ( const Layout_t layout,
const Domain< Dim2, DT > &  dom 
) [inline]
template<int Dim, int Dim2>
template<class DT >
GridLayoutView< Dim, Dim2 >::GridLayoutView ( const Layout_t layout,
const SliceDomain< DT > &  dom 
) [inline]
template<int Dim, int Dim2>
template<class DT >
GridLayoutView< Dim, Dim2 >::GridLayoutView ( const ViewLayout_t layout,
const Domain< Dim, DT > &  dom 
) [inline]
template<int Dim, int Dim2>
template<int OldViewDim, class DT >
GridLayoutView< Dim, Dim2 >::GridLayoutView ( const GridLayoutView< OldViewDim, Dim2 > &  layout,
const SliceDomain< DT > &  dom 
) [inline]
template<int Dim, int Dim2>
GridLayoutView< Dim, Dim2 >::GridLayoutView ( const This_t model) [inline]
template<int Dim, int Dim2>
GridLayoutView< Dim, Dim2 >::~GridLayoutView ( ) [inline]

Member Function Documentation

template<int Dim, int Dim2>
This_t& GridLayoutView< Dim, Dim2 >::operator= ( const This_t model) [inline]
template<int Dim, int Dim2>
template<class Ostream >
void GridLayoutView< Dim, Dim2 >::print ( Ostream &  ostr) const

Referenced by operator<<().

template<int Dim, int Dim2>
void GridLayoutView< Dim, Dim2 >::computeSubdomains ( ) const [inline]

Friends And Related Function Documentation

template<int Dim, int Dim2>
friend class GridLayoutView [friend]
template<int Dim, int Dim2>
friend class GridLayoutViewData [friend]

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