OpenVDB  6.2.1
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
WenoStencil< GridT, IsSafe > Class Template Reference

This is a special 19-point stencil that supports optimal fifth-order WENO upwinding, second-order central differencing, Laplacian, and zero-crossing test. More...

#include <Stencils.h>

Inherits BaseStencil< WenoStencil< GridT, IsSafe >, GridT, IsSafe >.

Public Types

typedef GridT GridType
 
typedef GridT::TreeType TreeType
 
typedef GridType::ValueType ValueType
 
typedef tree::ValueAccessor< const TreeType, IsSafe > AccessorType
 
typedef std::vector< ValueTypeBufferType
 
typedef BufferType::iterator IterType
 

Public Member Functions

 WenoStencil (const GridType &grid)
 
 WenoStencil (const GridType &grid, Real dx)
 
ValueType normSqGrad (const ValueType &isoValue=zeroVal< ValueType >()) const
 Return the norm-square of the WENO upwind gradient (computed via WENO upwinding and Godunov's scheme) at the previously buffered location. More...
 
math::Vec3< ValueTypegradient (const math::Vec3< ValueType > &V) const
 
math::Vec3< ValueTypegradient () const
 
ValueType laplacian () const
 
bool zeroCrossing () const
 
void moveTo (const Coord &ijk)
 Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. More...
 
void moveTo (const Coord &ijk, const ValueType &centerValue)
 Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. The method also takes a value of the center element of the stencil, assuming it is already known. More...
 
void moveTo (const IterType &iter)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
void moveTo (const Vec3< RealType > &xyz)
 Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors. More...
 
const ValueTypegetValue (unsigned int pos=0) const
 Return the value from the stencil buffer with linear offset pos. More...
 
const ValueTypegetValue () const
 Return the value at the specified location relative to the center of the stencil. More...
 
void setValue (const ValueType &value)
 Set the value at the specified location relative to the center of the stencil. More...
 
int size ()
 Return the size of the stencil buffer. More...
 
ValueType median () const
 Return the median value of the current stencil. More...
 
ValueType mean () const
 Return the mean value of the current stencil. More...
 
ValueType min () const
 Return the smallest value in the stencil buffer. More...
 
ValueType max () const
 Return the largest value in the stencil buffer. More...
 
const CoordgetCenterCoord () const
 Return the coordinates of the center point of the stencil. More...
 
const ValueTypegetCenterValue () const
 Return the value at the center of the stencil. More...
 
bool intersects (const ValueType &isoValue=zeroVal< ValueType >()) const
 Return true if the center of the stencil intersects the iso-contour specified by the isoValue. More...
 
const GridTypegrid () const
 Return a const reference to the grid from which this stencil was constructed. More...
 
const AccessorTypeaccessor () const
 Return a const reference to the ValueAccessor associated with this Stencil. More...
 

Static Public Attributes

static const int SIZE = 19
 

Protected Attributes

const GridTypemGrid
 
AccessorType mCache
 
BufferType mStencil
 
Coord mCenter
 

Friends

template<typename , typename , bool >
class BaseStencil
 

Detailed Description

template<typename GridT, bool IsSafe = true>
class openvdb::v6_2::math::WenoStencil< GridT, IsSafe >

This is a special 19-point stencil that supports optimal fifth-order WENO upwinding, second-order central differencing, Laplacian, and zero-crossing test.

Note
For optimal random access performance this class includes its own grid accessor.

Member Typedef Documentation

typedef tree::ValueAccessor<const TreeType, IsSafe> AccessorType
inherited
typedef std::vector<ValueType> BufferType
inherited
typedef GridT GridType
typedef BufferType::iterator IterType
inherited
typedef GridT::TreeType TreeType
typedef GridType::ValueType ValueType

Constructor & Destructor Documentation

WenoStencil ( const GridType grid)
inline
WenoStencil ( const GridType grid,
Real  dx 
)
inline

Member Function Documentation

const AccessorType& accessor ( ) const
inlineinherited

Return a const reference to the ValueAccessor associated with this Stencil.

const Coord& getCenterCoord ( ) const
inlineinherited

Return the coordinates of the center point of the stencil.

const ValueType& getCenterValue ( ) const
inlineinherited

Return the value at the center of the stencil.

const ValueType& getValue ( unsigned int  pos = 0) const
inlineinherited

Return the value from the stencil buffer with linear offset pos.

Note
The default (pos = 0) corresponds to the first element which is typically the center point of the stencil.
const ValueType& getValue ( ) const
inlineinherited

Return the value at the specified location relative to the center of the stencil.

math::Vec3<ValueType> gradient ( const math::Vec3< ValueType > &  V) const
inline

Return the optimal fifth-order upwind gradient corresponding to the direction V.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
math::Vec3<ValueType> gradient ( ) const
inline

Return the gradient computed at the previously buffered location by second-order central differencing.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
const GridType& grid ( ) const
inlineinherited

Return a const reference to the grid from which this stencil was constructed.

bool intersects ( const ValueType isoValue = zeroVal<ValueType>()) const
inlineinherited

Return true if the center of the stencil intersects the iso-contour specified by the isoValue.

ValueType laplacian ( ) const
inline

Return the Laplacian computed at the previously buffered location by second-order central differencing.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
ValueType max ( ) const
inlineinherited

Return the largest value in the stencil buffer.

ValueType mean ( ) const
inlineinherited

Return the mean value of the current stencil.

ValueType median ( ) const
inlineinherited

Return the median value of the current stencil.

ValueType min ( ) const
inlineinherited

Return the smallest value in the stencil buffer.

void moveTo ( const Coord ijk)
inlineinherited

Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors.

Parameters
ijkIndex coordinates of stencil center
void moveTo ( const Coord ijk,
const ValueType centerValue 
)
inlineinherited

Initialize the stencil buffer with the values of voxel (i, j, k) and its neighbors. The method also takes a value of the center element of the stencil, assuming it is already known.

Parameters
ijkIndex coordinates of stnecil center
centerValueValue of the center element of the stencil
void moveTo ( const IterType iter)
inlineinherited

Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.

Note
This version is slightly faster than the one above, since the center voxel's value is read directly from the iterator.
void moveTo ( const Vec3< RealType > &  xyz)
inlineinherited

Initialize the stencil buffer with the values of voxel (x, y, z) and its neighbors.

Parameters
xyzFloating point voxel coordinates of stencil center

This method will check to see if it is necessary to update the stencil based on the cached index coordinates of the center point.

ValueType normSqGrad ( const ValueType isoValue = zeroVal<ValueType>()) const
inline

Return the norm-square of the WENO upwind gradient (computed via WENO upwinding and Godunov's scheme) at the previously buffered location.

Note
This method should not be called until the stencil buffer has been populated via a call to moveTo(ijk).
void setValue ( const ValueType value)
inlineinherited

Set the value at the specified location relative to the center of the stencil.

int size ( )
inlineinherited

Return the size of the stencil buffer.

bool zeroCrossing ( ) const
inline

Return true if the sign of the value at the center point of the stencil differs from the sign of any of its six nearest neighbors

Friends And Related Function Documentation

friend class BaseStencil
friend

Member Data Documentation

AccessorType mCache
protectedinherited
Coord mCenter
protectedinherited
const GridType* mGrid
protectedinherited
BufferType mStencil
protectedinherited
const int SIZE = 19
static

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