39 #ifndef OPENVDB_TOOLS_LEVEL_SET_ADVECT_HAS_BEEN_INCLUDED
40 #define OPENVDB_TOOLS_LEVEL_SET_ADVECT_HAS_BEEN_INCLUDED
42 #include <tbb/parallel_for.h>
43 #include <tbb/parallel_reduce.h>
44 #include <openvdb/Platform.h>
47 #include <openvdb/math/FiniteDifference.h>
48 #include <boost/math/constants/constants.hpp>
95 template<
typename GridT,
96 typename FieldT = EnrightField<typename GridT::ValueType>,
97 typename InterruptT = util::NullInterrupter>
111 mTracker(grid, interrupt), mField(field),
113 mTemporalScheme(math::
TVD_RK2) {}
154 size_t advect(ValueType time0, ValueType time1);
170 Advect(
const Advect& other);
172 Advect(Advect& other, tbb::split);
174 virtual ~Advect() {
if (mIsMaster) this->clearField(); }
177 size_t advect(ValueType time0, ValueType time1);
179 void operator()(
const LeafRange& r)
const
181 if (mTask) mTask(const_cast<Advect*>(
this), r);
185 void operator()(
const LeafRange& r)
187 if (mTask) mTask(
this, r);
191 void join(
const Advect& other) { mMaxAbsV =
math::Max(mMaxAbsV, other.mMaxAbsV); }
193 enum ThreadingMode { PARALLEL_FOR, PARALLEL_REDUCE };
195 void cook(ThreadingMode mode,
size_t swapBuffer = 0);
197 typename GridT::ValueType sampleField(ValueType time0, ValueType time1);
199 void sampleXformedField(
const LeafRange& r, ValueType time0, ValueType time1);
200 void sampleAlignedField(
const LeafRange& r, ValueType time0, ValueType time1);
204 template <
int Nominator,
int Denominator>
205 void euler(
const LeafRange&, ValueType,
Index,
Index);
206 inline void euler01(
const LeafRange& r, ValueType t) {this->euler<0,1>(r, t, 0, 1);}
207 inline void euler12(
const LeafRange& r, ValueType t) {this->euler<1,2>(r, t, 1, 1);}
208 inline void euler34(
const LeafRange& r, ValueType t) {this->euler<3,4>(r, t, 1, 2);}
209 inline void euler13(
const LeafRange& r, ValueType t) {this->euler<1,3>(r, t, 1, 2);}
211 LevelSetAdvection& mParent;
213 const ValueType mMinAbsV;
216 typename boost::function<void (Advect*, const LeafRange&)> mTask;
217 const bool mIsMaster;
220 template<math::BiasedGradientScheme SpatialScheme>
221 size_t advect1(ValueType time0, ValueType time1);
225 size_t advect2(ValueType time0, ValueType time1);
230 size_t advect3(ValueType time0, ValueType time1);
240 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
244 switch (mSpatialScheme) {
246 return this->advect1<math::FIRST_BIAS >(time0, time1);
248 return this->advect1<math::SECOND_BIAS >(time0, time1);
250 return this->advect1<math::THIRD_BIAS >(time0, time1);
252 return this->advect1<math::WENO5_BIAS >(time0, time1);
254 return this->advect1<math::HJWENO5_BIAS>(time0, time1);
261 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
262 template<math::BiasedGradientScheme SpatialScheme>
266 switch (mTemporalScheme) {
268 return this->advect2<SpatialScheme, math::TVD_RK1>(time0, time1);
270 return this->advect2<SpatialScheme, math::TVD_RK2>(time0, time1);
272 return this->advect2<SpatialScheme, math::TVD_RK3>(time0, time1);
279 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
283 LevelSetAdvection<GridT, FieldT, InterruptT>::advect2(ValueType time0, ValueType time1)
286 if (trans.
mapType() == math::UniformScaleMap::mapType()) {
287 return this->advect3<SpatialScheme, TemporalScheme, math::UniformScaleMap>(time0, time1);
288 }
else if (trans.
mapType() == math::UniformScaleTranslateMap::mapType()) {
289 return this->advect3<SpatialScheme, TemporalScheme, math::UniformScaleTranslateMap>(time0, time1);
290 }
else if (trans.
mapType() == math::UnitaryMap::mapType()) {
291 return this->advect3<SpatialScheme, TemporalScheme, math::UnitaryMap >(time0, time1);
292 }
else if (trans.
mapType() == math::TranslationMap::mapType()) {
293 return this->advect3<SpatialScheme, TemporalScheme, math::TranslationMap>(time0, time1);
300 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
305 LevelSetAdvection<GridT, FieldT, InterruptT>::advect3(ValueType time0, ValueType time1)
307 Advect<MapT, SpatialScheme, TemporalScheme> tmp(*
this);
308 return tmp.advect(time0, time1);
315 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
319 LevelSetAdvection<GridT, FieldT, InterruptT>::
320 Advect<MapT, SpatialScheme, TemporalScheme>::
321 Advect(LevelSetAdvection& parent):
324 mMinAbsV(ValueType(1e-6)),
325 mMap(parent.mTracker.grid().transform().template constMap<MapT>().get()),
331 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
335 LevelSetAdvection<GridT, FieldT, InterruptT>::
336 Advect<MapT, SpatialScheme, TemporalScheme>::
337 Advect(
const Advect& other):
338 mParent(other.mParent),
340 mMinAbsV(other.mMinAbsV),
341 mMaxAbsV(other.mMaxAbsV),
348 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
352 LevelSetAdvection<GridT, FieldT, InterruptT>::
353 Advect<MapT, SpatialScheme, TemporalScheme>::
354 Advect(Advect& other, tbb::split):
355 mParent(other.mParent),
357 mMinAbsV(other.mMinAbsV),
358 mMaxAbsV(other.mMaxAbsV),
365 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
371 advect(ValueType time0, ValueType time1)
375 const bool isForward = time0 < time1;
376 while ((isForward ? time0<time1 : time0>time1) && mParent.mTracker.checkInterrupter()) {
378 mParent.mTracker.leafs().rebuildAuxBuffers(TemporalScheme ==
math::TVD_RK3 ? 2 : 1);
380 const ValueType dt = this->sampleField(time0, time1);
384 switch(TemporalScheme) {
388 mTask = boost::bind(&Advect::euler01, _1, _2, dt);
391 this->cook(PARALLEL_FOR, 1);
396 mTask = boost::bind(&Advect::euler01, _1, _2, dt);
399 this->cook(PARALLEL_FOR, 1);
403 mTask = boost::bind(&Advect::euler12, _1, _2, dt);
406 this->cook(PARALLEL_FOR, 1);
411 mTask = boost::bind(&Advect::euler01, _1, _2, dt);
414 this->cook(PARALLEL_FOR, 1);
418 mTask = boost::bind(&Advect::euler34, _1, _2, dt);
421 this->cook(PARALLEL_FOR, 2);
425 mTask = boost::bind(&Advect::euler13, _1, _2, dt);
428 this->cook(PARALLEL_FOR, 2);
431 OPENVDB_THROW(ValueError,
"Temporal integration scheme not supported!");
435 time0 += isForward ? dt : -dt;
437 mParent.mTracker.leafs().removeAuxBuffers();
440 mParent.mTracker.track();
445 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
448 inline typename GridT::ValueType
449 LevelSetAdvection<GridT, FieldT, InterruptT>::
450 Advect<MapT, SpatialScheme, TemporalScheme>::
451 sampleField(ValueType time0, ValueType time1)
454 const size_t leafCount = mParent.mTracker.leafs().leafCount();
455 if (leafCount==0)
return ValueType(0.0);
456 mVec =
new VectorType*[leafCount];
457 if (mParent.mField.transform() == mParent.mTracker.grid().transform()) {
458 mTask = boost::bind(&Advect::sampleAlignedField, _1, _2, time0, time1);
460 mTask = boost::bind(&Advect::sampleXformedField, _1, _2, time0, time1);
462 this->cook(PARALLEL_REDUCE);
464 #ifndef _MSC_VER // Visual C++ doesn't guarantee thread-safe initialization of local statics
467 const ValueType CFL = (TemporalScheme ==
math::TVD_RK1 ? ValueType(0.3) :
468 TemporalScheme == math::
TVD_RK2 ? ValueType(0.9) :
469 ValueType(1.0))/math::
Sqrt(ValueType(3.0));
470 const ValueType dt =
math::Abs(time1 - time0), dx = mParent.mTracker.voxelSize();
474 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
478 LevelSetAdvection<GridT, FieldT, InterruptT>::
479 Advect<MapT, SpatialScheme, TemporalScheme>::
480 sampleXformedField(
const LeafRange& range, ValueType time0, ValueType time1)
482 const bool isForward = time0 < time1;
483 typedef typename LeafType::ValueOnCIter VoxelIterT;
484 const MapT& map = *mMap;
485 mParent.mTracker.checkInterrupter();
486 for (
typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
487 VectorType* vec =
new VectorType[leafIter->onVoxelCount()];
488 mVec[leafIter.pos()] = vec;
489 for (VoxelIterT iter = leafIter->cbeginValueOn(); iter; ++iter, ++vec) {
490 const VectorType v = mParent.mField(map.applyMap(iter.getCoord().asVec3d()), time0);
492 *vec = isForward ? v : -v;
497 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
501 LevelSetAdvection<GridT, FieldT, InterruptT>::
502 Advect<MapT, SpatialScheme, TemporalScheme>::
503 sampleAlignedField(
const LeafRange& range, ValueType time0, ValueType time1)
505 const bool isForward = time0 < time1;
506 typedef typename LeafType::ValueOnCIter VoxelIterT;
507 mParent.mTracker.checkInterrupter();
508 for (
typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
509 VectorType* vec =
new VectorType[leafIter->onVoxelCount()];
510 mVec[leafIter.pos()] = vec;
511 for (VoxelIterT iter = leafIter->cbeginValueOn(); iter; ++iter, ++vec) {
512 const VectorType v = mParent.mField(iter.getCoord(), time0);
514 *vec = isForward ? v : -v;
519 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
523 LevelSetAdvection<GridT, FieldT, InterruptT>::
524 Advect<MapT, SpatialScheme, TemporalScheme>::
527 if (mVec == NULL)
return;
528 for (
size_t n=0, e=mParent.mTracker.leafs().leafCount(); n<e; ++n)
delete [] mVec[n];
533 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
537 LevelSetAdvection<GridT, FieldT, InterruptT>::
538 Advect<MapT, SpatialScheme, TemporalScheme>::
539 cook(ThreadingMode mode,
size_t swapBuffer)
541 mParent.mTracker.startInterrupter(
"Advecting level set");
543 const int grainSize = mParent.mTracker.getGrainSize();
544 const LeafRange range = mParent.mTracker.leafs().leafRange(grainSize);
546 if (grainSize == 0) {
548 }
else if (mode == PARALLEL_FOR) {
549 tbb::parallel_for(range, *
this);
550 }
else if (mode == PARALLEL_REDUCE) {
551 tbb::parallel_reduce(range, *
this);
556 mParent.mTracker.leafs().swapLeafBuffer(swapBuffer, grainSize == 0);
558 mParent.mTracker.endInterrupter();
563 template<
typename Gr
idT,
typename FieldT,
typename InterruptT>
566 template <
int Nominator,
int Denominator>
568 LevelSetAdvection<GridT, FieldT, InterruptT>::
569 Advect<MapT, SpatialScheme, TemporalScheme>::
570 euler(
const LeafRange& range, ValueType dt,
Index phiBuffer,
Index resultBuffer)
572 typedef math::BIAS_SCHEME<SpatialScheme> SchemeT;
573 typedef typename SchemeT::template ISStencil<GridType>::StencilType StencilT;
574 typedef typename LeafType::ValueOnCIter VoxelIterT;
575 typedef math::GradientBiased<MapT, SpatialScheme> GradT;
577 static const ValueType Alpha = ValueType(Nominator)/ValueType(Denominator);
578 static const ValueType Beta = ValueType(1) - Alpha;
580 mParent.mTracker.checkInterrupter();
581 const MapT& map = *mMap;
582 StencilT stencil(mParent.mTracker.grid());
583 for (
typename LeafRange::Iterator leafIter = range.begin(); leafIter; ++leafIter) {
584 const VectorType* v = mVec[leafIter.pos()];
585 const ValueType* phi = leafIter.buffer(phiBuffer).data();
586 ValueType* result = leafIter.buffer(resultBuffer).data();
587 for (VoxelIterT voxelIter = leafIter->cbeginValueOn(); voxelIter; ++voxelIter, ++v) {
588 const Index i = voxelIter.pos();
589 stencil.moveTo(voxelIter);
590 const ValueType a = stencil.getValue() - dt * v->dot(GradT::result(map, stencil,*v));
591 result[i] = Nominator ? Alpha * phi[i] + Beta * a : a;
600 #endif // OPENVDB_TOOLS_LEVEL_SET_ADVECT_HAS_BEEN_INCLUDED
Index32 Index
Definition: Types.h:58
Definition: FiniteDifference.h:198
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...
int32_t Abs(int32_t i)
Return the absolute value of the given quantity.
Definition: Math.h:293
Definition: FiniteDifference.h:263
Definition: Exceptions.h:88
bool isExactlyEqual(const T0 &a, const T1 &b)
Return true if a is exactly equal to b.
Definition: Math.h:407
#define OPENVDB_THROW(exception, message)
Definition: Exceptions.h:97
Definition: FiniteDifference.h:197
Definition: FiniteDifference.h:195
#define OPENVDB_VERSION_NAME
Definition: version.h:43
bool isZero(const Type &x)
Return true if x is exactly equal to zero.
Definition: Math.h:324
Definition: FiniteDifference.h:196
Definition: Exceptions.h:39
const Type & Max(const Type &a, const Type &b)
Return the maximum of two values.
Definition: Math.h:561
Type Pow2(Type x)
Return .
Definition: Math.h:514
Definition: FiniteDifference.h:194
BiasedGradientScheme
Biased Gradients are limited to non-centered differences.
Definition: FiniteDifference.h:192
Definition: FiniteDifference.h:265
Definition: FiniteDifference.h:264
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h:71
float Sqrt(float x)
Return the square root of a floating-point value.
Definition: Math.h:709
const Type & Min(const Type &a, const Type &b)
Return the minimum of two values.
Definition: Math.h:622
TemporalIntegrationScheme
Temporal integration schemes.
Definition: FiniteDifference.h:261
Definition: LeafManager.h:131