gstlrn::SPDEParam Class Reference

Definition of the parameters used within SPDE. More...

#include <SPDEParam.hpp>

Inheritance diagram for gstlrn::SPDEParam:

Detailed Description

Definition of the parameters used within SPDE.

refineK Discretization factor used for Kriging refineS Discretization factor used for Simulation border Border size nxmax Maximum number of vertices in the internal mesh (0 : no limit) epsNugget Nugget effect useStencil Default option for no Cholesky (can only be used in stationary case for Turbo Meshing) nMC Number of Monte-Carlo simulations (used for Variance and logdet) seedMC Seed for the random number generator (used for Variance and logdet)

cgparams Parameters for the Conjugate Gradient method

Public Member Functions
	SPDEParam (Id refineK=11, Id refineS=18, Id border=8, bool flag_polarized=true, Id nxmax=300, double epsNugget=EPSILON2, bool useStencil=true, Id nMC=10, Id seedMC=134341, const CGParam &cgparams=CGParam())
	SPDEParam (const SPDEParam &m)
SPDEParam &	operator= (const SPDEParam &m)
virtual	~SPDEParam ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable Interface.
Id	getBorder () const
CGParam	getCGparams () const
double	getEpsNugget () const
Id	getRefineK () const
Id	getRefineS () const
bool	isPolarized () const
void	setPolarized (bool flagPolarized)
Id	getNxMax () const
bool	getUseStencil () const
Id	getNMC () const
Id	getSeedMC () const
void	setBorder (Id border)
void	setCGparams (const CGParam &CGparams)
void	setEpsNugget (double epsNugget)
void	setRefineK (Id refineK)
void	setRefineS (Id refineS)
void	setNxMax (Id nxmax)
void	setUseStencil (bool useStencil)
void	setNMC (Id nMC)
void	setSeedMC (Id seedMC)
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final

Static Public Member Functions
static SPDEParam *	create (Id refineK=11, Id refineS=18, Id border=8, bool flag_polarized=true, Id nxmax=300, double epsNugget=EPSILON2, bool useStencil=true, Id nMC=10, Id seedMC=134341, const CGParam &cgparams=CGParam())

Constructor & Destructor Documentation

SPDEParam() [1/2]

gstlrn::SPDEParam::SPDEParam	(	Id	refineK = 11,
		Id	refineS = 18,
		Id	border = 8,
		bool	flag_polarized = true,
		Id	nxmax = 300,
		double	epsNugget = EPSILON2,
		bool	useStencil = true,
		Id	nMC = 10,
		Id	seedMC = 134341,
		const CGParam &	cgparams = CGParam()
	)

SPDEParam() [2/2]

gstlrn::SPDEParam::SPDEParam

(

const SPDEParam &

m

)

~SPDEParam()

gstlrn::SPDEParam::~SPDEParam ( )

virtual

Member Function Documentation

create()

SPDEParam * gstlrn::SPDEParam::create ( Id  refineK = 11, Id  refineS = 18, Id  border = 8, bool  flag_polarized = true, Id  nxmax = 300, double  epsNugget = EPSILON2, bool  useStencil = true, Id  nMC = 10, Id  seedMC = 134341, const CGParam &  cgparams = CGParam()  )

static

getBorder()

Id gstlrn::SPDEParam::getBorder ( ) const

inline

getCGparams()

CGParam gstlrn::SPDEParam::getCGparams ( ) const

inline

getEpsNugget()

double gstlrn::SPDEParam::getEpsNugget ( ) const

inline

getNMC()

Id gstlrn::SPDEParam::getNMC ( ) const

inline

getNxMax()

Id gstlrn::SPDEParam::getNxMax ( ) const

inline

getRefineK()

Id gstlrn::SPDEParam::getRefineK ( ) const

inline

getRefineS()

Id gstlrn::SPDEParam::getRefineS ( ) const

inline

getSeedMC()

Id gstlrn::SPDEParam::getSeedMC ( ) const

inline

getUseStencil()

bool gstlrn::SPDEParam::getUseStencil ( ) const

inline

isPolarized()

bool gstlrn::SPDEParam::isPolarized ( ) const

inline

operator=()

SPDEParam & gstlrn::SPDEParam::operator=

(

const SPDEParam &

m

)

setBorder()

void gstlrn::SPDEParam::setBorder ( Id  border )

inline

setCGparams()

void gstlrn::SPDEParam::setCGparams ( const CGParam &  CGparams )

inline

setEpsNugget()

void gstlrn::SPDEParam::setEpsNugget ( double  epsNugget )

inline

setNMC()

void gstlrn::SPDEParam::setNMC ( Id  nMC )

inline

setNxMax()

void gstlrn::SPDEParam::setNxMax ( Id  nxmax )

inline

setPolarized()

void gstlrn::SPDEParam::setPolarized ( bool  flagPolarized )

inline

setRefineK()

void gstlrn::SPDEParam::setRefineK ( Id  refineK )

inline

setRefineS()

void gstlrn::SPDEParam::setRefineS ( Id  refineS )

inline

setSeedMC()

void gstlrn::SPDEParam::setSeedMC ( Id  seedMC )

inline

setUseStencil()

void gstlrn::SPDEParam::setUseStencil ( bool  useStencil )

inline

toString()

String gstlrn::SPDEParam::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

AStringable Interface.

Reimplemented from gstlrn::AStringable.

---

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

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