FreePOOMA  2.4.1
Public Types | Public Member Functions
NoMesh< Dim > Class Template Reference

NoMesh is an extremely lightweight class that indicates a Field cannot answer mesh-type questions. More...

#include <NoMesh.h>

List of all members.

Public Types

enum  { dimensions = Dim }

Public Member Functions

 NoMesh ()
 We provide a default constructor that creates the object with empty domains.
template<class Layout >
 NoMesh (const Layout &layout)
 This constructor fully constructs the object using the layout to compute domains.
 NoMesh (const NoMesh< Dim > &model)
 Copy constructor.
 ~NoMesh ()
 Empty destructor is fine.
NoMesh< Dim > & operator= (const NoMesh< Dim > &rhs)
 Copy assignment operator.
View constructors.
 NoMesh (const NoMesh< Dim > &model, const Interval< Dim > &d)
 Interval view.
 NoMesh (const NoMesh< Dim > &model, const INode< Dim > &i)
 INode view.
 NoMesh (const NoMesh< Dim > &model, const FieldEnginePatch< Dim > &p)
 FieldEnginePatch view.
template<class Mesh , class Domain >
 NoMesh (const Mesh &, const Domain &d)
 General view.
Domain functions.
const Interval< Dim > & physicalVertexDomain () const
 The vertex domain, as the mesh was constructed with.
const Interval< Dim > & physicalCellDomain () const
 Function that returns a domain adjusted to give the indices of the cells.
const Interval< Dim > & totalVertexDomain () const
 The total vertex domain, including mesh guard vertices.
const Interval< Dim > & totalCellDomain () const
 The total cell domain, including mesh guard cells.

Detailed Description

template<int Dim>
class NoMesh< Dim >

NoMesh is an extremely lightweight class that indicates a Field cannot answer mesh-type questions.

When a Field has a NoMesh, it has the flavor of a "multi-array"; that is, an array with multiple engines.


Member Enumeration Documentation

template<int Dim>
anonymous enum
Enumerator:
dimensions 

Constructor & Destructor Documentation

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

We provide a default constructor that creates the object with empty domains.

To be useful, this object must be replaced by another version via assignment.

template<int Dim>
template<class Layout >
NoMesh< Dim >::NoMesh ( const Layout &  layout) [inline, explicit]

This constructor fully constructs the object using the layout to compute domains.

The Layout supplied must refer to VERTEX positions.

template<int Dim>
NoMesh< Dim >::NoMesh ( const NoMesh< Dim > &  model) [inline]

Copy constructor.

template<int Dim>
NoMesh< Dim >::NoMesh ( const NoMesh< Dim > &  model,
const Interval< Dim > &  d 
) [inline]

Interval view.

The Interval supplied must refer to VERTEX positions.

template<int Dim>
NoMesh< Dim >::NoMesh ( const NoMesh< Dim > &  model,
const INode< Dim > &  i 
) [inline]

INode view.

The INode supplied must refer to VERTEX positions.

template<int Dim>
NoMesh< Dim >::NoMesh ( const NoMesh< Dim > &  model,
const FieldEnginePatch< Dim > &  p 
) [inline]

FieldEnginePatch view.

The FieldEnginePatch supplied must refer to VERTEX positions.

template<int Dim>
template<class Mesh , class Domain >
NoMesh< Dim >::NoMesh ( const Mesh &  ,
const Domain d 
) [inline]

General view.

Made, for instance, by taking a Range-view of some other mesh.

The Domain supplied must refer to VERTEX positions.

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

Empty destructor is fine.

The pointer to the data is ref-counted so its lifetime is correctly managed.


Member Function Documentation

template<int Dim>
NoMesh<Dim>& NoMesh< Dim >::operator= ( const NoMesh< Dim > &  rhs) [inline]

Copy assignment operator.

template<int Dim>
const Interval<Dim>& NoMesh< Dim >::physicalVertexDomain ( ) const [inline]

The vertex domain, as the mesh was constructed with.

template<int Dim>
const Interval<Dim>& NoMesh< Dim >::physicalCellDomain ( ) const [inline]

Function that returns a domain adjusted to give the indices of the cells.

template<int Dim>
const Interval<Dim>& NoMesh< Dim >::totalVertexDomain ( ) const [inline]

The total vertex domain, including mesh guard vertices.

template<int Dim>
const Interval<Dim>& NoMesh< Dim >::totalCellDomain ( ) const [inline]

The total cell domain, including mesh guard cells.


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