SolarFlux.h

Go to the documentation of this file.

#ifndef SOLAR_FLUX_H
#define SOLAR_FLUX_H
 
#define SOLAR_FLUX_VERSION "6"
 
#include <iostream>
#include <memory>
#include <string>
#include <valarray>
 
#include "../../src/GenericManagingModule.h"
#include "../../src/ModuleFactory.h"
 
template <typename T>
class SolarFlux : public GenericManagingModule<T>
{
    private:
        static bool m_registered;
        std::string m_ini_filepath{"solar_flux/SolarFlux.ini"};
 
    public:
        SolarFlux(SimulationClassBase<T>* sim);
        bool setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules) override;
        bool exec(std::string_view param) override;  // main functionality of the module
 
        bool init() override;
        bool preTimeStep() override;
        bool postTimeStep() override { return true; };
        bool output() override { return true; };
 
        void writeToSim();
 
        std::vector<std::string> getChainInsertion() const override
        {
            return this->ini_file_data.getStringVectorParameters("chain_insertion");
        };
 
        static std::shared_ptr<GenericManagingModule<T>> createMethode(SimulationClassBase<T>* sim)
        {
            return std::make_shared<SolarFlux<T>>(sim);
        };
        static std::string getName() { return "SolarFlux"; };
        std::string_view getNameLocal() const override { return "SolarFlux"; };
        std::vector<std::string> getDependencies() const override
        {
            return this->ini_file_data.getStringVectorParameters("dependencies");
        };
};
 
// ================= Implementation =================
 
template <typename T>
SolarFlux<T>::SolarFlux(SimulationClassBase<T>* sim) : GenericManagingModule<T>(sim)
{
    try
    {
        std::string ini_folder_path{
            this->sim->m_simulation_config.getStringParameters("ini_folder_path")};
        this->ini_file_data.loadUserInput(ini_folder_path + m_ini_filepath);
        this->m_generic_submodules = this->ini_file_data.getStringVectorParameters("submodules");
    }
    catch (const BadInput& e)
    {
        std::cerr << "[SolarFlux]: " << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[SolarFlux]: ")
                       + static_cast<std::string>(e.what()));
    }
}
 
template <typename T>
bool SolarFlux<T>::setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
{
    try
    {
        this->sim->m_field_map.insert(
            {"QSol", std::valarray<double>(
                         this->sim->m_simulation_config.getIntParameters("number_of_facets"))});
        this->module_field = std::make_shared<std::valarray<T>>(
            this->sim->m_simulation_config.getIntParameters("number_of_facets"));
        this->setSubmodules(all_submodules);
    }
    catch (const BadInput& e)
    {
        std::cerr << "[SolarFlux]: Failed to insert field map and/or local "
                     "field!\n[SolarFlux]: "
                  << e.what() << '\n';
        throw BadInput(
            static_cast<std::string>("[SolarFlux]: Failed to insert field map and/or local "
                                     "field!\n[SolarFlux]: ")
            + static_cast<std::string>(e.what()));
    }
    return true;
}
 
template <typename T>
bool SolarFlux<T>::exec(std::string_view param)
{
    if (param == "InitChain")
    {
        return init();
    }
    if (param == "PreTimeStepChain")
    {
        return preTimeStep();
    }
    if (param == "PostTimeStepChain")
    {
        return postTimeStep();
    }
    if (param == "OutputChain")
    {
        return output();
    }
    return false;
}
 
template <typename T>
void SolarFlux<T>::writeToSim()
{
    this->sim->m_field_map["QSol"] = (*this->module_field);
}
 
template <typename T>
bool SolarFlux<T>::init()
{
    this->sub_module_chain.runChain("InitChain");
    writeToSim();
    return true;
}
 
template <typename T>
bool SolarFlux<T>::preTimeStep()
{
    this->sub_module_chain.runChain("PreTimeStepChain");
    writeToSim();
    return true;
}
 
template <typename T>
bool SolarFlux<T>::m_registered = ModuleFactory<T>::registerModule(getName(), createMethode);
 
#endif  // SOLAR_FLUX_H