Line data Source code
1 : /* +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 : Copyright (c) 2017-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 : #include "core/PlumedMain.h"
25 : #include "tools/Communicator.h"
26 :
27 : namespace PLMD {
28 : namespace colvar {
29 :
30 : //+PLUMEDOC COLVAR DIMER
31 : /*
32 : This CV computes the dimer interaction energy for a collection of dimers.
33 :
34 : Each dimer represents an atom, as described in the dimer paper that is referenced in the bibliography
35 : A system of N atoms is thus represented with N dimers, each
36 : Dimer being composed of two beads and a virtual site representing its center of mass.
37 :
38 : A typical configuration for a dimerized system has the following ordering of atoms:
39 :
40 : ````
41 : 1 TAG1 X Y Z N atoms representing the first bead of each Dimer
42 :
43 : 2 TAG2 X Y Z
44 :
45 : ...
46 :
47 : N TAGN X Y Z N atoms representing the second bead of each Dimer
48 :
49 : N+1 TAG1 X Y Z
50 :
51 : N+2 TAG2 X Y Z
52 :
53 : ...
54 :
55 : 2N TAGN X Y Z Optional: N atoms representing the center of mass of each Dimer
56 :
57 : 2N+1 TAG1 X Y Z
58 :
59 : 2N+2 TAG2 X Y Z
60 :
61 : ...
62 :
63 : 3N TAGN X Y Z The configuration might go on with un-dimerized atoms (like a solvent)
64 :
65 : 3N+1
66 :
67 : 3N+2
68 :
69 : ...
70 : ````
71 :
72 : The Dimer interaction energy is defined between atoms x and N+x, for x=1,...,N and is
73 : characterized by two parameters Q and DSIGMA. These are passed as mandatory arguments along with
74 : the temperature of the system.
75 :
76 : ## Examples
77 :
78 : This line tells Plumed to compute the Dimer interaction energy for every dimer in the system.
79 :
80 : ```plumed
81 : dim: DIMER TEMP=300 Q=0.5 ALLATOMS DSIGMA=0.002
82 : ```
83 :
84 : If the simulation doesn't use virtual sites for the dimers centers of mass,
85 : Plumed has to know in order to determine correctly the total number of dimers from
86 : the total number of atoms:
87 :
88 : ```plumed
89 : dim: DIMER TEMP=300 Q=0.5 ALLATOMS DSIGMA=0.002 NOVSITES
90 : ```
91 :
92 : The NOVSITES flag is not required if one provides the atom serials of each Dimer. These are
93 : defined through two lists of atoms provided __instead__ of the ALLATOMS keyword.
94 : For example, the Dimer interaction energy of dimers specified by beads (1;23),(5;27),(7;29) is:
95 :
96 : ```plumed
97 : dim: DIMER TEMP=300 Q=0.5 ATOMS1=1,5,7 ATOMS2=23,27,29 DSIGMA=0.002
98 : ```
99 :
100 : Note that the ATOMS1,ATOMS2 keywords can support atom groups and
101 : interval notation as defined in [GROUP](GROUP.md).
102 :
103 : In a Replica Exchange simulations the keyword DSIGMA can be used in two ways:
104 : if a plumed.n.dat file is provided for each replica, then DSIGMA is passed as a single value,
105 : like in the previous examples, and each replica will read its own DSIGMA value. If
106 : a unique plumed.dat is given, DSIGMA has to be a list containing a value for each replica.
107 : For 4 replicas:
108 :
109 : ```plumed
110 : #SETTINGS NREPLICAS=4
111 : dim: DIMER TEMP=300 Q=0.5 ATOMS1=1,5,7 ATOMS2=23,27,29 DSIGMA=0.002,0.002,0.004,0.01
112 : ```
113 :
114 : ## Using the CV
115 :
116 : The dimer interaction is not coded in the driver program and has to be inserted
117 : in the Hamiltonian of the system as a linear RESTRAINT (see [RESTRAINT](RESTRAINT.md)):
118 :
119 : ```plumed
120 : dim: DIMER TEMP=300 Q=0.5 ALLATOMS DSIGMA=0.002
121 : RESTRAINT ARG=dim AT=0 KAPPA=0 SLOPE=1 LABEL=dimforces
122 : ```
123 :
124 : In a replica exchange, Metadynamics (see [METAD](METAD.md)) can be used on the Dimer CV to reduce
125 : the number of replicas. Just keep in mind that METAD SIGMA values should be tuned
126 : in the standard way for each replica according to the value of DSIGMA.
127 : */
128 : //+ENDPLUMEDOC
129 :
130 : class Dimer : public Colvar {
131 : public:
132 : static void registerKeywords( Keywords& keys);
133 : explicit Dimer(const ActionOptions&);
134 : void calculate() override;
135 : protected:
136 : bool trimer,useall;
137 : int myrank, nranks;
138 : double qexp,temperature,beta,dsigma;
139 : std::vector<double> dsigmas;
140 : private:
141 : void consistencyCheck();
142 : std::vector<AtomNumber> usedatoms1;
143 : std::vector<AtomNumber> usedatoms2;
144 :
145 : };
146 :
147 : PLUMED_REGISTER_ACTION(Dimer, "DIMER")
148 :
149 :
150 :
151 4 : void Dimer::registerKeywords( Keywords& keys) {
152 4 : Colvar::registerKeywords(keys);
153 :
154 4 : keys.add("compulsory","DSIGMA","The interaction strength of the dimer bond.");
155 4 : keys.add("compulsory", "Q", "The exponent of the dimer potential.");
156 4 : keys.add("compulsory", "TEMP", "The temperature (in Kelvin) of the simulation.");
157 4 : keys.add("atoms", "ATOMS1", "The list of atoms representing the first bead of each Dimer being considered by this CV. Used if ALLATOMS flag is missing");
158 4 : keys.add("atoms", "ATOMS2", "The list of atoms representing the second bead of each Dimer being considered by this CV. Used if ALLATOMS flag is missing");
159 4 : keys.addFlag("ALLATOMS", false, "Use EVERY atom of the system. Overrides ATOMS keyword.");
160 4 : keys.addFlag("NOVSITES", false, "If present the configuration is without virtual sites at the centroid positions.");
161 8 : keys.setValueDescription("scalar","the dimer interaction energy");
162 4 : keys.addDOI("10.1021/acs.jctc.6b00691");
163 4 : }
164 :
165 :
166 :
167 2 : Dimer::Dimer(const ActionOptions& ao):
168 2 : PLUMED_COLVAR_INIT(ao) {
169 :
170 4 : log<<" Bibliography "<<plumed.cite("M Nava, F. Palazzesi, C. Perego and M. Parrinello, J. Chem. Theory Comput. 13, 425(2017)")<<"\n";
171 2 : parseVector("DSIGMA",dsigmas);
172 2 : parse("Q",qexp);
173 4 : parse("TEMP",temperature);
174 :
175 :
176 : std::vector<AtomNumber> atoms;
177 2 : parseFlag("ALLATOMS",useall);
178 2 : trimer=true;
179 : bool notrim;
180 2 : parseFlag("NOVSITES",notrim);
181 2 : trimer=!notrim;
182 :
183 2 : nranks=multi_sim_comm.Get_size();
184 2 : myrank=multi_sim_comm.Get_rank();
185 2 : if(dsigmas.size()==1) {
186 2 : dsigma=dsigmas[0];
187 : } else {
188 0 : dsigma=dsigmas[myrank];
189 : }
190 :
191 :
192 :
193 :
194 2 : if(useall) {
195 : // go with every atom in the system but not the virtuals...
196 : int natoms;
197 1 : if(trimer) {
198 1 : natoms= 2*getTotAtoms()/3;
199 : } else {
200 0 : natoms=getTotAtoms()/2;
201 : }
202 :
203 45 : for(unsigned int i=0; i<((unsigned int)natoms); i++) {
204 : AtomNumber ati;
205 : ati.setIndex(i);
206 44 : atoms.push_back(ati);
207 : }
208 : } else { // serials for the first beads of each dimer are given
209 1 : parseAtomList("ATOMS1",usedatoms1);
210 2 : parseAtomList("ATOMS2",usedatoms2);
211 :
212 : int isz1 = usedatoms1.size();
213 :
214 5 : for(unsigned int i=0; i<isz1; i++) {
215 : AtomNumber ati;
216 4 : ati.setIndex(usedatoms1[i].index());
217 4 : atoms.push_back(ati);
218 : }
219 :
220 : int isz2 = usedatoms2.size();
221 5 : for(unsigned int i=0; i<isz2; i++) {
222 : AtomNumber atip2;
223 4 : atip2.setIndex(usedatoms2[i].index());
224 4 : atoms.push_back(atip2);
225 : }
226 :
227 : }
228 2 : consistencyCheck();
229 2 : checkRead();
230 2 : beta = 1./(kBoltzmann*temperature);
231 :
232 2 : addValueWithDerivatives(); // allocate
233 2 : requestAtoms(atoms);
234 2 : setNotPeriodic();
235 2 : }
236 :
237 4 : void Dimer::calculate() {
238 4 : double cv_val=0;
239 4 : Tensor virial;
240 : std::vector<Vector> derivatives;
241 4 : std::vector<Vector> my_pos=getPositions();
242 4 : int atms = my_pos.size();
243 : std::vector<Vector> der_b2;
244 38 : for(int i=0; i<atms/2; i++) {
245 34 : Vector dist;
246 34 : dist = pbcDistance(my_pos[i],my_pos[i+atms/2]);
247 : double distquad=0;
248 136 : for(int j=0; j<3; j++) {
249 102 : distquad += dist[j]*dist[j];
250 : }
251 :
252 34 : double dsigquad = dsigma*dsigma;
253 34 : double fac1 = 1.0 + distquad/(2*qexp*dsigquad);
254 34 : double fac1qm1 = std::pow(fac1,qexp-1);
255 :
256 :
257 34 : cv_val += (fac1*fac1qm1-1.0)/beta;
258 34 : Vector der_val;
259 34 : Vector mder_val;
260 136 : for(int j=0; j<3; j++) {
261 102 : der_val[j] = -fac1qm1*dist[j]/(dsigquad*beta);
262 102 : mder_val[j]=-der_val[j];
263 : }
264 34 : derivatives.push_back(der_val);
265 34 : der_b2.push_back(mder_val);
266 :
267 : // virial part: each dimer contributes -x_{ij}*ds/dx_{ij} (s is the CV)
268 34 : double dfunc = fac1qm1/(beta*dsigquad);
269 34 : Vector dd(dfunc*dist);
270 34 : Tensor vv(dd,dist);
271 34 : virial -= vv;
272 :
273 : }
274 :
275 4 : derivatives.insert(derivatives.end(), der_b2.begin(), der_b2.end());
276 :
277 72 : for(unsigned int i=0; i<derivatives.size(); i++) {
278 68 : setAtomsDerivatives(i,derivatives[i]);
279 : }
280 :
281 4 : setValue(cv_val);
282 4 : setBoxDerivatives(virial);
283 :
284 4 : }
285 :
286 :
287 :
288 : /*****************
289 : There are some conditions that a valid input should satisfy.
290 : These are checked here and PLUMED error handlers are (eventually) called.
291 : ******************/
292 2 : void Dimer::consistencyCheck() {
293 2 : if(!useall && usedatoms1.size()!=usedatoms2.size()) {
294 0 : error("The provided atom lists are of different sizes.");
295 : }
296 :
297 2 : if(qexp<0.5 || qexp>1) {
298 0 : warning("Dimer CV is meant to be used with q-exponents between 0.5 and 1. We are not responsible for any black hole. :-)");
299 : }
300 :
301 2 : if(dsigma<0) {
302 0 : error("Please use positive sigma values for the Dimer strength constant");
303 : }
304 :
305 2 : if(temperature<0) {
306 0 : error("Please, use a positive value for the temperature...");
307 : }
308 :
309 : // if dsigmas has only one element means that either
310 : // you are using different plumed.x.dat files or a plumed.dat with a single replica
311 2 : if(dsigmas.size()!=nranks && dsigmas.size()!=1) {
312 0 : error("Mismatch between provided sigmas and number of replicas");
313 : }
314 :
315 2 : }
316 :
317 :
318 : }
319 : }
320 :
|
