MoCSI API Reference
Loading...
Searching...
No Matches
HeatCapacity.h
Go to the documentation of this file.
1#ifndef HEAT_CAPACITY_H
2#define HEAT_CAPACITY_H
3
4#define VERSION "3"
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{"heat_capacity/HeatCapacity.ini"};
41
42 public:
44 bool setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules) override;
45 bool exec(std::string_view param) override; // main functionality of the module
46
47 bool init() override;
48 bool preTimeStep() override;
49 bool postTimeStep() override { return true; };
50 bool output() override { return true; };
51
52 void writeToSim();
53
54 std::vector<std::string> getChainInsertion() const override
55 {
56 return this->ini_file_data.getStringVectorParameters("chain_insertion");
57 };
58
59 static std::shared_ptr<GenericManagingModule<T>> createMethode(SimulationClassBase<T>* sim)
60 {
61 return std::make_shared<HeatCapacity<T>>(sim);
62 };
63 static std::string getName() { return "HeatCapacity"; };
64 std::string_view getNameLocal() const override { return "HeatCapacity"; };
65};
66
67// ================= Implementation =================
68
69template <typename T>
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>
86bool HeatCapacity<T>::setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
87{
88 this->sim->m_field_map.insert(
89 {"HeatCapacity",
90 std::valarray<T>(this->sim->m_simulation_config.getIntParameters("numerical_layers")
91 * this->sim->m_simulation_config.getIntParameters("number_of_facets"))});
92 this->module_field = std::make_shared<std::valarray<T>>(
93 this->sim->m_simulation_config.getIntParameters("numerical_layers")
94 * this->sim->m_simulation_config.getIntParameters("number_of_facets"));
95 this->setSubmodules(all_submodules);
96
97 return true;
98}
99
100template <typename T>
101bool HeatCapacity<T>::exec(std::string_view param)
102{
103 if (param == "InitChain")
104 {
105 return init();
106 }
107 if (param == "PreTimeStepChain")
108 {
109 return preTimeStep();
110 }
111 if (param == "PostTimeStepChain")
112 {
113 return postTimeStep();
114 }
115 if (param == "OutputChain")
116 {
117 return output();
118 }
119 return false;
120}
121
122template <typename T>
124{
125 this->sim->m_field_map["HeatCapacity"] = (*this->module_field);
126}
127
128template <typename T>
130{
131 this->sub_module_chain.runChain("PreTimeStepChain");
132 writeToSim();
133 return true;
134}
135
136template <typename T>
138{
139 this->sub_module_chain.runChain("InitChain");
140 writeToSim();
141 return true;
142}
143
144template <typename T>
146
147#endif // HEAT_CAPACITY_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
Managing module that calculates heat capacity based on submodules.
Definition HeatCapacity.h:37
bool setup(std::vector< std::shared_ptr< GenericSubmodule< T > > > all_submodules) override
Definition HeatCapacity.h:86
static std::string getName()
Definition HeatCapacity.h:63
bool postTimeStep() override
Definition HeatCapacity.h:49
void writeToSim()
Definition HeatCapacity.h:123
std::string_view getNameLocal() const override
Definition HeatCapacity.h:64
bool exec(std::string_view param) override
Definition HeatCapacity.h:101
bool init() override
Definition HeatCapacity.h:137
HeatCapacity(SimulationClassBase< T > *sim)
Definition HeatCapacity.h:70
std::vector< std::string > getChainInsertion() const override
Definition HeatCapacity.h:54
bool preTimeStep() override
Definition HeatCapacity.h:129
static std::shared_ptr< GenericManagingModule< T > > createMethode(SimulationClassBase< T > *sim)
Definition HeatCapacity.h:59
bool output() override
Definition HeatCapacity.h:50
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