Phase.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 PHASE_H
#define PHASE_H
 
#include <fstream>
#include "../Errors.h"
#include "../Eos/Eos.h"
#include "../Maths/Coord.h"
#include "../Maths/Tensor.h"
#include "../libTierces/tinyxml2.h"
#include "../Order2/HeaderLimiter.h"
#include "../Tools.h"

class Phase
{
  public:
    Phase();
    virtual ~Phase();
    void printPhase(std::ofstream& fileStream) const;
    virtual void allocateAndCopyPhase(Phase** /*vecPhase*/) { Errors::errorMessage("allocateAndCopyPhase not available for requested phase type"); };
    virtual void copyPhase(Phase& /*phase*/) { Errors::errorMessage("copyPhase not available for requested phase type"); };
    virtual void extendedCalculusPhase(const Coord& /*velocity*/ = Errors::defaultDouble)
    {
      Errors::errorMessage("extendedCalculusPhase not available for requested phase type");
    };
 
    virtual void computeMassFraction(const double& /*density*/)
    {
      Errors::errorMessage("computeMassFraction not available for requested phase type");
    };
 
    virtual void localProjection(const Coord& /*normal*/, const Coord& /*tangent*/, const Coord& /*binormal*/)
    {
      Errors::errorMessage("projection not available for requested phase type");
    };
    virtual void reverseProjection(const Coord& /*normal*/, const Coord& /*tangent*/, const Coord& /*binormal*/)
    {
      Errors::errorMessage("reverseProjection not available for requested phase type");
    };
 
    //Specific methods for data printing
    //----------------------------------
    virtual int getNumberScalars() const
    {
      Errors::errorMessage("getNumberScalars not available for requested phase type");
      return 0;
    };
    virtual int getNumberVectors() const
    {
      Errors::errorMessage("getNumberVectors not available for requested phase type");
      return 0;
    };
    virtual double returnScalar(const int& /*numVar*/) const
    {
      Errors::errorMessage("returnScalar not available for requested phase type");
      return 0.;
    };
    virtual Coord returnVector(const int& /*numVar*/) const
    {
      Errors::errorMessage("returnVector not available for requested phase type");
      return 0;
    };
    virtual std::string returnNameScalar(const int& /*numVar*/) const
    {
      Errors::errorMessage("returnNameScalar not available for requested phase type");
      return std::string("");
    };
    virtual std::string returnNameVector(const int& /*numVar*/) const
    {
      Errors::errorMessage("returnNameVector not available for requested phase type");
      return std::string("");
    };
 
    //Specific method for reading from file
    //-------------------------------------
    virtual void setScalar(const int& /*numVar*/, const double& /*value*/)
    {
      Errors::errorMessage("setScalar not available for requested phase type");
    };
    virtual void setVector(const int& /*numVar*/, const Coord& /*value*/)
    {
      Errors::errorMessage("setVector not available for requested phase type");
    };
 
    //Specific methods for parallel computing
    //---------------------------------------
    virtual int numberOfTransmittedVariables() const
    {
      Errors::errorMessage("numberOfTransmittedVariables not available for requested phase type");
      return 0;
    };
    virtual void fillBuffer(double* /*buffer*/, int& /*counter*/) const
    {
      Errors::errorMessage("fillBuffer not available for requested phase type");
    };
    virtual void fillBuffer(std::vector<double>& /*dataToSend*/) const { Errors::errorMessage("fillBuffer not available for requested phase type"); };
    virtual void getBuffer(double* /*buffer*/, int& /*counter*/, Eos** /*eos*/)
    {
      Errors::errorMessage("getBuffer not available for requested phase type");
    };
    virtual void getBuffer(std::vector<double>& /*dataToReceive*/, int& /*counter*/, Eos** /*eos*/)
    {
      Errors::errorMessage("getBuffer not available for requested phase type");
    };
 
    //Specific methods for second order
    //---------------------------------
    virtual void computeSlopesPhase(const Phase& /*sLeft*/, const Phase& /*sRight*/, const double& /*distance*/)
    {
      Errors::errorMessage("computeSlopesPhase not available for requested phase type");
    };
    virtual void setToZero() { Errors::errorMessage("setToZero not available for requested phase type"); };
    virtual void setToMax() { Errors::errorMessage("setToMax not available for requested phase type"); };
    virtual void extrapolate(const Phase& /*slope*/, const double& /*distance*/)
    {
      Errors::errorMessage("extrapolate not available for requested phase type");
    };
    virtual void
    limitSlopes(const Phase& /*slopeGauche*/, const Phase& /*slopeDroite*/, Limiter& /*globalLimiter*/, Limiter& /*volumeFractionLimiter*/)
    {
      Errors::errorMessage("limitSlopes not available for requested phase type");
    };
    virtual void setMin(const Phase& /*phase1*/, const Phase& /*phase2*/) { Errors::errorMessage("setMin not available for requested phase type"); };
    virtual void setMax(const Phase& /*phase1*/, const Phase& /*phase2*/) { Errors::errorMessage("setMax not available for requested phase type"); };
    virtual void computeGradientLimiter(
      const Limiter& /*globalLimiter*/, const Phase& /*phase*/, const Phase& /*phaseMin*/, const Phase& /*phaseMax*/, const Phase& /*slope*/)
    {
      Errors::errorMessage("computeGradientLimiter not available for requested phase type");
    };
 
    //Specific methods for parallele computing at second order
    //--------------------------------------------------------
    virtual int numberOfTransmittedSlopes() const
    {
      Errors::errorMessage("numberOfTransmittedSlopes not available for requested phase type");
      return 0;
    };
    virtual void fillBufferSlopes(double* /*buffer*/, int& /*counter*/) const
    {
      Errors::errorMessage("fillBufferSlopes not available for requested phase type");
    };
    virtual void getBufferSlopes(double* /*buffer*/, int& /*counter*/)
    {
      Errors::errorMessage("getBufferSlopes not available for requested phase type");
    };
 
    //Specific methods for solids
    //---------------------------
    virtual double getSquareLongitudinalWaveSpeed() const
    {
      Errors::errorMessage("getSquareLongitudinalWaveSpeed not available for requested phase type");
      return Errors::defaultDouble;
    };
 
    //Verifications
    //-------------
    virtual void verifyPhase(const std::string& /*message*/ = "") const
    {
      Errors::errorMessage("verifyPhase not available for requested phase type");
    };
    virtual void verifyAndCorrectPhase() { Errors::errorMessage("verifyAndCorrectPhase not available for requested phase type"); };
    virtual void verifyAndCorrectDensityMax(const double& /*mass*/)
    {
      Errors::errorMessage("verifyAndCorrectDensityMax not available for requested phase type");
    };
    virtual void verifyAndCorrectDensityMax() { Errors::errorMessage("verifyAndCorrectDensityMax not available for requested phase type"); };
 
    //Accessors
    //---------
    virtual const double& getAlpha() const
    {
      Errors::errorMessage("getAlpha not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getMassFraction() const
    {
      Errors::errorMessage("getMassFraction not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getDensity() const
    {
      Errors::errorMessage("getDensity not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getOmega() const
    {
      Errors::errorMessage("getOmega not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getDensitySurEta() const
    {
      Errors::errorMessage("getDensitySurEta not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getPressure() const
    {
      Errors::errorMessage("getPressure not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getY() const
    {
      Errors::errorMessage("getY not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getU() const
    {
      Errors::errorMessage("getU not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getV() const
    {
      Errors::errorMessage("getV not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getW() const
    {
      Errors::errorMessage("getW not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual Coord& getVelocity()
    {
      Errors::errorMessage("getVelocity not available for requested phase type");
      return Coord::defaultCoordNonConst;
    };
    virtual const Coord& getVelocity() const
    {
      Errors::errorMessage("getVelocity not available for requested phase type");
      return Coord::defaultCoord;
    };
    virtual const double& getVectorPX() const
    {
      Errors::errorMessage("getVectorPX not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getVectorPY() const
    {
      Errors::errorMessage("getVectorPY not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getVectorPZ() const
    {
      Errors::errorMessage("getVectorPZ not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual Coord& getVectorP()
    {
      Errors::errorMessage("getVectorP not available for requested phase type");
      return Coord::defaultCoordNonConst;
    };
    virtual const Coord& getVectorP() const
    {
      Errors::errorMessage("getVectorP not available for requested phase type");
      return Coord::defaultCoordNonConst;
    };
    virtual Eos* getEos() const
    {
      Errors::errorMessage("EOS not available for requested phase type");
      return 0;
    };
    virtual const double& getEnergy() const
    {
      Errors::errorMessage("getEnergy impossible avec type de phase demande");
      return Errors::defaultDouble;
    };
    virtual const double& getEntropy() const
    {
      Errors::errorMessage("getEntropy impossible avec type de phase demande");
      return Errors::defaultDouble;
    };
    virtual const double& getSoundSpeed() const
    {
      Errors::errorMessage("getSoundSpeed impossible avec type de phase demande");
      return Errors::defaultDouble;
    };
    virtual const double& getSquareSoundSpeed() const
    {
      Errors::errorMessage("getSquareSoundSpeed impossible avec type de phase demande");
      return Errors::defaultDouble;
    };
    virtual const double& getTotalEnergy() const
    {
      Errors::errorMessage("getTotalEnergy impossible avec type de phase demande");
      return Errors::defaultDouble;
    };
    virtual double getTemperature() const
    {
      Errors::errorMessage("getT impossible avec type de phase demande");
      return 0.;
    };
    virtual const double& getLambda() const
    {
      Errors::errorMessage("getLambda not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const double& getEnergyCompaction() const
    {
      Errors::errorMessage("getEnergyCompaction not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const Tensor& getCobase() const
    {
      Errors::errorMessage("getCobase not available for requested phase type");
      return Tensor::defaultTensor;
    };
    virtual Tensor& getCobase()
    {
      Errors::errorMessage("getCobase not available for requested phase type");
      return Tensor::defaultTensorNonConst;
    };
    virtual const double& getEnergyElastic() const
    {
      Errors::errorMessage("getEnergyElastic not available for requested phase type");
      return Errors::defaultDouble;
    };
    virtual const Tensor& getStressTensor() const
    {
      Errors::errorMessage("getStressTensor not available for requested phase type");
      return Tensor::defaultTensor;
    };
    virtual Tensor& getStressTensor()
    {
      Errors::errorMessage("getStressTensor not available for requested phase type");
      return Tensor::defaultTensorNonConst;
    };
 
    virtual void setAlpha(double /*alpha*/) { Errors::errorMessage("setAlpha not available for requested phase type"); };
    virtual void setDensity(double /*density*/) { Errors::errorMessage("setDensity not available for requested phase type"); };
    virtual void setOmega(const double& /*omega*/) { Errors::errorMessage("setOmega not available for requested phase type"); };
    virtual void setDensitySurEta(const double& /*densitySurEta*/)
    {
      Errors::errorMessage("setDensitySurEta not available for requested phase type");
    };
    virtual void setPressure(double /*pressure*/) { Errors::errorMessage("setPressure not available for requested phase type"); };
    virtual void setVelocity(const double& /*u*/, const double& /*v*/, const double& /*w*/)
    {
      Errors::errorMessage("setVelocity not available for requested phase type");
    };
    virtual void setVelocity(const Coord& /*vit*/) { Errors::errorMessage("setVelocity not available for requested phase type"); };
    virtual void setU(const double& /*u*/) { Errors::errorMessage("setU not available for requested phase type"); };
    virtual void setV(const double& /*v*/) { Errors::errorMessage("setV not available for requested phase type"); };
    virtual void setW(const double& /*w*/) { Errors::errorMessage("setW not available for requested phase type"); };
    virtual void setVectorP(const double& /*x*/, const double& /*y*/, const double& /*z*/)
    {
      Errors::errorMessage("setVector not available for requested phase type");
    };
    virtual void setVectorP(const Coord& /*vit*/) { Errors::errorMessage("setVectorP not available for requested phase type"); };
    virtual void setX(const double& /*x*/) { Errors::errorMessage("setX not available for requested phase type"); };
    virtual void setY(const double& /*y*/) { Errors::errorMessage("setY not available for requested phase type"); };
    virtual void setZ(const double& /*z*/) { Errors::errorMessage("setZ not available for requested phase type"); };
    virtual void setEos(Eos* /*eos*/) { Errors::errorMessage("impossible to associate EOS to the requested phase type"); };
    virtual void setEnergy(double /*energy*/) { Errors::errorMessage("setEnergy not available for requested phase type"); };
    virtual void setEntropy(double /*entropy*/) { Errors::errorMessage("setEntropy not available for requested phase type"); };
    virtual void setSoundSpeed(double /*soundSpeed*/) { Errors::errorMessage("setSoundSpeed not available for requested phase type"); };
    virtual void setSquareSoundSpeed(double /*squareSoundSpeed*/)
    {
      Errors::errorMessage("setSquareSoundSpeed not available for requested phase type");
    };
    virtual void setTotalEnergy(double /*totalEnergy*/) { Errors::errorMessage("setTotalEnergy not available for requested phase type"); };
    virtual void setTotalEnergy(const double& /*energy*/, const Coord& /*vel*/)
    {
      Errors::errorMessage("setTotalEnergy not available for requested phase type");
    };
    virtual void setTemperature(double /*temperature*/) { Errors::errorMessage("setTemperature not available for requested phase type"); };
    virtual void setLambda(double /*lambda*/) { Errors::errorMessage("setLambda not available for requested phase type"); };
    virtual void setEnergyCompaction(double /*energyCompaction*/)
    {
      Errors::errorMessage("setEnergyCompaction not available for requested phase type");
    };
    virtual void setCobase(const Tensor& /*cobase*/) { Errors::errorMessage("setCobase not available for requested phase type"); };
    virtual void setEnergyElastic(double /*energyElastic*/) { Errors::errorMessage("setEnergyElastic not available for requested phase type"); };
    virtual void setStressTensor(const Tensor& /*stressTensor*/) { Errors::errorMessage("setStressTensor not available for requested phase type"); };
 
    //Operators
    //---------
    virtual void changeSign() { Errors::errorMessage("changeSign not available for requested phase type"); };
    virtual void multiplyAndAdd(const Phase& /*slopesPhasesTemp*/, const double& /*coeff*/)
    {
      Errors::errorMessage("multiplyAndAdd not available for requested phase type");
    };
    virtual void divide(const double& /*coeff*/) { Errors::errorMessage("divide not available for requested phase type"); };
 
  protected:
};
 
extern int numberScalarsPhase;
 
#endif // PHASE_H