MoCSI API Reference
Loading...
Searching...
No Matches
HeatConductivity.h
Go to the documentation of this file.
1#ifndef HEAT_CONDUCTIVITY_H
2#define HEAT_CONDUCTIVITY_H
3
4#define HEAT_CONDUCTIVITY_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
30template <typename T>
32{
33 private:
34 static bool m_registered;
35 std::string m_ini_filepath{"heat_conductivity/HeatConductivity.ini"};
36
37 public:
39 bool setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules) override;
40 bool exec(std::string_view param) override; // main functionality of the module
41
42 bool init();
43 bool preTimeStep() override;
44 bool postTimeStep() override { return true; };
45 bool output() override { return true; };
46
47 void writeToSim();
48
49 std::vector<std::string> getChainInsertion() const override
50 {
51 return this->ini_file_data.getStringVectorParameters("chain_insertion");
52 };
53
54 static std::shared_ptr<GenericManagingModule<T>> createMethode(SimulationClassBase<T>* sim)
55 {
56 return std::make_shared<HeatConductivity<T>>(sim);
57 };
58 static std::string getName() { return "HeatConductivity"; };
59 std::string_view getNameLocal() const override { return "HeatConductivity"; };
60};
61
62// ================= Implementation =================
63
64template <typename T>
66{
67 try
68 {
69 std::string ini_folder_path{
70 this->sim->m_simulation_config.getStringParameters("ini_folder_path")};
71 this->ini_file_data.loadUserInput(ini_folder_path + m_ini_filepath);
73 }
74 catch (const BadInput& e)
75 {
76 std::cerr << e.what() << '\n';
77 }
78}
79
80template <typename T>
81bool HeatConductivity<T>::setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
82{
83 this->sim->m_field_map.insert(
84 {"HeatConductivity",
85 std::valarray<T>(this->sim->m_simulation_config.getIntParameters("numerical_layers")
86 * this->sim->m_simulation_config.getIntParameters("number_of_facets"))});
87 this->module_field = std::make_shared<std::valarray<T>>(
88 this->sim->m_simulation_config.getIntParameters("numerical_layers")
89 * this->sim->m_simulation_config.getIntParameters("number_of_facets"));
90 this->setSubmodules(all_submodules);
91
92 return true;
93}
94
95template <typename T>
96bool HeatConductivity<T>::exec(std::string_view param)
97{
98 if (param == "InitChain")
99 {
100 return init();
101 }
102 if (param == "PreTimeStepChain")
103 {
104 return preTimeStep();
105 }
106 if (param == "PostTimeStepChain")
107 {
108 return postTimeStep();
109 }
110 if (param == "OutputChain")
111 {
112 return output();
113 }
114 return false;
115}
116
117template <typename T>
119{
120 this->sim->m_field_map["HeatConductivity"] = (*this->module_field);
121}
122
123template <typename T>
125{
126 this->sub_module_chain.runChain("PreTimeStepChain");
127 writeToSim();
128 return true;
129}
130
131template <typename T>
133{
134 this->sub_module_chain.runChain("InitChain");
135 writeToSim();
136 return true;
137}
138
139template <typename T>
141
142#endif // HEAT_CONDUCTIVITY_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
Definition HeatConductivity.h:32
bool output() override
Definition HeatConductivity.h:45
void writeToSim()
Definition HeatConductivity.h:118
static std::string getName()
Definition HeatConductivity.h:58
bool init()
Definition HeatConductivity.h:132
bool preTimeStep() override
Definition HeatConductivity.h:124
std::vector< std::string > getChainInsertion() const override
Definition HeatConductivity.h:49
bool setup(std::vector< std::shared_ptr< GenericSubmodule< T > > > all_submodules) override
Definition HeatConductivity.h:81
HeatConductivity(SimulationClassBase< T > *sim)
Definition HeatConductivity.h:65
static std::shared_ptr< GenericManagingModule< T > > createMethode(SimulationClassBase< T > *sim)
Definition HeatConductivity.h:54
bool postTimeStep() override
Definition HeatConductivity.h:44
bool exec(std::string_view param) override
Definition HeatConductivity.h:96
std::string_view getNameLocal() const override
Definition HeatConductivity.h:59
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:75
Definition SimulationClassBase.h:19
InputManager m_simulation_config
Definition SimulationClassBase.h:29