gstlrn::CalcSimuTurningBands Class Reference

#include <CalcSimuTurningBands.hpp>

Inheritance diagram for gstlrn::CalcSimuTurningBands:

Public Member Functions
	CalcSimuTurningBands (Id nbsimu=0, Id nbtuba=0, Id seed=4324324)
	CalcSimuTurningBands (const CalcSimuTurningBands &r)=delete
CalcSimuTurningBands &	operator= (const CalcSimuTurningBands &r)=delete
virtual	~CalcSimuTurningBands ()
Id	getNBtuba () const
void	setNBtuba (Id nbtuba)
Id	getNDirs () const
Id	simulate (Db *dbin, Db *dbout, Model *model, ANeigh *neigh, Id icase, Id flag_bayes=false, bool flag_pgs=false, bool flag_gibbs=false, bool flag_dgm=false)
Id	simulatePotential (Db *dbiso, Db *dbgrd, Db *dbtgt, Db *dbout, ModelGeneric *model, double delta)
void	setIcase (Id icase)
Id	getNbtuba () const
void	setNbtuba (Id nbtuba)
void	setBox (const 1 &box)
Public Member Functions inherited from gstlrn::ACalcSimuGaussian
	ACalcSimuGaussian (Id nbsimu=1, Id seed=4324324, bool verbose=false)
	ACalcSimuGaussian (const ACalcSimuGaussian &r)=delete
ACalcSimuGaussian &	operator= (const ACalcSimuGaussian &r)=delete
virtual	~ACalcSimuGaussian ()
Id	getNVar () const
void	saveResults (Db *db, Id isimu, const VectorBool &activeArray, const 1 &tab) const
	Save one multivariate simulation result into the Db.
void	setFlagBayes (bool flag_bayes)
void	setFlagDGM (bool flag_dgm)
void	setFlagGibbs (bool flag_gibbs)
void	setFlagPGS (bool flag_pgs)
void	setFlagOnGridOnly (bool flag_on_grid_only)
void	setFlagAllocationAlreadyDone (bool flag)
Public Member Functions inherited from gstlrn::ACalcSimulation
	ACalcSimulation (Id nbsimu=1, Id seed=4324324, bool verbose=false)
	ACalcSimulation (const ACalcSimulation &r)=delete
ACalcSimulation &	operator= (const ACalcSimulation &r)=delete
virtual	~ACalcSimulation ()
bool	isConditional () const
Id	getSeed () const
Id	getNbSimu () const
Id	getNVar () const
void	setShift (Id shift)
void	setSeed (Id seed)
void	setNbSimu (Id nbsimu)
Id	getSeedPerSimu (Id isimu) const
Public Member Functions inherited from gstlrn::ACalcInterpolator
	ACalcInterpolator (bool verbose=false)
	ACalcInterpolator (const ACalcInterpolator &r)=delete
ACalcInterpolator &	operator= (const ACalcInterpolator &r)=delete
virtual	~ACalcInterpolator ()
void	setModelGeneric (ModelGeneric *modelGeneric)
void	setNeigh (ANeigh *neigh)
void	setKrigopt (const KrigOpt &krigopt)
ModelGeneric *	getModelGeneric () const
ANeigh *	getNeigh () const
const KrigOpt &	getKrigopt () const
bool	hasModelGeneric (bool verbose=true) const
bool	hasNeigh (bool verbose=true) const
Public Member Functions inherited from gstlrn::ACalcDbToDb
	ACalcDbToDb (bool mustShareSameSpaceDimension=true, bool verbose=false)
	ACalcDbToDb (const ACalcDbToDb &r)=delete
ACalcDbToDb &	operator= (const ACalcDbToDb &r)=delete
virtual	~ACalcDbToDb ()
void	setDbin (Db *dbin)
void	setDbout (Db *dbout)
void	setNamingConvention (const NamingConvention &namconv)
void	setMustShareSpaceDimension (bool mustShareSpaceDimension)
Db *	getDbin () const
Db *	getDbout () const
DbGrid *	getGridin () const
DbGrid *	getGridout () const
const NamingConvention &	getNamingConvention () const
bool	hasDbin (bool verbose=true) const
bool	hasDbout (bool verbose=true) const
bool	isGridIn (bool verbose=true) const
bool	isGridOut (bool verbose=true) const
Public Member Functions inherited from gstlrn::ACalculator
	ACalculator (bool verbose=false)
	ACalculator (const ACalculator &r)=delete
ACalculator &	operator= (const ACalculator &r)=delete
virtual	~ACalculator ()
bool	run ()
bool	getVerbose () const
void	setVerbose (bool verbose)

Constructor & Destructor Documentation

CalcSimuTurningBands() [1/2]

gstlrn::CalcSimuTurningBands::CalcSimuTurningBands	(	Id	nbsimu = 0,
		Id	nbtuba = 0,
		Id	seed = 4324324
	)

CalcSimuTurningBands() [2/2]

gstlrn::CalcSimuTurningBands::CalcSimuTurningBands ( const CalcSimuTurningBands &  r )

delete

~CalcSimuTurningBands()

gstlrn::CalcSimuTurningBands::~CalcSimuTurningBands ( )

virtual

Member Function Documentation

getNBtuba()

Id gstlrn::CalcSimuTurningBands::getNBtuba ( ) const

inline

getNbtuba()

Id gstlrn::CalcSimuTurningBands::getNbtuba ( ) const

inline

getNDirs()

Id gstlrn::CalcSimuTurningBands::getNDirs ( ) const

inline

operator=()

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

delete

setBox()

void gstlrn::CalcSimuTurningBands::setBox ( const 1 &  box )

inline

setIcase()

void gstlrn::CalcSimuTurningBands::setIcase ( Id  icase )

inline

setNBtuba()

void gstlrn::CalcSimuTurningBands::setNBtuba ( Id  nbtuba )

inline

setNbtuba()

void gstlrn::CalcSimuTurningBands::setNbtuba ( Id  nbtuba )

inline

simulate()

Id gstlrn::CalcSimuTurningBands::simulate	(	Db *	dbin,
		Db *	dbout,
		Model *	model,
		ANeigh *	neigh,
		Id	icase,
		Id	flag_bayes = false,
		bool	flag_pgs = false,
		bool	flag_gibbs = false,
		bool	flag_dgm = false
	)

Perform the Simulation Process using the Turning Bands Method

Returns

Error return code

Parameters

[in]	dbin	Input Db structure
[in]	dbout	Output Db structure
[in]	model	Model structure
[in]	neigh	ANeigh structure
[in]	icase	Case for PGS or -1
[in]	flag_bayes	1 if the Bayes option is switched ON
[in]	flag_pgs	1 if called from PGS
[in]	flag_gibbs	1 if called from Gibbs
[in]	flag_dgm	1 if the Discrete Gaussian Model is used

simulatePotential()

Id gstlrn::CalcSimuTurningBands::simulatePotential	(	Db *	dbiso,
		Db *	dbgrd,
		Db *	dbtgt,
		Db *	dbout,
		ModelGeneric *	model,
		double	delta
	)

Perform the (non-conditional) Simulation(s) using the Turning Bands Method

Returns

Error return code

Parameters

[in]	dbiso	Isovalues Db structure
[in]	dbgrd	Gradient Db structure
[in]	dbtgt	Tangent Db structure
[in]	dbout	Output Db structure
[in]	model	Model structure
[in]	delta	Value of the increment

---

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

• include/Simulation/CalcSimuTurningBands.hpp
• src/Simulation/CalcSimuTurningBands.cpp