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 "Bias.h"
      23             : 
      24             : 
      25             : namespace PLMD {
      26             : namespace bias {
      27             : 
      28         677 : Bias::Bias(const ActionOptions&ao):
      29             :   Action(ao),
      30             :   ActionPilot(ao),
      31             :   ActionWithValue(ao),
      32             :   ActionWithArguments(ao),
      33         677 :   outputForces(getNumberOfArguments(),0.0)
      34             : {
      35         674 :   addComponentWithDerivatives("bias");
      36         674 :   componentIsNotPeriodic("bias");
      37         674 :   valueBias=getPntrToComponent("bias");
      38             : 
      39         674 :   if(getStride()>1) {
      40           3 :     log<<"  multiple time step "<<getStride()<<" ";
      41           9 :     log<<cite("Ferrarotti, Bottaro, Perez-Villa, and Bussi, J. Chem. Theory Comput. 11, 139 (2015)")<<"\n";
      42             :   }
      43        4478 :   for(unsigned i=0; i<getNumberOfArguments(); ++i) {
      44        3804 :     (getPntrToArgument(i)->getPntrToAction())->turnOnDerivatives();
      45             :   }
      46             : 
      47         674 :   ActionWithValue::turnOnDerivatives();
      48         677 : }
      49             : 
      50         703 : void Bias::registerKeywords( Keywords& keys ) {
      51         703 :   Action::registerKeywords(keys);
      52         703 :   ActionPilot::registerKeywords(keys);
      53         703 :   ActionWithValue::registerKeywords(keys);
      54         703 :   ActionWithArguments::registerKeywords(keys);
      55        1406 :   keys.add("hidden","STRIDE","the frequency with which the forces due to the bias should be calculated.  This can be used to correctly set up multistep algorithms");
      56         703 :   componentsAreNotOptional(keys);
      57        1406 :   keys.addOutputComponent("bias","default","the instantaneous value of the bias potential");
      58         703 : }
      59             : 
      60       78568 : void Bias::apply() {
      61       78568 :   const unsigned noa=getNumberOfArguments();
      62       78568 :   const unsigned ncp=getNumberOfComponents();
      63             : 
      64       78568 :   if(onStep()) {
      65       78568 :     double gstr = static_cast<double>(getStride());
      66      224452 :     for(unsigned i=0; i<noa; ++i) {
      67      145884 :       getPntrToArgument(i)->addForce(gstr*outputForces[i]);
      68             :     }
      69             :   }
      70             : 
      71             :   // additional forces on the bias component
      72       78568 :   std::vector<double> f(noa,0.0);
      73       78568 :   std::vector<double> forces(noa);
      74             : 
      75             :   bool at_least_one_forced=false;
      76      398265 :   for(unsigned i=0; i<ncp; ++i) {
      77      319697 :     if(getPntrToComponent(i)->applyForce(forces)) {
      78             :       at_least_one_forced=true;
      79         913 :       for(unsigned j=0; j<noa; j++) f[j]+=forces[j];
      80             :     }
      81             :   }
      82             : 
      83       78568 :   if(at_least_one_forced && !onStep()) error("you are biasing a bias with an inconsistent STRIDE");
      84             : 
      85       79409 :   if(at_least_one_forced) for(unsigned i=0; i<noa; ++i) {
      86         559 :       getPntrToArgument(i)->addForce(f[i]);
      87             :     }
      88             : 
      89       78568 : }
      90             : 
      91             : }
      92             : }
      93             : 
      94             :