QuantitiesAddPhys.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 QUANTITIESADDPHYS_H
#define QUANTITIESADDPHYS_H
 
class QuantitiesAddPhys; //pre-declaration of QuantitiesAddPhys class needed for AddPhys.h inclusion
 
#include "AddPhys.h"

class QuantitiesAddPhys
{
  public:
    QuantitiesAddPhys(AddPhys* addPhys);
    virtual ~QuantitiesAddPhys();

    virtual void computeQuantities(Cell* /*cell*/)
    {
      Errors::errorMessage("computeQuantities not implemented for used quantities of additional physics");
    };

    double computeEnergyAddPhys();
 
    //Accessors for the different gradients
    virtual void setGrad(const Coord& /*grad*/, const int& /*num*/ = -1)
    {
      Errors::errorMessage("setGrad not implemented for used quantities of additional physics");
    };

    virtual const Coord& getGrad(const int& /*num*/ = -1) const
    {
      Errors::errorMessage("getGrad not implemented for used quantities of additional physics");
      return Coord::defaultCoord;
    };

    virtual void setGradU(const Coord& /*grad*/) { Errors::errorMessage("setGradU not implemented for used quantities of additional physics"); };
    virtual void setGradV(const Coord& /*grad*/) { Errors::errorMessage("setGradV not implemented for used quantities of additional physics"); };
    virtual void setGradW(const Coord& /*grad*/) { Errors::errorMessage("setGradW not implemented for used quantities of additional physics"); };
    virtual void setGradTk(const int& /*phaseNum*/, const Coord& /*grad*/)
    {
      Errors::errorMessage("setGradTk not implemented for used quantities of additional physics");
    };

    virtual Coord getGradU() const
    {
      Errors::errorMessage("getGradU not implemented for used quantities of additional physics");
      return 0;
    };

    virtual Coord getGradV() const
    {
      Errors::errorMessage("getGradV not implemented for used quantities of additional physics");
      return 0;
    };

    virtual Coord getGradW() const
    {
      Errors::errorMessage("getGradW not implemented for used quantities of additional physics");
      return 0;
    };

    virtual const Coord& getGradTk(const int& /*phaseNum*/) const
    {
      Errors::errorMessage("getGradTk not implemented for used quantities of additional physics");
      return Coord::defaultCoord;
    };

    AddPhys* getAddPhys() { return m_addPhys; };

    virtual double getTurbulentViscosity() const
    {
      Errors::errorMessage("getTurbulentViscosity not implemented for used quantities of additional physics");
      return Errors::defaultInt;
    };

    virtual void setTurbulentViscosity(const double& /*turbulentViscosity*/)
    {
      Errors::errorMessage("setTurbulentViscosity not implemented for used quantities of additional physics");
    };
 
  protected:
    AddPhys* m_addPhys; 
 
  private:
};
 
extern std::vector<Variable> variableNameSurfTens; 
extern std::vector<int> numPhaseSurfTens;          
extern std::vector<Variable> variableNamesVisc;    
extern std::vector<int> numPhasesVisc;             
extern std::vector<Variable> variableNamesCond;    
extern std::vector<int> numPhasesCond;             
extern std::vector<Variable> variableNamesTurb;    
extern std::vector<int> numPhasesTurb;             
 
#endif // QUANTITIESADDPHYS_H