EOS.h

Go to the documentation of this file.

#pragma once
 
#include "EOSio.h"
#include "helm.h"
#include <string>
#include "composition.h"
#include <iomanip>
 
namespace serif::eos {

    struct EOSInput {
        serif::composition::Composition composition; 
        double density; 
        double temperature; 
        friend std::ostream& operator<<(std::ostream& os, const EOSInput& input) {
            os << "<EOSInput: "
               << "Density: " << input.density << " g/cm^3, "
               << "Temperature: " << input.temperature << " K, "
               << "Composition: " << input.composition << ">";
            return os;
        }
    };

    struct EOSParameter {
        explicit EOSParameter(std::string name_)
          : total(), gas(), radiation(),
            dDensity(), dTemperature(),
            dMeanAtomicMassNumber(),
            dMeanAtomicNumber(),
            name(std::move(name_)) {}
        double total; 
        double gas;   
        double radiation; 
 
        double dDensity; 
        double dTemperature; 
        double dMeanAtomicMassNumber; 
        double dMeanAtomicNumber; 
 
        std::string name; 
 
        friend std::ostream& operator<<(std::ostream& os, const EOSParameter& param) {
            os << std::setprecision(5) << "<EOSParameter (" << param.name << "): " << param.total << " (gas: " << param.gas
               << ", radiation: " << param.radiation << ") "
               << "d/dRho: " << param.dDensity << ", d/dT: " << param.dTemperature
               << ", d/dAbar: " << param.dMeanAtomicMassNumber
               << ", d/dZbar: " << param.dMeanAtomicNumber << ">";
            return os;
        }
 
 
    };

    struct EOSOutput {
        double electronFraction{}; 
        double electronChemicalPotential{}; 
        double neutronExcessFraction{}; 
 
        EOSParameter pressure {"pressure"}; 
        EOSParameter energy {"energy"}; 
        EOSParameter entropy {"entropy"}; 

        double chiTemperature();
        double chiRho();
        double soundSpeed();
        double adiabaticGradient();
        double gamma1();
        double gamma2();
        double gamma3();
        double specificHeatCapacityAtConstantVolume();
        double specificHeatCapacityAtConstantPressure();
 
        friend std::ostream& operator<<(std::ostream& os, const EOSOutput& output) {
            os << "EOSOutput:\n"
                << "\tElectron Fraction: " << output.electronFraction << "\n"
                << "\tElectron Chemical Potential: " << output.electronChemicalPotential << "\n"
                << "\tNeutron Excess Fraction: " << output.neutronExcessFraction << "\n\t"
                << output.pressure << "\n\t"
                << output.energy << "\n\t"
                << output.entropy;
            return os;
        }
    };

    class EOS {
    public:
        explicit EOS(const std::string& filename, EOSFormat format=EOSFormat::HELM);
        explicit EOS(const EOSio& reader);
        ~EOS() = default;

        [[nodiscard]] EOSOutput get(const EOSInput& in);
        [[nodiscard]] EOSFormat getFormat() const;
        [[nodiscard]] const EOSio& getReader() const;
    private:
        EOSio m_reader; 
    };
}