bitpit::LevelSetComplementBaseObject< SourceLevelSetObject > Class Template Reference

Base class that allows to evaluate the complement of a LevelSetObjects. More...

Inheritance diagram for bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >:

Collaboration diagram for bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >:

Public Member Functions
bool	empty () const override
const SourceLevelSetObject *	getCellReferenceObject (long id) const override
const SourceLevelSetObject *	getReferenceObject (const std::array< double, 3 > &point) const override
virtual const SourceLevelSetObject *	getSourceObject () const
std::vector< const SourceLevelSetObject * >	getSourceObjects () const override
Public Member Functions inherited from bitpit::LevelSetProxyObject< SourceLevelSetObject, SourceLevelSetObject >
int	getCellReferenceObjectId (long id) const override
virtual const SourceLevelSetObject *	getCellReferencePrimaryObject (long id) const
int	getCellReferencePrimaryObjectId (long id) const override
int	getPrimaryObjectId (long) const
std::vector< int >	getPrimarySourceObjectIds () const override
virtual std::vector< const SourceLevelSetObject * >	getPrimarySourceObjects () const
int	getReferenceObjectId (const std::array< double, 3 > &point) const override
virtual const SourceLevelSetObject *	getReferencePrimaryObject (const std::array< double, 3 > &point) const
int	getReferencePrimaryObjectId (const std::array< double, 3 > &point) const override
std::vector< int >	getSourceObjectIds () const override
bool	isCellInNarrowBand (long id) const override
bool	isInNarrowBand (const std::array< double, 3 > &point) const override
bool	isPrimary () const override

Protected Member Functions
	LevelSetComplementBaseObject (int id, const SourceLevelSetObject *source)
std::array< double, 3 >	_evalCellGradient (long id, bool signedLevelSet) const override
short	_evalCellSign (long id) const override
double	_evalCellValue (long id, bool signedLevelSet) const override
std::array< double, 3 >	_evalGradient (const std::array< double, 3 > &point, bool signedLevelSet) const override
short	_evalSign (const std::array< double, 3 > &point) const override
double	_evalValue (const std::array< double, 3 > &point, bool signedLevelSet) const override
void	fillCellPropagatedSignCache () override
void	replaceSourceObject (const SourceLevelSetObject *current, const SourceLevelSetObject *updated) override
Protected Member Functions inherited from bitpit::LevelSetProxyObject< SourceLevelSetObject, SourceLevelSetObject >
	LevelSetProxyObject (int)
void	fillCellLocationCache () override
void	fillCellLocationCache (const std::vector< adaption::Info > &adaptionData) override

Detailed Description

template<typename SourceLevelSetObject>
class bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >

Base class that allows to evaluate the complement of a LevelSetObjects.

Definition at line 38 of file levelSetComplementObject.hpp.

Constructor & Destructor Documentation

LevelSetComplementBaseObject()

template<typename SourceLevelSetObject>

bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::LevelSetComplementBaseObject ( int id, const SourceLevelSetObject * source )

protected

Constructor.

Parameters

[in]	id	identifier of object
[in]	source	pointer to source object

Definition at line 50 of file levelSetComplementObject.tpp.

Member Function Documentation

_evalCellGradient()

template<typename SourceLevelSetObject>

std::array< double, 3 > bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::_evalCellGradient ( long id, bool signedLevelSet ) const

overrideprotected

Evaluate levelset gradient at the specified cell.

Parameters

id	is the id of the cell
signedLevelSet	controls if signed levelset function will be used

Returns

The gradient of the levelset at the specified cell.

Definition at line 168 of file levelSetComplementObject.tpp.

_evalCellSign()

template<typename SourceLevelSetObject>

short bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::_evalCellSign ( long id ) const

overrideprotected

Evaluate levelset sign at the specified cell.

Parameters

id	is the id of the cell

Returns

The sign of the levelset at the specified cell.

Definition at line 137 of file levelSetComplementObject.tpp.

_evalCellValue()

template<typename SourceLevelSetObject>

double bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::_evalCellValue ( long id, bool signedLevelSet ) const

overrideprotected

Evaluate levelset value at the specified cell.

Parameters

id	is the id of the cell
signedLevelSet	controls if signed levelset function will be used

Returns

The value of the levelset at the specified cell.

Definition at line 150 of file levelSetComplementObject.tpp.

_evalGradient()

template<typename SourceLevelSetObject>

std::array< double, 3 > bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::_evalGradient ( const std::array< double, 3 > & point, bool signedLevelSet ) const

overrideprotected

Evaluate levelset gradient at the specified point.

Parameters

point	are the coordinates of the point
signedLevelSet	controls if signed levelset function will be used

Returns

The gradient of the levelset at the specified point.

Definition at line 216 of file levelSetComplementObject.tpp.

_evalSign()

template<typename SourceLevelSetObject>

short bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::_evalSign ( const std::array< double, 3 > & point ) const

overrideprotected

Evaluate levelset sign at the specified point.

Parameters

point

are the coordinates of the point

Returns

The sign of the levelset at the specified point.

Definition at line 185 of file levelSetComplementObject.tpp.

_evalValue()

template<typename SourceLevelSetObject>

double bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::_evalValue ( const std::array< double, 3 > & point, bool signedLevelSet ) const

overrideprotected

Evaluate levelset value at the specified point.

Parameters

point	are the coordinates of the point
signedLevelSet	controls if signed levelset function will be used

Returns

The value of the levelset at the specified point.

Definition at line 198 of file levelSetComplementObject.tpp.

empty()

template<typename SourceLevelSetObject>

bool bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::empty ( ) const

override

Checks if the object is empty.

Returns

Returns true is the object is empty, false otherwise.

Definition at line 62 of file levelSetComplementObject.tpp.

fillCellPropagatedSignCache()

template<typename SourceLevelSetObject>

void bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::fillCellPropagatedSignCache ( )

overrideprotected

Fill the cache that contains the propagated cell sign.

Definition at line 87 of file levelSetComplementObject.tpp.

getCellReferenceObject()

template<typename SourceLevelSetObject>

const SourceLevelSetObject * bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::getCellReferenceObject ( long id ) const

overridevirtual

Get the object that defines the levelset information for the specified cell.

Parameters

[in]

id

cell index

Returns

The object that defines the levelset information for the specified cell.

Implements bitpit::LevelSetProxyObject< SourceLevelSetObject, SourceLevelSetObject >.

Definition at line 234 of file levelSetComplementObject.tpp.

getReferenceObject()

template<typename SourceLevelSetObject>

const SourceLevelSetObject * bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::getReferenceObject ( const std::array< double, 3 > & point ) const

overridevirtual

Get the object that defines the levelset information for the specified point.

Parameters

[in]

point

are the coordinates of the point

Returns

The object that defines the levelset information for the specified point.

Implements bitpit::LevelSetProxyObject< SourceLevelSetObject, SourceLevelSetObject >.

Definition at line 249 of file levelSetComplementObject.tpp.

getSourceObject()

template<typename SourceLevelSetObject>

const SourceLevelSetObject * bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::getSourceObject ( ) const

virtual

Get the objects that define

Returns

pointers to all primary objects involved in the definition of the boolean object levelset information.

Definition at line 263 of file levelSetComplementObject.tpp.

getSourceObjects()

template<typename SourceLevelSetObject>

std::vector< const SourceLevelSetObject * > bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::getSourceObjects ( ) const

overridevirtual

Get all objects that compose the boolean object.

Returns

pointers to all primary objects involved in the definition of the boolean object levelset information.

Implements bitpit::LevelSetProxyObject< SourceLevelSetObject, SourceLevelSetObject >.

Definition at line 275 of file levelSetComplementObject.tpp.

replaceSourceObject()

template<typename SourceLevelSetObject>

void bitpit::LevelSetComplementBaseObject< SourceLevelSetObject >::replaceSourceObject ( const SourceLevelSetObject * current, const SourceLevelSetObject * updated )

overrideprotectedvirtual

Replace a source object.

Parameters

[in]	current	current source object
[in]	updated	updated source object

Implements bitpit::LevelSetProxyObject< SourceLevelSetObject, SourceLevelSetObject >.

Definition at line 74 of file levelSetComplementObject.tpp.

---

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

• src/levelset/levelSetComplementObject.hpp
• src/levelset/levelSetComplementObject.tpp