Limiter.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 LIMITER_H
#define LIMITER_H
 
#include "../Errors.h"
#include "../Tools.h"
 
class Limiter
{
  public:
    Limiter();
    virtual ~Limiter();
 
    virtual double limiteSlope(const double& /*slope1*/, const double& /*slope2*/)
    {
      Errors::errorMessage("Unknown limiter");
      return 0.;
    };
    virtual bool AmITHINC() { return false; }
 
    virtual double computeGradientLimiter(double val, double min, double max, double slope) const;
 
    virtual LimiterType getType() { return m_limType; }
 
  protected:
    LimiterType m_limType; 
};
 
#endif // LIMITER_H