All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Bias.cpp
Go to the documentation of this file.
1 /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2  Copyright (c) 2013 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-code.org for more information.
6 
7  This file is part of plumed, version 2.0.
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 
29 Action(ao),
30 ActionPilot(ao),
31 ActionWithValue(ao),
33 outputForces(getNumberOfArguments(),0.0)
34 {
35  if(getStride()>1) error("Using bias with stride!=1 is not currently supported");
36 }
37 
43  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");
44 }
45 
46 void Bias::apply(){
47  if(onStep()) for(unsigned i=0;i<getNumberOfArguments();++i){
49  }
50 }
51 
52 }
53 }
54 
55 
static void registerKeywords(Keywords &keys)
Register all the relevant keywords for the action.
void addForce(double f)
Add some force on this value.
Definition: Value.h:247
std::vector< double > outputForces
Definition: Bias.h:45
This is used to create PLMD::Action objects that are run with some set frequency. ...
Definition: ActionPilot.h:39
static void registerKeywords(Keywords &keys)
Registers the list of keywords.
void error(const std::string &msg) const
Crash calculation and print documentation.
Definition: Action.cpp:195
Value * getPntrToArgument(const unsigned n)
Return a pointer to specific argument.
void add(const std::string &t, const std::string &k, const std::string &d)
Add a new keyword of type t with name k and description d.
Definition: Keywords.cpp:167
This is used to create PLMD::Action objects that take the output from some other Action as input...
Bias(const ActionOptions &ao)
Definition: Bias.cpp:28
Used to create a PLMD::Action that has some scalar or vectorial output that may or may not have some ...
int getStride() const
Definition: ActionPilot.cpp:42
This class holds the keywords and their documentation.
Definition: Keywords.h:36
This class is used to bring the relevant information to the Action constructor.
Definition: Action.h:41
Base class for all the input Actions.
Definition: Action.h:60
static void registerKeywords(Keywords &keys)
Register all the relevant keywords for the action.
Definition: Action.cpp:49
static void registerKeywords(Keywords &keys)
Create the keywords for actionPilot.
Definition: ActionPilot.cpp:27
void apply()
Apply an Action.
Definition: Bias.cpp:46
static void registerKeywords(Keywords &)
Definition: Bias.cpp:38
bool onStep() const
Check if the action is active on this step.
Definition: ActionPilot.cpp:38
unsigned getNumberOfArguments() const
Returns the number of arguments.