Line data    Source code

       1             : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
       2             :    Copyright (c) 2012-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 "Colvar.h"
      23             : #include "core/ActionRegister.h"
      24             : 
      25             : namespace PLMD {
      26             : namespace colvar {
      27             : 
      28             : //+PLUMEDOC COLVAR FAKE
      29             : /*
      30             : This is a fake colvar container that is used by cltools or various other actions that supports input and period definitions
      31             : 
      32             : This action is used in the code for sum_hills. The following example shows how a fake input can be setup
      33             : 
      34             : ```plumed
      35             : d2: FAKE ATOMS=1 PERIODIC=-3.14,3.14
      36             : ```
      37             : 
      38             : */
      39             : //+ENDPLUMEDOC
      40             : 
      41             : class ColvarFake : public Colvar {
      42             : 
      43             : public:
      44             :   static void registerKeywords( Keywords& keys );
      45             :   explicit ColvarFake(const ActionOptions&);
      46           0 :   std::string getOutputComponentDescription( const std::string& cname, const Keywords& keys ) const override {
      47           0 :     plumed_error();
      48             :   }
      49             : // active methods:
      50             :   void calculate() override;
      51             : };
      52             : 
      53             : PLUMED_REGISTER_ACTION(ColvarFake,"FAKE")
      54             : 
      55          19 : void ColvarFake::registerKeywords( Keywords& keys ) {
      56          19 :   Colvar::registerKeywords( keys );
      57          19 :   keys.add("atoms","ATOMS","the fake atom index, a number is enough");
      58          19 :   keys.reserve("compulsory","PERIODIC","if the output of your function is periodic then you should specify the periodicity of the function.  If the output is not periodic you must state this using PERIODIC=NO,NO (one for the lower and the other for the upper boundary). For multicomponents then it is PERIODIC=mincomp1,maxcomp1,mincomp2,maxcomp2  etc ");
      59          19 :   keys.use("PERIODIC");
      60          19 :   keys.add("optional","COMPONENTS","additional components that this variable is supposed to have. Periodicity is ruled by PERIODIC keyword ");
      61          19 :   useCustomisableComponents(keys);
      62          19 : }
      63             : 
      64          17 : ColvarFake::ColvarFake(const ActionOptions&ao):
      65          17 :   PLUMED_COLVAR_INIT(ao) {
      66             :   std::vector<AtomNumber> atoms;
      67          34 :   parseAtomList("ATOMS",atoms);
      68             : 
      69             :   std::vector<std::string> comps;
      70             :   // multiple components for this variable
      71          34 :   parseVector("COMPONENTS",comps);
      72          17 :   if(comps.size()!=0) {
      73           2 :     for(unsigned i=0; i<comps.size(); i++) {
      74           2 :       addComponentWithDerivatives(comps[i]);
      75             :     }
      76             :     // periodicity
      77             :   } else {
      78             :     // only one component for this variable
      79          32 :     addValueWithDerivatives();
      80             :   }
      81             :   std::vector<std::string> period;
      82          34 :   parseVector("PERIODIC",period);
      83          17 :   if(period.size()!=0) {
      84          17 :     plumed_massert(static_cast<unsigned>(getNumberOfComponents()*2)==period.size(),"the periodicty should coincide with the number of components");
      85          17 :     if(comps.size()!=0) {
      86           2 :       for(int i=0; i<getNumberOfComponents(); i++) {
      87           1 :         std::string pp=comps[i];
      88           1 :         if(period[i*2]!="none" && period[i*2+1]!="none" ) {
      89           1 :           componentIsPeriodic(pp,period[i*2],period[i*2+1]);
      90             :         } else {
      91           0 :           componentIsNotPeriodic(pp);
      92             :         }
      93             :       }
      94             :     } else {
      95          29 :       if(period[0]!="none" && period[1]!="none" ) {
      96          13 :         setPeriodic(period[0],period[1]);
      97             :       } else {
      98           3 :         setNotPeriodic();
      99             :       }
     100             :     }
     101             :   } else {
     102           0 :     if(comps.size()!=0) {
     103           0 :       for(int i=0; i<getNumberOfComponents(); i++) {
     104           0 :         componentIsNotPeriodic(getPntrToComponent(i)->getName());
     105             :       }
     106             :     } else {
     107           0 :       setNotPeriodic();
     108             :     }
     109             :   }
     110          17 :   checkRead();
     111          17 :   requestAtoms(atoms);
     112             : 
     113          34 : }
     114             : 
     115             : 
     116             : // calculator
     117           0 : void ColvarFake::calculate() {
     118           0 :   plumed_merror("you should never have got here");
     119             : }
     120             : 
     121             : }
     122             : }
     123             : 
     124             : 
     125             :