HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme > Struct Template Reference

Checks the divergence against a range. More...

#include <Diagnostics.h>

Public Types

typedef GridT::ValueType ValueType
 
typedef VecTraits< ValueType >
::ElementType 
ElementType
 
typedef TreeIterT TileIterT
 
typedef tree::IterTraits
< typename TreeIterT::NodeT,
typename TreeIterT::ValueIterT >
::template NodeConverter
< typename
GridT::TreeType::LeafNodeType >
::Type 
VoxelIterT
 
typedef GridT::ConstAccessor AccT
 

Public Member Functions

 HBOOST_STATIC_ASSERT (hboost::is_floating_point< ElementType >::value)
 
 CheckDivergence (const GridT &grid, const ValueType &_min, const ValueType &_max)
 Constructor taking a grid and a range to be tested against. More...
 
bool operator() (const ElementType &v) const
 Return true if the value is smaller than min or larger than max. More...
 
bool operator() (const TreeIterT &) const
 Return true if zero is outside the range. More...
 
bool operator() (const VoxelIterT &iter) const
 Return true if the divergence at a voxel location of the iterator is out of range. More...
 
std::string str () const
 Return a string describing a failed check. More...
 

Public Attributes

AccT acc
 
const ValueType invdx
 
const ValueType minVal
 
const ValueType maxVal
 

Detailed Description

template<typename GridT, typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
struct openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >

Checks the divergence against a range.

Definition at line 566 of file Diagnostics.h.

Member Typedef Documentation

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
typedef GridT::ConstAccessor openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::AccT

Definition at line 574 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
typedef VecTraits<ValueType>::ElementType openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::ElementType

Definition at line 569 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
typedef TreeIterT openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::TileIterT

Definition at line 571 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
typedef GridT::ValueType openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::ValueType

Definition at line 568 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
typedef tree::IterTraits<typename TreeIterT::NodeT, typename TreeIterT::ValueIterT>::template NodeConverter<typename GridT::TreeType::LeafNodeType>::Type openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::VoxelIterT

Definition at line 573 of file Diagnostics.h.

Constructor & Destructor Documentation

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::CheckDivergence ( const GridT &  grid,
const ValueType _min,
const ValueType _max 
)
inline

Constructor taking a grid and a range to be tested against.

Definition at line 577 of file Diagnostics.h.

Member Function Documentation

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::HBOOST_STATIC_ASSERT ( hboost::is_floating_point< ElementType >::value  )
template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::operator() ( const ElementType v) const
inline

Return true if the value is smaller than min or larger than max.

Definition at line 593 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::operator() ( const TreeIterT &  ) const
inline

Return true if zero is outside the range.

Note
We assume that the divergence of a tile is always zero.

Definition at line 597 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
bool openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::operator() ( const VoxelIterT iter) const
inline

Return true if the divergence at a voxel location of the iterator is out of range.

Definition at line 601 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
std::string openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::str ( ) const
inline

Return a string describing a failed check.

Definition at line 608 of file Diagnostics.h.

Member Data Documentation

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
AccT openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::acc

Definition at line 615 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
const ValueType openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::invdx

Definition at line 616 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
const ValueType openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::maxVal

Definition at line 616 of file Diagnostics.h.

template<typename GridT , typename TreeIterT = typename GridT::ValueOnCIter, math::DScheme DiffScheme = math::CD_2ND>
const ValueType openvdb::OPENVDB_VERSION_NAME::tools::CheckDivergence< GridT, TreeIterT, DiffScheme >::minVal

Definition at line 616 of file Diagnostics.h.


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