Homec4science
Diffusion tamaas (ci-fix-static-checks) Browse

tamaas/src/functional.hh
4ffcbbdeb112ci-fix-static-checks

Last Change
Raw File

functional.hh
View Options

/**
*
* @author Lucas Frérot <lucas.frerot@epfl.ch>
*
* @section LICENSE
*
* Copyright (©) 2016 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 "surface.hh"
#include <map>
/* -------------------------------------------------------------------------- */
__BEGIN_TAMAAS__
// forward declaration of BemFFTBase
class BemFFTBase;
/// Abstract class for functional interface definition
class Functional {
public:
/// Constructor
explicit Functional(BemFFTBase & bem);
/// Destructor
virtual ~Functional();
public:
/// Compute value of objective function
virtual Real computeF() = 0;
/// Compute gradient of objective function (du)
virtual void computeGradFU() = 0;
/// Compute gradient of objective function (dp)
virtual void computeGradFP() = 0;
/// Set parameters
void setParameter(std::string name, Real new_p) { this->parameters[name] = new_p; }
/// Get parameters
Real getParameter(std::string name) { return this->parameters[name]; }
/// Get parameters map
const std::map<std::string, Real> & getParametersMap() const { return this->parameters; }
/// Copy parameters
void copyParameters(const std::map<std::string, Real> & params);
/// Set gradF pointer
void setGradFPointer(Surface<Real> * p);
/// Get gradF surface
const Surface<Real> & getGradF() const { return *gradF; }
protected:
std::map<std::string, Real> parameters;
BemFFTBase & bem;
Surface<Real> * gradF;
};
__END_TAMAAS__
#endif // __FUNCTIONAL_HH__
c4science · Help