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 "Bias.h"
23 : #include "core/ActionRegister.h"
24 :
25 : namespace PLMD {
26 : namespace bias {
27 :
28 : //+PLUMEDOC BIAS UPPER_WALLS
29 : /*
30 : Defines a wall for the value of one or more collective variables,
31 : which limits the region of the phase space accessible during the simulation.
32 :
33 : The restraining potential starts acting on the system when the value of the CV is greater
34 : (in the case of UPPER_WALLS) or lower (in the case of LOWER_WALLS) than a certain limit \f$a_i\f$ (AT)
35 : minus an offset \f$o_i\f$ (OFFSET).
36 : The expression for the bias due to the wall is given by:
37 :
38 : for UPPER_WALLS:
39 : \f$
40 : \sum_i {k_i}((x_i-a_i+o_i)/s_i)^e_i
41 : \f$
42 :
43 : for LOWER_WALLS:
44 : \f$
45 : \sum_i {k_i}|(x_i-a_i-o_i)/s_i|^e_i
46 : \f$
47 :
48 : \f$k_i\f$ (KAPPA) is an energy constant in internal unit of the code, \f$s_i\f$ (EPS) a rescaling factor and
49 : \f$e_i\f$ (EXP) the exponent determining the power law. By default: EXP = 2, EPS = 1.0, OFFSET = 0.
50 :
51 :
52 : \par Examples
53 :
54 : The following input tells plumed to add both a lower and an upper walls on the distance
55 : between atoms 3 and 5 and the distance between atoms 2 and 4. The lower and upper limits
56 : are defined at different values. The strength of the walls is the same for the four cases.
57 : It also tells plumed to print the energy of the walls.
58 : \plumedfile
59 : DISTANCE ATOMS=3,5 LABEL=d1
60 : DISTANCE ATOMS=2,4 LABEL=d2
61 : UPPER_WALLS ARG=d1,d2 AT=1.0,1.5 KAPPA=150.0,150.0 EXP=2,2 EPS=1,1 OFFSET=0,0 LABEL=uwall
62 : LOWER_WALLS ARG=d1,d2 AT=0.0,1.0 KAPPA=150.0,150.0 EXP=2,2 EPS=1,1 OFFSET=0,0 LABEL=lwall
63 : PRINT ARG=uwall.bias,lwall.bias
64 : \endplumedfile
65 :
66 : */
67 : //+ENDPLUMEDOC
68 :
69 : //+PLUMEDOC BIAS UPPER_WALLS_SCALAR
70 : /*
71 : Defines a wall for the value of one or more collective variables,
72 : which limits the region of the phase space accessible during the simulation.
73 :
74 : \par Examples
75 :
76 : */
77 : //+ENDPLUMEDOC
78 :
79 : class UWalls : public Bias {
80 : std::vector<double> at;
81 : std::vector<double> kappa;
82 : std::vector<double> exp;
83 : std::vector<double> eps;
84 : std::vector<double> offset;
85 : public:
86 : explicit UWalls(const ActionOptions&);
87 : void calculate() override;
88 : static void registerKeywords(Keywords& keys);
89 : };
90 :
91 : PLUMED_REGISTER_ACTION(UWalls,"UPPER_WALLS_SCALAR")
92 :
93 30 : void UWalls::registerKeywords(Keywords& keys) {
94 30 : Bias::registerKeywords(keys); keys.setDisplayName("UPPER_WALLS");
95 90 : keys.use("ARG"); keys.add("hidden","NO_ACTION_LOG","suppresses printing from action on the log");
96 60 : keys.add("compulsory","AT","the positions of the wall. The a_i in the expression for a wall.");
97 60 : keys.add("compulsory","KAPPA","the force constant for the wall. The k_i in the expression for a wall.");
98 60 : keys.add("compulsory","OFFSET","0.0","the offset for the start of the wall. The o_i in the expression for a wall.");
99 60 : keys.add("compulsory","EXP","2.0","the powers for the walls. The e_i in the expression for a wall.");
100 60 : keys.add("compulsory","EPS","1.0","the values for s_i in the expression for a wall");
101 60 : keys.addOutputComponent("force2","default","the instantaneous value of the squared force due to this bias potential");
102 30 : }
103 :
104 14 : UWalls::UWalls(const ActionOptions&ao):
105 : PLUMED_BIAS_INIT(ao),
106 28 : at(getNumberOfArguments(),0),
107 14 : kappa(getNumberOfArguments(),0.0),
108 14 : exp(getNumberOfArguments(),2.0),
109 14 : eps(getNumberOfArguments(),1.0),
110 28 : offset(getNumberOfArguments(),0.0)
111 : {
112 : // Note : the sizes of these vectors are checked automatically by parseVector
113 14 : parseVector("OFFSET",offset);
114 14 : parseVector("EPS",eps);
115 14 : parseVector("EXP",exp);
116 14 : parseVector("KAPPA",kappa);
117 14 : parseVector("AT",at);
118 14 : checkRead();
119 :
120 14 : log.printf(" at");
121 28 : for(unsigned i=0; i<at.size(); i++) log.printf(" %f",at[i]);
122 14 : log.printf("\n");
123 14 : log.printf(" with an offset");
124 28 : for(unsigned i=0; i<offset.size(); i++) log.printf(" %f",offset[i]);
125 14 : log.printf("\n");
126 14 : log.printf(" with force constant");
127 28 : for(unsigned i=0; i<kappa.size(); i++) log.printf(" %f",kappa[i]);
128 14 : log.printf("\n");
129 14 : log.printf(" and exponent");
130 28 : for(unsigned i=0; i<exp.size(); i++) log.printf(" %f",exp[i]);
131 14 : log.printf("\n");
132 14 : log.printf(" rescaled");
133 28 : for(unsigned i=0; i<eps.size(); i++) log.printf(" %f",eps[i]);
134 14 : log.printf("\n");
135 :
136 28 : addComponent("force2"); componentIsNotPeriodic("force2");
137 14 : }
138 :
139 14059 : void UWalls::calculate() {
140 : double ene=0.0;
141 : double totf2=0.0;
142 28118 : for(unsigned i=0; i<getNumberOfArguments(); ++i) {
143 : double f = 0.0;
144 14059 : const double cv=difference(i,at[i],getArgument(i));
145 14059 : const double off=offset[i];
146 14059 : const double epsilon=eps[i];
147 14059 : const double uscale = (cv+off)/epsilon;
148 14059 : if( uscale > 0.) {
149 26 : const double k=kappa[i];
150 26 : const double exponent=exp[i];
151 26 : double power = pow( uscale, exponent );
152 26 : f = -( k / epsilon ) * exponent * power / uscale;
153 26 : ene += k * power;
154 26 : totf2 += f * f;
155 : }
156 14059 : setOutputForce(i,f);
157 : }
158 14059 : setBias(ene);
159 14059 : getPntrToComponent("force2")->set(totf2);
160 14059 : }
161 :
162 : }
163 : }
|
