HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT > Class Template Reference

Analytical, divergence-free and periodic velocity field. More...

#include <VelocityFields.h>

Public Types

typedef ScalarT ValueType
 
typedef math::Vec3< ScalarT > VectorType
 

Public Member Functions

 EnrightField ()
 
math::Transform transform () const
 
VectorType operator() (const Vec3d &xyz, ValueType time) const
 
VectorType operator() (const Coord &ijk, ValueType time) const
 

Detailed Description

template<typename ScalarT = float>
class openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >

Analytical, divergence-free and periodic velocity field.

Note
Primarily intended for debugging!
Warning
This analytical velocity only produce meaningful values in the unit box in world space. In other words make sure any level set surface is fully enclosed in the axis aligned bounding box spanning 0->1 in world units.

Definition at line 101 of file VelocityFields.h.

Member Typedef Documentation

template<typename ScalarT = float>
typedef ScalarT openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >::ValueType

Definition at line 104 of file VelocityFields.h.

template<typename ScalarT = float>
typedef math::Vec3<ScalarT> openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >::VectorType

Definition at line 105 of file VelocityFields.h.

Constructor & Destructor Documentation

template<typename ScalarT = float>
openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >::EnrightField ( )
inline

Definition at line 109 of file VelocityFields.h.

Member Function Documentation

template<typename ScalarT >
math::Vec3< ScalarT > openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >::operator() ( const Vec3d &  xyz,
ValueType  time 
) const
inline
Returns
the velocity in world units, evaluated at the world position xyz and at the specified time

Definition at line 129 of file VelocityFields.h.

template<typename ScalarT = float>
VectorType openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >::operator() ( const Coord &  ijk,
ValueType  time 
) const
inline
Returns
the velocity at the coordinate space position ijk

Definition at line 121 of file VelocityFields.h.

template<typename ScalarT = float>
math::Transform openvdb::OPENVDB_VERSION_NAME::tools::EnrightField< ScalarT >::transform ( ) const
inline
Returns
const reference to the identity transform between world and index space
Note
Use this method to determine if a client grid is aligned with the coordinate space of this velocity field

Definition at line 114 of file VelocityFields.h.

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