HeliocentricDistance.h

Go to the documentation of this file.

#ifndef HELIOCENTRIC_DISTANCE_H
#define HELIOCENTRIC_DISTANCE_H
 
#define HELIOCENTRIC_DISTANCE_VERSION "7"
 
#include <iostream>
#include <memory>
#include <string>
#include <valarray>
 
#include "../../src/GenericManagingModule.h"
#include "../../src/ModuleFactory.h"
 
template <typename T>
class HeliocentricDistance : public GenericManagingModule<T>
{
    private:
        static bool m_registered;
        std::string m_ini_filepath{"heliocentric_distance/HeliocentricDistance.ini"};
 
    public:
        HeliocentricDistance(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<HeliocentricDistance<T>>(sim);
        };
        static std::string getName() { return "HeliocentricDistance"; };
        std::string_view getNameLocal() const override { return "HeliocentricDistance"; };
};
 
// ================= Implementation =================
 
template <typename T>
HeliocentricDistance<T>::HeliocentricDistance(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 << "[HeliocentricDistance]: " << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[HeliocentricDistance]: ")
                       + static_cast<std::string>(e.what()));
    }
}
 
template <typename T>
bool HeliocentricDistance<T>::setup(
    std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
{
    try
    {
        this->sim->m_field_map.insert({"HeliocentricDistance", std::valarray<T>(1)});
        this->module_field = std::make_shared<std::valarray<T>>(1);
        this->setSubmodules(all_submodules);
    }
    catch (const BadInput& e)
    {
        std::cerr << "[HeliocentricDistance]: Failed to insert field map and/or local "
                     "field!\n[HeliocentricDistance]: "
                  << e.what() << '\n';
        throw BadInput(static_cast<std::string>(
                           "[HeliocentricDistance]: Failed to insert field map and/or local "
                           "field!\n[HeliocentricDistance]: ")
                       + static_cast<std::string>(e.what()));
    }
    return true;
}
 
template <typename T>
bool HeliocentricDistance<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 HeliocentricDistance<T>::writeToSim()
{
    this->sim->m_field_map["HeliocentricDistance"] = (*this->module_field);
}
 
template <typename T>
bool HeliocentricDistance<T>::preTimeStep()
{
    this->sub_module_chain.runChain("PreTimeStepChain");
    writeToSim();
    return true;
}
 
template <typename T>
bool HeliocentricDistance<T>::init()
{
    this->sub_module_chain.runChain("InitChain");
    writeToSim();
    return true;
}
 
template <typename T>
bool HeliocentricDistance<T>::m_registered =
    ModuleFactory<T>::registerModule(getName(), createMethode);
 
#endif  // HELIOCENTRIC_DISTANCE_H