CanonicalCentering< Dim > Class Template Reference

This object makes available some canonical centerings. More...

#include <FieldCentering.h>

List of all members.

Public Member Functions

 CanonicalCentering ()
 Internal POOMA constructors.
 ~CanonicalCentering ()
 Deallocate centering_table_m.
Centering< Dim > operator() (const enum CenteringType type, const enum ContinuityType discontinuous, int dimension=0) const
 Return the desired centering.


Detailed Description

template<int Dim>
class CanonicalCentering< Dim >

This object makes available some canonical centerings.

By calling with

  1. a centering type, e.g., CellType or VertexType,
  2. whether the centering should be discontinuous or not,
  3. a dimension [0,Dim),

the corresponding centering is returned. Some parameters do not make sense for some centerings.

The canonical centerings include:

The dimension field should be the bitwise-or of X, Y, Z, and All, where the All value equals X | Y | Z. For example, using `Y | Z' yields the edges along the y- and z-axes or yields the y- and z-faces.


Constructor & Destructor Documentation

template<int Dim>
CanonicalCentering< Dim >::CanonicalCentering (  ) 

Internal POOMA constructors.

These ctors are used internally by POOMA. They are not really meant to be called by users.

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

Deallocate centering_table_m.

References CellType.


Member Function Documentation

template<int Dim>
Centering<Dim> CanonicalCentering< Dim >::operator() ( const enum CenteringType  type,
const enum ContinuityType  discontinuous,
int  dimension = 0 
) const [inline]

Return the desired centering.

References AllDim.


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

Generated on Wed Mar 16 06:19:42 2011 for FreePOOMA by  doxygen 1.5.9