LBIBCell
 All Classes Functions Variables Friends Pages
GlobalSimulationParameters.hpp
1 /* Copyright (c) 2013 David Sichau <mail"at"sichau"dot"eu>
2  * 2013-2015 Simon Tanaka <tanakas"at"gmx"dot"ch>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 #ifndef GLOBALSIMULATIONPARAMETERS_HPP
23 #define GLOBALSIMULATIONPARAMETERS_HPP
24 
25 #include <UtilLib/include/Singleton.hpp>
26 #include <map>
27 #include <string>
28 #include <vector>
29 
30 namespace LbmLib {
36  public:
41 
47  void loadGlobalSimulationParameters(const std::string& fileName);
48 
54  void writeGlobalSimulationParameters(const std::string& fileName) const;
55 
59  void printParameters() const;
60 
66  unsigned int getCurrentIteration() const {
67  return currentIteration_;
68  }
69 
75  unsigned int getIterations() const {
76  return iterations_;
77  }
78 
84  unsigned int getReportSteps() const {
85  return reportSteps_;
86  }
87 
92  void setReportSteps(unsigned int steps) {
93  this->reportSteps_ = steps;
94  }
95 
100  double getTauFluid() const {
101  return tauFluid_;
102  }
103 
109  unsigned int getSizeX() const {
110  return sizeX_;
111  }
112 
118  unsigned int getSizeY() const {
119  return sizeY_;
120  }
121 
127  const std::map<std::string, double>& getCdeSolvers() const {
128  return cdeSolvers_;
129  }
130 
136  unsigned int operator++(int integer) {
137  return currentIteration_++;
138  }
139 
140  private:
144  unsigned int currentIteration_;
145 
149  unsigned int iterations_;
150 
154  unsigned int reportSteps_;
155 
159  unsigned int sizeX_;
160 
164  unsigned int sizeY_;
165 
169  double tauFluid_;
170 
174  std::map<std::string, double> cdeSolvers_;
175 };
176 
177 
182 globalSimulationParametersSingleton_;
183 
189 static GlobalSimulationParameters_& Parameters =
191 } // end namespace
192 
193 #endif // GLOBALSIMULATIONPARAMETERS_HPP
unsigned int getIterations() const
getter for the number of iterations the simulation should be executed
The class which stores all parameters. Do not instantiate this class but use the singleton provided b...
unsigned int operator++(int integer)
increment operator to increase the current iterations
unsigned int getReportSteps() const
getter for the report steps
unsigned int getSizeX() const
getter for the size x
static T & instance()
Definition: Singleton.hpp:90
const std::map< std::string, double > & getCdeSolvers() const
getter for the cdeSolvers and their tau's
void loadGlobalSimulationParameters(const std::string &fileName)
loads the parameters from the file
double getTauFluid() const
getter for the tau of the fluid
GlobalSimulationParameters_()
the class that stores all parameters related to the simulation
void setReportSteps(unsigned int steps)
setReportSteps
void printParameters() const
prints the parameters to the standard output
unsigned int getCurrentIteration() const
getter for the current iterations
unsigned int getSizeY() const
getter for the size y
void writeGlobalSimulationParameters(const std::string &fileName) const
writes all parameters to the file