Homec4science
Diffusion tamaas (features/netcdf-mpi) Browse

tamaas/src/model/functional.hh
2d8966ce17e8features/netcdf-mpi

Last Change
Raw File

functional.hh
View Options

/**
* @file
*
* @author Lucas Frérot <lucas.frerot@epfl.ch>
*
* @section LICENSE
*
* Copyright (©) 2017 EPFL (Ecole Polytechnique Fédérale de
* Lausanne) Laboratory (LSMS - Laboratoire de Simulation en Mécanique des
* Solides)
*
* Tamaas is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* Tamaas 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Tamaas. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#ifndef __FUNCTIONAL_HH__
#define __FUNCTIONAL_HH__
/* -------------------------------------------------------------------------- */
#include "be_engine.hh"
#include "tamaas.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_TAMAAS__
namespace functional {
/// Generic functional class for the cost function of the optimization problem
class Functional {
public:
/// Constructor
explicit Functional(const BEEngine& engine) : engine(engine) {}
/// Destructor
virtual ~Functional() = default;
public:
/// Compute functional
virtual Real computeF(GridBase<Real>& variable,
GridBase<Real>& dual) const = 0;
/// Compute functional gradient
virtual void computeGradF(GridBase<Real>& variable,
GridBase<Real>& gradient) const = 0;
protected:
const BEEngine& engine;
};
} // namespace functional
__END_TAMAAS__
/* -------------------------------------------------------------------------- */
#endif // ___FUNCTIONAL_HH__
c4science · Help