Line data    Source code

       1             : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
       2             :    Copyright (c) 2016-2023 The plumed team
       3             :    (see the PEOPLE file at the root of the distribution for a list of names)
       4             : 
       5             :    See http://www.plumed.org for more information.
       6             : 
       7             :    This file is part of plumed, version 2.
       8             : 
       9             :    plumed is free software: you can redistribute it and/or modify
      10             :    it under the terms of the GNU Lesser General Public License as published by
      11             :    the Free Software Foundation, either version 3 of the License, or
      12             :    (at your option) any later version.
      13             : 
      14             :    plumed is distributed in the hope that it will be useful,
      15             :    but WITHOUT ANY WARRANTY; without even the implied warranty of
      16             :    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      17             :    GNU Lesser General Public License for more details.
      18             : 
      19             :    You should have received a copy of the GNU Lesser General Public License
      20             :    along with plumed.  If not, see <http://www.gnu.org/licenses/>.
      21             : +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ */
      22             : #ifndef __PLUMED_gridtools_ContourFindingBase_h
      23             : #define __PLUMED_gridtools_ContourFindingBase_h
      24             : 
      25             : #include "ActionWithInputGrid.h"
      26             : #include "tools/RootFindingBase.h"
      27             : 
      28             : namespace PLMD {
      29             : namespace gridtools {
      30             : 
      31             : class ContourFindingBase : public ActionWithInputGrid {
      32             : private:
      33             : /// This is the object that does the root finding
      34             :   RootFindingBase<ContourFindingBase> mymin;
      35             : protected:
      36             : /// Where you would like to find the contour
      37             :   double contour;
      38             : /// Find a contour along line specified by direction
      39             :   void findContour( const std::vector<double>& direction, std::vector<double>& point ) const ;
      40             : public:
      41             :   static void registerKeywords( Keywords& keys );
      42             :   explicit ContourFindingBase(const ActionOptions&ao);
      43             : /// Get the contour value
      44             :   double getDifferenceFromContour( const std::vector<double>& x, std::vector<double>& der ) const ;
      45             : /// Overwrite not needed stuff
      46          32 :   unsigned getNumberOfDerivatives() override {
      47          32 :     return 0;
      48             :   }
      49             : /// This is not periodic
      50           0 :   bool isPeriodic() override {
      51           0 :     return false;
      52             :   }
      53             : };
      54             : 
      55             : inline
      56             : void ContourFindingBase::findContour( const std::vector<double>& direction, std::vector<double>& point ) const {
      57        1242 :   mymin.linesearch( direction, point, &ContourFindingBase::getDifferenceFromContour );
      58        1242 : }
      59             : 
      60             : inline
      61        8244 : double ContourFindingBase::getDifferenceFromContour( const std::vector<double>& x, std::vector<double>& der ) const {
      62        8344 :   return getFunctionValueAndDerivatives( x, der ) - contour;
      63             : }
      64             : 
      65             : }
      66             : }
      67             : #endif