CalcSimuTurningBands Class Reference

#include <CalcSimuTurningBands.hpp>

Inheritance diagram for CalcSimuTurningBands:

Public Member Functions
	CalcSimuTurningBands (int nbsimu=0, int nbtuba=0, bool flag_check=false, int seed=4324324)
	CalcSimuTurningBands (const CalcSimuTurningBands &r)=delete
CalcSimuTurningBands &	operator= (const CalcSimuTurningBands &r)=delete
virtual	~CalcSimuTurningBands ()
int	getNBtuba () const
void	setNBtuba (int nbtuba)
int	getNDirs () const
int	simulate (Db *dbin, Db *dbout, Model *model, ANeigh *neigh, int icase, int flag_bayes=false, const VectorDouble &dmean=VectorDouble(), const MatrixSquareSymmetric &dcov=MatrixSquareSymmetric(), bool flag_pgs=false, bool flag_gibbs=false, bool flag_dgm=false)
int	simulatePotential (Db *dbiso, Db *dbgrd, Db *dbtgt, Db *dbout, Model *model, double delta)
const MatrixSquareSymmetric &	getBayesCov () const
void	setBayesCov (const MatrixSquareSymmetric &bayes_cov)
const VectorDouble &	getBayesMean () const
void	setBayesMean (const VectorDouble &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)
int	getIcase () const
void	setIcase (int icase)
int	getNbtuba () const
void	setNbtuba (int nbtuba)
void	setFlagAllocationAlreadyDone (int flag)
Public Member Functions inherited from ACalcSimulation
	ACalcSimulation (int nbsimu, int seed=4324324)
	ACalcSimulation (const ACalcSimulation &r)=delete
ACalcSimulation &	operator= (const ACalcSimulation &r)=delete
virtual	~ACalcSimulation ()
int	getSeed () const
int	getNbSimu () const
void	setSeed (int seed)
void	setNbSimu (int nbsimu)
Public Member Functions inherited from ACalcInterpolator
	ACalcInterpolator ()
	ACalcInterpolator (const ACalcInterpolator &r)=delete
ACalcInterpolator &	operator= (const ACalcInterpolator &r)=delete
virtual	~ACalcInterpolator ()
void	setModel (Model *model)
void	setNeigh (ANeigh *neigh)
Model *	getModel () const
ANeigh *	getNeigh () const
bool	hasModel (bool verbose=true) const
bool	hasNeigh (bool verbose=true) const
Public Member Functions inherited from 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 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]

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

CalcSimuTurningBands() [2/2]

CalcSimuTurningBands::CalcSimuTurningBands ( const CalcSimuTurningBands &  r )

delete

~CalcSimuTurningBands()

CalcSimuTurningBands::~CalcSimuTurningBands ( )

virtual

Member Function Documentation

getBayesCov()

const MatrixSquareSymmetric& CalcSimuTurningBands::getBayesCov ( ) const

inline

getBayesMean()

const VectorDouble& CalcSimuTurningBands::getBayesMean ( ) const

inline

getIcase()

int CalcSimuTurningBands::getIcase ( ) const

inline

getNBtuba()

int CalcSimuTurningBands::getNBtuba ( ) const

inline

getNbtuba()

int CalcSimuTurningBands::getNbtuba ( ) const

inline

getNDirs()

int CalcSimuTurningBands::getNDirs ( ) const

inline

isFlagBayes()

bool CalcSimuTurningBands::isFlagBayes ( ) const

inline

isFlagCheck()

bool CalcSimuTurningBands::isFlagCheck ( ) const

inline

isFlagGibbs()

bool CalcSimuTurningBands::isFlagGibbs ( ) const

inline

isFlagPgs()

bool CalcSimuTurningBands::isFlagPgs ( ) const

inline

isValidForTurningBands()

bool 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& CalcSimuTurningBands::operator= ( const CalcSimuTurningBands &  r )

delete

setBayesCov()

void CalcSimuTurningBands::setBayesCov ( const MatrixSquareSymmetric &  bayes_cov )

inline

setBayesMean()

void CalcSimuTurningBands::setBayesMean ( const VectorDouble &  dmean )

inline

setFlagAllocationAlreadyDone()

void CalcSimuTurningBands::setFlagAllocationAlreadyDone ( int  flag )

inline

setFlagBayes()

void CalcSimuTurningBands::setFlagBayes ( bool  flag_bayes )

inline

setFlagCheck()

void CalcSimuTurningBands::setFlagCheck ( bool  flag_check )

inline

setFlagDgm()

void CalcSimuTurningBands::setFlagDgm ( bool  flag_dgm )

inline

setFlagGibbs()

void CalcSimuTurningBands::setFlagGibbs ( bool  flag_gibbs )

inline

setFlagPgs()

void CalcSimuTurningBands::setFlagPgs ( bool  flag_pgs )

inline

setIcase()

void CalcSimuTurningBands::setIcase ( int  icase )

inline

setNBtuba()

void CalcSimuTurningBands::setNBtuba ( int  nbtuba )

inline

setNbtuba()

void CalcSimuTurningBands::setNbtuba ( int  nbtuba )

inline

simulate()

int CalcSimuTurningBands::simulate	(	Db *	dbin,
		Db *	dbout,
		Model *	model,
		ANeigh *	neigh,
		int	icase,
		int	flag_bayes = false,
		const VectorDouble &	dmean = VectorDouble(),
		const MatrixSquareSymmetric &	dcov = MatrixSquareSymmetric(),
		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()

int 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