MoCSI API Reference
Loading...
Searching...
No Matches
Emissivity.h
Go to the documentation of this file.
1#ifndef EMISSIVITY_H
2#define EMISSIVITY_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{"emissivity/Emissivity.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<Emissivity<T>>(sim);
62 };
63 static std::string getName() { return "Emissivity"; };
64 std::string_view getNameLocal() const override { return "Emissivity"; };
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 Emissivity<T>::setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
87{
88 this->sim->m_field_map.insert(
89 {"Emissivity",
90 std::valarray<T>(this->sim->m_simulation_config.getIntParameters("number_of_facets"))});
91 this->module_field = std::make_shared<std::valarray<T>>(
92 this->sim->m_simulation_config.getIntParameters("number_of_facets"));
93 this->setSubmodules(all_submodules);
94 return true;
95}
96
97template <typename T>
98bool Emissivity<T>::exec(std::string_view param)
99{
100 if (param == "InitChain")
101 {
102 return init();
103 }
104 if (param == "PreTimeStepChain")
105 {
106 return preTimeStep();
107 }
108 if (param == "PostTimeStepChain")
109 {
110 return postTimeStep();
111 }
112 if (param == "OutputChain")
113 {
114 return output();
115 }
116 return false;
117}
118
119template <typename T>
121{
122 this->sim->m_field_map["Emissivity"] = (*this->module_field);
123}
124
125template <typename T>
127{
128 this->sub_module_chain.runChain("InitChain");
129 writeToSim();
130 return true;
131}
132
133template <typename T>
135{
136 this->sub_module_chain.runChain("PreTimeStepChain");
137 writeToSim();
138 return true;
139}
140
141template <typename T>
143
144#endif // EMISSIVITY_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
Managing module that calculates emissivity based on submodules.
Definition Emissivity.h:37
static std::shared_ptr< GenericManagingModule< T > > createMethode(SimulationClassBase< T > *sim)
Definition Emissivity.h:59
Emissivity(SimulationClassBase< T > *sim)
Definition Emissivity.h:70
bool setup(std::vector< std::shared_ptr< GenericSubmodule< T > > > all_submodules) override
Definition Emissivity.h:86
bool exec(std::string_view param) override
Definition Emissivity.h:98
bool output() override
Definition Emissivity.h:50
std::vector< std::string > getChainInsertion() const override
Definition Emissivity.h:54
bool postTimeStep() override
Definition Emissivity.h:49
static std::string getName()
Definition Emissivity.h:63
void writeToSim()
Definition Emissivity.h:120
bool preTimeStep() override
Definition Emissivity.h:134
bool init() override
Definition Emissivity.h:126
std::string_view getNameLocal() const override
Definition Emissivity.h:64
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