10#ifndef OPENVDB_TOOLS_LEVEL_SET_ADVECT_HAS_BEEN_INCLUDED
11#define OPENVDB_TOOLS_LEVEL_SET_ADVECT_HAS_BEEN_INCLUDED
13#include <tbb/parallel_for.h>
14#include <tbb/parallel_reduce.h>
70template<
typename GridT,
71 typename FieldT = EnrightField<typename GridT::ValueType>,
72 typename InterruptT = util::NullInterrupter>
86 mTracker(grid, interrupt), mField(field),
87 mSpatialScheme(math::HJWENO5_BIAS),
88 mTemporalScheme(math::TVD_RK2) {}
104 return mTracker.getSpatialScheme();
108 mTracker.setSpatialScheme(scheme);
112 return mTracker.getTemporalScheme();
116 mTracker.setTemporalScheme(scheme);
136 size_t advect(ValueType time0, ValueType time1);
151 Advect(
const Advect& other);
153 virtual ~Advect() {
if (mIsMaster) this->clearField(); }
156 size_t advect(ValueType time0, ValueType time1);
158 void operator()(
const LeafRange& r)
const
160 if (mTask) mTask(
const_cast<Advect*
>(
this), r);
164 void cook(
const char* msg,
size_t swapBuffer = 0);
166 typename GridT::ValueType sampleField(ValueType time0, ValueType time1);
167 template <
bool Aligned>
void sample(
const LeafRange& r, ValueType t0, ValueType t1);
168 inline void sampleXformed(
const LeafRange& r, ValueType t0, ValueType t1)
170 this->sample<false>(r, t0, t1);
172 inline void sampleAligned(
const LeafRange& r, ValueType t0, ValueType t1)
174 this->sample<true>(r, t0, t1);
179 template <
int Nominator,
int Denominator>
180 void euler(
const LeafRange&, ValueType, Index, Index);
181 inline void euler01(
const LeafRange& r, ValueType t) {this->euler<0,1>(r, t, 0, 1);}
182 inline void euler12(
const LeafRange& r, ValueType t) {this->euler<1,2>(r, t, 1, 1);}
183 inline void euler34(
const LeafRange& r, ValueType t) {this->euler<3,4>(r, t, 1, 2);}
184 inline void euler13(
const LeafRange& r, ValueType t) {this->euler<1,3>(r, t, 1, 2);}
186 LevelSetAdvection& mParent;
187 VectorType* mVelocity;
190 typename std::function<void (Advect*,
const LeafRange&)> mTask;
191 const bool mIsMaster;
194 template<math::BiasedGradientScheme SpatialScheme>
195 size_t advect1(ValueType time0, ValueType time1);
197 template<math::BiasedGradientScheme SpatialScheme,
198 math::TemporalIntegrationScheme TemporalScheme>
199 size_t advect2(ValueType time0, ValueType time1);
201 template<math::BiasedGradientScheme SpatialScheme,
202 math::TemporalIntegrationScheme TemporalScheme,
204 size_t advect3(ValueType time0, ValueType time1);
209 math::BiasedGradientScheme mSpatialScheme;
210 math::TemporalIntegrationScheme mTemporalScheme;
215template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
219 switch (mSpatialScheme) {
220 case math::FIRST_BIAS:
221 return this->advect1<math::FIRST_BIAS >(time0, time1);
222 case math::SECOND_BIAS:
223 return this->advect1<math::SECOND_BIAS >(time0, time1);
224 case math::THIRD_BIAS:
225 return this->advect1<math::THIRD_BIAS >(time0, time1);
226 case math::WENO5_BIAS:
227 return this->advect1<math::WENO5_BIAS >(time0, time1);
228 case math::HJWENO5_BIAS:
229 return this->advect1<math::HJWENO5_BIAS>(time0, time1);
237template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
238template<math::BiasedGradientScheme SpatialScheme>
242 switch (mTemporalScheme) {
244 return this->advect2<SpatialScheme, math::TVD_RK1>(time0, time1);
246 return this->advect2<SpatialScheme, math::TVD_RK2>(time0, time1);
248 return this->advect2<SpatialScheme, math::TVD_RK3>(time0, time1);
256template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
257template<math::BiasedGradientScheme SpatialScheme, math::TemporalIntegrationScheme TemporalScheme>
259LevelSetAdvection<GridT, FieldT, InterruptT>::advect2(ValueType time0, ValueType time1)
262 if (trans.
mapType() == math::UniformScaleMap::mapType()) {
263 return this->advect3<SpatialScheme, TemporalScheme, math::UniformScaleMap>(time0, time1);
264 }
else if (trans.
mapType() == math::UniformScaleTranslateMap::mapType()) {
265 return this->advect3<SpatialScheme, TemporalScheme, math::UniformScaleTranslateMap>(
267 }
else if (trans.
mapType() == math::UnitaryMap::mapType()) {
268 return this->advect3<SpatialScheme, TemporalScheme, math::UnitaryMap >(time0, time1);
269 }
else if (trans.
mapType() == math::TranslationMap::mapType()) {
270 return this->advect3<SpatialScheme, TemporalScheme, math::TranslationMap>(time0, time1);
278template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
280 math::BiasedGradientScheme SpatialScheme,
281 math::TemporalIntegrationScheme TemporalScheme,
284LevelSetAdvection<GridT, FieldT, InterruptT>::advect3(ValueType time0, ValueType time1)
286 Advect<MapT, SpatialScheme, TemporalScheme> tmp(*
this);
287 return tmp.advect(time0, time1);
294template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
297 math::BiasedGradientScheme SpatialScheme,
298 math::TemporalIntegrationScheme TemporalScheme>
300LevelSetAdvection<GridT, FieldT, InterruptT>::
301Advect<MapT, SpatialScheme, TemporalScheme>::
302Advect(LevelSetAdvection& parent)
306 , mMap(parent.mTracker.grid().transform().template constMap<MapT>().get())
313template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
319LevelSetAdvection<GridT, FieldT, InterruptT>::
320Advect<MapT, SpatialScheme, TemporalScheme>::
321Advect(
const Advect& other)
322 : mParent(other.mParent)
323 , mVelocity(other.mVelocity)
324 , mOffsets(other.mOffsets)
332template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
340advect(ValueType time0, ValueType time1)
342 namespace ph = std::placeholders;
347 const bool isForward = time0 < time1;
348 while ((isForward ? time0<time1 : time0>time1) && mParent.mTracker.checkInterrupter()) {
351 mParent.mTracker.leafs().rebuildAuxBuffers(TemporalScheme ==
math::TVD_RK3 ? 2 : 1);
354 const ValueType dt = this->sampleField(time0, time1);
358 switch(TemporalScheme) {
362 mTask = std::bind(&Advect::euler01, ph::_1, ph::_2, dt);
365 this->cook(
"Advecting level set using TVD_RK1", 1);
370 mTask = std::bind(&Advect::euler01, ph::_1, ph::_2, dt);
373 this->cook(
"Advecting level set using TVD_RK1 (step 1 of 2)", 1);
377 mTask = std::bind(&Advect::euler12, ph::_1, ph::_2, dt);
380 this->cook(
"Advecting level set using TVD_RK1 (step 2 of 2)", 1);
385 mTask = std::bind(&Advect::euler01, ph::_1, ph::_2, dt);
388 this->cook(
"Advecting level set using TVD_RK3 (step 1 of 3)", 1);
392 mTask = std::bind(&Advect::euler34, ph::_1, ph::_2, dt);
395 this->cook(
"Advecting level set using TVD_RK3 (step 2 of 3)", 2);
399 mTask = std::bind(&Advect::euler13, ph::_1, ph::_2, dt);
402 this->cook(
"Advecting level set using TVD_RK3 (step 3 of 3)", 2);
405 OPENVDB_THROW(ValueError,
"Temporal integration scheme not supported!");
409 time0 += isForward ? dt : -dt;
411 mParent.mTracker.leafs().removeAuxBuffers();
414 mParent.mTracker.track();
420template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
425inline typename GridT::ValueType
426LevelSetAdvection<GridT, FieldT, InterruptT>::
427Advect<MapT, SpatialScheme, TemporalScheme>::
428sampleField(ValueType time0, ValueType time1)
430 namespace ph = std::placeholders;
432 const int grainSize = mParent.mTracker.getGrainSize();
433 const size_t leafCount = mParent.mTracker.leafs().leafCount();
434 if (leafCount==0)
return ValueType(0.0);
437 size_t size=0, voxelCount=mParent.mTracker.leafs().getPrefixSum(mOffsets, size, grainSize);
440 if (mParent.mField.transform() == mParent.mTracker.grid().transform()) {
441 mTask = std::bind(&Advect::sampleAligned, ph::_1, ph::_2, time0, time1);
443 mTask = std::bind(&Advect::sampleXformed, ph::_1, ph::_2, time0, time1);
445 assert(voxelCount == mParent.mTracker.grid().activeVoxelCount());
446 mVelocity =
new VectorType[ voxelCount ];
447 this->cook(
"Sampling advection field");
450 ValueType maxAbsV = 0;
451 VectorType* v = mVelocity;
452 for (
size_t i = 0; i < voxelCount; ++i, ++v) {
453 maxAbsV =
math::Max(maxAbsV, ValueType(v->lengthSqr()));
458 static const ValueType CFL = (TemporalScheme ==
math::TVD_RK1 ? ValueType(0.3) :
459 TemporalScheme == math::
TVD_RK2 ? ValueType(0.9) :
460 ValueType(1.0))/math::
Sqrt(ValueType(3.0));
461 const ValueType dt =
math::Abs(time1 - time0), dx = mParent.mTracker.voxelSize();
466template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
471template<
bool Aligned>
473LevelSetAdvection<GridT, FieldT, InterruptT>::
474Advect<MapT, SpatialScheme, TemporalScheme>::
475sample(
const LeafRange& range, ValueType time0, ValueType time1)
477 const bool isForward = time0 < time1;
478 using VoxelIterT =
typename LeafType::ValueOnCIter;
479 const MapT& map = *mMap;
480 const FieldT field( mParent.mField );
481 mParent.mTracker.checkInterrupter();
482 for (
typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
483 VectorType* vel = mVelocity + mOffsets[ leafIter.pos() ];
484 for (VoxelIterT iter = leafIter->cbeginValueOn(); iter; ++iter, ++vel) {
486 const VectorType v = Aligned ? field(iter.getCoord(), time0) :
487 field(map.applyMap(iter.getCoord().asVec3d()), time0);
488 *vel = isForward ? v : -v;
495template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
501LevelSetAdvection<GridT, FieldT, InterruptT>::
502Advect<MapT, SpatialScheme, TemporalScheme>::
512template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
518LevelSetAdvection<GridT, FieldT, InterruptT>::
519Advect<MapT, SpatialScheme, TemporalScheme>::
520cook(
const char* msg,
size_t swapBuffer)
522 mParent.mTracker.startInterrupter( msg );
524 const int grainSize = mParent.mTracker.getGrainSize();
525 const LeafRange range = mParent.mTracker.leafs().leafRange(grainSize);
527 grainSize == 0 ? (*this)(range) : tbb::parallel_for(range, *this);
529 mParent.mTracker.leafs().swapLeafBuffer(swapBuffer, grainSize == 0);
531 mParent.mTracker.endInterrupter();
537template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
542template <
int Nominator,
int Denominator>
544LevelSetAdvection<GridT, FieldT, InterruptT>::
545Advect<MapT, SpatialScheme, TemporalScheme>::
546euler(
const LeafRange& range, ValueType dt,
Index phiBuffer,
Index resultBuffer)
548 using SchemeT = math::BIAS_SCHEME<SpatialScheme>;
549 using StencilT =
typename SchemeT::template ISStencil<GridType>::StencilType;
550 using VoxelIterT =
typename LeafType::ValueOnCIter;
551 using GradT = math::GradientBiased<MapT, SpatialScheme>;
553 static const ValueType Alpha = ValueType(Nominator)/ValueType(Denominator);
554 static const ValueType Beta = ValueType(1) - Alpha;
556 mParent.mTracker.checkInterrupter();
557 const MapT& map = *mMap;
558 StencilT stencil(mParent.mTracker.grid());
559 for (
typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
560 const VectorType* vel = mVelocity + mOffsets[ leafIter.pos() ];
561 const ValueType* phi = leafIter.buffer(phiBuffer).data();
562 ValueType* result = leafIter.buffer(resultBuffer).data();
563 for (VoxelIterT voxelIter = leafIter->cbeginValueOn(); voxelIter; ++voxelIter, ++vel) {
564 const Index i = voxelIter.pos();
565 stencil.moveTo(voxelIter);
567 stencil.getValue() - dt * vel->dot(GradT::result(map, stencil, *vel));
568 result[i] = Nominator ? Alpha * phi[i] + Beta * a : a;
579#ifdef OPENVDB_USE_EXPLICIT_INSTANTIATION
581#ifdef OPENVDB_INSTANTIATE_LEVELSETADVECT
Performs multi-threaded interface tracking of narrow band level sets. This is the building-block for ...
Defines two simple wrapper classes for advection velocity fields as well as VelocitySampler and Veloc...
Definition Exceptions.h:65
TemporalIntegrationScheme
Temporal integration schemes.
Definition FiniteDifference.h:234
@ TVD_RK1
Definition FiniteDifference.h:236
@ TVD_RK2
Definition FiniteDifference.h:237
@ TVD_RK3
Definition FiniteDifference.h:238
bool isApproxZero(const Type &x)
Return true if x is equal to zero to within the default floating-point comparison tolerance.
Definition Math.h:349
float Sqrt(float x)
Return the square root of a floating-point value.
Definition Math.h:761
const Type & Max(const Type &a, const Type &b)
Return the maximum of two values.
Definition Math.h:595
BiasedGradientScheme
Biased Gradients are limited to non-centered differences.
Definition FiniteDifference.h:165
const Type & Min(const Type &a, const Type &b)
Return the minimum of two values.
Definition Math.h:656
Coord Abs(const Coord &xyz)
Definition Coord.h:515
bool isZero(const Type &x)
Return true if x is exactly equal to zero.
Definition Math.h:337
Index32 Index
Definition Types.h:54
Definition Exceptions.h:13
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
static T value()
Definition Math.h:155
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition version.h.in:121
#define OPENVDB_USE_VERSION_NAMESPACE
Definition version.h.in:212
#define OPENVDB_INSTANTIATE_CLASS
Definition version.h.in:153