FieldOffset< Dim > Class Template Reference

Given a field f, a Loc loc, and a field offset (offset,num), a field value can be obtained. More...

#include <FieldOffset.h>

List of all members.

Public Member Functions

 FieldOffset (const Loc< Dim > &loc, const int subFieldNumber=0)
 User-callable constructors. These ctors are meant to be called by users.
 FieldOffset ()
 Internal POOMA constructor.
void setSubFieldNumber (int subFieldNumber)
Loc< Dim > & modifyCellOffset ()
const Loc< Dim > & cellOffset () const
 Get the cell offset.
int subFieldNumber () const
 Get the subfield number.


Detailed Description

template<int Dim>
class FieldOffset< Dim >

Given a field f, a Loc loc, and a field offset (offset,num), a field value can be obtained.

Since each value specified by the field's centering is stored in a separate subfield, the offset is used to specify the appropriate subfield.


Constructor & Destructor Documentation

template<int Dim>
FieldOffset< Dim >::FieldOffset ( const Loc< Dim > &  loc,
const int  subFieldNumber = 0 
) [inline]

User-callable constructors. These ctors are meant to be called by users.

References PInsist.

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

Internal POOMA constructor.

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


Member Function Documentation

template<int Dim>
void FieldOffset< Dim >::setSubFieldNumber ( int  subFieldNumber  )  [inline]

template<int Dim>
Loc<Dim>& FieldOffset< Dim >::modifyCellOffset (  )  [inline]

template<int Dim>
const Loc<Dim>& FieldOffset< Dim >::cellOffset (  )  const [inline]

template<int Dim>
int FieldOffset< Dim >::subFieldNumber (  )  const [inline]


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

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