-
Notifications
You must be signed in to change notification settings - Fork 28
/
linear.h
98 lines (80 loc) · 3.36 KB
/
linear.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
Copyright (C) 2018-2024 by the authors of the World Builder code.
This file is part of the World Builder.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef WORLD_BUILDER_FEATURES_MANTLE_LAYER_MODELS_TEMPERATURE_LINEAR_H
#define WORLD_BUILDER_FEATURES_MANTLE_LAYER_MODELS_TEMPERATURE_LINEAR_H
#include "world_builder/features/mantle_layer_models/temperature/interface.h"
#include "world_builder/features/feature_utilities.h"
#include "world_builder/objects/surface.h"
namespace WorldBuilder
{
namespace Features
{
using namespace FeatureUtilities;
namespace MantleLayerModels
{
namespace Temperature
{
/**
* This class represents a mantle layer and can implement submodules
* for temperature and composition. These submodules determine what
* the returned temperature or composition of the temperature and composition
* functions of this class will be.
*/
class Linear final: public Interface
{
public:
/**
* constructor
*/
Linear(WorldBuilder::World *world);
/**
* Destructor
*/
~Linear() override final;
/**
* declare and read in the world builder file into the parameters class
*/
static
void declare_entries(Parameters &prm, const std::string &parent_name = "");
/**
* declare and read in the world builder file into the parameters class
*/
void parse_entries(Parameters &prm, const std::vector<Point<2>> &coordinates) override final;
/**
* Returns a temperature based on the given position, depth in the model,
* gravity and current temperature.
*/
double get_temperature(const Point<3> &position,
const Objects::NaturalCoordinate &position_in_natural_coordinates,
const double depth,
const double gravity,
double temperature,
const double feature_min_depth,
const double feature_max_depth) const override final;
private:
// linear temperature submodule parameters
double min_depth;
Objects::Surface min_depth_surface;
double max_depth;
Objects::Surface max_depth_surface;
double top_temperature;
double bottom_temperature;
Operations operation;
};
} // namespace Temperature
} // namespace MantleLayerModels
} // namespace Features
} // namespace WorldBuilder
#endif