FreePOOMA  2.4.1
Public Types | Public Member Functions
Engine< Dim, T, CompressibleBrick > Class Template Reference

Engine<Dim,T,CompressibleBrick> (aka CompressibleBrick-Engine) More...

#include <CompressibleBrick.h>

Inheritance diagram for Engine< Dim, T, CompressibleBrick >:
Inheritance graph
[legend]
Collaboration diagram for Engine< Dim, T, CompressibleBrick >:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { brick = true }
enum  { dimensions = Dim }
enum  { hasDataObject = true }
enum  { dynamic = false }
enum  { zeroBased = false }
enum  { multiPatch = false }
typedef Engine< Dim, T,
CompressibleBrick
This_t
typedef Engine< Dim, T,
CompressibleBrick
Engine_t
typedef Pooma::BrickBase< Dim > Base_t
typedef Base_t::Domain_t Domain_t
typedef DomainLayout< Dim > Layout_t
typedef T Element_t
typedef T & ElementRef_t
typedef CompressibleBrick Tag_t

Public Member Functions

 Engine ()
 Engine (const Domain_t &domain)
 Engine (const Domain_t &domain, const T &elementModel)
 Engine (const Layout_t &layout)
 Engine (const Node< Domain_t > &node)
 Engine (const Engine_t &model)
 ~Engine ()
Engine_toperator= (const Engine_t &model)
ElementRef_t operator() (int) const
ElementRef_t operator() (int, int) const
ElementRef_t operator() (int, int, int) const
ElementRef_t operator() (int, int, int, int) const
ElementRef_t operator() (int, int, int, int, int) const
ElementRef_t operator() (int, int, int, int, int, int) const
ElementRef_t operator() (int, int, int, int, int, int, int) const
Element_t read (int) const
Element_t read (int, int) const
Element_t read (int, int, int) const
Element_t read (int, int, int, int) const
Element_t read (int, int, int, int, int) const
Element_t read (int, int, int, int, int, int) const
Element_t read (int, int, int, int, int, int, int) const
ElementRef_t operator() (const Loc< Dim > &) const
Element_t read (const Loc< Dim > &) const
const Domain_tdomain () const
 Return the domain.
Engine_tmakeOwnCopy ()
Pooma::DataObject_tdataObject () const
DataBlockPtr< T > dataBlock () const
CompressibleBlock< T > cblock () const
bool compressed () const
long elementsCompressed () const
void tryCompress ()
void uncompress ()
compressedRead () const
T & compressedReadWrite () const
bool compressedBrickIsWholeView () const

Detailed Description

template<int Dim, class T>
class Engine< Dim, T, CompressibleBrick >

Engine<Dim,T,CompressibleBrick> (aka CompressibleBrick-Engine)

Engine<Dim,T,CompressibleBrick> is an Engine that manages a contiguous, local, Dim-dimensional brick of data that can compress itself to a single value if all the values are the same.

Template Parameters:

The Domain of this engine is an Interval<Dim>, which is a tensor product of Dim 1-D intervals.

Subsetting Engine<Dim,T,CompressibleBrick> returns an Engine<Dim,T,CompressibleBrickView>. See below.


Member Typedef Documentation

template<int Dim, class T >
typedef Engine<Dim,T,CompressibleBrick> Engine< Dim, T, CompressibleBrick >::This_t

Reimplemented from Pooma::BrickBase< Dim >.

template<int Dim, class T >
typedef Engine<Dim,T,CompressibleBrick> Engine< Dim, T, CompressibleBrick >::Engine_t
template<int Dim, class T >
typedef Pooma::BrickBase<Dim> Engine< Dim, T, CompressibleBrick >::Base_t
template<int Dim, class T >
typedef Base_t::Domain_t Engine< Dim, T, CompressibleBrick >::Domain_t

Reimplemented from Pooma::BrickBase< Dim >.

template<int Dim, class T >
typedef DomainLayout<Dim> Engine< Dim, T, CompressibleBrick >::Layout_t

Reimplemented from Pooma::BrickBase< Dim >.

template<int Dim, class T >
typedef T Engine< Dim, T, CompressibleBrick >::Element_t
template<int Dim, class T >
typedef T& Engine< Dim, T, CompressibleBrick >::ElementRef_t
template<int Dim, class T >
typedef CompressibleBrick Engine< Dim, T, CompressibleBrick >::Tag_t

Member Enumeration Documentation

template<int Dim, class T >
anonymous enum
Enumerator:
brick 
template<int Dim, class T >
anonymous enum
Enumerator:
dimensions 
template<int Dim, class T >
anonymous enum
Enumerator:
hasDataObject 
template<int Dim, class T >
anonymous enum
Enumerator:
dynamic 
template<int Dim, class T >
anonymous enum
Enumerator:
zeroBased 
template<int Dim, class T >
anonymous enum
Enumerator:
multiPatch 

Constructor & Destructor Documentation

template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::Engine ( ) [inline]
template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::Engine ( const Domain_t domain) [explicit]
template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::Engine ( const Domain_t domain,
const T &  elementModel 
)
template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::Engine ( const Layout_t layout) [explicit]
template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::Engine ( const Node< Domain_t > &  node) [explicit]
template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::Engine ( const Engine_t model)
template<int Dim, class T >
Engine< Dim, T, CompressibleBrick >::~Engine ( )

Member Function Documentation

template<int Dim, class T >
Engine_t& Engine< Dim, T, CompressibleBrick >::operator= ( const Engine_t model)
template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1,
int  i2 
) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1,
int  i2,
int  i3 
) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1,
int  i2,
int  i3,
int  i4 
) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1,
int  i2,
int  i3,
int  i4,
int  i5 
) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1,
int  i2,
int  i3,
int  i4,
int  i5,
int  i6 
) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( int  i1,
int  i2,
int  i3,
int  i4,
int  i5,
int  i6,
int  i7 
) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1,
int  i2 
) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1,
int  i2,
int  i3 
) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1,
int  i2,
int  i3,
int  i4 
) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1,
int  i2,
int  i3,
int  i4,
int  i5 
) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1,
int  i2,
int  i3,
int  i4,
int  i5,
int  i6 
) const [inline]

References CTAssert.

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( int  i1,
int  i2,
int  i3,
int  i4,
int  i5,
int  i6,
int  i7 
) const [inline]

References CTAssert.

template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::operator() ( const Loc< Dim > &  loc) const [inline]
template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::read ( const Loc< Dim > &  loc) const [inline]
template<int Dim, class T >
const Domain_t& Engine< Dim, T, CompressibleBrick >::domain ( ) const [inline]

Return the domain.

Reimplemented from Pooma::BrickBase< Dim >.

References Interval< Dim >::domain.

template<int Dim, class T >
Engine_t& Engine< Dim, T, CompressibleBrick >::makeOwnCopy ( )
template<int Dim, class T >
Pooma::DataObject_t* Engine< Dim, T, CompressibleBrick >::dataObject ( ) const [inline]
template<int Dim, class T >
DataBlockPtr<T> Engine< Dim, T, CompressibleBrick >::dataBlock ( ) const [inline]
template<int Dim, class T >
CompressibleBlock<T> Engine< Dim, T, CompressibleBrick >::cblock ( ) const [inline]
template<int Dim, class T >
bool Engine< Dim, T, CompressibleBrick >::compressed ( ) const [inline]
template<int Dim, class T >
long Engine< Dim, T, CompressibleBrick >::elementsCompressed ( ) const

Referenced by elementsCompressed().

template<int Dim, class T >
void Engine< Dim, T, CompressibleBrick >::tryCompress ( ) [inline]

Referenced by compress().

template<int Dim, class T >
void Engine< Dim, T, CompressibleBrick >::uncompress ( ) [inline]

Referenced by uncompress().

template<int Dim, class T >
T Engine< Dim, T, CompressibleBrick >::compressedRead ( ) const [inline]
template<int Dim, class T >
T & Engine< Dim, T, CompressibleBrick >::compressedReadWrite ( ) const [inline]
template<int Dim, class T >
bool Engine< Dim, T, CompressibleBrick >::compressedBrickIsWholeView ( ) const [inline]

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