BooleanObject Class Reference

#include <BooleanObject.hpp>

Inheritance diagram for BooleanObject:

Public Member Functions
	BooleanObject (const AShape *shape)
	BooleanObject (const BooleanObject &r)
BooleanObject &	operator= (const BooleanObject &r)
virtual	~BooleanObject ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...
void	setMode (int mode)
void	setOrientation (double orientation)
void	setCenter (int idim, double value)
void	setCenter (const VectorDouble &center)
void	setExtension (int idim, double value)
void	setValue (int rank, double value)
int	getMode () const
double	getCenter (int idim) const
double	getExtension (int idim) const
double	getOrientation () const
double	getValue (int rank) const
const AShape *	getToken () const
bool	isCompatiblePore (const Db *db)
bool	isCompatibleGrainAdd (const Db *db)
bool	isCompatibleGrainDelete (const Db *db, int iptr_cover)
void	projectToGrid (DbGrid *dbout, int iptr_simu, int iptr_rank, int facies, int rank)
int	coverageUpdate (Db *db, int iptr_cover, int val)
VectorDouble	getValues () const
Public Member Functions inherited from AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (int level) const final

Static Public Member Functions
static BooleanObject *	generate (const DbGrid *dbout, const VectorDouble &cdgrain, const ModelBoolean *tokens, const SimuBooleanParam &boolparam, double eps=EPSILON3)

Constructor & Destructor Documentation

BooleanObject() [1/2]

BooleanObject::BooleanObject

(

const AShape *

shape

)

BooleanObject() [2/2]

BooleanObject::BooleanObject

(

const BooleanObject &

r

)

~BooleanObject()

BooleanObject::~BooleanObject ( )

virtual

Member Function Documentation

coverageUpdate()

int BooleanObject::coverageUpdate	(	Db *	db,
		int	iptr_cover,
		int	val
	)

Update the covering value of each constraining grain after a deletion or an addition operation

Returns

Count of grains not covered after the operation

Parameters

[in]	db	Db structure
[in]	iptr_cover	UID for the covering variable
[in]	val	type of the operation to be tested 1 for addition; -1 for deletion

generate()

BooleanObject * BooleanObject::generate ( const DbGrid *  dbout, const VectorDouble &  cdgrain, const ModelBoolean *  tokens, const SimuBooleanParam &  boolparam, double  eps = EPSILON3  )

static

Function used to generate the geometry of an object

getCenter()

double BooleanObject::getCenter ( int  idim ) const

inline

getExtension()

double BooleanObject::getExtension ( int  idim ) const

inline

getMode()

int BooleanObject::getMode ( ) const

inline

getOrientation()

double BooleanObject::getOrientation ( ) const

inline

getToken()

const AShape* BooleanObject::getToken ( ) const

inline

getValue()

double BooleanObject::getValue ( int  rank ) const

inline

getValues()

VectorDouble BooleanObject::getValues

(

)

const

isCompatibleGrainAdd()

bool BooleanObject::isCompatibleGrainAdd

(

const Db *

db

)

Check if an object can be added with regards to the constraining grains

Parameters

[in]

db

Constraining data set

isCompatibleGrainDelete()

bool BooleanObject::isCompatibleGrainDelete	(	const Db *	db,
		int	iptr_cover
	)

Check if an object can be deleted with regards to the constraining grains

Parameters

[in]	db	Constraining data set
[in]	iptr_cover	UIUD for coverage variable

isCompatiblePore()

bool BooleanObject::isCompatiblePore

(

const Db *

db

)

Check if the current object is compatible with the constraining pores

Returns

True if it is compatible; False otherwise

Parameters

[in]

db

Constraining data set

operator=()

BooleanObject & BooleanObject::operator=

(

const BooleanObject &

r

)

projectToGrid()

void BooleanObject::projectToGrid	(	DbGrid *	dbout,
		int	iptr_simu,
		int	iptr_rank,
		int	facies,
		int	rank
	)

setCenter() [1/2]

void BooleanObject::setCenter

(

const VectorDouble &

center

)

setCenter() [2/2]

void BooleanObject::setCenter ( int  idim, double  value  )

inline

setExtension()

void BooleanObject::setExtension ( int  idim, double  value  )

inline

setMode()

void BooleanObject::setMode ( int  mode )

inline

setOrientation()

void BooleanObject::setOrientation ( double  orientation )

inline

setValue()

void BooleanObject::setValue ( int  rank, double  value  )

inline

toString()

String BooleanObject::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

---

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

• include/Simulation/BooleanObject.hpp
• src/Simulation/BooleanObject.cpp