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             : #ifndef __PLUMED_core_ActionPilot_h
      23             : #define __PLUMED_core_ActionPilot_h
      24             : 
      25             : #include "Action.h"
      26             : 
      27             : namespace PLMD {
      28             : 
      29             : /**
      30             : \ingroup MULTIINHERIT
      31             : This is used to create PLMD::Action objects that are run with some set frequency.
      32             : Any PLMD::Action
      33             : that does not inherit from PLMD::Action is only run when some other Action requires the output from
      34             : it in order to run.  This class is used in PLMD::Bias
      35             :  Action which drives the execution of other Action's.
      36             :  Action's of this kind are executed with a fixed stride
      37             :  which is specified on the directive line with a STRIDE= keyword
      38             : */
      39        1941 : class ActionPilot:
      40             :   public virtual Action
      41             : {
      42             :   int stride; // multiple time step
      43             : public:
      44             :   explicit ActionPilot(const ActionOptions&);
      45             : /// Create the keywords for actionPilot
      46             :   static void registerKeywords(Keywords& keys);
      47             : /// Check if the action is active on this step
      48             :   virtual bool onStep()const;
      49             : /// Set the value of the stride
      50             :   void setStride( const int& n );
      51             : /// Get the stride
      52             :   int getStride()const;
      53             : };
      54             : 
      55             : }
      56             : 
      57             : #endif
      58             :