Potential.hpp File Reference

#include "gstlearn_export.hpp"
#include "geoslib_define.h"
#include "Basic/VectorNumT.hpp"

Functions
GSTLEARN_EXPORT int	potential_kriging (Db *db, Db *dbgrd, Db *dbtgt, DbGrid *dbout, Model *model, ANeigh *neigh, double nugget_grd=0., double nugget_tgt=0., bool flag_pot=true, bool flag_grad=false, bool flag_trans=false, bool flag_save_data=false, int opt_part=0, bool verbose=false)
GSTLEARN_EXPORT int	potential_cov (Model *model, bool verbose, int type1, const VectorDouble &x10, const VectorDouble &x1p, const VectorDouble &tx1, int type2, const VectorDouble &x20, const VectorDouble &x2p, const VectorDouble &tx2, VectorDouble &covtab)
GSTLEARN_EXPORT int	potential_simulate (Db *dbiso, Db *dbgrd, Db *dbtgt, DbGrid *dbout, Model *model, ANeigh *neigh, double nugget_grd=0., double nugget_tgt=0., double dist_tempere=TEST, bool flag_trans=false, int seed=135674, int nbsimu=1, int nbtuba=100, bool verbose=false)
GSTLEARN_EXPORT int	potential_xvalid (Db *dbiso, Db *dbgrd, Db *dbtgt, Model *model, ANeigh *neigh, double nugget_grd=0., double nugget_tgt=0., bool flag_dist_conv=false, bool verbose=false)

Function Documentation

potential_cov()

GSTLEARN_EXPORT int potential_cov	(	Model *	model,
		bool	verbose,
		int	type1,
		const VectorDouble &	x10,
		const VectorDouble &	x1p,
		const VectorDouble &	tx1,
		int	type2,
		const VectorDouble &	x20,
		const VectorDouble &	x2p,
		const VectorDouble &	tx2,
		VectorDouble &	covtab
	)

Potential covariance

Returns

Error return code

Parameters

[in]	model	Model structure
[in]	verbose	Verbose flag
[in]	type1	Type of the first point 1 for gradient; 2 for tangent; 3 for isopotential
[in]	x10	Coordinates of the centering for first point
[in]	x1p	Coordinates of the first point
[in]	tx1	Tangent values at the first point
[in]	type2	Type of the second point 1 for gradient; 2 for tangent; 3 for isopotential (Sign is negative for target point)
[in]	x20	Coordinates of the centering for second point
[in]	x2p	Coordinates of the second point
[in]	tx2	Tangent values at the second point
[out]	covtab	Array of returned values (dimensionned to ndim*ndim)

potential_kriging()

GSTLEARN_EXPORT int potential_kriging	(	Db *	dbiso,
		Db *	dbgrd,
		Db *	dbtgt,
		DbGrid *	dbout,
		Model *	model,
		ANeigh *	neigh,
		double	nugget_grd,
		double	nugget_tgt,
		bool	flag_pot,
		bool	flag_grad,
		bool	flag_trans,
		bool	flag_save_data,
		int	opt_part,
		bool	verbose
	)

Potential estimation

Returns

Error return code

Parameters

[in]	dbiso	Iso-potential Db structure
[in]	dbgrd	Gradient Db structure
[in]	dbtgt	Tangent Db structure (optional)
[in]	dbout	Output Db structure
[in]	model	Model structure
[in]	neigh	ANeigh structure
[in]	nugget_grd	Nugget effect for Gradients
[in]	nugget_tgt	Nugget effect for Tangents
[in]	flag_pot	True if the Potential must be estimated
[in]	flag_grad	True if the gradient must also be estimated
[in]	flag_trans	True if the estimation result must be translated into layer number
[in]	flag_save_data	True if the Potential / Gradient must be saved on any Information file
[in]	opt_part	Option to exhibit only a part of estimation: 0 : the whole estimation 1 : the gradient contribution only 2 : the tangent contribution only 3 : the isovalues contribution only 4 : the drift contribution only 5 : the external drift contribution only
[in]	verbose	Verbose option

Remarks

The results will be stored in the dbout file

- the estimation in the variable ELoc::Z

- the gradient components in the variables ELoc::GRD

potential_simulate()

GSTLEARN_EXPORT int potential_simulate	(	Db *	dbiso,
		Db *	dbgrd,
		Db *	dbtgt,
		DbGrid *	dbout,
		Model *	model,
		ANeigh *	neigh,
		double	nugget_grd,
		double	nugget_tgt,
		double	dist_tempere,
		bool	flag_trans,
		int	seed,
		int	nbsimu,
		int	nbtuba,
		bool	verbose
	)

Potential simulations

Returns

Error return code

Parameters

[in]	dbiso	Iso-potential Db structure
[in]	dbgrd	Gradient Db structure
[in]	dbtgt	Tangent Db structure (optional)
[in]	dbout	Output Db structure
[in]	model	Model structure
[in]	neigh	ANeigh structure
[in]	nugget_grd	Nugget effect for Gradients
[in]	nugget_tgt	Nugget effect for Tangents
[in]	dist_tempere	Distance for tempering simulations (or TEST)
[in]	flag_trans	True if the estimation result must be translated into layer number
[in]	seed	Seed for the random number generator
[in]	nbsimu	Number of simulations
[in]	nbtuba	Number of turning bands
[in]	verbose	Verbose option

Remarks

The simulations will be stored in the dbout file (ELoc::SIMU)

potential_xvalid()

GSTLEARN_EXPORT int potential_xvalid	(	Db *	dbiso,
		Db *	dbgrd,
		Db *	dbtgt,
		Model *	model,
		ANeigh *	neigh,
		double	nugget_grd,
		double	nugget_tgt,
		bool	flag_dist_conv,
		bool	verbose
	)

Potential cross-validation

Returns

Error return code

Parameters

[in]	dbiso	Iso-potential Db structure
[in]	dbgrd	Gradient Db structure
[in]	dbtgt	Tangent Db structure (optional)
[in]	model	Model structure
[in]	neigh	ANeigh structure
[in]	nugget_grd	Nugget effect for Gradients
[in]	nugget_tgt	Nugget effect for Tangents
[in]	flag_dist_conv	Flag for converting into distance
[in]	verbose	Verbose option