Line data    Source code

       1             : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
       2             :    Copyright (c) 2011-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             : #include "core/ActionPilot.h"
      23             : #include "core/ActionWithValue.h"
      24             : #include "core/ActionWithArguments.h"
      25             : #include "core/ActionRegister.h"
      26             : #include "tools/File.h"
      27             : 
      28             : namespace PLMD {
      29             : namespace generic {
      30             : 
      31             : //+PLUMEDOC PRINTANALYSIS DUMPDERIVATIVES
      32             : /*
      33             : Dump the derivatives with respect to the input parameters for one or more objects (generally CVs, functions or biases).
      34             : 
      35             : For a CV this line in input instructs plumed to print the derivative of the CV with respect to the atom positions
      36             : and the cell vectors (virial-like form).  In contrast, for a function or bias the derivative with respect to the input "CVs"
      37             : will be output.  This command is most often used to test whether or not analytic derivatives have been implemented correctly.  This
      38             : can be done by outputting the derivatives calculated analytically and numerically.  You can control the buffering of output using the \ref FLUSH keyword.
      39             : 
      40             : \par Examples
      41             : 
      42             : The following input instructs plumed to write a file called deriv that contains both the
      43             : analytical and numerical derivatives of the distance between atoms 1 and 2.
      44             : \plumedfile
      45             : DISTANCE ATOMS=1,2 LABEL=distance
      46             : DISTANCE ATOMS=1,2 LABEL=distanceN NUMERICAL_DERIVATIVES
      47             : DUMPDERIVATIVES ARG=distance,distanceN STRIDE=1 FILE=deriv
      48             : \endplumedfile
      49             : 
      50             : (See also \ref DISTANCE)
      51             : 
      52             : */
      53             : //+ENDPLUMEDOC
      54             : 
      55             : class DumpDerivatives :
      56             :   public ActionPilot,
      57             :   public ActionWithArguments {
      58             :   std::string file;
      59             :   std::string fmt;
      60             :   OFile of;
      61             : public:
      62       13598 :   void calculate() override {}
      63             :   explicit DumpDerivatives(const ActionOptions&);
      64             :   static void registerKeywords(Keywords& keys);
      65       13556 :   void apply() override {}
      66             :   void update() override;
      67             :   ~DumpDerivatives();
      68             : };
      69             : 
      70       14377 : PLUMED_REGISTER_ACTION(DumpDerivatives,"DUMPDERIVATIVES")
      71             : 
      72         300 : void DumpDerivatives::registerKeywords(Keywords& keys) {
      73         300 :   Action::registerKeywords(keys);
      74         300 :   ActionPilot::registerKeywords(keys);
      75         300 :   ActionWithArguments::registerKeywords(keys);
      76         300 :   keys.use("ARG");
      77         600 :   keys.add("compulsory","STRIDE","1","the frequency with which the derivatives should be output");
      78         600 :   keys.add("compulsory","FILE","the name of the file on which to output the derivatives");
      79         600 :   keys.add("compulsory","FMT","%15.10f","the format with which the derivatives should be output");
      80         300 :   keys.use("RESTART");
      81         300 :   keys.use("UPDATE_FROM");
      82         300 :   keys.use("UPDATE_UNTIL");
      83         300 : }
      84             : 
      85         296 : DumpDerivatives::DumpDerivatives(const ActionOptions&ao):
      86             :   Action(ao),
      87             :   ActionPilot(ao),
      88             :   ActionWithArguments(ao),
      89         296 :   fmt("%15.10f") {
      90         592 :   parse("FILE",file);
      91         296 :   if( file.length()==0 ) {
      92           0 :     error("name of output file was not specified");
      93             :   }
      94         296 :   parse("FMT",fmt);
      95         296 :   fmt=" "+fmt;
      96         296 :   of.link(*this);
      97         296 :   of.open(file);
      98         296 :   log.printf("  on file %s\n",file.c_str());
      99         296 :   log.printf("  with format %s\n",fmt.c_str());
     100             :   unsigned nargs=getNumberOfArguments();
     101             :   if( nargs==0 ) {
     102           0 :     error("no arguments specified");
     103             :   }
     104         296 :   (getPntrToArgument(0)->getPntrToAction())->turnOnDerivatives();
     105         296 :   unsigned npar=getPntrToArgument(0)->getNumberOfDerivatives();
     106         296 :   if( npar==0 ) {
     107           0 :     error("one or more arguments has no derivatives");
     108             :   }
     109         919 :   for(unsigned i=1; i<nargs; i++) {
     110         623 :     (getPntrToArgument(i)->getPntrToAction())->turnOnDerivatives();
     111         623 :     if( npar!=getPntrToArgument(i)->getNumberOfDerivatives() ) {
     112           0 :       error("the number of derivatives must be the same in all values being dumped");
     113             :     }
     114             :   }
     115         296 :   checkRead();
     116         296 : }
     117             : 
     118             : 
     119       13541 : void DumpDerivatives::update() {
     120       13541 :   unsigned npar=getPntrToArgument(0)->getNumberOfDerivatives();
     121      925251 :   for(unsigned ipar=0; ipar<npar; ipar++) {
     122      911710 :     of.fmtField(" %f");
     123      911710 :     of.printField("time",getTime());
     124      911710 :     of.printField("parameter",(int)ipar);
     125     4538982 :     for(unsigned i=0; i<getNumberOfArguments(); i++) {
     126     3627272 :       of.fmtField(fmt);
     127     3627272 :       of.printField(getPntrToArgument(i)->getName(),getPntrToArgument(i)->getDerivative(ipar) );
     128             :     }
     129      911710 :     of.printField();
     130             :   }
     131       13541 : }
     132             : 
     133         592 : DumpDerivatives::~DumpDerivatives() {
     134         592 : }
     135             : 
     136             : }
     137             : 
     138             : 
     139             : }