Eos.h

Go to the documentation of this file.

//
//       ,---.     ,--,    .---.     ,--,    ,---.    .-. .-.
//       | .-'   .' .')   / .-. )  .' .'     | .-'    |  \| |
//       | `-.   |  |(_)  | | |(_) |  |  __  | `-.    |   | |
//       | .-'   \  \     | | | |  \  \ ( _) | .-'    | |\  |
//       |  `--.  \  `-.  \ `-' /   \  `-) ) |  `--.  | | |)|
//       /( __.'   \____\  )---'    )\____/  /( __.'  /(  (_)
//      (__)              (_)      (__)     (__)     (__)
//      Official webSite: https://code-mphi.github.io/ECOGEN/
//
//  This file is part of ECOGEN.
//
//  ECOGEN is the legal property of its developers, whose names
//  are listed in the copyright file included with this source
//  distribution.
//
//  ECOGEN is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  ECOGEN is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with ECOGEN (file LICENSE).
//  If not, see <http://www.gnu.org/licenses/>.
 
#ifndef EOS_H
#define EOS_H
 
#include "../Maths/Coord.h"
#include "../Maths/Tensor.h"
#include "../Errors.h"
#include "../libTierces/tinyxml2.h"

enum TypeEOS
{
  IG,
  SG,
  NASG,
  VDW,
  Polynomial,
  NLS
};
 
class Eos; //Predeclaration of class to include following .h
 
#include "../Tools.h"

class Eos
{
  public:
    Eos(int& number);
    virtual ~Eos();
 
    //Constant methods
    const std::string& getName() const { return m_name; };
    virtual TypeEOS getType() const { return TypeEOS::IG; };
    const int& getNumber() const { return m_number; };

    void readPhysicalParameters(tinyxml2::XMLNode* element);

    double computeEnthalpy(const double& density, const double& pressure) const;
    double
    computeTotalEnthalpy(const double& density, const double& pressure, const double& velX, const double& velY = 0., const double& velZ = 0.) const;
    double computeTotalEnthalpy(const double& density, const double& pressure, const Coord& velocity) const;
    const double& getMu() const { return m_mu; };
    const double& getLambda() const { return m_lambda; };
    void assignEpsilonForAlphaNull(bool alphaNull) const;
 
    //Gereral methods for all EOS
 
    //Virtual methods for child classes
    virtual void assignParametersEos(std::string name, std::vector<double> parametersEos) = 0;
    virtual double computeTemperature(const double& /*density*/, const double& /*pressure or energy*/) const
    {
      Errors::errorMessage("computeTemperature not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEnergy(const double& /*density*/, const double& /*pressure or temperature*/) const
    {
      Errors::errorMessage("computeEnergy not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEnergyFromDensityAndTemperature(const double& /*density*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("computeEnergyFromDensityAndTemperature not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computePressure(const double& /*density*/, const double& /*energy or temperature*/) const
    {
      Errors::errorMessage("computePressure not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeDensity(const double& /*pressure*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("computeDensity not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeSoundSpeed(const double& /*density*/, const double& /*pressure*/) const
    {
      Errors::errorMessage("computeSoundSpeed not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeSquareSoundSpeed(const double& /*density*/, const double& /*entropy or energy*/) const
    {
      Errors::errorMessage("computeSquareSoundSpeed not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeInterfaceSoundSpeed(const double& /*density*/, const double& /*interfacePressure*/, const double& /*pressure*/) const
    {
      Errors::errorMessage("computeInterfaceSoundSpeed not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeAcousticImpedance(const double& /*density*/, const double& /*pressure*/) const
    {
      Errors::errorMessage("computeAcousticImpedance not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double
    computeDensityTimesInterfaceSoundSpeedSquare(const double& /*density*/, const double& /*interfacePressure*/, const double& /*pressure*/) const
    {
      Errors::errorMessage("computeDensityTimesInterfaceSoundSpeedSquare not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEntropy(const double& /*temperature*/, const double& /*pressure*/) const
    {
      Errors::errorMessage("computeEntropy not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEntropyFromDensityAndEnergy(const double& /*density*/, const double& /*energy*/) const
    {
      Errors::errorMessage("computeEntropyFromDensityAndEnergy not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEntropyFromDensityAndPressure(const double& /*density*/, const double& /*pressure*/) const
    {
      Errors::errorMessage("computeEntropyFromDensityAndPressure not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEntropyFromDensityAndTemperature(const double& /*density*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("computeEntropyFromDensityAndTemperature not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computePressureFromDensityAndEntropy(const double& /*density*/, const double& /*entropy*/) const
    {
      Errors::errorMessage("computePressureFromDensityAndEntropy not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computePressureFromDensityAndTemperature(const double& /*density*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("computePressureFromDensityAndTemperature not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computePressureIsentropic(const double& /*initialPressure*/, const double& /*initialDensity*/, const double& /*finalDensity*/) const
    {
      Errors::errorMessage("computePressureIsentropic not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computePressureHugoniot(const double& /*initialPressure*/, const double& /*initialDensity*/, const double& /*finalDensity*/) const
    {
      Errors::errorMessage("computePressureHugoniot not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeDensityIsentropic(const double& /*initialPressure*/,
                                            const double& /*initialDensity*/,
                                            const double& /*finalPressure*/,
                                            double* /*drhodp*/ = 0) const
    {
      Errors::errorMessage("computeDensityIsentropic not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeDensityHugoniot(const double& /*initialPressure*/,
                                          const double& /*initialDensity*/,
                                          const double& /*finalPressure*/,
                                          double* /*drhodp*/ = 0) const
    {
      Errors::errorMessage("computeDensityHugoniot not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeDensityPfinal(const double& /*initialPressure*/,
                                        const double& /*initialDensity*/,
                                        const double& /*finalPressure*/,
                                        double* /*drhodp*/ = 0) const
    {
      Errors::errorMessage("computeDensityPfinal not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double computeEnthalpyIsentropic(const double& /*initialPressure*/,
                                             const double& /*initialDensity*/,
                                             const double& /*finalPressure*/,
                                             double* /*dhdp*/ = 0) const
    {
      Errors::errorMessage("computeEnthalpyIsentropic not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double
    computeDensitySaturation(const double& /*pressure*/, const double& /*Tsat*/, const double& /*dTsatdP*/, double* /*drhodp*/ = 0) const
    {
      Errors::errorMessage("computeDensitySaturation not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double
    computeDensityEnergySaturation(const double& /*pressure*/, const double& /*rho*/, const double& /*drhodp*/, double* /*drhoedp*/ = 0) const
    {
      Errors::errorMessage("computeDensityEnergySaturation not available for EOS : " + m_name);
      return 0.;
    };

    virtual void
    sendSpecialMixtureEos(double& /*gamPinfOverGamMinusOne*/, double& /*eRef*/, double& /*oneOverGamMinusOne*/, double& /*covolume*/) const
    {
      Errors::errorMessage("sendSpecialMixtureEos not yet programmed for EOS : " + m_name);
    };

    virtual double vfpfh(const double& /*pressure*/, const double& /*enthalpy*/) const
    {
      Errors::errorMessage("vfpfh not yet programmed for EOS : " + m_name);
      return 0.;
    };
 
    //Partial derivatives
    virtual double dvdpch(const double& /*pressure*/, const double& /*enthalpy*/) const
    {
      Errors::errorMessage("dvdpch not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double dvdhcp(const double& /*pressure*/) const
    {
      Errors::errorMessage("dvdhcp not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double drhodpcT(const double& /*pressure*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("drhodpcT not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double dedrho(const double& /*density*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("dedrho not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double dedrhoSecond(const double& /*density*/, const double& /*temperature*/) const
    {
      Errors::errorMessage("dedrhoSecond not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double kappa(const double& /*density*/) const
    {
      Errors::errorMessage("kappa not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double kappaPrime(const double& /*density*/) const
    {
      Errors::errorMessage("kappaPrime not yet programmed for EOS : " + m_name);
      return 0.;
    };

    virtual double kappaSecond(const double& /*density*/) const
    {
      Errors::errorMessage("kappaSecond not yet programmed for EOS : " + m_name);
      return 0.;
    };
 
    //Checking..
    virtual void verifyPressure(const double& /*pressure*/, const std::string& /*message*/ = " ") const
    {
      Errors::errorMessage("verifyPressure not yet programmed Eos : " + m_name);
    };

    virtual void verifyAndModifyPressure(double& /*pressure*/) const
    {
      Errors::errorMessage("verifyAndModifyPressure not yet programmed Eos : " + m_name);
    };

    virtual void verifyAndCorrectDensityMax(const double& /*mass*/, double& /*alpha*/, double& /*density*/) const
    {
      Errors::errorMessage("verifyAndCorrectDensityMax not yet programmed Eos : " + m_name);
    };

    virtual void verifyAndCorrectDensityMax(double& /*density*/) const
    {
      Errors::errorMessage("verifyAndCorrectDensityMax not yet programmed Eos : " + m_name);
    };
 
    //Get
    virtual const double& getGamma() const { return Errors::defaultDouble; };
    virtual const double& getPInf() const { return Errors::defaultDouble; };
    virtual const double& getCv() const { return Errors::defaultDouble; };
    virtual const double& getERef() const { return Errors::defaultDouble; };
    virtual const double& getSRef() const { return Errors::defaultDouble; };
 
  protected:
    int m_number;       
    std::string m_name; 
 
    double m_mu;     
    double m_lambda; 
};
 
extern double
  epsilonAlphaNull; 
 
#endif // EOS_H