Level Set driver class. More...

Public Member Functions
	LevelSet (LevelSet &&other)=default

	LevelSet (LevelSetFillIn expectedFillIn=LevelSetFillIn::SPARSE)

int	addObject (const std::unordered_set< long > &, int id=levelSetDefaults::OBJECT)

int	addObject (const std::vector< long > &, long, bool, int id=levelSetDefaults::OBJECT)

template<typename LevelSetSourceObject = LevelSetObject>
int	addObject (LevelSetBooleanOperation, const std::vector< int > &, int id=levelSetDefaults::OBJECT)

template<typename LevelSetSourceObject = LevelSetObject>
int	addObject (LevelSetBooleanOperation, int, int, int id=levelSetDefaults::OBJECT)

int	addObject (std::unique_ptr< LevelSetObject > &&)

int	addObject (std::unique_ptr< SurfaceKernel > &&, double, int id=levelSetDefaults::OBJECT)

int	addObject (std::unique_ptr< SurfUnstructured > &&, double, int id=levelSetDefaults::OBJECT)

int	addObject (SurfaceKernel *, double, int id=levelSetDefaults::OBJECT)

int	addObject (SurfaceKernel *, double, LevelSetSurfaceSmoothing, int id=levelSetDefaults::OBJECT)

int	addObject (SurfUnstructured *, double, int id=levelSetDefaults::OBJECT)

int	addObject (SurfUnstructured *, double, LevelSetSurfaceSmoothing, int id=levelSetDefaults::OBJECT)

template<typename LevelSetSourceObject = LevelSetObject>
int	addObjectComplement (int, int id=levelSetDefaults::OBJECT)

	BITPIT_DEPRECATED_FOR (double getSizeNarrowBand() const, double getNarrowBandSize() const)

	BITPIT_DEPRECATED_FOR (void compute(), void evaluate())

	BITPIT_DEPRECATED_FOR (void compute(const std::vector< int > &ids), void evaluate(const std::vector< int > &ids))

	BITPIT_DEPRECATED_FOR (void compute(int id), void evaluate(int id))

	BITPIT_DEPRECATED_FOR (void setSizeNarrowBand(double size), void setNarrowBandSize(double size))

	BITPIT_DEPRECATED_FOR (void update(const std::vector< adaption::Info > &adaptionData, const std::vector< int > &ids), void update(const std::vector< adaption::Info > &adaptionData))

	BITPIT_DEPRECATED_FOR (void update(const std::vector< adaption::Info > &adaptionData, int id), void update(const std::vector< adaption::Info > &adaptionData))

void	clear ()

void	dump (std::ostream &) const

double	getNarrowBandSize () const

LevelSetObject &	getObject (int) const

template<typename T>
T &	getObject (int) const

int	getObjectCount () const

std::vector< int >	getObjectIds () const

LevelSetObject *	getObjectPtr (int) const

template<typename T>
T *	getObjectPtr (int) const

std::vector< LevelSetObject * >	getObjectPtrs () const

template<typename T>
std::vector< T * >	getObjectPtrs () const

bool	isObjectRemovable (int)

void	partition (const std::vector< adaption::Info > &)

bool	removeObject (int)

void	removeObjects ()

void	restore (std::istream &)

void	setMesh (VolumeKernel *mesh)

void	setNarrowBandSize (double size=0)

void	setPropagateSign (bool)

void	setSign (bool)

void	update (const std::vector< adaption::Info > &adaptionData)

Detailed Description

Level Set driver class.

LevelSet is the main user interface class for computing signed- or unsigned- distance functions on Cartesian or Octree meshes with respect to geometrical objects. The user needs to define the computional kernel by calling setMesh() and the objects which define the zero levelset via addObject().

Evaluation of the fields inside the narrow band is always performed using an exact algorithm, on the other hand evaluation of the fields in the bulk can be performed choosing different algorithms.

With respect to the levelset value, the domain can be divided in two regions: the narrow band and the bulk. The narrow band defines the portion of the domain close to the zero-levelset iso surface whereas the bulk is everything else. Regardless of the specified narrow bans size, the narrow band will always contain the intersected cells and their neighbours.

LevelSet can use two types of storages: sparse or dense. When sparse storage is used, objects will only allocate space for storing information of cells that are inside the narrow band. Instead, when dense storage is used, objects will still evaluate information only for cells inside the narrow band, but they will allocate space for all cells of the mesh. If the narrow band covers a large portion of the domain, it will be more efficient to allocate space for all the cells of the mesh, rather than keep track of the cells inside the narrow band and store space only for those cells.

LevelSet will test if the underlying mesh can provide a MPI communicator. In case LevelSet is parallelized according the underlying mesh partitioning.

Examples: RBF_example_00001.cpp.

Definition at line 51 of file levelSet.hpp.

Constructor & Destructor Documentation

◆ LevelSet()

bitpit::LevelSet::LevelSet ( LevelSetFillIn expectedFillIn = LevelSetFillIn::SPARSE )

Default constructor

Definition at line 83 of file levelSet.cpp.

Member Function Documentation

◆ addObject() [1/11]

int bitpit::LevelSet::addObject	(	const std::unordered_set< long > &	list,
		int	id = levelSetDefaults::OBJECT )

Adds a LevelSetMask object composed of the external envelope of a list of mesh cells. Objects can be added to the levelset only after setting the mesh.

Parameters

[in]	list	list of indices of cells
[in]	id	id to be assigned to object. In case default value is passed the insertion order will be used as identifier

Returns: identifier of new object

Definition at line 323 of file levelSet.cpp.

◆ addObject() [2/11]

int bitpit::LevelSet::addObject	(	const std::vector< long > &	list,
		long	refInterface,
		bool	invert,
		int	id = levelSetDefaults::OBJECT )

Adds a LevelSetMask object composed of a list of interfaces Objects can be added to the levelset only after setting the mesh.

Parameters

[in]	list	list of indices of interfaces
[in]	refInterface	id of reference interface
[in]	invert	if orientation should be inverted with respect to the reference interface
[in]	id	id to be assigned to object. In case default value is passed the insertion order will be used as identifier

Returns: identifier of new object

Definition at line 341 of file levelSet.cpp.

◆ addObject() [3/11]

template<typename LevelSetSourceObject>

int bitpit::LevelSet::addObject	(	LevelSetBooleanOperation	operation,
		const std::vector< int > &	ids,
		int	id = levelSetDefaults::OBJECT )

Adds a boolean operation between that will be applied recursively to a series of objects Objects can be added to the levelset only after setting the mesh.

Parameters

[in]	operation	boolean operation
[in]	ids	vector with indices of operand objects
[in]	id	id to be assigned to object. In case default value is passed the insertion order will be used as identifier

Returns: identifier of new object

Definition at line 86 of file levelSet.tpp.

◆ addObject() [4/11]

template<typename LevelSetSourceObject>

int bitpit::LevelSet::addObject	(	LevelSetBooleanOperation	operation,
		int	id1,
		int	id2,
		int	id = levelSetDefaults::OBJECT )

Adds a boolean operation between two objects Objects can be added to the levelset only after setting the mesh.

Parameters

[in]	operation	boolean operation
[in]	id1	id of first operand
[in]	id2	id of second operand
[in]	id	id to be assigned to object. In case default value is passed the insertion order will be used as identifier

Returns: identifier of new object

Examples: RBF_example_00001.cpp.

Definition at line 60 of file levelSet.tpp.

◆ addObject() [5/11]

int bitpit::LevelSet::addObject ( std::unique_ptr< LevelSetObject > && object )

Adds a generic LevelSetObject Objects can be added to the levelset only after setting the mesh.

Parameters

[in] object generic object

Returns: the index associated to the object

Definition at line 356 of file levelSet.cpp.