Abstract base class for 3-D PDE-based iterative level set solver. More...

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

Inheritance diagram for CubbyFlow::IterativeLevelSetSolver3:

Public Member Functions
	IterativeLevelSetSolver3 ()=default
	Default constructor. More...

	IterativeLevelSetSolver3 (const IterativeLevelSetSolver3 &)=delete
	Deleted copy constructor. More...

	IterativeLevelSetSolver3 (IterativeLevelSetSolver3 &&) noexcept=delete
	Deleted move constructor. More...

	~IterativeLevelSetSolver3 () override=default
	Default virtual destructor. More...

IterativeLevelSetSolver3 &	operator= (const IterativeLevelSetSolver3 &)=delete
	Deleted copy assignment operator. More...

IterativeLevelSetSolver3 &	operator= (IterativeLevelSetSolver3 &&) noexcept=delete
	Deleted move assignment operator. 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

double	GetMaxCFL () const
	Returns the maximum CFL limit. More...

void	SetMaxCFL (double newMaxCFL)
	Sets the maximum CFL limit. More...

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...

LevelSetSolver3 &	operator= (const LevelSetSolver3 &)=delete
	Deleted copy assignment operator. More...

LevelSetSolver3 &	operator= (LevelSetSolver3 &&) noexcept=delete
	Deleted move assignment operator. More...

Protected Member Functions
virtual void	GetDerivatives (ConstArrayView3< double > grid, const Vector3D &gridSpacing, size_t i, size_t j, size_t k, std::array< double, 2 > dx, std::array< double, 2 > dy, std::array< double, 2 > *dz) const =0
	Computes the derivatives for given grid point. More...

Detailed Description

Abstract base class for 3-D PDE-based iterative level set solver.

This class provides infrastructure for 3-D PDE-based iterative level set solver. Internally, the class implements upwind-style wave propagation and the inheriting classes must provide a way to compute the derivatives for given grid points.

See also: Osher, Stanley, and Ronald Fedkiw. Level set methods and dynamic implicit surfaces. Vol. 153. Springer Science & Business Media, 2006.

Constructor & Destructor Documentation

◆ IterativeLevelSetSolver3() [1/3]

CubbyFlow::IterativeLevelSetSolver3::IterativeLevelSetSolver3 ( )

default

Default constructor.

◆ IterativeLevelSetSolver3() [2/3]

CubbyFlow::IterativeLevelSetSolver3::IterativeLevelSetSolver3 ( const IterativeLevelSetSolver3 & )

delete

Deleted copy constructor.

◆ IterativeLevelSetSolver3() [3/3]

CubbyFlow::IterativeLevelSetSolver3::IterativeLevelSetSolver3 ( IterativeLevelSetSolver3 && )

deletenoexcept

Deleted move constructor.

◆ ~IterativeLevelSetSolver3()

CubbyFlow::IterativeLevelSetSolver3::~IterativeLevelSetSolver3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

◆ Extrapolate() [1/3]

void CubbyFlow::IterativeLevelSetSolver3::Extrapolate	(	const ScalarGrid3 &	input,
		const ScalarField3 &	sdf,
		double	maxDistance,
		ScalarGrid3 *	output
	)

overridevirtual

Extrapolates given scalar field from negative to positive SDF region.

Parameters

input	Input scalar field to be extrapolated.
sdf	Reference signed-distance field.
maxDistance	Max range of extrapolation.
output	Output scalar field.

Implements CubbyFlow::LevelSetSolver3.

◆ Extrapolate() [2/3]

void CubbyFlow::IterativeLevelSetSolver3::Extrapolate	(	const CollocatedVectorGrid3 &	input,
		const ScalarField3 &	sdf,
		double	maxDistance,
		CollocatedVectorGrid3 *	output
	)

overridevirtual

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

Parameters

input	Input collocated vector field to be extrapolated.
sdf	Reference signed-distance field.
maxDistance	Max range of extrapolation.
output	Output collocated vector field.

Implements CubbyFlow::LevelSetSolver3.

◆ Extrapolate() [3/3]

void CubbyFlow::IterativeLevelSetSolver3::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

input	Input face-centered field to be extrapolated.
sdf	Reference signed-distance field.
maxDistance	Max range of extrapolation.
output	Output face-centered vector field.

Implements CubbyFlow::LevelSetSolver3.

◆ GetDerivatives()

virtual void CubbyFlow::IterativeLevelSetSolver3::GetDerivatives	(	ConstArrayView3< double >	grid,
		const Vector3D &	gridSpacing,
		size_t	i,
		size_t	j,
		size_t	k,
		std::array< double, 2 > *	dx,
		std::array< double, 2 > *	dy,
		std::array< double, 2 > *	dz
	)		const

protectedpure virtual

Computes the derivatives for given grid point.

Implemented in CubbyFlow::ENOLevelSetSolver3, and CubbyFlow::UpwindLevelSetSolver3.

◆ GetMaxCFL()

double CubbyFlow::IterativeLevelSetSolver3::GetMaxCFL ( ) const

Returns the maximum CFL limit.

◆ operator=() [1/2]

IterativeLevelSetSolver3& CubbyFlow::IterativeLevelSetSolver3::operator= ( const IterativeLevelSetSolver3 & )

delete

Deleted copy assignment operator.

◆ operator=() [2/2]

IterativeLevelSetSolver3& CubbyFlow::IterativeLevelSetSolver3::operator= ( IterativeLevelSetSolver3 && )

deletenoexcept

Deleted move assignment operator.

◆ Reinitialize()

void CubbyFlow::IterativeLevelSetSolver3::Reinitialize	(	const ScalarGrid3 &	inputSDF,
		double	maxDistance,
		ScalarGrid3 *	outputSDF
	)

overridevirtual

Reinitializes given scalar field to signed-distance field.

Parameters

inputSDF	Input signed-distance field which can be distorted.
maxDistance	Max range of reinitialization.
outputSDF	Output signed-distance field.

Implements CubbyFlow::LevelSetSolver3.

◆ SetMaxCFL()

void CubbyFlow::IterativeLevelSetSolver3::SetMaxCFL ( double newMaxCFL )

Sets the maximum CFL limit.

This function sets the maximum CFL limit for the internal upwind-style PDE calculation. The negative input will be clamped to 0.

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

Core/Solver/LevelSet/IterativeLevelSetSolver3.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IterativeLevelSetSolver3() [1/3]

◆ IterativeLevelSetSolver3() [2/3]

◆ IterativeLevelSetSolver3() [3/3]

◆ ~IterativeLevelSetSolver3()

Member Function Documentation

◆ Extrapolate() [1/3]

◆ Extrapolate() [2/3]

◆ Extrapolate() [3/3]

◆ GetDerivatives()

◆ GetMaxCFL()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Reinitialize()

◆ SetMaxCFL()