gstlrn::RuleShadow Class Reference

#include <RuleShadow.hpp>

Inheritance diagram for gstlrn::RuleShadow:

Public Member Functions
	RuleShadow ()
	RuleShadow (double slope, double sh_dsup, double sh_down, const 1 &shift)
	RuleShadow (const RuleShadow &m)
RuleShadow &	operator= (const RuleShadow &m)
virtual	~RuleShadow ()
String	displaySpecific () const override
Id	particularities (Db *db, const Db *dbprop, Model *model, Id flag_grid_check, Id flag_stat) const override
Id	gaus2facData (PropDef *propdef, Db *dbin, Db *dbout, Id *flag_used, Id ipgs, Id isimu, Id nbsimu) override
Id	gaus2facResult (PropDef *propdef, Db *dbout, Id *flag_used, Id ipgs, Id isimu, Id nbsimu) const override
Id	evaluateBounds (PropDef *propdef, Db *dbin, Db *dbout, Id isimu, Id igrf, Id ipgs, Id nbsimu) const override
double	getShDown () const
double	getShDsup () const
double	getSlope () const
double	getDMax () const
double	getTgte () const
double	getIncr () const
const &	getShift () const
double	getShift (Id idim) const
Public Member Functions inherited from gstlrn::Rule
	Rule (double rho=0.)
	Rule (const Rule &m)
Rule &	operator= (const Rule &m)
virtual	~Rule ()
String	toString (const AStringFormat *strfmt=nullptr) const override
Id	resetFromNames (const VectorString &nodnames, double rho=0.)
Id	resetFromCodes (const 1 &nodes, double rho=0.)
Id	resetFromNumericalCoding (const 1 &n_type, const 1 &n_facs, double rho=0.)
Id	resetFromFaciesCount (Id nfacies, double rho=0.)
virtual bool	checkModel (const Model *model, Id nvar=0) const
Id	getFlagProp () const
const ERule &	getModeRule () const
double	getRho () const
const Node *	getMainNode () const
void	setFlagProp (Id flagProp)
void	setRho (double rho) const
void	setModeRule (const ERule &modeRule)
	TODO : Check if mutable is really necessary.
Id	setProportions (const 1 &proportions=1()) const
Id	statistics (Id verbose, Id *node_tot, Id *nfac_tot, Id *nmax_tot, Id *ny1_tot, Id *ny2_tot, double *prop_tot) const
Id	getNFacies () const
Id	getNGRF () const
Id	getNY1 () const
Id	getNY2 () const
bool	isYUsed (Id igrf) const
	whichGRFUsed () const
double	getProportion (Id facies)
std::array< double, 4 >	getThresh (Id facies) const
	getThreshFromRectangle (Id rect, Id *facies)
Id	getFaciesFromGaussian (double y1, double y2) const
	getNodes () const
void	updateShift () 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
Public Member Functions inherited from gstlrn::ASerializable
	ASerializable ()
	ASerializable (const ASerializable &r)
ASerializable &	operator= (const ASerializable &r)
	ASerializable (ASerializable &&r) noexcept
ASerializable &	operator= (ASerializable &&r) noexcept
virtual	~ASerializable ()
bool	dumpToNF (const String &NFFilename, const EFormatNF &format=EFormatNF::fromKey("DEFAULT"), bool verbose=false) const
	Dump the contents of an object into an Output File using a given Output NF Format.
void	setDefaultFormatNF (const EFormatNF &format)

Additional Inherited Members
Static Public Member Functions inherited from gstlrn::Rule
static Rule *	create (double rho=0.)
static Rule *	createFromNF (const String &NFFilename, bool verbose=true)
static Rule *	createFromNames (const VectorString &nodnames, double rho=0.)
static Rule *	createFromCodes (const 1 &nodes, double rho=0.)
static Rule *	createFromNumericalCoding (const 1 &n_type, const 1 &n_facs, double rho=0.)
static Rule *	createFromFaciesCount (Id nfacies, double rho=0.)
Static Public Member Functions inherited from gstlrn::ASerializable
static String	buildFileName (Id status, const String &filename, bool ensureDirExist=false)
static String	getFileIdentity (const String &filename, bool verbose=false)
static void	setPrefixName (const String &prefixName)
static void	unsetPrefixName ()
static const String &	getPrefixName ()

Constructor & Destructor Documentation

RuleShadow() [1/3]

gstlrn::RuleShadow::RuleShadow

(

)

RuleShadow() [2/3]

gstlrn::RuleShadow::RuleShadow	(	double	slope,
		double	sh_dsup,
		double	sh_down,
		const 1 &	shift
	)

Defining the Lithotype Rule in the case of Shadow

Parameters

slope	Slope definition
sh_dsup	Maximum threshold
sh_down	Minimum threshold
shift	Shift orientation

RuleShadow() [3/3]

gstlrn::RuleShadow::RuleShadow

(

const RuleShadow &

m

)

~RuleShadow()

gstlrn::RuleShadow::~RuleShadow ( )

virtual

Member Function Documentation

displaySpecific()

String gstlrn::RuleShadow::displaySpecific ( ) const

overridevirtual

Reimplemented from gstlrn::Rule.

evaluateBounds()

Id gstlrn::RuleShadow::evaluateBounds ( PropDef *  propdef, Db *  dbin, Db *  dbout, Id  isimu, Id  igrf, Id  ipgs, Id  nbsimu  ) const

overridevirtual

Set the bounds and possibly add replicates (Shadow)

Returns

Error return code

Parameters

[in]	propdef	PropDef structure
[in]	dbin	Db structure
[in]	dbout	Db grid structure
[in]	isimu	Rank of the simulation (if EProcessOper::CONDITIONAL)
[in]	igrf	Rank of the GRF
[in]	ipgs	Rank of the GS
[in]	nbsimu	Number of simulations (if EProcessOper::CONDITIONAL)

Reimplemented from gstlrn::Rule.

gaus2facData()

Id gstlrn::RuleShadow::gaus2facData ( PropDef *  propdef, Db *  dbin, Db *  dbout, Id *  flag_used, Id  ipgs, Id  isimu, Id  nbsimu  )

overridevirtual

Combine the underlying GRF into a facies value at data points (Shadow)

Returns

Error return code

Parameters

[in]	propdef	Props structure
[in]	dbin	Db input structure
[in]	dbout	Db output structure
[in]	flag_used	1 if the gaussian is used; 0 otherwise
[in]	ipgs	Rank of the PGS
[in]	isimu	Rank of the simulation
[in]	nbsimu	Number of simulations

Remarks

Attributes ELoc::GAUSFAC are mandatory

Attributes ELoc::FACIES are mandatory

Reimplemented from gstlrn::Rule.

gaus2facResult()

Id gstlrn::RuleShadow::gaus2facResult ( PropDef *  propdef, Db *  dbout, Id *  flag_used, Id  ipgs, Id  isimu, Id  nbsimu  ) const

overridevirtual

Combine the underlying GRF into a facies value (Shadow case)

Returns

Error return code

Parameters

[in]	propdef	Props structure
[in]	dbout	Db output structure
[in]	flag_used	1 if the gaussian is used; 0 otherwise
[in]	ipgs	Rank of the PGS
[in]	isimu	Rank of the simulation
[in]	nbsimu	Number of simulations

Remarks

Attributes ELoc::FACIES and ELoc::SIMU are mandatory

Reimplemented from gstlrn::Rule.

getDMax()

double gstlrn::RuleShadow::getDMax ( ) const

inline

getIncr()

double gstlrn::RuleShadow::getIncr ( ) const

inline

getShDown()

double gstlrn::RuleShadow::getShDown ( ) const

inline

getShDsup()

double gstlrn::RuleShadow::getShDsup ( ) const

inline

getShift() [1/2]

const & gstlrn::RuleShadow::getShift ( ) const

inline

getShift() [2/2]

double gstlrn::RuleShadow::getShift ( Id  idim ) const

inline

getSlope()

double gstlrn::RuleShadow::getSlope ( ) const

inline

getTgte()

double gstlrn::RuleShadow::getTgte ( ) const

inline

operator=()

RuleShadow & gstlrn::RuleShadow::operator=

(

const RuleShadow &

m

)

particularities()

Id gstlrn::RuleShadow::particularities ( Db *  db, const Db *  dbprop, Model *  model, Id  flag_grid_check, Id  flag_stat  ) const

overridevirtual

Define the particularities of the PGS model (for Shadow)

Returns

Error return code

Parameters

[in]	db	Db structure
[in]	dbprop	Db structure used for proportions
[in]	model	Model structure (only used for shift option)
[in]	flag_grid_check	1 if grid is compulsory; 0 otherwise (only for SHIFT)
[in]	flag_stat	1 for stationary; 0 otherwise

Reimplemented from gstlrn::Rule.

---

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

• include/LithoRule/RuleShadow.hpp
• src/LithoRule/RuleShadow.cpp