1.11.1
CCC
 
Loading...
Searching...
No Matches
gstlrn::CalcSimuBoolean Class Reference

Class for performing Boolean simulation. More...

#include <CalcSimuBoolean.hpp>

Inheritance diagram for gstlrn::CalcSimuBoolean:
gstlrn::ACalcSimulation gstlrn::AStringable gstlrn::ACalcInterpolator gstlrn::ACalcDbToDb gstlrn::ACalculator

Detailed Description

Class for performing Boolean simulation.

A Boolean simulation results in drawing random object into a Field conditionally to existing samples or not These objects are called tokens and are generated according to:

  • their type (extension, orientation, ...)
  • their proportion: fix or variable

The samples (used for conditional simulations) are defined in input Db (as Z Locator variable) and are set to 0 (pore) or 1 (grain) If the proportion is variable, it uses Proportion locator in output DbGrid

Public Member Functions

 CalcSimuBoolean (Id nbsimu=0, Id seed=4324324, bool verbose=false)
 
 CalcSimuBoolean (const CalcSimuBoolean &r)=delete
 
CalcSimuBooleanoperator= (const CalcSimuBoolean &r)=delete
 
virtual ~CalcSimuBoolean ()
 
String toString (const AStringFormat *strfmt=nullptr) const override
 Interface to AStringable.
 
const SimuBooleanParamgetBoolparam () const
 
void setBoolParam (const SimuBooleanParam &boolparam)
 
void setTokens (const ModelBoolean *tokens)
 
void setFlagSimu (bool flag)
 
void setFlagRank (bool flag)
 
 extractObjects () const
 
- Public Member Functions inherited from gstlrn::ACalcSimulation
 ACalcSimulation (Id nbsimu=1, Id seed=4324324, bool verbose=false)
 
 ACalcSimulation (const ACalcSimulation &r)=delete
 
ACalcSimulationoperator= (const ACalcSimulation &r)=delete
 
virtual ~ACalcSimulation ()
 
bool isConditional () const
 
Id getSeed () const
 
Id getNbSimu () const
 
Id getNVar () const
 
void setShift (Id shift)
 
void setSeed (Id seed)
 
void setNbSimu (Id nbsimu)
 
Id getSeedPerSimu (Id isimu) const
 
- Public Member Functions inherited from gstlrn::ACalcInterpolator
 ACalcInterpolator (bool verbose=false)
 
 ACalcInterpolator (const ACalcInterpolator &r)=delete
 
ACalcInterpolatoroperator= (const ACalcInterpolator &r)=delete
 
virtual ~ACalcInterpolator ()
 
void setModelGeneric (ModelGeneric *modelGeneric)
 
void setNeigh (ANeigh *neigh)
 
void setKrigopt (const KrigOpt &krigopt)
 
ModelGenericgetModelGeneric () const
 
ANeighgetNeigh () const
 
const KrigOptgetKrigopt () const
 
bool hasModelGeneric (bool verbose=true) const
 
bool hasNeigh (bool verbose=true) const
 
- Public Member Functions inherited from gstlrn::ACalcDbToDb
 ACalcDbToDb (bool mustShareSameSpaceDimension=true, bool verbose=false)
 
 ACalcDbToDb (const ACalcDbToDb &r)=delete
 
ACalcDbToDboperator= (const ACalcDbToDb &r)=delete
 
virtual ~ACalcDbToDb ()
 
void setDbin (Db *dbin)
 
void setDbout (Db *dbout)
 
void setNamingConvention (const NamingConvention &namconv)
 
void setMustShareSpaceDimension (bool mustShareSpaceDimension)
 
DbgetDbin () const
 
DbgetDbout () const
 
DbGridgetGridin () const
 
DbGridgetGridout () const
 
const NamingConventiongetNamingConvention () const
 
bool hasDbin (bool verbose=true) const
 
bool hasDbout (bool verbose=true) const
 
bool isGridIn (bool verbose=true) const
 
bool isGridOut (bool verbose=true) const
 
- Public Member Functions inherited from gstlrn::ACalculator
 ACalculator (bool verbose=false)
 
 ACalculator (const ACalculator &r)=delete
 
ACalculatoroperator= (const ACalculator &r)=delete
 
virtual ~ACalculator ()
 
bool run ()
 
bool getVerbose () const
 
void setVerbose (bool verbose)
 
- Public Member Functions inherited from gstlrn::AStringable
 AStringable ()
 
 AStringable (const AStringable &r)
 
AStringableoperator= (const AStringable &r)
 
virtual ~AStringable ()
 
virtual void display (const AStringFormat *strfmt=nullptr) const final
 
virtual void display (Id level) const final
 
void printConcreteClassName () const
 

Constructor & Destructor Documentation

◆ CalcSimuBoolean() [1/2]

gstlrn::CalcSimuBoolean::CalcSimuBoolean ( Id  nbsimu = 0,
Id  seed = 4324324,
bool  verbose = false 
)

◆ CalcSimuBoolean() [2/2]

gstlrn::CalcSimuBoolean::CalcSimuBoolean ( const CalcSimuBoolean r)
delete

◆ ~CalcSimuBoolean()

gstlrn::CalcSimuBoolean::~CalcSimuBoolean ( )
virtual

Member Function Documentation

◆ extractObjects()

gstlrn::CalcSimuBoolean::extractObjects ( ) const

◆ getBoolparam()

const SimuBooleanParam & gstlrn::CalcSimuBoolean::getBoolparam ( ) const
inline

◆ operator=()

CalcSimuBoolean & gstlrn::CalcSimuBoolean::operator= ( const CalcSimuBoolean r)
delete

◆ setBoolParam()

void gstlrn::CalcSimuBoolean::setBoolParam ( const SimuBooleanParam boolparam)
inline

◆ setFlagRank()

void gstlrn::CalcSimuBoolean::setFlagRank ( bool  flag)
inline

◆ setFlagSimu()

void gstlrn::CalcSimuBoolean::setFlagSimu ( bool  flag)
inline

◆ setTokens()

void gstlrn::CalcSimuBoolean::setTokens ( const ModelBoolean tokens)
inline

◆ toString()

String gstlrn::CalcSimuBoolean::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: