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::VelocityIntegrator< GridT, Staggered, SampleOrder > Class Template Reference

Performs Runge-Kutta time integration of variable order in a static velocity field. More...

#include <VelocityFields.h>

Public Types

typedef GridT::ValueType VecType
 
typedef VecType::ValueType ElementType
 

Public Member Functions

 VelocityIntegrator (const GridT &velGrid)
 
template<size_t OrderRK, typename LocationType >
void rungeKutta (const ElementType dt, LocationType &world) const
 Variable order Runge-Kutta time integration for a single time step. More...
 

Detailed Description

template<typename GridT = Vec3fGrid, bool Staggered = false, size_t SampleOrder = 1>
class openvdb::OPENVDB_VERSION_NAME::tools::VelocityIntegrator< GridT, Staggered, SampleOrder >

Performs Runge-Kutta time integration of variable order in a static velocity field.

Note
Note that the order of the velocity sampling is controlled with the SampleOrder template parameter, which defaults to one, i.e. a tri-linear interpolation kernel.

Definition at line 215 of file VelocityFields.h.

Member Typedef Documentation

template<typename GridT = Vec3fGrid, bool Staggered = false, size_t SampleOrder = 1>
typedef VecType::ValueType openvdb::OPENVDB_VERSION_NAME::tools::VelocityIntegrator< GridT, Staggered, SampleOrder >::ElementType

Definition at line 219 of file VelocityFields.h.

template<typename GridT = Vec3fGrid, bool Staggered = false, size_t SampleOrder = 1>
typedef GridT::ValueType openvdb::OPENVDB_VERSION_NAME::tools::VelocityIntegrator< GridT, Staggered, SampleOrder >::VecType

Definition at line 218 of file VelocityFields.h.

Constructor & Destructor Documentation

template<typename GridT = Vec3fGrid, bool Staggered = false, size_t SampleOrder = 1>
openvdb::OPENVDB_VERSION_NAME::tools::VelocityIntegrator< GridT, Staggered, SampleOrder >::VelocityIntegrator ( const GridT &  velGrid)
inline

Definition at line 221 of file VelocityFields.h.

Member Function Documentation

template<typename GridT = Vec3fGrid, bool Staggered = false, size_t SampleOrder = 1>
template<size_t OrderRK, typename LocationType >
void openvdb::OPENVDB_VERSION_NAME::tools::VelocityIntegrator< GridT, Staggered, SampleOrder >::rungeKutta ( const ElementType  dt,
LocationType &  world 
) const
inline

Variable order Runge-Kutta time integration for a single time step.

Parameters
dtTime sub-step for the Runge-Kutte integrator of order OrderRK
worldLocation in world space coordinates (both input and output)

Definition at line 230 of file VelocityFields.h.

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