AddPhys.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 ADDPHYS_H
#define ADDPHYS_H
 
class AddPhys; //Predeclaration of the AddPhys class to include Cell.h and CellInterface.h
 
#include "../Errors.h"
#include "../Order1/Cell.h"
#include "../Order1/CellInterface.h"
#include "QuantitiesAddPhys.h"
#include "../Parallel/Parallel.h"

class AddPhys
{
  public:
    AddPhys();
    virtual ~AddPhys();

    virtual void addQuantityAddPhys(Cell* /*cell*/) { Errors::errorMessage("addQuantityAddPhys not implemented for used additional physics"); };
 
    virtual std::string whoAmI() const
    {
      Errors::errorMessage("whoAmI not implemented for used additional physics");
      return std::string("");
    };

    virtual double computeEnergyAddPhys(QuantitiesAddPhys* /*QPA*/) { return 0.; };
    void computeFluxAddPhys(CellInterface* cellInterface);
    void computeFluxAddPhysBoundary(CellInterface* cellInterface);
    void addNonConsAddPhys(Cell* cell);
    virtual void solveFluxAddPhys(CellInterface* /*cellInterface*/)
    {
      Errors::errorMessage("solveFluxAddPhys not implemented for used additional physics");
    };

    virtual void solveFluxAddPhysBoundary(CellInterface* /*cellInterface*/)
    {
      Errors::errorMessage("solveFluxAddPhysLimite not implemented for used additional physics");
    };

    virtual void addFluxAddPhys(CellInterface* cellInterface, const double& coefAMR);
    virtual void subtractFluxAddPhys(CellInterface* cellInterface, const double& coefAMR);
    virtual void addNonCons(Cell* /*cell*/) { Errors::errorMessage("addNonCons not implemented for used additional physics"); };
    virtual void addSymmetricTermsRadialAxisOnX(Cell* /*cell*/)
    {
      Errors::errorMessage("addSymmetricTerms not implemented for used additional physics");
    };

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

    virtual void reinitializeColorFunction(std::vector<Cell*>* /*cellsLvl*/, const int& /*lvl*/) {};

    virtual bool reinitializationActivated() { return false; };

    virtual void communicationsAddPhys(const int& /*dim*/, const int& /*lvl*/)
    {
      Errors::errorMessage("communicationsAddPhys not implemented for used additional physics");
    };

    virtual const int& getNumTransportAssociated() const
    {
      Errors::errorMessage("getNumTransportAssociated not implemented for used additional physics");
      return Errors::defaultInt;
    };

    virtual void computeTurbulenceParameters() const
    {
      Errors::errorMessage("computeTurbulenceParameters not implemented for used additional physics");
    };
 
  protected:
  private:
};
 
#endif // ADDPHYS_H