CubbyFlow::FMMLevelSetSolver3 Class Referencefinal

Three-dimensional fast marching method (FMM) implementation. More...

#include <Core/Solver/LevelSet/FMMLevelSetSolver3.hpp>

Inheritance diagram for CubbyFlow::FMMLevelSetSolver3:
CubbyFlow::LevelSetSolver3

Public Member Functions

 FMMLevelSetSolver3 ()=default
 Default constructor. More...
 
void Reinitialize (const ScalarGrid3 &inputSDF, double maxDistance, ScalarGrid3 *outputSDF) override
 
void Extrapolate (const ScalarGrid3 &input, const ScalarField3 &sdf, double maxDistance, ScalarGrid3 *output) override
 
void Extrapolate (const CollocatedVectorGrid3 &input, const ScalarField3 &sdf, double maxDistance, CollocatedVectorGrid3 *output) override
 
void Extrapolate (const FaceCenteredGrid3 &input, const ScalarField3 &sdf, double maxDistance, FaceCenteredGrid3 *output) override
 
- Public Member Functions inherited from CubbyFlow::LevelSetSolver3
 LevelSetSolver3 ()=default
 Default constructor. More...
 
 LevelSetSolver3 (const LevelSetSolver3 &)=delete
 Deleted copy constructor. More...
 
 LevelSetSolver3 (LevelSetSolver3 &&) noexcept=delete
 Deleted move constructor. More...
 
virtual ~LevelSetSolver3 ()=default
 Default virtual destructor. More...
 
LevelSetSolver3operator= (const LevelSetSolver3 &)=delete
 Deleted copy assignment operator. More...
 
LevelSetSolver3operator= (LevelSetSolver3 &&) noexcept=delete
 Deleted move assignment operator. More...
 

Detailed Description

Three-dimensional fast marching method (FMM) implementation.

This class implements 3-D FMM. First-order upwind-style differencing is used to solve the PDE.

See also
https://math.berkeley.edu/~sethian/2006/Explanations/fast_marching_explain.html
Sethian, James A. "A fast marching level set method for monotonically advancing fronts." Proceedings of the National Academy of Sciences 93.4 (1996): 1591-1595.

Constructor & Destructor Documentation

◆ FMMLevelSetSolver3()

CubbyFlow::FMMLevelSetSolver3::FMMLevelSetSolver3 ( )
default

Default constructor.

Member Function Documentation

◆ Extrapolate() [1/3]

void CubbyFlow::FMMLevelSetSolver3::Extrapolate ( const ScalarGrid3 input,
const ScalarField3 sdf,
double  maxDistance,
ScalarGrid3 output 
)
overridevirtual

Extrapolates given scalar field from negative to positive SDF region.

Parameters
inputInput scalar field to be extrapolated.
sdfReference signed-distance field.
maxDistanceMax range of extrapolation.
outputOutput scalar field.

Implements CubbyFlow::LevelSetSolver3.

◆ Extrapolate() [2/3]

void CubbyFlow::FMMLevelSetSolver3::Extrapolate ( const CollocatedVectorGrid3 input,
const ScalarField3 sdf,
double  maxDistance,
CollocatedVectorGrid3 output 
)
overridevirtual

Extrapolates given collocated vector field from negative to positive SDF region.

Parameters
inputInput collocated vector field to be extrapolated.
sdfReference signed-distance field.
maxDistanceMax range of extrapolation.
outputOutput collocated vector field.

Implements CubbyFlow::LevelSetSolver3.

◆ Extrapolate() [3/3]

void CubbyFlow::FMMLevelSetSolver3::Extrapolate ( const FaceCenteredGrid3 input,
const ScalarField3 sdf,
double  maxDistance,
FaceCenteredGrid3 output 
)
overridevirtual

Extrapolates given face-centered vector field from negative to positive SDF region.

Parameters
inputInput face-centered field to be extrapolated.
sdfReference signed-distance field.
maxDistanceMax range of extrapolation.
outputOutput face-centered vector field.

Implements CubbyFlow::LevelSetSolver3.

◆ Reinitialize()

void CubbyFlow::FMMLevelSetSolver3::Reinitialize ( const ScalarGrid3 inputSDF,
double  maxDistance,
ScalarGrid3 outputSDF 
)
overridevirtual

Reinitializes given scalar field to signed-distance field.

Parameters
inputSDFInput signed-distance field which can be distorted.
maxDistanceMax range of reinitialization.
outputSDFOutput signed-distance field.

Implements CubbyFlow::LevelSetSolver3.


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