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 ()
int	simulate (int ns, int seed=4273, bool verbose=false, int nd=100)
int	compute (Db *dbout, int iuid=0, bool verbose=false, const NamingConvention &namconv=NamingConvention("Simu"))
bool	isValidForSpectral (const Model *model) const
void	setModel (const Model *&model)
void	setNdim (int ndim)
void	setNs (int ns)

Constructor & Destructor Documentation

SimuSpectral() [1/2]

SimuSpectral::SimuSpectral

(

const Model *

model = nullptr

)

SimuSpectral() [2/2]

SimuSpectral::SimuSpectral

(

const SimuSpectral &

r

)

~SimuSpectral()

SimuSpectral::~SimuSpectral ( )

virtual

Member Function Documentation

compute()

int SimuSpectral::compute	(	Db *	dbout,
		int	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 SimuSpectral::isValidForSpectral

(

const Model *

model

)

const

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 & SimuSpectral::operator=

(

const SimuSpectral &

r

)

setModel()

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

inline

setNdim()

void SimuSpectral::setNdim ( int  ndim )

inline

setNs()

void SimuSpectral::setNs ( int  ns )

inline

simulate()

int SimuSpectral::simulate	(	int	ns,
		int	seed = 4273,
		bool	verbose = false,
		int	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