gstlrn::BooleanObject Class Reference

#include <BooleanObject.hpp>

Inheritance diagram for gstlrn::BooleanObject:

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

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

Constructor & Destructor Documentation

BooleanObject() [1/2]

gstlrn::BooleanObject::BooleanObject

(

const AShape *

shape

)

BooleanObject() [2/2]

gstlrn::BooleanObject::BooleanObject

(

const BooleanObject &

r

)

~BooleanObject()

gstlrn::BooleanObject::~BooleanObject ( )

virtual

Member Function Documentation

coverageUpdate()

Id gstlrn::BooleanObject::coverageUpdate	(	Db *	db,
		Id	iptr_cover,
		Id	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 * gstlrn::BooleanObject::generate ( const DbGrid *  dbout, const 1 &  cdgrain, const ModelBoolean *  tokens, const SimuBooleanParam &  boolparam, double  eps = EPSILON3  )

static

Function used to generate the geometry of an object

getCenter()

double gstlrn::BooleanObject::getCenter ( Id  idim ) const

inline

getExtension()

double gstlrn::BooleanObject::getExtension ( Id  idim ) const

inline

getMode()

Id gstlrn::BooleanObject::getMode ( ) const

inline

getOrientation()

double gstlrn::BooleanObject::getOrientation ( ) const

inline

getToken()

const AShape * gstlrn::BooleanObject::getToken ( ) const

inline

getValue()

double gstlrn::BooleanObject::getValue ( Id  rank ) const

inline

getValues()

gstlrn::BooleanObject::getValues

(

)

const

isCompatibleGrainAdd()

bool gstlrn::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 gstlrn::BooleanObject::isCompatibleGrainDelete	(	const Db *	db,
		Id	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 gstlrn::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 & gstlrn::BooleanObject::operator=

(

const BooleanObject &

r

)

projectToGrid()

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

setCenter() [1/2]

void gstlrn::BooleanObject::setCenter

(

const 1 &

center

)

setCenter() [2/2]

void gstlrn::BooleanObject::setCenter ( Id  idim, double  value  )

inline

setExtension()

void gstlrn::BooleanObject::setExtension ( Id  idim, double  value  )

inline

setMode()

void gstlrn::BooleanObject::setMode ( Id  mode )

inline

setOrientation()

void gstlrn::BooleanObject::setOrientation ( double  orientation )

inline

setValue()

void gstlrn::BooleanObject::setValue ( Id  rank, double  value  )

inline

toString()

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

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

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