HeliocentricDistanceConstantCustom.h

Go to the documentation of this file.

#ifndef HELIOCENTRIC_DISTANCE_CONSTANT_CUSTOM_H
#define HELIOCENTRIC_DISTANCE_CONSTANT_CUSTOM_H
 
#define HELIOCENTRIC_DISTANCE_CONSTANT_CUSTOM_VERSION "7"
 
#include <iostream>
#include <memory>
#include <string>
#include <valarray>
 
#include "../../src/GenericSubmodule.h"
#include "../../src/ModuleFactory.h"
 
template <typename T>
class HeliocentricDistanceConstantCustom : public GenericSubmodule<T>
{
    private:
        static bool m_registered;
        std::string m_ini_filepath{"heliocentric_distance/HeliocentricDistanceConstantCustom.ini"};
        T m_heliocentric_distance;
 
    public:
        HeliocentricDistanceConstantCustom(SimulationClassBase<T>* sim);
        bool setup(std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
            override;  // loads module into necessary module chains (auto load for calculation
                       // chains)
        bool exec(std::string_view param) override;  // main functionality of the module
 
        // Since the distance is constant it must not be updated
        bool init() override;
        bool preTimeStep() override;
        bool postTimeStep() override { return true; };
        bool output() override { return true; };
 
        void calculateHeliocentricDistance();
 
        void setFieldPtr(std::shared_ptr<std::valarray<T>> field_ptr) override
        {
            this->module_field = field_ptr;
        }
 
        static std::shared_ptr<GenericSubmodule<T>> createMethode(SimulationClassBase<T>* sim)
        {
            return std::make_shared<HeliocentricDistanceConstantCustom<T>>(sim);
        }
        static std::string getName() { return "HeliocentricDistanceConstantCustom"; }
        std::string_view getNameLocal() const override
        {
            return "HeliocentricDistanceConstantCustom";
        };
        std::vector<std::string> getDependencies() const override
        {
            return this->ini_file_data.getStringVectorParameters("dependencies");
        };
};
 
// ================= Implementation =================
 
template <typename T>
HeliocentricDistanceConstantCustom<T>::HeliocentricDistanceConstantCustom(
    SimulationClassBase<T>* sim)
    : GenericSubmodule<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 << "[HeliocentricDistanceConstantCustom]: " << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[HeliocentricDistanceConstantCustom]: ")
                       + static_cast<std::string>(e.what()));
    }
}
 
template <typename T>
bool HeliocentricDistanceConstantCustom<T>::setup(
    std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
{
    try
    {
        this->m_heliocentric_distance =
            this->ini_file_data.getDoubleParameters("heliocentric_distance");
    }
    catch (const BadInput& e)
    {
        std::cerr << "[HeliocentricDistanceConstantCustom]: " << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[HeliocentricDistanceConstantCustom]: ")
                       + static_cast<std::string>(e.what()));
    }
    return true;
}
 
template <typename T>
bool HeliocentricDistanceConstantCustom<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 HeliocentricDistanceConstantCustom<T>::calculateHeliocentricDistance()
{
    (*this->module_field) = this->m_heliocentric_distance;
}
 
template <typename T>
bool HeliocentricDistanceConstantCustom<T>::preTimeStep()
{
    calculateHeliocentricDistance();
    return true;
}
 
template <typename T>
bool HeliocentricDistanceConstantCustom<T>::init()
{
    calculateHeliocentricDistance();
    return true;
}
 
template <typename T>
bool HeliocentricDistanceConstantCustom<T>::m_registered =
    ModuleFactory<T>::registerModule(getName(), createMethode);
 
#endif  // HELIOCENTRIC_DISTANCE_CONSTANT_CUSTOM_H