gstlrn::CalcSimuTurningBands Class Reference

#include <CalcSimuTurningBands.hpp>

Inheritance diagram for gstlrn::CalcSimuTurningBands:

Public Member Functions
	CalcSimuTurningBands (Id nbsimu=0, Id nbtuba=0, bool flag_check=false, 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, const 1 &dmean=1(), const MatrixSymmetric &dcov=MatrixSymmetric(), bool flag_pgs=false, bool flag_gibbs=false, bool flag_dgm=false)
Id	simulatePotential (Db *dbiso, Db *dbgrd, Db *dbtgt, Db *dbout, Model *model, double delta)
const MatrixSymmetric &	getBayesCov () const
void	setBayesCov (const MatrixSymmetric &bayes_cov)
const &	getBayesMean () const
void	setBayesMean (const 1 &dmean)
bool	isFlagCheck () const
void	setFlagCheck (bool flag_check)
bool	isFlagBayes () const
void	setFlagBayes (bool flag_bayes)
void	setFlagDgm (bool flag_dgm)
bool	isFlagGibbs () const
void	setFlagGibbs (bool flag_gibbs)
bool	isFlagPgs () const
void	setFlagPgs (bool flag_pgs)
Id	getIcase () const
void	setIcase (Id icase)
Id	getNbtuba () const
void	setNbtuba (Id nbtuba)
void	setFlagAllocationAlreadyDone (Id flag)
Public Member Functions inherited from gstlrn::ACalcSimulation
	ACalcSimulation (Id nbsimu, Id seed=4324324)
	ACalcSimulation (const ACalcSimulation &r)=delete
ACalcSimulation &	operator= (const ACalcSimulation &r)=delete
virtual	~ACalcSimulation ()
Id	getSeed () const
Id	getNbSimu () const
void	setSeed (Id seed)
void	setNbSimu (Id nbsimu)
Public Member Functions inherited from gstlrn::ACalcInterpolator
	ACalcInterpolator ()
	ACalcInterpolator (const ACalcInterpolator &r)=delete
ACalcInterpolator &	operator= (const ACalcInterpolator &r)=delete
virtual	~ACalcInterpolator ()
void	setModel (ModelGeneric *model)
void	setNeigh (ANeigh *neigh)
void	setKrigopt (const KrigOpt &krigopt)
ModelGeneric *	getModel () const
ANeigh *	getNeigh () const
const KrigOpt &	getKrigopt () const
bool	hasModel (bool verbose=true) const
bool	hasNeigh (bool verbose=true) const
Public Member Functions inherited from gstlrn::ACalcDbToDb
	ACalcDbToDb (bool mustShareSameSpaceDimension=true)
	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
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 ()
	ACalculator (const ACalculator &r)=delete
ACalculator &	operator= (const ACalculator &r)=delete
virtual	~ACalculator ()
bool	run ()

Static Public Member Functions
static bool	isValidForTurningBands (const Model *model)

Constructor & Destructor Documentation

CalcSimuTurningBands() [1/2]

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

CalcSimuTurningBands() [2/2]

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

delete

~CalcSimuTurningBands()

gstlrn::CalcSimuTurningBands::~CalcSimuTurningBands ( )

virtual

Member Function Documentation

getBayesCov()

const MatrixSymmetric & gstlrn::CalcSimuTurningBands::getBayesCov ( ) const

inline

getBayesMean()

const & gstlrn::CalcSimuTurningBands::getBayesMean ( ) const

inline

getIcase()

Id gstlrn::CalcSimuTurningBands::getIcase ( ) const

inline

getNBtuba()

Id gstlrn::CalcSimuTurningBands::getNBtuba ( ) const

inline

getNbtuba()

Id gstlrn::CalcSimuTurningBands::getNbtuba ( ) const

inline

getNDirs()

Id gstlrn::CalcSimuTurningBands::getNDirs ( ) const

inline

isFlagBayes()

bool gstlrn::CalcSimuTurningBands::isFlagBayes ( ) const

inline

isFlagCheck()

bool gstlrn::CalcSimuTurningBands::isFlagCheck ( ) const

inline

isFlagGibbs()

bool gstlrn::CalcSimuTurningBands::isFlagGibbs ( ) const

inline

isFlagPgs()

bool gstlrn::CalcSimuTurningBands::isFlagPgs ( ) const

inline

isValidForTurningBands()

bool gstlrn::CalcSimuTurningBands::isValidForTurningBands ( const Model *  model )

static

Check if the Model can be simulated using Turning Bands

Returns

True if the Model is valid; 0 otherwise

Parameters

[in]

model

Model structure

operator=()

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

delete

setBayesCov()

void gstlrn::CalcSimuTurningBands::setBayesCov ( const MatrixSymmetric &  bayes_cov )

inline

setBayesMean()

void gstlrn::CalcSimuTurningBands::setBayesMean ( const 1 &  dmean )

inline

setFlagAllocationAlreadyDone()

void gstlrn::CalcSimuTurningBands::setFlagAllocationAlreadyDone ( Id  flag )

inline

setFlagBayes()

void gstlrn::CalcSimuTurningBands::setFlagBayes ( bool  flag_bayes )

inline

setFlagCheck()

void gstlrn::CalcSimuTurningBands::setFlagCheck ( bool  flag_check )

inline

setFlagDgm()

void gstlrn::CalcSimuTurningBands::setFlagDgm ( bool  flag_dgm )

inline

setFlagGibbs()

void gstlrn::CalcSimuTurningBands::setFlagGibbs ( bool  flag_gibbs )

inline

setFlagPgs()

void gstlrn::CalcSimuTurningBands::setFlagPgs ( bool  flag_pgs )

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,
		const 1 &	dmean = 1(),
		const MatrixSymmetric &	dcov = MatrixSymmetric(),
		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]	dmean	Array giving the prior means for the drift terms
[in]	dcov	Array containing the prior covariance matrix for the drift terms
[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,
		Model *	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