#include <RuleShift.hpp>

Inheritance diagram for gstlrn::RuleShift:

Public Member Functions
	RuleShift ()

	RuleShift (const RuleShift &m)

RuleShift &	operator= (const RuleShift &m)

virtual	~RuleShift ()

String	displaySpecific () const override

Id	resetFromNodes (const 1 &nodes, const 1 &shift)

Id	resetFromNames (const VectorString &nodnames, const 1 &shift)

Id	resetFromFaciesCount (Id nfacies, const 1 &shift)

Id	resetFromNumericalCoding (const 1 &n_type, const 1 &n_facs, const 1 &shift)

Id	particularities (Db db, const Db dbprop, Model *model, Id flag_grid_check, Id flag_stat) const 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

bool	checkModel (const Model *model, Id nvar=0) const override

double	getShDown () const

double	getShDsup () const

double	getSlope () 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 Id	gaus2facData (PropDef propdef, Db dbin, Db dbout, Id flag_used, Id ipgs, Id isimu, Id nbsimu)

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)

Static Public Member Functions
static RuleShift *	createFromNodes (const 1 &nodes, const 1 &shift)

static RuleShift *	createFromNames (const VectorString &nodnames, const 1 &shift)

static RuleShift *	createFromFaciesCount (Id nfacies, const 1 &shift)

static RuleShift *	createFromNumericalCoding (const 1 &n_type, const 1 &n_facs, const 1 &shift)

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

◆ RuleShift() [1/2]

gstlrn::RuleShift::RuleShift ( )

◆ RuleShift() [2/2]

gstlrn::RuleShift::RuleShift ( const RuleShift & m )

◆ ~RuleShift()

gstlrn::RuleShift::~RuleShift ( )

virtual

Member Function Documentation

◆ checkModel()

bool gstlrn::RuleShift::checkModel	(	const Model *	model,
		Id	nvar = `0`
	)		const

overridevirtual

Reimplemented from gstlrn::Rule.

◆ createFromFaciesCount()

RuleShift * gstlrn::RuleShift::createFromFaciesCount	(	Id	nfacies,
		const 1 &	shift
	)

static

◆ createFromNames()

RuleShift * gstlrn::RuleShift::createFromNames	(	const VectorString &	nodnames,
		const 1 &	shift
	)

static

◆ createFromNodes()

RuleShift * gstlrn::RuleShift::createFromNodes	(	const 1 &	nodes,
		const 1 &	shift
	)

static

◆ createFromNumericalCoding()

RuleShift * gstlrn::RuleShift::createFromNumericalCoding	(	const 1 &	n_type,
		const 1 &	n_facs,
		const 1 &	shift
	)

static

◆ displaySpecific()

String gstlrn::RuleShift::displaySpecific ( ) const

overridevirtual

Reimplemented from gstlrn::Rule.

◆ evaluateBounds()

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

overridevirtual

Set the bounds and possibly add replicates

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.

◆ gaus2facResult()

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

overridevirtual

Combine the underlying GRF into a facies value

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.

◆ getShDown()

double gstlrn::RuleShift::getShDown ( ) const

inline

◆ getShDsup()

double gstlrn::RuleShift::getShDsup ( ) const

inline

◆ getShift() [1/2]

const & gstlrn::RuleShift::getShift ( ) const

inline

◆ getShift() [2/2]

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

inline

◆ getSlope()

double gstlrn::RuleShift::getSlope ( ) const

inline

◆ operator=()

RuleShift & gstlrn::RuleShift::operator= ( const RuleShift & m )

◆ particularities()

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

overridevirtual

Define the particularities of the PGS model

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.

◆ resetFromFaciesCount()

Id gstlrn::RuleShift::resetFromFaciesCount	(	Id	nfacies,
		const 1 &	shift
	)

Definition of the Lithotype RuleShift

Parameters

nfacies	Number of facies
shift	Vector defining the shift

◆ resetFromNames()

Id gstlrn::RuleShift::resetFromNames	(	const VectorString &	nodnames,
		const 1 &	shift
	)

◆ resetFromNodes()

Id gstlrn::RuleShift::resetFromNodes	(	const 1 &	nodes,
		const 1 &	shift
	)

Definition of the Lithotype RuleShift

Parameters

nodes	List of "integer" nodes (should only include "S", no "T")
shift	Vector defining the Shift

◆ resetFromNumericalCoding()

Id gstlrn::RuleShift::resetFromNumericalCoding	(	const 1 &	n_type,
		const 1 &	n_facs,
		const 1 &	shift
	)

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

include/LithoRule/RuleShift.hpp
src/LithoRule/RuleShift.cpp

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ RuleShift() [1/2]

◆ RuleShift() [2/2]

◆ ~RuleShift()

Member Function Documentation

◆ checkModel()

◆ createFromFaciesCount()

◆ createFromNames()

◆ createFromNodes()

◆ createFromNumericalCoding()

◆ displaySpecific()

◆ evaluateBounds()

◆ gaus2facResult()

◆ getShDown()

◆ getShDsup()

◆ getShift() [1/2]

◆ getShift() [2/2]

◆ getSlope()

◆ operator=()

◆ particularities()

◆ resetFromFaciesCount()

◆ resetFromNames()

◆ resetFromNodes()

◆ resetFromNumericalCoding()