HeliocentricDistanceVariableSpice.h

Go to the documentation of this file.

#ifndef HELIOCENTRIC_DISTANCE_VARIABLE_SPICE_H
#define HELIOCENTRIC_DISTANCE_VARIABLE_SPICE_H
 
#define HELIOCENTRIC_DISTANCE_VARIABLE_SPICE_VERSION "8"
 
#ifdef SPICE_PRESENT
 
extern "C"
{
#include "SpiceUsr.h"
}
 
#include <iostream>
#include <memory>
#include <string>
#include <valarray>
 
#include "../../src/GenericSubmodule.h"
#include "../../src/ModuleFactory.h"
#include "../../src/PhysicalConstants.h"
 
template <typename T>
class HeliocentricDistanceVariableSpice : public GenericSubmodule<T>
{
    private:
        static bool m_registered;
        std::string m_ini_filepath{"heliocentric_distance/HeliocentricDistanceVariableSpice.ini"};
        std::string m_start_time_utc;
        std::string m_observer_id;
        std::string m_reference_frame_id;
        std::string m_abcorr;
        ConstSpiceChar* m_target = "SUN";
        SpiceDouble m_et;
        SpiceDouble m_start_time_et;
        SpiceDouble m_body_center_to_sun_vector[3];
        SpiceDouble m_light_time;
        T m_au{};
 
    public:
        HeliocentricDistanceVariableSpice(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
 
        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<HeliocentricDistanceVariableSpice<T>>(sim);
        }
        static std::string getName() { return "HeliocentricDistanceVariableSpice"; }
        std::string_view getNameLocal() const override
        {
            return "HeliocentricDistanceVariableSpice";
        };
        std::vector<std::string> getDependencies() const override
        {
            return this->ini_file_data.getStringVectorParameters("dependencies");
        };
};
 
// ================= Implementation =================
 
template <typename T>
HeliocentricDistanceVariableSpice<T>::HeliocentricDistanceVariableSpice(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 << "[HeliocentricDistanceVariableSpice]: " << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[HeliocentricDistanceVariableSpice]: ")
                       + static_cast<std::string>(e.what()));
    }
}
 
template <typename T>
bool HeliocentricDistanceVariableSpice<T>::setup(
    std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
{
    m_au = PhysicalConstants::au;
 
    return true;
}
 
template <typename T>
bool HeliocentricDistanceVariableSpice<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 HeliocentricDistanceVariableSpice<T>::calculateHeliocentricDistance()
{
    // Calculate current ephemerides times from current timestep
    this->m_et = this->m_start_time_et + this->sim->elapsed_time;
    spkpos_c(this->m_target, this->m_et, this->m_reference_frame_id.c_str(), this->m_abcorr.c_str(),
             this->m_observer_id.c_str(), this->m_body_center_to_sun_vector, &this->m_light_time);
    // Again this module_field has length 1 (only one parameter)
    (*this->module_field)[0] = vnorm_c(this->m_body_center_to_sun_vector) * 1000 / m_au;
}
 
template <typename T>
bool HeliocentricDistanceVariableSpice<T>::preTimeStep()
{
    calculateHeliocentricDistance();
    return true;
}
 
template <typename T>
bool HeliocentricDistanceVariableSpice<T>::init()
{
    // Load metadata kernel (can be done multiple times for different modules)
    if (this->sim->my_rank == 0)
    {
        std::cout << "[HeliocentricDistanceVariableSpice]: Loading SPICE kernels.\n";
    }
    try
    {
        furnsh_c(this->ini_file_data.getStringParameters("spice_metakernel_path").c_str());
    }
    catch (const BadInput& e)
    {
        std::cerr << "[HeliocentricDistanceVariableSpice] :" << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[HeliocentricDistanceVariableSpice]: ")
                       + static_cast<std::string>(e.what()));
    }
    if (this->sim->my_rank == 0)
    {
        std::cout << "[HeliocentricDistanceVariableSpice]: Done.\n";
    }
 
    // Read ini file for correct IDs
    try
    {
        this->m_start_time_utc = this->ini_file_data.getStringParameters("start_time_utc");
        str2et_c(this->m_start_time_utc.c_str(), &this->m_start_time_et);
        this->m_et = this->m_start_time_et;
        this->m_observer_id = this->ini_file_data.getStringParameters("object_id");
        this->m_reference_frame_id = this->ini_file_data.getStringParameters("reference_frame_id");
        this->m_abcorr = this->ini_file_data.getStringParameters("abcorr");
    }
    catch (const BadInput& e)
    {
        std::cerr << "[HeliocentricDistanceVariableSpice]: " << e.what() << '\n';
        throw BadInput(static_cast<std::string>("[HeliocentricDistanceVariableSpice]: ")
                       + static_cast<std::string>(e.what()));
    }
    if (this->sim->my_rank == 0)
    {
        std::cout << "[HeliocentricDistanceVariableSpice]: Loaded parameters.\n";
    }
 
    calculateHeliocentricDistance();
    return true;
}
 
template <typename T>
bool HeliocentricDistanceVariableSpice<T>::m_registered =
    ModuleFactory<T>::registerModule(getName(), createMethode);
 
#endif  // SPICE_PRESENT
 
#endif  // HELIOCENTRIC_DISTANCE_VARIABLE_SPICE_H