Gradient.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 GRADIENT_H
#define GRADIENT_H
 
class Gradient; //Predeclaration of class to include following .h
 
#include <vector>
#include "../Maths/Coord.h"
#include "../Order1/Cell.h"

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

    virtual void computeGradients(Cell* /*cell*/,
                                  std::vector<Coord>& /*grads*/,
                                  const std::vector<Variable>& /*nameVariables*/,
                                  const std::vector<int>& /*numPhases*/)
    {
      Errors::errorMessage("computeGradient not available for required gradient method");
    };
 
    virtual const TypeGrad& getType() const { return m_type; };
 
  protected:
    TypeGrad m_type;
};
 
#endif // GRADIENT_H