World Builder  0.1.0-pre
A geodyanmic initial conditions generator
world.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2018 by the authors of the World Builder code.
3 
4  This file is part of the World Builder.
5 
6  This program is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published
8  by the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19 
20 #ifndef _world_builder_world_h
21 #define _world_builder_world_h
22 
23 
24 #include <boost/property_tree/ptree.hpp>
25 
27 
28 using boost::property_tree::ptree;
29 
30 
31 namespace WorldBuilder
32 {
33  namespace Features
34  {
35  class Interface;
36  }
37 
38  class World
39  {
40  public:
45  World(std::string filename);
46 
50  ~World();
51 
55  void declare_and_parse(Parameters &parameters);
56 
57  double temperature(const std::array<double, 2> &point, const double depth, const double gravity_norm) const;
58 
59  double temperature(const std::array<double, 3> &point, const double depth, const double gravity_norm) const;
60 
61 
62  bool composition(const std::array<double, 2> &point, const double depth, const unsigned int composition_number) const;
63 
64  bool composition(const std::array<double, 3> &point, const double depth, const unsigned int composition_number) const;
65 
69  static const char path_seperator = '.';
70 
71 
73 
74  private:
75  unsigned int dim;
76 
77 
78 
79 
80 
81 
82  };
83 }
84 
85 #endif
Parameters parameters
Definition: world.h:72