The class which stores all parameters. Do not instantiate this class but use the singleton provided below. More...

#include <GlobalSimulationParameters.hpp>

Public Member Functions
	GlobalSimulationParameters_ ()
	the class that stores all parameters related to the simulation

void	loadGlobalSimulationParameters (const std::string &fileName)
	loads the parameters from the file More...

void	writeGlobalSimulationParameters (const std::string &fileName) const
	writes all parameters to the file More...

void	printParameters () const
	prints the parameters to the standard output

unsigned int	getCurrentIteration () const
	getter for the current iterations More...

unsigned int	getIterations () const
	getter for the number of iterations the simulation should be executed More...

unsigned int	getReportSteps () const
	getter for the report steps More...

void	setReportSteps (unsigned int steps)
	setReportSteps More...

double	getTauFluid () const
	getter for the tau of the fluid More...

unsigned int	getSizeX () const
	getter for the size x More...

unsigned int	getSizeY () const
	getter for the size y More...

const std::map< std::string, double > &	getCdeSolvers () const
	getter for the cdeSolvers and their tau's More...

unsigned int	operator++ (int integer)
	increment operator to increase the current iterations More...

Detailed Description

The class which stores all parameters. Do not instantiate this class but use the singleton provided below.

Definition at line 35 of file GlobalSimulationParameters.hpp.

Member Function Documentation

const std::map<std::string, double>& LbmLib::GlobalSimulationParameters_::getCdeSolvers ( ) const

inline

getter for the cdeSolvers and their tau's

Returns: list of the mapping

Definition at line 127 of file GlobalSimulationParameters.hpp.

unsigned int LbmLib::GlobalSimulationParameters_::getCurrentIteration ( ) const

inline

getter for the current iterations

Returns: the current iterations

Definition at line 66 of file GlobalSimulationParameters.hpp.

unsigned int LbmLib::GlobalSimulationParameters_::getIterations ( ) const

inline

getter for the number of iterations the simulation should be executed

Returns: the number iterations

Definition at line 75 of file GlobalSimulationParameters.hpp.

unsigned int LbmLib::GlobalSimulationParameters_::getReportSteps ( ) const

inline

getter for the report steps

Returns: the number of report steps

Definition at line 84 of file GlobalSimulationParameters.hpp.

unsigned int LbmLib::GlobalSimulationParameters_::getSizeX ( ) const

inline

getter for the size x

Returns: the size x of the simulation

Definition at line 109 of file GlobalSimulationParameters.hpp.

unsigned int LbmLib::GlobalSimulationParameters_::getSizeY ( ) const

inline

getter for the size y

Returns: the size y of the simulaton

Definition at line 118 of file GlobalSimulationParameters.hpp.

double LbmLib::GlobalSimulationParameters_::getTauFluid ( ) const

inline

getter for the tau of the fluid

Returns: the tau of the fluid

Definition at line 100 of file GlobalSimulationParameters.hpp.

void LbmLib::GlobalSimulationParameters_::loadGlobalSimulationParameters ( const std::string & fileName )

loads the parameters from the file

Parameters

fileName the filename

Definition at line 34 of file GlobalSimulationParameters.cpp.

unsigned int LbmLib::GlobalSimulationParameters_::operator++ ( int integer )

inline

increment operator to increase the current iterations

Parameters

integer the incremented

Returns: the number of current iterations

Definition at line 136 of file GlobalSimulationParameters.hpp.

void LbmLib::GlobalSimulationParameters_::setReportSteps ( unsigned int steps )

inline

setReportSteps

Parameters

steps

Definition at line 92 of file GlobalSimulationParameters.hpp.

void LbmLib::GlobalSimulationParameters_::writeGlobalSimulationParameters ( const std::string & fileName ) const

writes all parameters to the file

Parameters

fileName the filename

Definition at line 74 of file GlobalSimulationParameters.cpp.

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

/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/include/GlobalSimulationParameters.hpp
/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/src/GlobalSimulationParameters.cpp

Public Member Functions

Detailed Description

Member Function Documentation