HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType.h

Go to the documentation of this file.

#ifndef HEAT_CONDUCTIVITY_VARIABLE_GUNDLACH_2013_NON_POROUS_ROCK_SOLID_ASTEROID_TYPE_H
#define HEAT_CONDUCTIVITY_VARIABLE_GUNDLACH_2013_NON_POROUS_ROCK_SOLID_ASTEROID_TYPE_H
 
#define HEAT_CONDUCTIVITY_VARIABLE_GUNDLACH_2013_NON_POROUS_ROCK_SOLID_ASTEROID_TYPE_VERSION "2"
 
#include <iostream>
#include <memory>
#include <string>
#include <valarray>
 
#include "../../src/GenericSubmodule.h"
#include "../../src/ModuleFactory.h"
 
template <typename T>
class HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType
    : public GenericSubmodule<T>
{
    private:
        static bool m_registered;
        std::string m_ini_filepath{
            "heat_conductivity/"
            "HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType.ini"};
        std::string m_asteroid_type{};
 
    public:
        HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType() {};
        HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType(
            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 calculateHeatConductivity();
 
        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<
                HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<T>>(sim);
        }
        static std::string getName()
        {
            return "HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType";
        }
        std::string_view getNameLocal() const override
        {
            return "HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType";
        };
        std::vector<std::string> getDependencies() const override
        {
            return this->ini_file_data.getStringVectorParameters("dependencies");
        };
};
 
// ================= Implementation =================
 
template <typename T>
HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<T>::
    HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType(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");
        this->m_asteroid_type = this->ini_file_data.getStringParameters("asteroid_type");
    }
    catch (const BadInput& e)
    {
        std::cerr << "[HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType]: "
                  << e.what() << '\n';
        throw BadInput(static_cast<std::string>(
                           "[HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType]: ")
                       + static_cast<std::string>(e.what()));
    }
}
 
template <typename T>
bool HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<T>::setup(
    std::vector<std::shared_ptr<GenericSubmodule<T>>> all_submodules)
{
    std::vector<std::string> implemented_asteroid_types{"S", "Q", "M", "C"};
    if (std::find(implemented_asteroid_types.begin(), implemented_asteroid_types.end(),
                  this->m_asteroid_type)
        == implemented_asteroid_types.end())
    {
        std::cerr << "[HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType]: "
                     "Requested asteroid type not implemented.\n";
        throw std::runtime_error(
            static_cast<std::string>("[HeatConductivityVariableGundlach2013NonPorousRockSolidAstero"
                                     "idType]: Requested asteroid type not implemented."));
    }
    return true;
}
 
template <typename T>
bool HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<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 HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<
    T>::calculateHeatConductivity()
{
    const std::valarray<T>& temperature{this->sim->getField("Temperature")};
    if ((this->m_asteroid_type) == "S" || (this->m_asteroid_type) == "Q")
    {
        (*this->module_field) = 2.18;
    }
    else if ((this->m_asteroid_type) == "C")
    {
        for (int i = 0; i < temperature.size(); ++i)
        {
            (*this->module_field)[i] = 1.19 + 2.1e-3 * temperature[i];
        }
    }
    else if ((this->m_asteroid_type) == "M")
    {
        for (int i = 0; i < temperature.size(); ++i)
        {
            (*this->module_field)[i] = 12.63 + 5.1e-2 * temperature[i];
        }
    }
    else
    {
        std::cerr << "[HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType]: "
                     "Requested asteroid type not implemented.\n";
        throw std::runtime_error(
            static_cast<std::string>("[HeatConductivityVariableGundlach2013NonPorousRockSolidAstero"
                                     "idType]: Requested asteroid type not implemented."));
    }
}
 
template <typename T>
bool HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<T>::preTimeStep()
{
    calculateHeatConductivity();
    return true;
}
 
template <typename T>
bool HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<T>::init()
{
    calculateHeatConductivity();
    return true;
}
 
template <typename T>
bool HeatConductivityVariableGundlach2013NonPorousRockSolidAsteroidType<T>::m_registered =
    ModuleFactory<T>::registerModule(getName(), createMethode);
 
#endif  // HEAT_CONDUCTIVITY_VARIABLE_GUNDLACH_2013_NON_POROUS_ROCK_SOLID_ASTEROID_TYPE_H