engine_abstract.h

Go to the documentation of this file.

#pragma once
 
#include "gridfire/reaction/reaction.h"
#include "gridfire/network.h"
#include "gridfire/screening/screening_abstract.h"
#include "gridfire/screening/screening_types.h"
 
#include <vector>
#include <unordered_map>

 
namespace gridfire {

    template<typename T>
    concept IsArithmeticOrAD = std::is_same_v<T, double> || std::is_same_v<T, CppAD::AD<double>>;

    template <IsArithmeticOrAD T>
    struct StepDerivatives {
        std::vector<T> dydt; 
        T nuclearEnergyGenerationRate = T(0.0); 
    };

    class Engine {
    public:
        virtual ~Engine() = default;

        [[nodiscard]] virtual const std::vector<fourdst::atomic::Species>& getNetworkSpecies() const = 0;

        [[nodiscard]] virtual StepDerivatives<double> calculateRHSAndEnergy(
            const std::vector<double>& Y,
            double T9,
            double rho
        ) const = 0;
    };

    class DynamicEngine : public Engine {
    public:
        virtual void generateJacobianMatrix(
            const std::vector<double>& Y,
            double T9, double rho
        ) = 0;

        [[nodiscard]] virtual double getJacobianMatrixEntry(
            int i,
            int j
        ) const = 0;

        virtual void generateStoichiometryMatrix() = 0;

        [[nodiscard]] virtual int getStoichiometryMatrixEntry(
            int speciesIndex,
            int reactionIndex
        ) const = 0;

        [[nodiscard]] virtual double calculateMolarReactionFlow(
            const reaction::Reaction& reaction,
            const std::vector<double>& Y,
            double T9,
            double rho
        ) const = 0;

        [[nodiscard]] virtual const reaction::LogicalReactionSet& getNetworkReactions() const = 0;

        [[nodiscard]] virtual std::unordered_map<fourdst::atomic::Species, double> getSpeciesTimescales(
            const std::vector<double>& Y,
            double T9,
            double rho
        ) const = 0;

        virtual void update(const NetIn& netIn) = 0;

        virtual void setScreeningModel(screening::ScreeningType model) = 0;

        [[nodiscard]] virtual screening::ScreeningType getScreeningModel() const = 0;
    };
}