Loading...
Searching...
No Matches
PointAdvect.h
Go to the documentation of this file.
// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0
//
/// @author Ken Museth, D.J. Hill (openvdb port, added staggered grid support)
///
/// @file tools/PointAdvect.h
///
/// @brief Class PointAdvect advects points (with position) in a static velocity field
#ifndef OPENVDB_TOOLS_POINT_ADVECT_HAS_BEEN_INCLUDED
#define OPENVDB_TOOLS_POINT_ADVECT_HAS_BEEN_INCLUDED
#include <openvdb/openvdb.h>
#include <openvdb/Types.h> // Vec3 types and version number
#include <openvdb/Grid.h> // grid
#include <openvdb/math/Math.h> // min
#include <openvdb/util/NullInterrupter.h>
#include <openvdb/thread/Threading.h>
#include "Interpolation.h" // sampling
#include "VelocityFields.h" // VelocityIntegrator
#include <tbb/blocked_range.h> // threading
#include <tbb/parallel_for.h> // threading
#include <vector>
namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace tools {
/// Class that holds a Vec3 grid, to be interpreted as the closest point to a constraint
/// surface. Supports a method to allow a point to be projected onto the closest point
/// on the constraint surface. Uses Caching.
template<typename CptGridT = Vec3fGrid>
class ClosestPointProjector
{
public:
using CptGridType = CptGridT;
using CptAccessor = typename CptGridType::ConstAccessor;
using CptValueType = typename CptGridType::ValueType;
ClosestPointProjector():
mCptIterations(0)
{
}
ClosestPointProjector(const CptGridType& cptGrid, int n):
mCptGrid(&cptGrid),
mCptAccessor(cptGrid.getAccessor()),
mCptIterations(n)
{
}
ClosestPointProjector(const ClosestPointProjector &other):
mCptGrid(other.mCptGrid),
mCptAccessor(mCptGrid->getAccessor()),
mCptIterations(other.mCptIterations)
{
}
void setConstraintIterations(unsigned int cptIterations) { mCptIterations = cptIterations; }
unsigned int numIterations() { return mCptIterations; }
// point constraint
template <typename LocationType>
inline void projectToConstraintSurface(LocationType& W) const
{
/// Entries in the CPT tree are the closest point to the constraint surface.
/// The interpolation step in sample introduces error so that the result
/// of a single sample may not lie exactly on the surface. The iterations
/// in the loop exist to minimize this error.
CptValueType result(W[0], W[1],W[2]);
for (unsigned int i = 0; i < mCptIterations; ++i) {
const Vec3R location = mCptGrid->worldToIndex(Vec3R(result[0], result[1], result[2]));
BoxSampler::sample<CptAccessor>(mCptAccessor, location, result);
}
W[0] = result[0];
W[1] = result[1];
W[2] = result[2];
}
private:
const CptGridType* mCptGrid; // Closest-Point-Transform vector field
CptAccessor mCptAccessor;
unsigned int mCptIterations;
};// end of ClosestPointProjector class
////////////////////////////////////////
/// Performs passive or constrained advection of points in a velocity field
/// represented by an OpenVDB grid and an optional closest-point-transform (CPT)
/// represented in another OpenVDB grid. Note the CPT is assumed to be
/// in world coordinates and NOT index coordinates!
/// Supports both collocated velocity grids and staggered velocity grids
///
/// The @c PointListT template argument refers to any class with the following
/// interface (e.g., std::vector<openvdb::Vec3f>):
/// @code
/// class PointList {
/// ...
/// public:
/// using value_type = internal_vector3_type; // must support [] component access
/// openvdb::Index size() const; // number of points in list
/// value_type& operator[](int n); // world space position of nth point
/// };
/// @endcode
///
/// @note All methods (except size) are assumed to be thread-safe and
/// the positions are returned as non-const references since the
/// advection method needs to modify them!
template<typename GridT = Vec3fGrid,
typename PointListT = std::vector<typename GridT::ValueType>,
bool StaggeredVelocity = false,
typename InterrupterType = util::NullInterrupter>
class PointAdvect
{
public:
using GridType = GridT;
using PointListType = PointListT;
using LocationType = typename PointListT::value_type;
using VelocityFieldIntegrator = VelocityIntegrator<GridT, StaggeredVelocity>;
PointAdvect(const GridT& velGrid, InterrupterType* interrupter = nullptr):
mVelGrid(&velGrid),
mPoints(nullptr),
mIntegrationOrder(1),
mThreaded(true),
mInterrupter(interrupter)
{
}
PointAdvect(const PointAdvect &other) :
mVelGrid(other.mVelGrid),
mPoints(other.mPoints),
mDt(other.mDt),
mAdvIterations(other.mAdvIterations),
mIntegrationOrder(other.mIntegrationOrder),
mThreaded(other.mThreaded),
mInterrupter(other.mInterrupter)
{
}
virtual ~PointAdvect()
{
}
/// If the order of the integration is set to zero no advection is performed
bool earlyOut() const { return (mIntegrationOrder==0);}
/// get & set
void setThreaded(bool threaded) { mThreaded = threaded; }
bool getThreaded() { return mThreaded; }
void setIntegrationOrder(unsigned int order) {mIntegrationOrder = order;}
/// Constrained advection of a list of points over a time = dt * advIterations
void advect(PointListT& points, float dt, unsigned int advIterations = 1)
{
if (this->earlyOut()) return; // nothing to do!
mPoints = &points;
mDt = dt;
mAdvIterations = advIterations;
if (mInterrupter) mInterrupter->start("Advecting points by OpenVDB velocity field: ");
if (mThreaded) {
tbb::parallel_for(tbb::blocked_range<size_t>(0, mPoints->size()), *this);
} else {
(*this)(tbb::blocked_range<size_t>(0, mPoints->size()));
}
if (mInterrupter) mInterrupter->end();
}
/// Never call this method directly - it is use by TBB and has to be public!
void operator() (const tbb::blocked_range<size_t> &range) const
{
if (mInterrupter && mInterrupter->wasInterrupted()) {
thread::cancelGroupExecution();
}
VelocityFieldIntegrator velField(*mVelGrid);
switch (mIntegrationOrder) {
case 1:
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
// loop over number of time steps
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<1>(mDt, X0);
}
}
}
break;
case 2:
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
// loop over number of time steps
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<2>(mDt, X0);
}
}
}
break;
case 3:
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
// loop over number of time steps
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<3>(mDt, X0);
}
}
}
break;
case 4:
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
// loop over number of time steps
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<4>(mDt, X0);
}
}
}
break;
}
}
private:
// the velocity field
const GridType* mVelGrid;
// vertex list of all the points
PointListT* mPoints;
// time integration parameters
float mDt; // time step
unsigned int mAdvIterations; // number of time steps
unsigned int mIntegrationOrder;
// operational parameters
bool mThreaded;
InterrupterType* mInterrupter;
};//end of PointAdvect class
template<typename GridT = Vec3fGrid,
typename PointListT = std::vector<typename GridT::ValueType>,
bool StaggeredVelocity = false,
typename CptGridType = GridT,
typename InterrupterType = util::NullInterrupter>
class ConstrainedPointAdvect
{
public:
using GridType = GridT;
using LocationType = typename PointListT::value_type;
using VelocityIntegratorType = VelocityIntegrator<GridT, StaggeredVelocity>;
using ClosestPointProjectorType = ClosestPointProjector<CptGridType>;
using PointListType = PointListT;
ConstrainedPointAdvect(const GridType& velGrid,
const GridType& cptGrid, int cptn, InterrupterType* interrupter = nullptr):
mVelGrid(&velGrid),
mCptGrid(&cptGrid),
mCptIter(cptn),
mInterrupter(interrupter)
{
}
ConstrainedPointAdvect(const ConstrainedPointAdvect& other):
mVelGrid(other.mVelGrid),
mCptGrid(other.mCptGrid),
mCptIter(other.mCptIter),
mPoints(other.mPoints),
mDt(other.mDt),
mAdvIterations(other.mAdvIterations),
mIntegrationOrder(other.mIntegrationOrder),
mThreaded(other.mThreaded),
mInterrupter(other.mInterrupter)
{
}
virtual ~ConstrainedPointAdvect(){}
void setConstraintIterations(unsigned int cptIter) {mCptIter = cptIter;}
void setIntegrationOrder(unsigned int order) {mIntegrationOrder = order;}
void setThreaded(bool threaded) { mThreaded = threaded; }
bool getThreaded() { return mThreaded; }
/// Constrained Advection a list of points over a time = dt * advIterations
void advect(PointListT& points, float dt, unsigned int advIterations = 1)
{
mPoints = &points;
mDt = dt;
if (mIntegrationOrder==0 && mCptIter == 0) {
return; // nothing to do!
}
(mIntegrationOrder>0) ? mAdvIterations = advIterations : mAdvIterations = 1;
if (mInterrupter) mInterrupter->start("Advecting points by OpenVDB velocity field: ");
const size_t N = mPoints->size();
if (mThreaded) {
tbb::parallel_for(tbb::blocked_range<size_t>(0, N), *this);
} else {
(*this)(tbb::blocked_range<size_t>(0, N));
}
if (mInterrupter) mInterrupter->end();
}
/// Never call this method directly - it is use by TBB and has to be public!
void operator() (const tbb::blocked_range<size_t> &range) const
{
if (mInterrupter && mInterrupter->wasInterrupted()) {
thread::cancelGroupExecution();
}
VelocityIntegratorType velField(*mVelGrid);
ClosestPointProjectorType cptField(*mCptGrid, mCptIter);
switch (mIntegrationOrder) {
case 0://pure CPT projection
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
for (unsigned int i = 0; i < mAdvIterations; ++i) {
cptField.projectToConstraintSurface(X0);
}
}
}
break;
case 1://1'th order advection and CPT projection
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<1>(mDt, X0);
cptField.projectToConstraintSurface(X0);
}
}
}
break;
case 2://2'nd order advection and CPT projection
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<2>(mDt, X0);
cptField.projectToConstraintSurface(X0);
}
}
}
break;
case 3://3'rd order advection and CPT projection
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<3>(mDt, X0);
cptField.projectToConstraintSurface(X0);
}
}
}
break;
case 4://4'th order advection and CPT projection
{
for (size_t n = range.begin(); n != range.end(); ++n) {
LocationType& X0 = (*mPoints)[n];
for (unsigned int i = 0; i < mAdvIterations; ++i) {
velField.template rungeKutta<4>(mDt, X0);
cptField.projectToConstraintSurface(X0);
}
}
}
break;
}
}
private:
const GridType* mVelGrid; // the velocity field
const GridType* mCptGrid;
int mCptIter;
PointListT* mPoints; // vertex list of all the points
// time integration parameters
float mDt; // time step
unsigned int mAdvIterations; // number of time steps
unsigned int mIntegrationOrder; // order of Runge-Kutta integration
// operational parameters
bool mThreaded;
InterrupterType* mInterrupter;
};// end of ConstrainedPointAdvect class
} // namespace tools
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb
#endif // OPENVDB_TOOLS_POINT_ADVECT_HAS_BEEN_INCLUDED
Grid.h
Interpolation.h
Math.h
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
NullInterrupter.h
Types.h
VelocityFields.h
Defines two simple wrapper classes for advection velocity fields as well as VelocitySampler and Veloc...
openvdb::v11_0::tools::ClosestPointProjector
Definition PointAdvect.h:38
openvdb::v11_0::tools::ClosestPointProjector::ClosestPointProjector
ClosestPointProjector(const ClosestPointProjector &other)
Definition PointAdvect.h:54
openvdb::v11_0::tools::ClosestPointProjector::CptGridType
CptGridT CptGridType
Definition PointAdvect.h:40
openvdb::v11_0::tools::ClosestPointProjector::ClosestPointProjector
ClosestPointProjector()
Definition PointAdvect.h:44
openvdb::v11_0::tools::ClosestPointProjector::CptAccessor
typename CptGridType::ConstAccessor CptAccessor
Definition PointAdvect.h:41
openvdb::v11_0::tools::ClosestPointProjector::projectToConstraintSurface
void projectToConstraintSurface(LocationType &W) const
Definition PointAdvect.h:65
openvdb::v11_0::tools::ClosestPointProjector::numIterations
unsigned int numIterations()
Definition PointAdvect.h:61
openvdb::v11_0::tools::ClosestPointProjector::setConstraintIterations
void setConstraintIterations(unsigned int cptIterations)
Definition PointAdvect.h:60
openvdb::v11_0::tools::ClosestPointProjector::CptValueType
typename CptGridType::ValueType CptValueType
Definition PointAdvect.h:42
openvdb::v11_0::tools::ClosestPointProjector::ClosestPointProjector
ClosestPointProjector(const CptGridType &cptGrid, int n)
Definition PointAdvect.h:48
openvdb::v11_0::tools::ConstrainedPointAdvect::ConstrainedPointAdvect
ConstrainedPointAdvect(const ConstrainedPointAdvect &other)
Definition PointAdvect.h:265
openvdb::v11_0::tools::ConstrainedPointAdvect::ClosestPointProjectorType
ClosestPointProjector< CptGridType > ClosestPointProjectorType
Definition PointAdvect.h:254
openvdb::v11_0::tools::ConstrainedPointAdvect::setIntegrationOrder
void setIntegrationOrder(unsigned int order)
Definition PointAdvect.h:280
openvdb::v11_0::tools::ConstrainedPointAdvect::ConstrainedPointAdvect
ConstrainedPointAdvect(const GridType &velGrid, const GridType &cptGrid, int cptn, InterrupterType *interrupter=nullptr)
Definition PointAdvect.h:257
openvdb::v11_0::tools::ConstrainedPointAdvect::setThreaded
void setThreaded(bool threaded)
Definition PointAdvect.h:282
openvdb::v11_0::tools::ConstrainedPointAdvect::advect
void advect(PointListT &points, float dt, unsigned int advIterations=1)
Constrained Advection a list of points over a time = dt * advIterations.
Definition PointAdvect.h:286
openvdb::v11_0::tools::ConstrainedPointAdvect::VelocityIntegratorType
VelocityIntegrator< GridT, StaggeredVelocity > VelocityIntegratorType
Definition PointAdvect.h:253
openvdb::v11_0::tools::ConstrainedPointAdvect::LocationType
typename PointListT::value_type LocationType
Definition PointAdvect.h:252
openvdb::v11_0::tools::ConstrainedPointAdvect::getThreaded
bool getThreaded()
Definition PointAdvect.h:283
openvdb::v11_0::tools::ConstrainedPointAdvect::setConstraintIterations
void setConstraintIterations(unsigned int cptIter)
Definition PointAdvect.h:279
openvdb::v11_0::tools::ConstrainedPointAdvect::GridType
GridT GridType
Definition PointAdvect.h:251
openvdb::v11_0::tools::ConstrainedPointAdvect::PointListType
PointListT PointListType
Definition PointAdvect.h:255
openvdb::v11_0::tools::ConstrainedPointAdvect::~ConstrainedPointAdvect
virtual ~ConstrainedPointAdvect()
Definition PointAdvect.h:277
openvdb::v11_0::tools::PointAdvect::earlyOut
bool earlyOut() const
If the order of the integration is set to zero no advection is performed.
Definition PointAdvect.h:145
openvdb::v11_0::tools::PointAdvect::~PointAdvect
virtual ~PointAdvect()
Definition PointAdvect.h:141
openvdb::v11_0::tools::PointAdvect::VelocityFieldIntegrator
VelocityIntegrator< GridT, StaggeredVelocity > VelocityFieldIntegrator
Definition PointAdvect.h:121
openvdb::v11_0::tools::PointAdvect::setIntegrationOrder
void setIntegrationOrder(unsigned int order)
Definition PointAdvect.h:149
openvdb::v11_0::tools::PointAdvect::setThreaded
void setThreaded(bool threaded)
get & set
Definition PointAdvect.h:147
openvdb::v11_0::tools::PointAdvect::advect
void advect(PointListT &points, float dt, unsigned int advIterations=1)
Constrained advection of a list of points over a time = dt * advIterations.
Definition PointAdvect.h:152
openvdb::v11_0::tools::PointAdvect::LocationType
typename PointListT::value_type LocationType
Definition PointAdvect.h:120
openvdb::v11_0::tools::PointAdvect::getThreaded
bool getThreaded()
Definition PointAdvect.h:148
openvdb::v11_0::tools::PointAdvect::PointAdvect
PointAdvect(const GridT &velGrid, InterrupterType *interrupter=nullptr)
Definition PointAdvect.h:123
openvdb::v11_0::tools::PointAdvect::GridType
GridT GridType
Definition PointAdvect.h:118
openvdb::v11_0::tools::PointAdvect::PointAdvect
PointAdvect(const PointAdvect &other)
Definition PointAdvect.h:131
openvdb::v11_0::tools::PointAdvect::PointListType
PointListT PointListType
Definition PointAdvect.h:119
openvdb::v11_0::tools::VelocityIntegrator
Performs Runge-Kutta time integration of variable order in a static velocity field.
Definition VelocityFields.h:216
openvdb::v11_0::points
Definition AttributeArray.h:41
openvdb::v11_0::Vec3fGrid
Vec3SGrid Vec3fGrid
Definition openvdb.h:85
openvdb::v11_0::Vec3R
math::Vec3< Real > Vec3R
Definition Types.h:72
openvdb
Definition Exceptions.h:13
openvdb.h
openvdb::v11_0::tools::BoxSampler::sample
static bool sample(const TreeT &inTree, const Vec3R &inCoord, typename TreeT::ValueType &result)
Trilinearly reconstruct inTree at inCoord and store the result in result.
Definition Interpolation.h:743
openvdb::v11_0::util::NullInterrupter
Base class for interrupters.
Definition NullInterrupter.h:26
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition version.h.in:121
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition version.h.in:212