Homec4science
Diffusion tamaas (features/netcdf-mpi) Browse

tamaas/src/model/meta_functional.hh
9c2793e41f9dfeatures/netcdf-mpi

Last Change
Raw File

meta_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 __META_FUNCTIONAL_HH__
#define __META_FUNCTIONAL_HH__
#include "functional.hh"
#include "tamaas.hh"
#include <list>
#include <memory>
__BEGIN_TAMAAS__
namespace functional {
/// Meta functional that contains list of functionals
class MetaFunctional : public Functional {
using FunctionalList = std::list<std::pair<Functional*, bool>>;
public:
~MetaFunctional() override;
public:
/// Compute functional
Real computeF(GridBase<Real>& variable, GridBase<Real>& dual) const override;
/// Compute functional gradient
void computeGradF(GridBase<Real>& variable,
GridBase<Real>& gradient) const override;
/// Add functional to the list
void addFunctionalTerm(Functional* term, bool own);
/// Add functional to the list
void addFunctionalTerm(std::pair<Functional*, bool> element);
protected:
FunctionalList functionals;
};
} // namespace functional
__END_TAMAAS__
#endif // __META_FUNCTIONAL_HH__
c4science · Help