Homec4science
Diffusion tamaas (features/declarative) Browse

tamaas/src/functional.hh
8ab5db4a63a3features/declarative

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_H
#define FUNCTIONAL_H
#include "surface.hh"
/* -------------------------------------------------------------------------- */
// 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 void computeF() = 0;
/// Compute gradient of objective function
virtual void computeGradF() = 0;
/// Get value of objective function
inline Real & getF() { return F; }
/// Get value of gradient
inline Surface<Real> & getGradF() { return gradF; }
/// Recenter the value of gradF based on average in contact
virtual void centerGradFOnContactArea();
/// Set applied pressure
inline void setAppliedPressure(Real new_p) { this->applied_pressure = new_p; }
protected:
Surface<Real> gradF;
Real F;
Real applied_pressure;
BemFFTBase & bem;
};
#endif // FUNCTIONAL_H
c4science · Help