PropDef.hpp File Reference

#include "gstlearn_export.hpp"
#include "Enum/EProcessOper.hpp"

Classes
class	PropDef

Functions
GSTLEARN_EXPORT int	get_rank_from_propdef (PropDef *propdef, int ipgs, int igrf)
GSTLEARN_EXPORT int	rule_thresh_define_shadow (PropDef *propdef, Db *dbin, const RuleShadow *rule, int facies, int iech, int isimu, int nbsimu, double *t1min, double *t1max, double *t2min, double *t2max, double *dsup, double *down)
GSTLEARN_EXPORT int	rule_thresh_define (PropDef *propdef, Db *dbin, const Rule *rule, int facies, int iech, int isimu, int nbsimu, int flag_check, double *t1min, double *t1max, double *t2min, double *t2max)
GSTLEARN_EXPORT void	proportion_rule_process (PropDef *propdef, const EProcessOper &mode)
GSTLEARN_EXPORT PropDef *	proportion_manage (int mode, int flag_facies, int flag_stat, int ngrf1, int ngrf2, int nfac1, int nfac2, Db *db, const Db *dbprop, const VectorDouble &propcst, PropDef *proploc)
GSTLEARN_EXPORT void	propdef_reset (PropDef *propdef)
GSTLEARN_EXPORT void	proportion_print (PropDef *propdef)

Function Documentation

get_rank_from_propdef()

GSTLEARN_EXPORT int get_rank_from_propdef	(	PropDef *	propdef,
		int	ipgs,
		int	igrf
	)

Give the rank of a "variable" for a given GRF and PGS

Returns

Returned rank

Parameters

[in]	propdef	PropDef structure
[in]	ipgs	Rank of the GS
[in]	igrf	Rank of the Gaussian

propdef_reset()

GSTLEARN_EXPORT void propdef_reset

(

PropDef *

propdef

)

Set memory proportion so as to provoke the update at first usage

Parameters

[in]

propdef

Pointer to Propdef structure

proportion_manage()

GSTLEARN_EXPORT PropDef* proportion_manage	(	int	mode,
		int	flag_facies,
		int	flag_stat,
		int	ngrf1,
		int	ngrf2,
		int	nfac1,
		int	nfac2,
		Db *	db,
		const Db *	dbprop,
		const VectorDouble &	propcst,
		PropDef *	proploc
	)

Allocate or deallocate a proportion array

Returns

Pointer on the returned PropDef structure

Parameters

[in]	mode	1 for allocation; -1 for deallocation
[in]	flag_facies	1 if Gibbs is used for facies
[in]	flag_stat	1 if the proportions are stationary
[in]	ngrf1	Number of GRFs for the first PGS
[in]	ngrf2	Number of GRFs for the second PGS
[in]	nfac1	Number of facies for the first PGS
[in]	nfac2	Number of facies for the second PGS
[in]	db	Db structure containing the data
[in]	dbprop	Db structure containing the proportions (only used in the non-stationary case)
[in]	propcst	Constant set of proportions (used if flag_stat)
[in]	proploc	PropDef structure (used for mode<0)

proportion_print()

GSTLEARN_EXPORT void proportion_print

(

PropDef *

propdef

)

Print the (non-stationary) proportions

Parameters

[in]

propdef

PropDef structure

proportion_rule_process()

GSTLEARN_EXPORT void proportion_rule_process	(	PropDef *	propdef,
		const EProcessOper &	mode
	)

Set the method to compute Proportions

Parameters

[in]	propdef	PropDef structure
[in]	mode	Type of operation (EProcessOper)

rule_thresh_define()

GSTLEARN_EXPORT int rule_thresh_define	(	PropDef *	propdef,
		Db *	db,
		const Rule *	rule,
		int	facies,
		int	iech,
		int	isimu,
		int	nbsimu,
		int	flag_check,
		double *	t1min,
		double *	t1max,
		double *	t2min,
		double *	t2max
	)

Set the (non-stationary) proportions and define thresholds

Returns

Error return code

Parameters

[in]	propdef	PropDef structure
[in]	db	Db input structure
[in]	rule	Rule structure
[in]	facies	Facies of interest (or ITEST) starting from 1
[in]	iech	Rank of the data in the input Db
[in]	isimu	Rank of the simulation (EProcessOper::CONDITIONAL)
[in]	nbsimu	Number of simulations
[in]	flag_check	1 if the consistency check with the actual proportion of the current facies must be done
[out]	t1min	Minimum threshold for Y1
[out]	t1max	Maximum threshold for Y1
[out]	t2min	Minimum threshold for Y2
[out]	t2max	Maximum threshold for Y2

rule_thresh_define_shadow()

GSTLEARN_EXPORT int rule_thresh_define_shadow	(	PropDef *	propdef,
		Db *	db,
		const RuleShadow *	rule,
		int	facies,
		int	iech,
		int	isimu,
		int	nbsimu,
		double *	t1min,
		double *	t1max,
		double *	t2min,
		double *	t2max,
		double *	sh_dsup,
		double *	sh_down
	)

Set the (non-stationary) proportions and define thresholds (for shadow only)

Returns

Error return code

Parameters

[in]	propdef	PropDef structure
[in]	db	Db input structure
[in]	rule	Rule structure
[in]	facies	Facies of interest (or GV_ITEST)
[in]	iech	Rank of the data in the input Db
[in]	isimu	Rank of the simulation (EProcessOper::CONDITIONAL)
[in]	nbsimu	Number of simulations (EProcessOper::CONDITIONAL)
[out]	t1min	Minimum threshold for Y1
[out]	t1max	Maximum threshold for Y1
[out]	t2min	Minimum threshold for Y2
[out]	t2max	Maximum threshold for Y2
[out]	sh_dsup	Local or global upwards shift (shadow)
[out]	sh_down	Local or global downwards shift (shadow)