UT_VoxelProbeAverage< T, XStep, YStep, ZStep > Class Template Reference

#include <UT_VoxelArray.h>

List of all members.

Public Member Functions

 UT_VoxelProbeAverage ()
virtual ~UT_VoxelProbeAverage ()
void setArray (UT_VoxelArray< T > *vox)
template<typename S >
bool setIndex (UT_VoxelArrayIterator< S > &vit)
bool setIndex (int x, int y, int z)
getValue () const

Protected Member Functions

valueZ (int z) const
valueYZ (int y, int z) const

Protected Attributes

UT_VoxelProbe< T, true, false,
false > 
myLines [2][2]


Detailed Description

template<typename T, int XStep, int YStep, int ZStep>
class UT_VoxelProbeAverage< T, XStep, YStep, ZStep >

UT_VoxelProbeAverage

When working with MAC grids one often has slightly misalgined fields. Ie, one field is at the half-grid spacing of another field. The step values are 0 if the dimension is algined, -1 for half a step back (ie, (val(-1)+val(0))/2) and 1 for half a step forward (ie, (val(0)+val(1))/2)

Definition at line 1229 of file UT_VoxelArray.h.


Constructor & Destructor Documentation

template<typename T, int XStep, int YStep, int ZStep>
UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::UT_VoxelProbeAverage (  )  [inline]

Definition at line 1233 of file UT_VoxelArray.h.

template<typename T, int XStep, int YStep, int ZStep>
virtual UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::~UT_VoxelProbeAverage (  )  [inline, virtual]

Definition at line 1234 of file UT_VoxelArray.h.


Member Function Documentation

template<typename T, int XStep, int YStep, int ZStep>
T UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::getValue (  )  const [inline]

Returns the velocity centered at this index, thus an average of the values in each of our internal probes.

Definition at line 1245 of file UT_VoxelArray.h.

template<typename T , int XStep, int YStep, int ZStep>
void UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::setArray ( UT_VoxelArray< T > *  vox  )  [inline]

VoxelProbeAverage methods

Definition at line 3419 of file UT_VoxelArray.C.

template<typename T , int XStep, int YStep, int ZStep>
bool UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::setIndex ( int  x,
int  y,
int  z 
) [inline]

Definition at line 3439 of file UT_VoxelArray.C.

template<typename T, int XStep, int YStep, int ZStep>
template<typename S >
bool UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::setIndex ( UT_VoxelArrayIterator< S > &  vit  )  [inline]

Definition at line 1239 of file UT_VoxelArray.h.

template<typename T, int XStep, int YStep, int ZStep>
T UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::valueYZ ( int  y,
int  z 
) const [inline, protected]

Definition at line 1260 of file UT_VoxelArray.h.

template<typename T, int XStep, int YStep, int ZStep>
T UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::valueZ ( int  z  )  const [inline, protected]

Definition at line 1253 of file UT_VoxelArray.h.


Member Data Documentation

template<typename T, int XStep, int YStep, int ZStep>
UT_VoxelProbe<T, true, false, false> UT_VoxelProbeAverage< T, XStep, YStep, ZStep >::myLines[2][2] [protected]

Definition at line 1270 of file UT_VoxelArray.h.


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

Generated on Fri May 25 00:10:56 2012 for HDK by  doxygen 1.5.9