Rule.hpp File Reference

#include "gstlearn_export.hpp"
#include "Enum/ERule.hpp"
#include "LithoRule/Node.hpp"
#include "LithoRule/PropDef.hpp"
#include "Basic/VectorNumT.hpp"
#include "Basic/AStringable.hpp"
#include "Basic/ASerializable.hpp"

Classes
class	Rule

Functions
GSTLEARN_EXPORT void	set_rule_mode (int rule_mode)
GSTLEARN_EXPORT int	get_rule_mode (void)
GSTLEARN_EXPORT double	get_rule_extreme (int mode)
GSTLEARN_EXPORT Rule *	rule_free (const Rule *rule)
GSTLEARN_EXPORT Model *	model_rule_combine (const Model *model1, const Model *model2, const Rule *rule)
GSTLEARN_EXPORT int	db_rule_shadow (Db *db, Db *dbprop, RuleShadow *rule, Model *model1, const VectorDouble &props, int flag_stat, int nfacies)

Function Documentation

db_rule_shadow()

GSTLEARN_EXPORT int db_rule_shadow	(	Db *	db,
		Db *	dbprop,
		RuleShadow *	rule,
		Model *	model,
		const VectorDouble &	props,
		int	flag_stat,
		int	nfacies
	)

Apply the Rule transformation to the GRFs of a Db (Shadow case)

Returns

Error return code

Parameters

[in]	db	Output Db structure
[in]	dbprop	Db structure used for proportions (non-stationary case)
[in]	rule	Lithotype Rule definition
[in]	model	First Model structure (only for SHIFT)
[in]	props	Array of proportions for the facies
[in]	flag_stat	1 for stationary; 0 otherwise
[in]	nfacies	Number of facies

Remarks

The input variable must be locatorized as Z or ELoc::SIMU

It will be changed in this function to locator ELoc::SIMU

get_rule_extreme()

GSTLEARN_EXPORT double get_rule_extreme

(

int

mode

)

Get the lower or upper bound

Returns

Lower of Upper Bound

Parameters

[in]

mode

<0 for lower bound; >0 for upper bound

get_rule_mode()

GSTLEARN_EXPORT int get_rule_mode

(

void

)

Get the current Rule Mode

Returns

Returns the current mode (1 for Gaussian; 0 for Raw)

model_rule_combine()

GSTLEARN_EXPORT Model* model_rule_combine	(	const Model *	model1,
		const Model *	model2,
		const Rule *	rule
	)

Combine two basic models into a bivariate model (residuals model)

Returns

The newly Model structure

Parameters

[in]	model1	First input Model
[in]	model2	Second input Model
[in]	rule	Rule

Remarks

: The drift is not copied into the new model

rule_free()

GSTLEARN_EXPORT Rule* rule_free

(

const Rule *

rule

)

Free a Rule structure

Returns

Pointer to the newly freed Rule structure

Parameters

[in]

rule

Rule structure to be freed

set_rule_mode()

GSTLEARN_EXPORT void set_rule_mode

(

int

rule_mode

)

Set the Rule Mode

Parameters

[in]

rule_mode

1 for Gaussian; 0 for absence of conversion

Remarks

The absence of conversion is used in order to evaluate the

real thresholds along the rule for representing the rule

by proportions rather than in gaussian scale