MoCSI API Reference
Loading...
Searching...
No Matches
TemperatureSaverIterationsTool.h
Go to the documentation of this file.
1#ifndef TEMPERATURE_SAVER_ITERATIONS_TOOL_H
2#define TEMPERATURE_SAVER_ITERATIONS_TOOL_H
3
4#define VERSION "4"
5
6#include <iostream>
7#include <memory>
8#include <string>
9#include <valarray>
10
11#include "../../src/GenericManagingModule.h"
12#include "../../src/ModuleFactory.h"
13
35template <typename T>
37{
38 private:
39 static bool m_registered;
40 std::string m_ini_filepath{"tools/TemperatureSaverIterationsTool.ini"};
41 int m_number_of_facets;
42 int m_numerical_layers;
43
44 public:
46 bool setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules) override;
47 bool exec(std::string_view param) override; // main functionality of the module
48
49 bool init() override { return true; };
50 bool preTimeStep() override;
51 bool postTimeStep() override { return true; };
52 bool output() override { return true; };
53 std::vector<std::string> getChainInsertion() const override
54 {
55 return this->ini_file_data.getStringVectorParameters("chain_insertion");
56 };
57
58 static std::shared_ptr<GenericManagingModule<T>> createMethode(SimulationClassBase<T>* sim)
59 {
60 return std::make_shared<TemperatureSaverIterationsTool<T>>(sim);
61 };
62 static std::string getName() { return "TemperatureSaverIterationsTool"; };
63 std::string_view getNameLocal() const override { return "TemperatureSaverIterationsTool"; };
64};
65
66// ================= Implementation =================
67
68template <typename T>
70 : GenericManagingModule<T>(sim)
71{
72 try
73 {
74 std::string ini_folder_path{
75 this->sim->m_simulation_config.getStringParameters("ini_folder_path")};
76 this->ini_file_data.loadUserInput(ini_folder_path + m_ini_filepath);
78 }
79 catch (const BadInput& e)
80 {
81 std::cerr << e.what() << '\n';
82 }
83}
84
85template <typename T>
87 std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
88{
89 m_number_of_facets = this->sim->m_simulation_config.getIntParameters("number_of_facets");
90 m_numerical_layers = this->sim->m_simulation_config.getIntParameters("numerical_layers");
91 this->sim->m_field_map.insert(
92 {"TemperatureSaverIterationsTool",
93 std::valarray<double>(
94 this->sim->m_simulation_config.getIntParameters("numerical_layers")
95 * this->sim->m_simulation_config.getIntParameters("number_of_facets"))});
96 this->module_field = std::make_shared<std::valarray<T>>(
97 this->sim->m_simulation_config.getIntParameters("numerical_layers")
98 * this->sim->m_simulation_config.getIntParameters("number_of_facets"));
99 this->setSubmodules(all_submodules);
100 return true;
101}
102
103template <typename T>
104bool TemperatureSaverIterationsTool<T>::exec(std::string_view param)
105{
106 if (param == "InitChain")
107 {
108 return init();
109 }
110 if (param == "PreTimeStepChain")
111 {
112 return preTimeStep();
113 }
114 if (param == "PostTimeStepChain")
115 {
116 return postTimeStep();
117 }
118 if (param == "OutputChain")
119 {
120 return output();
121 }
122 return false;
123}
124
125template <typename T>
127{
128 for (int i{0}; i < m_number_of_facets; i++)
129 {
130 this->sim->m_field_map["TemperatureSaverIterationsTool"][i] =
131 this->sim->getFieldValue("Temperature", i * m_numerical_layers);
132 }
133 return true;
134}
135
136template <typename T>
138 ModuleFactory<T>::registerModule(getName(), createMethode);
139
140#endif // TEMPERATURE_SAVER_ITERATIONS_TOOL_H
This error class inherits from std::exception and marks faulty parameter or CL inputs....
Definition IniParser.h:71
const char * what() const noexcept override
Definition IniParser.h:78
Abstract base class for the managing modules. Managing modules are the highest tier of modules and ar...
Definition GenericManagingModule.h:29
InputManager ini_file_data
Definition GenericManagingModule.h:38
SimulationClassBase< T > * sim
Definition GenericManagingModule.h:31
std::vector< std::string > m_generic_submodules
Definition GenericManagingModule.h:36
Abstract base class for the submodules. Submodules are below managing modules and will only be run by...
Definition GenericSubmodule.h:25
std::vector< std::string > getStringVectorParameters(const std::string &key) const
Definition InputManager.cpp:503
void loadUserInput(const std::string &user_ini_file_path)
Public function to load and merge user supplied ini files with the already stored data.
Definition InputManager.cpp:42
std::string getStringParameters(const std::string &key) const
Getter function to access the m_parameters map and returns a string. Throws a BadInput error,...
Definition InputManager.cpp:493
static constexpr bool registerModule(std::string name, creation_method module) noexcept
Function that adds a module to the module registry map.
Definition ModuleFactory.h:68
Definition SimulationClassBase.h:15
InputManager m_simulation_config
Definition SimulationClassBase.h:24
Helper module to store the updated temperature from the last inner iteration.
Definition TemperatureSaverIterationsTool.h:37
bool preTimeStep() override
Definition TemperatureSaverIterationsTool.h:126
bool output() override
Definition TemperatureSaverIterationsTool.h:52
std::vector< std::string > getChainInsertion() const override
Definition TemperatureSaverIterationsTool.h:53
bool exec(std::string_view param) override
Definition TemperatureSaverIterationsTool.h:104
bool setup(std::vector< std::shared_ptr< GenericSubmodule< T > > > all_submodules) override
Definition TemperatureSaverIterationsTool.h:86
std::string_view getNameLocal() const override
Definition TemperatureSaverIterationsTool.h:63
TemperatureSaverIterationsTool(SimulationClassBase< T > *sim)
Definition TemperatureSaverIterationsTool.h:69
bool init() override
Definition TemperatureSaverIterationsTool.h:49
bool postTimeStep() override
Definition TemperatureSaverIterationsTool.h:51
static std::string getName()
Definition TemperatureSaverIterationsTool.h:62
static std::shared_ptr< GenericManagingModule< T > > createMethode(SimulationClassBase< T > *sim)
Definition TemperatureSaverIterationsTool.h:58