OGS
CreateHeatTransportBHEProcess.cpp
Go to the documentation of this file.
1
12
13#include <algorithm>
14#include <pybind11/pybind11.h>
15
16#include <vector>
17
18#include "BHE/BHETypes.h"
19#include "BHE/CreateBHE1PType.h"
21#include "BHE/CreateBHEUType.h"
24#include "ParameterLib/Utils.h"
26
27namespace ProcessLib
28{
29namespace HeatTransportBHE
30{
31std::unique_ptr<Process> createHeatTransportBHEProcess(
32 std::string const& name,
33 MeshLib::Mesh& mesh,
34 std::unique_ptr<ProcessLib::AbstractJacobianAssembler>&& jacobian_assembler,
35 std::vector<ProcessVariable> const& variables,
36 std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
37 unsigned const integration_order,
38 BaseLib::ConfigTree const& config,
39 std::map<std::string,
40 std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
41 curves,
42 std::map<int, std::shared_ptr<MaterialPropertyLib::Medium>> const& media)
43{
45 config.checkConfigParameter("type", "HEAT_TRANSPORT_BHE");
46
47 DBUG("Create HeatTransportBHE Process.");
48
50
52 auto const pv_config = config.getConfigSubtree("process_variables");
53 std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
54 process_variables;
55
56 // reading primary variables for each
57 // BHE----------------------------------------------------------
59 auto range =
61 pv_config.getConfigParameterList<std::string>("process_variable");
62 std::vector<std::reference_wrapper<ProcessVariable>> per_process_variables;
63
64 for (std::string const& pv_name : range)
65 {
66 if (pv_name != "temperature_soil" &&
67 pv_name.find("temperature_BHE") == std::string::npos)
68 {
70 "Found a process variable name '{}'. It should be "
71 "'temperature_soil' or 'temperature_BHE_X'",
72 pv_name);
73 }
74 auto variable = std::find_if(variables.cbegin(), variables.cend(),
75 [&pv_name](ProcessVariable const& v)
76 { return v.getName() == pv_name; });
77
78 if (variable == variables.end())
79 {
81 "Could not find process variable '{:s}' in the provided "
82 "variables list for config tag <{:s}>.",
83 pv_name, "process_variable");
84 }
85 DBUG("Found process variable '{:s}' for config tag <{:s}>.",
86 variable->getName(), "process_variable");
87
88 per_process_variables.emplace_back(
89 const_cast<ProcessVariable&>(*variable));
90 }
91 process_variables.push_back(std::move(per_process_variables));
92 // end of reading primary variables for each
93 // BHE----------------------------------------------------------
94
96 // reading BHE parameters --------------------------------------------------
97 std::vector<BHE::BHETypes> bhes;
98
99 auto const& bhe_configs =
101 config.getConfigSubtree("borehole_heat_exchangers");
102
103 auto const using_server_communication =
105 config.getConfigParameter<bool>("use_server_communication", false);
106
107 for (
108 auto const& bhe_config :
110 bhe_configs.getConfigSubtreeList("borehole_heat_exchanger"))
111 {
112 // read in the parameters
113 const std::string bhe_type =
115 bhe_config.getConfigParameter<std::string>("type");
116
117 if (bhe_type == "1U")
118 {
119 bhes.emplace_back(
120 BHE::createBHEUType<BHE::BHE_1U>(bhe_config, curves));
121 continue;
122 }
123
124 if (bhe_type == "CXA")
125 {
126 bhes.emplace_back(
127 BHE::createBHECoaxial<BHE::BHE_CXA>(bhe_config, curves));
128 continue;
129 }
130
131 if (bhe_type == "CXC")
132 {
133 bhes.emplace_back(
134 BHE::createBHECoaxial<BHE::BHE_CXC>(bhe_config, curves));
135 continue;
136 }
137
138 if (bhe_type == "2U")
139 {
140 bhes.emplace_back(
141 BHE::createBHEUType<BHE::BHE_2U>(bhe_config, curves));
142 continue;
143 }
144
145 if (bhe_type == "1P")
146 {
147 bhes.emplace_back(
148 BHE::createBHE1PType<BHE::BHE_1P>(bhe_config, curves));
149 continue;
150 }
151 OGS_FATAL("Unknown BHE type '{:s}'.", bhe_type);
152 }
153 // end of reading BHE parameters -------------------------------------------
154
155 auto media_map =
157
158 // find if bhe uses python boundary condition
159 auto const using_tespy =
160 visit([](auto const& bhe) { return bhe.use_python_bcs; }, bhes[0]);
161
164 // create a pythonBoundaryCondition object
165 if (using_tespy || using_server_communication)
166 {
167 // Evaluate Python code in scope of main module
168 pybind11::object scope =
169 pybind11::module::import("__main__").attr("__dict__");
170
171 if (!scope.contains("bc_bhe"))
172 OGS_FATAL(
173 "Function 'bc_bhe' is not defined in the python script file, "
174 "or there was no python script file specified.");
175
176 py_object =
177 scope["bc_bhe"]
179
180 if (py_object == nullptr)
181 OGS_FATAL(
182 "Not able to access the correct bc pointer from python script "
183 "file specified.");
184
185 // create BHE network dataframe from Python
186 py_object->dataframe_network = py_object->initializeDataContainer();
187 if (!py_object->isOverriddenEssential())
188 {
189 DBUG(
190 "Method `initializeDataContainer' not overridden in Python "
191 "script.");
192 }
193 // clear ogs bc_node_id memory in dataframe
194 std::get<3>(py_object->dataframe_network).clear(); // ogs_bc_node_id
195
196 // here calls the tespyHydroSolver to get the pipe flow velocity in bhe
197 // network
198 /* for 2U type the flowrate initialization process below causes conflict
199 // replace the value in flow velocity Matrix _u
200 auto const tespy_flow_rate = std::get<4>(py_object->dataframe_network);
201 const std::size_t n_bhe = tespy_flow_rate.size();
202 if (bhes.size() != n_bhe)
203 OGS_FATAL(
204 "The number of BHEs defined in OGS and TESPy are not the "
205 "same!");
206
207 for (std::size_t idx_bhe = 0; idx_bhe < n_bhe; idx_bhe++)
208 {
209 // the flow_rate in OGS should be updated from the flow_rate
210 // computed by TESPy.
211 auto update_flow_rate = [&](auto& bhe) {
212 bhe.updateHeatTransferCoefficients(tespy_flow_rate[idx_bhe]);
213 };
214 visit(update_flow_rate, bhes[idx_bhe]);
215 }
216 */
217 }
218
219 HeatTransportBHEProcessData process_data(
220 std::move(media_map), std::move(bhes), py_object, using_tespy,
221 using_server_communication);
222
223 SecondaryVariableCollection secondary_variables;
224
225 ProcessLib::createSecondaryVariables(config, secondary_variables);
226
227 return std::make_unique<HeatTransportBHEProcess>(
228 std::move(name), mesh, std::move(jacobian_assembler), parameters,
229 integration_order, std::move(process_variables),
230 std::move(process_data), std::move(secondary_variables));
231}
232} // namespace HeatTransportBHE
233} // namespace ProcessLib
#define OGS_FATAL(...)
Definition Error.h:26
void DBUG(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:30
T getConfigParameter(std::string const &param) const
ConfigTree getConfigSubtree(std::string const &root) const
Range< ValueIterator< T > > getConfigParameterList(std::string const &param) const
void checkConfigParameter(std::string const &param, std::string_view const value) const
Handles configuration of several secondary variables from the project file.
MaterialSpatialDistributionMap createMaterialSpatialDistributionMap(std::map< int, std::shared_ptr< Medium > > const &media, MeshLib::Mesh const &mesh)
std::unique_ptr< Process > createHeatTransportBHEProcess(std::string const &name, MeshLib::Mesh &mesh, std::unique_ptr< ProcessLib::AbstractJacobianAssembler > &&jacobian_assembler, std::vector< ProcessVariable > const &variables, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, unsigned const integration_order, BaseLib::ConfigTree const &config, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves, std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &media)
void createSecondaryVariables(BaseLib::ConfigTree const &config, SecondaryVariableCollection &secondary_variables)