Line data Source code
1 : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 : Copyright (c) 2013-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 :
23 : #include "core/ActionPilot.h"
24 : #include "core/ActionWithArguments.h"
25 : #include "core/ActionRegister.h"
26 : #include "core/PlumedMain.h"
27 :
28 : namespace PLMD {
29 : namespace generic {
30 :
31 : //+PLUMEDOC PRINTANALYSIS COMMITTOR
32 : /*
33 : Does a committor analysis.
34 :
35 : The following input monitors two torsional angles during a simulation,
36 : defines two basins (A and B) as a function of the two torsion angles and
37 : stops the simulation when it falls in one of the two. The log
38 : file shows the latest values for the CVs and the basin reached.
39 :
40 : ```plumed
41 : TORSION ATOMS=1,2,3,4 LABEL=r1
42 : TORSION ATOMS=2,3,4,5 LABEL=r2
43 : COMMITTOR ...
44 : ARG=r1,r2
45 : STRIDE=10
46 : BASIN_LL1=0.15,0.20
47 : BASIN_UL1=0.25,0.40
48 : BASIN_LL2=-0.25,-0.40
49 : BASIN_UL2=-0.15,-0.20
50 : ... COMMITTOR
51 : ```
52 :
53 : */
54 : //+ENDPLUMEDOC
55 :
56 : class Committor :
57 : public ActionPilot,
58 : public ActionWithArguments {
59 : private:
60 : std::string file;
61 : OFile ofile;
62 : std::string fmt;
63 : std::vector< std::vector<double> > lowerlimits;
64 : std::vector< std::vector<double> > upperlimits;
65 : unsigned nbasins;
66 : unsigned basin;
67 : bool doNotStop;
68 : public:
69 : static void registerKeywords( Keywords& keys );
70 : explicit Committor(const ActionOptions&ao);
71 : void calculate() override;
72 30 : void apply() override {}
73 : };
74 :
75 : PLUMED_REGISTER_ACTION(Committor,"COMMITTOR")
76 :
77 11 : void Committor::registerKeywords( Keywords& keys ) {
78 11 : Action::registerKeywords(keys);
79 11 : ActionPilot::registerKeywords(keys);
80 11 : ActionWithArguments::registerKeywords(keys);
81 22 : keys.addInputKeyword("compulsory","ARG","scalar","the labels of the values which is being used to define the committor surface");
82 11 : keys.add("numbered", "BASIN_LL","List of lower limits for basin #");
83 11 : keys.add("numbered", "BASIN_UL","List of upper limits for basin #");
84 22 : keys.reset_style("BASIN_LL","compulsory");
85 22 : keys.reset_style("BASIN_UL","compulsory");
86 11 : keys.add("compulsory","STRIDE","1","the frequency with which the CVs are analyzed");
87 11 : keys.add("optional","FILE","the name of the file on which to output the reached basin");
88 11 : keys.add("optional","FMT","the format that should be used to output real numbers");
89 11 : keys.addFlag("NOSTOP",false,"if true do not stop the simulation when reaching a basin but just keep track of it");
90 11 : }
91 :
92 9 : Committor::Committor(const ActionOptions&ao):
93 : Action(ao),
94 : ActionPilot(ao),
95 : ActionWithArguments(ao),
96 9 : fmt("%f"),
97 9 : basin(0),
98 18 : doNotStop(false) {
99 9 : ofile.link(*this);
100 18 : parse("FILE",file);
101 9 : if(file.length()>0) {
102 2 : ofile.open(file);
103 2 : log.printf(" on file %s\n",file.c_str());
104 : } else {
105 7 : log.printf(" on plumed log file\n");
106 7 : ofile.link(log);
107 : }
108 9 : parse("FMT",fmt);
109 9 : fmt=" "+fmt;
110 9 : log.printf(" with format %s\n",fmt.c_str());
111 :
112 13 : for(unsigned b=1;; ++b ) {
113 : std::vector<double> tmpl, tmpu;
114 22 : parseNumberedVector("BASIN_LL", b, tmpl );
115 44 : parseNumberedVector("BASIN_UL", b, tmpu );
116 22 : if( tmpl.empty() && tmpu.empty() ) {
117 : break;
118 : }
119 13 : if( tmpl.size()!=getNumberOfArguments()) {
120 0 : error("Wrong number of values for BASIN_LL: they should be equal to the number of arguments");
121 : }
122 13 : if( tmpu.size()!=getNumberOfArguments()) {
123 0 : error("Wrong number of values for BASIN_UL: they should be equal to the number of arguments");
124 : }
125 13 : lowerlimits.push_back(tmpl);
126 13 : upperlimits.push_back(tmpu);
127 13 : nbasins=b;
128 13 : }
129 :
130 9 : parseFlag("NOSTOP", doNotStop);
131 :
132 9 : checkRead();
133 :
134 :
135 22 : for(unsigned b=0; b<nbasins; b++) {
136 13 : log.printf(" BASIN %u definition:\n", b+1);
137 32 : for(unsigned i=0; i<getNumberOfArguments(); ++i) {
138 19 : if(lowerlimits[b][i]>upperlimits[b][i]) {
139 0 : error("COMMITTOR: UPPER bounds must always be greater than LOWER bounds");
140 : }
141 19 : log.printf(" %f - %f\n", lowerlimits[b][i], upperlimits[b][i]);
142 : }
143 13 : if(doNotStop) {
144 3 : log.printf(" COMMITOR will keep track of the visited basins without stopping the simulations\n");
145 : }
146 : }
147 :
148 20 : for(unsigned i=0; i<getNumberOfArguments(); ++i) {
149 11 : ofile.setupPrintValue( getPntrToArgument(i) );
150 : }
151 9 : }
152 :
153 30 : void Committor::calculate() {
154 : std::vector<unsigned> inbasin;
155 30 : inbasin.assign (nbasins,1);
156 :
157 : // check if current configuration belongs to a basin
158 106 : for(unsigned b=0; b<nbasins; ++b) {
159 221 : for(unsigned i=0; i<getNumberOfArguments(); ++i) {
160 145 : if(getArgument(i)>lowerlimits[b][i]&&getArgument(i)<upperlimits[b][i]) {
161 : inbasin[b]*=1;
162 : } else {
163 80 : inbasin[b]*=0;
164 : }
165 : }
166 : }
167 :
168 : // check in which basin we are if any and if this is the same or a new one
169 : bool inonebasin = false;
170 71 : for(unsigned b=0; b<nbasins; ++b) {
171 61 : if(inbasin[b]==1) {
172 20 : if(basin!=(b+1)) {
173 15 : basin = b+1;
174 15 : ofile.fmtField(" %f");
175 15 : ofile.printField("time",getTime());
176 38 : for(unsigned i=0; i<getNumberOfArguments(); i++) {
177 23 : ofile.fmtField(fmt);
178 23 : ofile.printField( getPntrToArgument(i), getArgument(i) );
179 : }
180 15 : ofile.printField("basin", static_cast<int> (b+1));
181 15 : ofile.printField();
182 : }
183 : inonebasin = true;
184 : break;
185 : }
186 : }
187 : if(!inonebasin) {
188 10 : basin = 0;
189 : }
190 :
191 : // then check if the simulation should be stopped
192 30 : if(inonebasin&&(!doNotStop)) {
193 : std::string num;
194 8 : Tools::convert( basin, num );
195 8 : std::string str = "COMMITTED TO BASIN " + num;
196 8 : ofile.addConstantField(str);
197 8 : ofile.printField();
198 8 : ofile.flush();
199 8 : plumed.stop();
200 : }
201 30 : }
202 :
203 : }
204 : }
|
