eos.hpp

#ifndef ABLATELIBRARY_EOS_HPP
#define ABLATELIBRARY_EOS_HPP
#include <petsc.h>
#include <functional>
#include <iostream>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "domain/field.hpp"
#include "domain/fieldDescriptor.hpp"
 
namespace ablate::eos {
 
enum class ThermodynamicProperty {
    Pressure,
    Temperature,
    InternalSensibleEnergy,
    SensibleEnthalpy,
    SpecificHeatConstantVolume,
    SpecificHeatConstantPressure,
    SpeedOfSound,
    SpeciesSensibleEnthalpy,
    Density
};
 
struct ThermodynamicFunction {
    PetscErrorCode (*function)(const PetscReal conserved[], PetscReal* property, void* ctx) = nullptr;
    std::shared_ptr<void> context = nullptr;
    PetscInt propertySize = 1;
};
 
struct ThermodynamicTemperatureFunction {
    PetscErrorCode (*function)(const PetscReal conserved[], PetscReal T, PetscReal* property, void* ctx) = nullptr;
    std::shared_ptr<void> context = nullptr;
    PetscInt propertySize = 1;
};
 
using EOSFunction = std::function<void(PetscReal property1, PetscReal property2, PetscInt dim, const PetscReal velocity[], const PetscReal other[], PetscReal conserved[])>;
 
class EOS {
   protected:
    const std::string type;
 
   public:
    explicit EOS(std::string typeIn) : type(std::move(typeIn)){};
    virtual ~EOS() = default;
 
    // Some known extra properties
    // the conserved (density*yi) solution field for species mass fractions
    inline const static std::string YI = "Yi";
    // progress fields are used by the eos/chemistry model to transport required non species
    inline const static std::string PROGRESS = "Progress";
 
    virtual void View(std::ostream& stream) const = 0;
 
    [[nodiscard]] virtual ThermodynamicFunction GetThermodynamicFunction(ThermodynamicProperty property, const std::vector<domain::Field>& fields) const = 0;
 
    [[nodiscard]] virtual ThermodynamicTemperatureFunction GetThermodynamicTemperatureFunction(ThermodynamicProperty property, const std::vector<domain::Field>& fields) const = 0;
 
    [[nodiscard]] virtual EOSFunction GetFieldFunctionFunction(const std::string& field, ThermodynamicProperty property1, ThermodynamicProperty property2,
                                                               std::vector<std::string> otherProperties) const = 0;
 
    [[nodiscard]] virtual const std::vector<std::string>& GetSpeciesVariables() const = 0;
 
    [[nodiscard]] virtual const std::vector<std::string>& GetProgressVariables() const = 0;
 
    [[nodiscard]] virtual std::vector<std::string> GetFieldTags() const { return std::vector<std::string>{}; }
 
    [[nodiscard]] virtual std::vector<std::shared_ptr<domain::FieldDescriptor>> GetAdditionalFields() const { return {}; }
 
    [[nodiscard]] virtual const std::vector<std::string>& GetFieldFunctionProperties() const { return GetSpeciesVariables(); }
 
    friend std::ostream& operator<<(std::ostream& out, const EOS& eos) {
        eos.View(out);
        return out;
    }
};
 
constexpr std::string_view to_string(const ThermodynamicProperty& prop) {
    switch (prop) {
        case ThermodynamicProperty::Pressure:
            return "pressure";
        case ThermodynamicProperty::Temperature:
            return "temperature";
        case ThermodynamicProperty::InternalSensibleEnergy:
            return "internalSensibleEnergy";
        case ThermodynamicProperty::SensibleEnthalpy:
            return "sensibleEnthalpy";
        case ThermodynamicProperty::SpecificHeatConstantVolume:
            return "specificHeatConstantVolume";
        case ThermodynamicProperty::SpecificHeatConstantPressure:
            return "specificHeatConstantPressure";
        case ThermodynamicProperty::SpeedOfSound:
            return "speedOfSound";
        case ThermodynamicProperty::SpeciesSensibleEnthalpy:
            return "speciesSensibleEnthalpy";
        case ThermodynamicProperty::Density:
            return "density";
    }
    return "";
}
 
constexpr ThermodynamicProperty from_string(const std::string_view& prop) {
    if (prop == "pressure") return ThermodynamicProperty::Pressure;
    if (prop == "temperature") return ThermodynamicProperty::Temperature;
    if (prop == "internalSensibleEnergy") return ThermodynamicProperty::InternalSensibleEnergy;
    if (prop == "sensibleEnthalpy") return ThermodynamicProperty::SensibleEnthalpy;
    if (prop == "specificHeatConstantVolume") return ThermodynamicProperty::SpecificHeatConstantVolume;
    if (prop == "specificHeatConstantPressure") return ThermodynamicProperty::SpecificHeatConstantPressure;
    if (prop == "speedOfSound") return ThermodynamicProperty::SpeedOfSound;
    if (prop == "speciesSensibleEnthalpy") return ThermodynamicProperty::SpeciesSensibleEnthalpy;
    if (prop == "density") return ThermodynamicProperty::Density;
    throw std::invalid_argument("No known ThermodynamicProperty for " + std::string(prop));
}
 
inline std::ostream& operator<<(std::ostream& out, const ThermodynamicProperty& prop) {
    auto string = to_string(prop);
    out << string;
    return out;
}
 
inline std::istream& operator>>(std::istream& in, ThermodynamicProperty& prop) {
    std::string propString;
    in >> propString;
    prop = from_string(propString);
    return in;
}
 
}  // namespace ablate::eos
 
#endif  // ABLATELIBRARY_EOS_HPP