OpenVDB  5.2.0
Public Types | Public Member Functions | List of all members
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

 BOOST_STATIC_ASSERT (boost::is_floating_point< ScalarT >::value)
 
 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::v5_2::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.

Member Typedef Documentation

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

Constructor & Destructor Documentation

EnrightField ( )
inline

Member Function Documentation

BOOST_STATIC_ASSERT ( boost::is_floating_point< ScalarT >::value  )
math::Vec3< 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
VectorType operator() ( const Coord &  ijk,
ValueType  time 
) const
inline
Returns
the velocity at the coordinate space position ijk
math::Transform 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

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