UT_VoxelProbeFace< T > Class Template Reference

#include <UT_VoxelArray.h>

Public Member Functions
	UT_VoxelProbeFace ()
	~UT_VoxelProbeFace ()
void	setArray (const UT_VoxelArray< T > *vx, const UT_VoxelArray< T > *vy, const UT_VoxelArray< T > *vz)
void	setVoxelSize (const UT_Vector3 &voxelsize)
template<typename S >
bool	setIndex (UT_VoxelArrayIterator< S > &vit)
template<typename S >
bool	setIndex (UT_VoxelTileIterator< S > &vit)
bool	setIndex (int x, int y, int z)
T	face (int axis, int side) const
UT_Vector3	value () const
T	divergence () const
	Returns the divergence of this cell. More...

Static Protected Member Functions
static void	swapLines (UT_VoxelProbe< T, true, false, false > &ym, UT_VoxelProbe< T, true, false, false > &yp)

Protected Attributes
UT_VoxelProbe< T, true, false, false >	myLines [3][2]
bool	myValid
int	myX
int	myY
int	myZ
int	myMinValidX
	Half inclusive [,) range of valid x queries for current cache. More...
int	myMaxValidX
UT_Vector3	myVoxelSize
UT_Vector3	myInvVoxelSize

Detailed Description

template<typename T>
class UT_VoxelProbeFace< T >

UT_VoxelProbeFace is designed to walk over three velocity fields that store face-centered values. The indices refer to the centers of the voxels.

Definition at line 83 of file UT_VoxelArray.h.

Constructor & Destructor Documentation

template<typename T >

UT_VoxelProbeFace< T >::UT_VoxelProbeFace

(

)

UT_VoxelProbeFace methods

Definition at line 8942 of file UT_VoxelArray.C.

template<typename T >

UT_VoxelProbeFace< T >::~UT_VoxelProbeFace

(

)

Definition at line 8948 of file UT_VoxelArray.C.

Member Function Documentation

template<typename T >

T UT_VoxelProbeFace< T >::divergence ( ) const

inline

Returns the divergence of this cell.

Definition at line 2609 of file UT_VoxelArray.h.

template<typename T >

T UT_VoxelProbeFace< T >::face ( int  axis, int  side  ) const

inline

Get the face values on each face component. Parameters are axis then side. 0 is the lower face, 1 the higher face.

Definition at line 2591 of file UT_VoxelArray.h.

template<typename T >

void UT_VoxelProbeFace< T >::setArray	(	const UT_VoxelArray< T > *	vx,
		const UT_VoxelArray< T > *	vy,
		const UT_VoxelArray< T > *	vz
	)

Definition at line 8955 of file UT_VoxelArray.C.

template<typename T >

template<typename S >

bool UT_VoxelProbeFace< T >::setIndex ( UT_VoxelArrayIterator< S > &  vit )

inline

Definition at line 2581 of file UT_VoxelArray.h.

template<typename T >

template<typename S >

bool UT_VoxelProbeFace< T >::setIndex ( UT_VoxelTileIterator< S > &  vit )

inline

Definition at line 2584 of file UT_VoxelArray.h.

template<typename T >

bool UT_VoxelProbeFace< T >::setIndex	(	int	x,
		int	y,
		int	z
	)

Definition at line 8981 of file UT_VoxelArray.C.

template<typename T >

void UT_VoxelProbeFace< T >::setVoxelSize

(

const UT_Vector3 &

voxelsize

)

Definition at line 8972 of file UT_VoxelArray.C.

template<typename T >

void UT_VoxelProbeFace< T >::swapLines ( UT_VoxelProbe< T, true, false, false > &  ym, UT_VoxelProbe< T, true, false, false > &  yp  )

staticprotected

Definition at line 9049 of file UT_VoxelArray.C.

template<typename T >

UT_Vector3 UT_VoxelProbeFace< T >::value ( ) const

inline

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

Definition at line 2601 of file UT_VoxelArray.h.

Member Data Documentation

template<typename T >

UT_Vector3 UT_VoxelProbeFace< T >::myInvVoxelSize

protected

Definition at line 2632 of file UT_VoxelArray.h.

template<typename T >

UT_VoxelProbe<T, true, false, false> UT_VoxelProbeFace< T >::myLines[3][2]

protected

Definition at line 2623 of file UT_VoxelArray.h.

template<typename T >

int UT_VoxelProbeFace< T >::myMaxValidX

protected

Definition at line 2630 of file UT_VoxelArray.h.

template<typename T >

int UT_VoxelProbeFace< T >::myMinValidX

protected

Half inclusive [,) range of valid x queries for current cache.

Definition at line 2630 of file UT_VoxelArray.h.

template<typename T >

bool UT_VoxelProbeFace< T >::myValid

protected

Cached look up position. myValid stores if they are valid values or not

Definition at line 2627 of file UT_VoxelArray.h.

template<typename T >

UT_Vector3 UT_VoxelProbeFace< T >::myVoxelSize

protected

Definition at line 2632 of file UT_VoxelArray.h.

template<typename T >

int UT_VoxelProbeFace< T >::myX

protected

Definition at line 2628 of file UT_VoxelArray.h.

template<typename T >

int UT_VoxelProbeFace< T >::myY

protected

Definition at line 2628 of file UT_VoxelArray.h.

template<typename T >

int UT_VoxelProbeFace< T >::myZ

protected

Definition at line 2628 of file UT_VoxelArray.h.

---

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

• UT/UT_VoxelArray.h
• UT/UT_VoxelArray.C