Source.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 SOURCE_H
#define SOURCE_H
 
#include "../libTierces/tinyxml2.h"
#include "../Errors.h"
#include "../Tools.h"
#include "../Order1/Cell.h"
#include "../Models/Flux.h"

class Source
{
  public:
    Source(int physicalEntity = 0);
    virtual ~Source();

    virtual void prepSourceTerms(Cell* /*cell*/, const int& /*i*/ = 0) { Errors::errorMessage("prepSourceTerms not available for required source"); };

    virtual void integrateSourceTerms(Cell* /*cell*/, const double& /*dt*/, Prim /*type*/ = vecPhases)
    {
      Errors::errorMessage("integrateSourceTerms not available for required source");
    };

    virtual void sourceEvolution(const double& /*time*/) {};

    virtual Coord computeAbsVelocity(const Coord& /*relVelocity*/, const Coord& /*position*/)
    {
      Errors::errorMessage("computeAbsVelocity not available for required source");
      return 0.;
    };
 
    virtual Coord getOmega()
    {
      Errors::errorMessage("getOmega not available for required source");
      return Coord::defaultCoord;
    }
    virtual bool getRiemannCoupling()
    {
      Errors::errorMessage("getRiemannCoupling not available for required source");
      return false;
    }
 
    virtual int getPhysicalEntity() { return m_physicalEntity; }
 
  protected:
    int m_physicalEntity;
};
 
#endif // SOURCE_H