gstlrn::Potential Class Reference

#include <Potential.hpp>

Public Member Functions
	Potential (Db *dbiso, Db *dbgrd, Db *dbtgt, ModelGeneric *model, double nugget_grd=0., double nugget_tgt=0.)
	Potential (const Potential &r)=delete
Potential &	operator= (const Potential &r)=delete
virtual	~Potential ()
void	setVerbose (bool value)
Id	kriging (DbGrid *dbout, bool flag_pot=true, bool flag_grad=false, bool flag_trans=false, bool flag_save_data=false, Id option_part=0)
Id	simulate (DbGrid *dbout, double dist_tempere=TEST, bool flag_trans=false, Id seed=13443, Id nbsimu=1, Id nbtuba=100)
Id	xvalid (bool flag_dist_conv)

Constructor & Destructor Documentation

Potential() [1/2]

gstlrn::Potential::Potential	(	Db *	dbiso,
		Db *	dbgrd,
		Db *	dbtgt,
		ModelGeneric *	model,
		double	nugget_grd = 0.,
		double	nugget_tgt = 0.
	)

Potential() [2/2]

gstlrn::Potential::Potential ( const Potential &  r )

delete

~Potential()

gstlrn::Potential::~Potential ( )

virtual

Member Function Documentation

kriging()

Id gstlrn::Potential::kriging	(	DbGrid *	dbout,
		bool	flag_pot = true,
		bool	flag_grad = false,
		bool	flag_trans = false,
		bool	flag_save_data = false,
		Id	option_part = 0
	)

Potential estimation

Returns

Error return code

Parameters

[in]	dbout	Output Db structure
[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]	option_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

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

operator=()

Potential & gstlrn::Potential::operator= ( const Potential &  r )

delete

setVerbose()

void gstlrn::Potential::setVerbose ( bool  value )

inline

simulate()

Id gstlrn::Potential::simulate	(	DbGrid *	dbout,
		double	dist_tempere = TEST,
		bool	flag_trans = false,
		Id	seed = 13443,
		Id	nbsimu = 1,
		Id	nbtuba = 100
	)

Potential simulations

Returns

Error return code

Parameters

[in]	dbout	Output Db structure
[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

Remarks

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

xvalid()

Id gstlrn::Potential::xvalid

(

bool

flag_dist_conv

)

Potential cross-validation

Returns

Error return code

Parameters

[in]

flag_dist_conv

Flag for converting into distance

---

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

• include/API/Potential.hpp
• src/API/Potential.cpp