Model.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 MODELE_H
#define MODELE_H
 
class Model; //Predeclaration of class to include following .h
 
#include "Flux.h"
#include "../Maths/Coord.h"
#include "../Errors.h"
#include "../Relaxations/Relaxation.h"
#include "GradPhase.h"
#include "GradMixture.h"
 
//Only boundary Riemann solvers require to extract interface data for output
//This vector allows to use default value for intern Riemann solvers
static std::vector<double> DEFAULT_VEC_INTERFACE_DATA(VarBoundary::SIZE, 0.);

class Model
{
  public:
    Model(const std::string& name, const int& numbTransports);
    virtual ~Model();

    virtual void allocateCons(Flux** /*cons*/) { Errors::errorMessage("allocateCons not available for required model"); };
    virtual void allocatePhase(Phase** /*phase*/) { Errors::errorMessage("allocatePhase not available for required model"); };
    virtual void allocatePhaseSolid(Phase** /*phase*/) {};
    virtual void allocatePhaseGradient(GradPhase** /*phase*/) { Errors::errorMessage("allocatePhaseGradient not available for required model"); };
    virtual void allocatePhaseSolidGradient(GradPhase** /*phase*/)
    {
      Errors::errorMessage("allocatePhaseSolidGradient not available for required model");
    };

    virtual void allocateMixture(Mixture** /*mixture*/) { Errors::errorMessage("allocateMixture not available for required model"); };
    virtual void allocateMixtureGradient(GradMixture** /*mixture*/)
    {
      Errors::errorMessage("allocateMixtureGradient not available for required model");
    };

    void allocateEos(Cell& cell) const;
    void initializeRelaxation(Cell* cell) const;

    virtual void fulfillState(Phase** /*phases*/, Mixture* /*mixture*/) { Errors::errorMessage("fulfillState not available for required model"); };

    virtual void fulfillStateResume(Phase** /*phases*/, Mixture* /*mixture*/)
    {
      Errors::errorMessage("fulfillStateResume not available for required model");
    };

    virtual void initializeAugmentedVariables(Cell* /*cell*/)
    {
      Errors::errorMessage("initializeAugmentedVariables not available for required model");
    };
 
    //Fluid-flow Riemann solvers
    //--------------------------
    virtual void solveRiemannIntern(Cell& /*cellLeft*/,
                                    Cell& /*cellRight*/,
                                    const double& /*dxLeft*/,
                                    const double& /*dxRight*/,
                                    double& /*dtMax*/,
                                    std::vector<double>& /*boundData*/ = DEFAULT_VEC_INTERFACE_DATA) const
    {
      Errors::errorMessage("solveRiemannIntern not available for required model");
    };

    virtual void solveRiemannInternMRF(Cell& /*cellLeft*/,
                                       Cell& /*cellRight*/,
                                       const double& /*dxLeft*/,
                                       const double& /*dxRight*/,
                                       double& /*dtMax*/,
                                       const Coord& /*omega*/,
                                       const Coord& /*normal*/,
                                       const Coord& /*tangent*/,
                                       const Coord& /*binormal*/,
                                       const Coord& /*position*/) const
    {
      Errors::errorMessage("solveRiemannInternMRF not available for required model");
    };

    virtual void solveRiemannWall(Cell& /*cellLeft*/, const double& /*dxLeft*/, double& /*dtMax*/, std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannWall or solveRiemannSymmetry not available for required model");
    };

    virtual void solveRiemannSymmetry(Cell& cellLeft, const double& dxLeft, double& dtMax, std::vector<double>& boundData) const
    {
      this->solveRiemannWall(cellLeft, dxLeft, dtMax, boundData);
    };

    virtual void solveRiemannMovingWall(
      Cell& /*cellLeft*/, const double& /*dxLeft*/, double& /*dtMax*/, double /*wallVelocity*/, std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannMovingWall not available for required model");
    };

    virtual void solveRiemannInletTank(Cell& /*cellLeft*/,
                                       const double& /*dxLeft*/,
                                       double& /*dtMax*/,
                                       const double* /*ak0*/,
                                       const double* /*rhok0*/,
                                       const double& /*p0*/,
                                       const double& /*T0*/,
                                       std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannInletTank not available for required model");
    };

    virtual void solveRiemannInletInjStagState(Cell& /*cellLeft*/,
                                               const double& /*dxLeft*/,
                                               double& /*dtMax*/,
                                               const double /*m0*/,
                                               const double* /*ak0*/,
                                               const double* /*rhok0*/,
                                               const double* /*pk0*/,
                                               std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannInletInjStagState not available for required model");
    };

    virtual void solveRiemannInletInjTemp(Cell& /*cellLeft*/,
                                          const double& /*dxLeft*/,
                                          double& /*dtMax*/,
                                          const double /*m0*/,
                                          const double* /*Tk0*/,
                                          const double* /*ak0*/,
                                          std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannInletInjTemp not available for required model");
    };

    virtual void solveRiemannOutletPressure(
      Cell& /*cellLeft*/, const double& /*dxLeft*/, double& /*dtMax*/, const double /*p0*/, std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannOutletPressure not available for required model");
    };

    virtual void solveRiemannOutletMassflow(
      Cell& /*cellLeft*/, const double& /*dxLeft*/, double& /*dtMax*/, const double /*m0*/, std::vector<double>& /*boundData*/) const
    {
      Errors::errorMessage("solveRiemannOutletMassflow not available for required model");
    };

    virtual void solveRiemannNullFlux() const { Errors::errorMessage("solveRiemannNullFlux not available for required model"); };
 
    //Transports Riemann solvers
    //--------------------------
    virtual void solveRiemannTransportIntern(Cell& /*cellLeft*/, Cell& /*cellRight*/)
    {
      Errors::errorMessage("solveRiemannTransportIntern not available for required model");
    };

    virtual void solveRiemannTransportWall() { Errors::errorMessage("solveRiemannTransportWall not available for required model"); };
    virtual void solveRiemannTransportMovingWall(Cell& /*cellLeft*/, double /*wallVelocity*/)
    {
      Errors::errorMessage("solveRiemannTransportMovingWall not available for required model");
    };

    virtual void solveRiemannTransportInletInjStagState(Cell& /*cellLeft*/, double* /*valueTransports*/)
    {
      Errors::errorMessage("solveRiemannTransportInletInjStagState not available for required model");
    };

    virtual void solveRiemannTransportInletTank(Cell& /*cellLeft*/, double* /*valueTransports*/)
    {
      Errors::errorMessage("solveRiemannTransportInletTank not available for required model");
    };

    virtual void solveRiemannTransportOutletPressure(Cell& /*cellLeft*/, double* /*valueTransports*/)
    {
      Errors::errorMessage("solveRiemannTransportOutletPressure not available for required model");
    };

    virtual void reverseProjection(const Coord /*normal*/, const Coord /*tangent*/, const Coord /*binormal*/) const
    {
      Errors::errorMessage("reverseProjection not available for required model");
    };
 
    //Relaxations
    //-----------
    void relaxations(Cell* cell, const double& dt, Prim type = vecPhases) const;
    virtual void correctionEnergy(Cell* /*cell*/, Prim /*type*/ = vecPhases) const {};
 
    //Low-Mach preconditioning
    //------------------------
    virtual void lowMachSoundSpeed(double& /*machRef*/,
                                   const double& /*uL*/,
                                   double& /*cL*/,
                                   const double& /*uR*/ = Errors::defaultDouble,
                                   double& /*cR*/       = Tools::uselessDouble) const
    {
      Errors::errorMessage("lowMachSoundSpeed not available for required model");
    };
 
    //Moving Reference Frame
    //----------------------
    virtual void addNonConsMrfFlux(Phase** /*phases*/) { Errors::errorMessage("addNonConsMrfFlux not available for required model"); };
    virtual void reverseProjectionMrfFlux(const Coord /*normal*/, const Coord /*tangent*/, const Coord /*binormal*/) const
    {
      Errors::errorMessage("reverseProjectionMrfFlux not available for required model");
    };
 
    //Compaction
    //----------
    virtual void readCompactionParameters(tinyxml2::XMLElement* /*elementCompaction*/, std::string /*fileName*/, const int& /*k*/)
    {
      Errors::errorMessage("readCompactionParameters not available for required model");
    };

    virtual bool compaction(const int& /*k*/) const
    {
      Errors::errorMessage("compaction not available for required model");
      return false;
    };

    virtual const double& getDensityReference(const int& /*k*/) const
    {
      Errors::errorMessage("getDensityReference not available for required model");
      return Errors::defaultDouble;
    };

    virtual double computeEnergyCompaction(const int& /*k*/, const double& /*alpha*/, const double& /*density*/, const double& /*lambda*/) const
    {
      Errors::errorMessage("computeEnergyCompaction not available for required model");
      return Errors::defaultDouble;
    };

    virtual double
    computeCompactionPressure_dkappadxi(const int& /*k*/, const double& /*alpha*/, const double& /*density*/, const double& /*lambda*/) const
    {
      Errors::errorMessage("computeCompactionPressure_dkappadxi not available for required model");
      return Errors::defaultDouble;
    };

    virtual double
    computeCompactionPressure_dkappadalpha(const int& /*k*/, const double& /*alpha*/, const double& /*density*/, const double& /*lambda*/) const
    {
      Errors::errorMessage("computeCompactionPressure_dkappadalpha not available for required model");
      return Errors::defaultDouble;
    };

    virtual double computeCompactionPlasticity(
      const int& /*k*/, const double& /*alpha*/, const double& /*density*/, const double& /*lambda*/, const double& /*pc*/, double& /*f*/) const
    {
      Errors::errorMessage("computeCompactionPlasticity not available for required model");
      return Errors::defaultDouble;
    };
 
    //Solid elasticity and plasticity
    //-------------------------------
    virtual void readSolidParameters(tinyxml2::XMLElement* /*elementSolid*/, std::string /*fileName*/, const int& /*k*/)
    {
      Errors::errorMessage("readSolidParameters not available for required model");
    };

    virtual const double* getDensityReference() const
    {
      Errors::errorMessage("getDensityReference not available for required model");
      return 0;
    };

    virtual const double* getElasticParameterA() const
    {
      Errors::errorMessage("getElasticParameterA not available for required model");
      return 0;
    };

    virtual const double* getShearModulus() const
    {
      Errors::errorMessage("getShearModulus not available for required model");
      return 0;
    };

    virtual const double* getChi() const
    {
      Errors::errorMessage("getChi not available for required model");
      return 0;
    }; //KS//NF

    virtual const double* getElasticityLimit() const
    {
      Errors::errorMessage("getElasticityLimit not available for required model");
      return 0;
    };

    virtual double computeElasticEnergy(const int& /*k*/, const Tensor& /*cobase*/) const
    {
      Errors::errorMessage("computeElasticEnergy not available for required model");
      return Errors::defaultDouble;
    };

    virtual void computeElasticEnergyAndStressTensor(const int& /*k*/,
                                                     const Tensor& /*cobase*/,
                                                     const double& /*pressure*/,
                                                     const double& /*density*/,
                                                     double& /*elasticEnergy*/,
                                                     Tensor& /*stressTensor*/) const
    {
      Errors::errorMessage("computeElasticEnergyAndStressTensor not available for required model");
    };

    virtual double computeSquareLongitudinalWaveSpeed(const int& /*k*/, const Phase& /*phase*/)
    {
      Errors::errorMessage("computeSquareLongitudinalWaveSpeed not available for required model");
      return Errors::defaultDouble;
    };
 
    //Accessors
    //---------
    virtual double selectScalar(Phase** /*phases*/, Mixture* /*mixture*/, Transport* /*transports*/, Variable /*nameVariable*/, int /*num*/ = 0) const
    {
      Errors::errorMessage("selectScalar not available for required model");
      return Errors::defaultDouble;
    };

    virtual const double& getSM()
    {
      Errors::errorMessage("getSM not available for required model");
      return Errors::defaultDouble;
    };

    virtual const Coord& getVelocity(const Cell* /*cell*/) const
    {
      Errors::errorMessage("getVelocity not available for required model");
      return Coord::defaultCoord;
    };
    virtual Coord& getVelocity(Cell* /*cell*/)
    {
      Errors::errorMessage("getVelocity not available for required model");
      return Coord::defaultCoordNonConst;
    };
 
    virtual const Coord& getVectorP(const Cell* /*cell*/) const
    {
      Errors::errorMessage("getVectorP not available for required model");
      return Coord::defaultCoord;
    };
    virtual Coord& getVectorP(Cell* /*cell*/)
    {
      Errors::errorMessage("getVectorP not available for required model");
      return Coord::defaultCoordNonConst;
    };
 
    std::vector<Relaxation*>* getRelaxations() { return &m_relaxations; };
 
    void printInfo() const;
    virtual const std::string& whoAmI() const { return Errors::defaultString; };
 
    virtual void setSmoothCrossSection1d(const bool& /*applySmooth*/)
    {
      Errors::errorMessage("setSmoothCrossSection1d not available for required model");
    };
    virtual const bool& isSmoothCrossSection1d() const { return m_smoothCrossSection1d; };
 
    const bool& getLowMach() const { return m_lowMach; };
    void setLowMach(const bool& lowMach) { m_lowMach = lowMach; };
    virtual void setMachRefMin(const double& machRefMin) { m_machRefMin = machRefMin; };

    virtual void setPhaseSlope(Phase& /*phaseSlope*/, int /*k*/) {};
    virtual void setSlopeDistance(const double& /*slopeDistance*/) {};
 
  protected:
    // clang-format off
    std::string m_name;                     
    std::vector<Relaxation*> m_relaxations; 
 
    bool m_lowMach;                         
    double m_machRefMin;                    
    bool m_smoothCrossSection1d;            
    // clang-format on
  private:
};
 
#endif // MODELE_H