PhaseNEq.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 PHASENEQ_H
#define PHASENEQ_H
 
#include "../Phase.h"
#include "../../Eos/Eos.h"

class PhaseNEq : public Phase
{
  public:
    PhaseNEq();
    PhaseNEq(tinyxml2::XMLElement* material, Eos* eos, std::string fileName);
    ~PhaseNEq() override;
 
    void allocateAndCopyPhase(Phase** vecPhase) override;
    void copyPhase(Phase& phase) override;
    void extendedCalculusPhase(const Coord& /*velocity*/ = Errors::defaultDouble) override;
    void computeMassFraction(const double& density) override;
 
    void localProjection(const Coord& normal, const Coord& tangent, const Coord& binormal) override;
    void reverseProjection(const Coord& normal, const Coord& tangent, const Coord& binormal) override;
 
    //Specific methods for data printing
    //----------------------------------
    int getNumberScalars() const override { return numberScalarsPhase; };
    int getNumberVectors() const override { return 1; };
    double returnScalar(const int& numVar) const override;
    Coord returnVector(const int& numVar) const override;
    std::string returnNameScalar(const int& numVar) const override;
    std::string returnNameVector(const int& numVar) const override;
 
    //Specific method for reading from file
    //-------------------------------------
    void setScalar(const int& numVar, const double& value) override;
    void setVector(const int& numVar, const Coord& value) override;
 
    //Specific methods for parallel computing
    //---------------------------------------
    int numberOfTransmittedVariables() const override;
    void fillBuffer(double* buffer, int& counter) const override;
    void fillBuffer(std::vector<double>& dataToSend) const override;
    void getBuffer(double* buffer, int& counter, Eos** eos) override;
    void getBuffer(std::vector<double>& dataToReceive, int& counter, Eos** eos) override;
 
    //Specific methods for second order
    //---------------------------------
    void computeSlopesPhase(const Phase& sLeft, const Phase& sRight, const double& distance) override;
    void setToZero() override;
    void setToMax() override;
    void extrapolate(const Phase& slope, const double& distance) override;
    void limitSlopes(const Phase& slopeGauche, const Phase& slopeDroite, Limiter& globalLimiter, Limiter& volumeFractionLimiter) override;
    void setMin(const Phase& phase1, const Phase& phase2) override;
    void setMax(const Phase& phase1, const Phase& phase2) override;
    void computeGradientLimiter(
      const Limiter& globalLimiter, const Phase& phase, const Phase& phaseMin, const Phase& phaseMax, const Phase& slope) override;
 
    //Specific methods for parallele computing at second order
    //--------------------------------------------------------
    int numberOfTransmittedSlopes() const override;
    void fillBufferSlopes(double* buffer, int& counter) const override;
    void getBufferSlopes(double* buffer, int& counter) override;
 
    //Verifications
    //-------------
    void verifyPhase(const std::string& message = "") const override;
    void verifyAndCorrectPhase() override;
    void verifyAndCorrectDensityMax(const double& mass) override;
    void verifyAndCorrectDensityMax() override;
 
    //Accessors
    //---------
    const double& getAlpha() const override { return m_alpha; };
    const double& getMassFraction() const override { return m_Y; };
    const double& getDensity() const override { return m_density; };
    const double& getPressure() const override { return m_pressure; };
    const double& getY() const override { return m_Y; };
    const double& getU() const override { return m_velocity.getX(); };
    const double& getV() const override { return m_velocity.getY(); };
    const double& getW() const override { return m_velocity.getZ(); };
    Coord& getVelocity() override { return m_velocity; };
    const Coord& getVelocity() const override { return m_velocity; };
    Eos* getEos() const override { return m_eos; };
    const double& getEnergy() const override { return m_energy; };
    const double& getSoundSpeed() const override { return m_soundSpeed; };
    const double& getTotalEnergy() const override { return m_totalEnergy; };
    double getTemperature() const override { return m_temperature; };
 
    void setAlpha(double alpha) override;
    void setDensity(double density) override;
    void setPressure(double pressure) override;
    void setVelocity(const double& u, const double& v, const double& w) override;
    void setVelocity(const Coord& vit) override;
    void setU(const double& u) override { m_velocity.setX(u); };
    void setV(const double& v) override { m_velocity.setY(v); };
    void setW(const double& w) override { m_velocity.setZ(w); };
    void setEos(Eos* eos) override;
    void setEnergy(double energy) override;
    void setSoundSpeed(double soundSpeed) override;
 
    //Operators
    //---------
    void changeSign() override;
    void multiplyAndAdd(const Phase& slopesPhasesTemp, const double& coeff) override;
    void divide(const double& coeff) override;
 
  protected:
    double m_alpha;       
    double m_density;     
    double m_pressure;    
    Coord m_velocity;     
    double m_Y;           
    double m_temperature; 
    Eos* m_eos;           
    double m_energy;      
    double m_totalEnergy; 
    double m_soundSpeed;  
};
 
#endif // PHASENEQ_H