gstlrn::SimuSpectral Class Reference

#include <SimuSpectral.hpp>

Detailed Description

Class for operating the Spectral simulations

Public Member Functions
	SimuSpectral (const Model *model=nullptr)
	SimuSpectral (const SimuSpectral &r)
SimuSpectral &	operator= (const SimuSpectral &r)
virtual	~SimuSpectral ()
Id	simulate (Id ns, Id seed=4273, bool verbose=false, Id nd=100)
Id	compute (Db *dbout, Id iuid=0, bool verbose=false, const NamingConvention &namconv=NamingConvention("Simu"))
void	setModel (const Model *&model)
void	setNdim (Id ndim)
void	setNs (Id ns)

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

Constructor & Destructor Documentation

SimuSpectral() [1/2]

gstlrn::SimuSpectral::SimuSpectral

(

const Model *

model = nullptr

)

SimuSpectral() [2/2]

gstlrn::SimuSpectral::SimuSpectral

(

const SimuSpectral &

r

)

~SimuSpectral()

gstlrn::SimuSpectral::~SimuSpectral ( )

virtual

Member Function Documentation

compute()

Id gstlrn::SimuSpectral::compute	(	Db *	dbout,
		Id	iuid = 0,
		bool	verbose = false,
		const NamingConvention &	namconv = NamingConvention("Simu")
	)

Compute the simulation on Dbout using Spectral Method

Parameters

dbout	Db containing the results
iuid	Address for storage (or 0 if the variable must be created locally)
verbose	Verbose flag
namconv	Naming convention (only used when 'iuid' == 0)

isValidForSpectral()

bool gstlrn::SimuSpectral::isValidForSpectral ( const Model *  model )

static

Check if the Model can be simulated using Spectral Method

Returns

True if the Model is valid; 0 otherwise

Parameters

[in]

model

Model structure

operator=()

SimuSpectral & gstlrn::SimuSpectral::operator=

(

const SimuSpectral &

r

)

setModel()

void gstlrn::SimuSpectral::setModel ( const Model *&  model )

inline

setNdim()

void gstlrn::SimuSpectral::setNdim ( Id  ndim )

inline

setNs()

void gstlrn::SimuSpectral::setNs ( Id  ns )

inline

simulate()

Id gstlrn::SimuSpectral::simulate	(	Id	ns,
		Id	seed = 4273,
		bool	verbose = false,
		Id	nd = 100
	)

Perpare the simulation context (This method works for Rn and Sphere)

Parameters

ns	Number of components
seed	Seed for random number generation 5à: avoid setting the seed)
verbose	Verbose flag
nd	Number of discretization of the spectrum

---

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

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