Flux.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 FLUX_H
#define FLUX_H
 
class Flux; //Predeclaration of class Flux to include Cell.h
 
#include "Phase.h"
#include "../Order1/Cell.h"
#include "../Tools.h"

class Flux
{
  public:
    Flux();
    virtual ~Flux();
 
    virtual void printFlux() const { Errors::errorMessage("printFlux not available for required model"); };

    virtual void addFlux(Flux* /*flux*/) { Errors::errorMessage("addFlux not available for required model"); };
    virtual void addFlux(double /*coefA*/) { Errors::errorMessage("addFlux not available for required model"); };
    virtual void subtractFlux(double /*coefA*/) { Errors::errorMessage("subtractFlux not available for required model"); };
    virtual void addFluxRotatingRegion(double /*coefA*/) { Errors::errorMessage("addFluxRotatingRegion not available for required model"); };
    virtual void subtractFluxRotatingRegion(double /*coefA*/)
    {
      Errors::errorMessage("subtractFluxRotatingRegion not available for required model");
    };

    virtual void multiply(double /*scalar*/) { Errors::errorMessage("multiply not available for required model"); };
    virtual void setBufferFlux(Cell& /*cell*/) { Errors::errorMessage("setBufferFlux not available for required model"); };
    virtual void buildCons(Phase** /*phases*/, Mixture* /*mixture*/) { Errors::errorMessage("buildCons not available for required model"); };
    virtual void buildPrim(Phase** /*phases*/, Mixture* /*mixture*/) { Errors::errorMessage("buildPrim not available for required model"); };
    virtual void setToZero() { Errors::errorMessage("setToZero not available for required model"); };

    virtual void addNonCons(double /*coefA*/, const Cell* /*cell*/, const Coord& /*normal*/, const Coord& /*tangent*/, const Coord& /*binormal*/)
    {
      Errors::errorMessage("addNonCons not available for required model");
    };

    virtual void subtractNonCons(double /*coefA*/, const Cell* /*cell*/, const Coord& /*normal*/, const Coord& /*tangent*/, const Coord& /*binormal*/)
    {
      Errors::errorMessage("subtractNonCons not available for required model");
    };

    virtual void correctionEnergy(Cell* /*cell*/, Prim /*type*/ = vecPhases) const {};
 
    virtual void schemeCorrection(Cell& /*cell*/) const {};

    virtual void addSymmetricTerms(Phase** /*phases*/, Mixture* /*mixture*/, const double& /*r*/, const double& /*v*/)
    {
      Errors::errorMessage("addSymmetricTerms not implemented for used model");
    };

    virtual void prepSourceTermsGravity(const Coord& /*g*/) { Errors::errorMessage("prepSourceTermsGravity not available for required model"); };
    virtual void prepSourceTermsHeating(const double& /*q*/) { Errors::errorMessage("prepSourceTermsHeating not available for required model"); };
    virtual void prepSourceTermsMRF(Cell* /*cell*/, const Coord& /*omega*/)
    {
      Errors::errorMessage("prepSourceTermsMRF not available for required model");
    };

    virtual void prepSourceTermsPlaneWave(const Cell* /*cell*/, const double& /*sourceMomentum*/, const Coord& /*pulseDirection*/)
    {
      Errors::errorMessage("prepSourceTermsPlaneWave not available for required model");
    };

    virtual void addFluxSmooth1D(double /*coefA*/, const Coord& /*normal*/, Cell* /*cell*/)
    {
      Errors::errorMessage("addFluxSmooth1D not available for required model");
    };

    virtual void substractFluxSmooth1D(double /*coefA*/, const Coord& /*normal*/, Cell* /*cell*/)
    {
      Errors::errorMessage("substractFluxSmooth1D not available for required model");
    };
 
    //Moving Reference Frame
    virtual void addNonConsMrfFlux(Phase** /*phases*/) { Errors::errorMessage("addNonConsMrfFlux not available for required model"); };
 
    // Accessors
    //----------
    virtual const double& getAlpha(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getAlpha not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getMass(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getMass not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getEnergyMix() const
    {
      Errors::errorMessage("getEnergyMix not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getMassMix() const
    {
      Errors::errorMessage("getMassMix not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getEqOmega() const
    {
      Errors::errorMessage("getEqOmega not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getEqDensitySurEta() const
    {
      Errors::errorMessage("getEqDensitySurEta not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getEnergy(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getEnergy not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getTotEnergy(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getTotEnergy not available for required model");
      return Errors::defaultDouble;
    };
    virtual const double& getLambda(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getLambda not available for required model");
      return Errors::defaultDouble;
    };
    virtual const Tensor& getCobase(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getCobase not available for required model");
      return Tensor::defaultTensor;
    };
    virtual const Coord& getMomentum() const
    {
      Errors::errorMessage("getMomentum not available for required model");
      return Coord::defaultCoord;
    };
    virtual const Coord& getMomentum(const int& /*numPhase*/) const
    {
      Errors::errorMessage("getMomentum not available for required model");
      return Coord::defaultCoord;
    };
    virtual const Coord& getEqVectorP() const
    {
      Errors::errorMessage("getEqVectorP not available for required model");
      return Coord::defaultCoord;
    };
 
    virtual void setCons(const Flux* /*cons*/) { Errors::errorMessage("setCons not available for required model"); };
 
  protected:
    double m_sM;    
    double m_uStar; 
  private:
};
 
extern std::vector<Flux*> sourceCons;
extern Flux* fluxBuff;
extern Flux* fluxBuffMRF;
 
#endif // FLUX_H