Merge branch release-2021 into merge-2021-into-master
[alexxy/gromacs.git] / src / gromacs / topology / idef.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5  * Copyright (c) 2001-2004, The GROMACS development team.
6  * Copyright (c) 2013,2014,2015,2016,2018 by the GROMACS development team.
7  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9  * and including many others, as listed in the AUTHORS file in the
10  * top-level source directory and at http://www.gromacs.org.
11  *
12  * GROMACS is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Lesser General Public License
14  * as published by the Free Software Foundation; either version 2.1
15  * of the License, or (at your option) any later version.
16  *
17  * GROMACS is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with GROMACS; if not, see
24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
26  *
27  * If you want to redistribute modifications to GROMACS, please
28  * consider that scientific software is very special. Version
29  * control is crucial - bugs must be traceable. We will be happy to
30  * consider code for inclusion in the official distribution, but
31  * derived work must not be called official GROMACS. Details are found
32  * in the README & COPYING files - if they are missing, get the
33  * official version at http://www.gromacs.org.
34  *
35  * To help us fund GROMACS development, we humbly ask that you cite
36  * the research papers on the package. Check out http://www.gromacs.org.
37  */
38 #ifndef GMX_TOPOLOGY_IDEF_H
39 #define GMX_TOPOLOGY_IDEF_H
40
41 #include <cstdio>
42
43 #include <array>
44 #include <vector>
45
46 #include "gromacs/math/vectypes.h"
47 #include "gromacs/topology/ifunc.h"
48 #include "gromacs/utility/real.h"
49
50 struct gmx_ffparams_t;
51
52 typedef union t_iparams {
53     /* Some parameters have A and B values for free energy calculations.
54      * The B values are not used for regular simulations of course.
55      * Free Energy for nonbondeds can be computed by changing the atom type.
56      * The harmonic type is used for all harmonic potentials:
57      * bonds, angles and improper dihedrals
58      */
59     struct
60     {
61         real a, b, c;
62     } bham;
63     struct
64     {
65         real rA, krA, rB, krB;
66     } harmonic;
67     struct
68     {
69         real klinA, aA, klinB, aB;
70     } linangle;
71     struct
72     {
73         real lowA, up1A, up2A, kA, lowB, up1B, up2B, kB;
74     } restraint;
75     /* No free energy supported for cubic bonds, FENE, WPOL or cross terms */
76     struct
77     {
78         real b0, kb, kcub;
79     } cubic;
80     struct
81     {
82         real bm, kb;
83     } fene;
84     struct
85     {
86         real r1e, r2e, krr;
87     } cross_bb;
88     struct
89     {
90         real r1e, r2e, r3e, krt;
91     } cross_ba;
92     struct
93     {
94         real thetaA, kthetaA, r13A, kUBA, thetaB, kthetaB, r13B, kUBB;
95     } u_b;
96     struct
97     {
98         real theta, c[5];
99     } qangle;
100     struct
101     {
102         real alpha;
103     } polarize;
104     struct
105     {
106         real alpha, drcut, khyp;
107     } anharm_polarize;
108     struct
109     {
110         real al_x, al_y, al_z, rOH, rHH, rOD;
111     } wpol;
112     struct
113     {
114         real a, alpha1, alpha2, rfac;
115     } thole;
116     struct
117     {
118         real c6, c12;
119     } lj;
120     struct
121     {
122         real c6A, c12A, c6B, c12B;
123     } lj14;
124     struct
125     {
126         real fqq, qi, qj, c6, c12;
127     } ljc14;
128     struct
129     {
130         real qi, qj, c6, c12;
131     } ljcnb;
132     /* Proper dihedrals can not have different multiplicity when
133      * doing free energy calculations, because the potential would not
134      * be periodic anymore.
135      */
136     struct
137     {
138         real phiA, cpA;
139         int  mult;
140         real phiB, cpB;
141     } pdihs;
142     struct
143     {
144         real dA, dB;
145     } constr;
146     /* Settle can not be used for Free energy calculations of water bond geometry.
147      * Use shake (or lincs) instead if you have to change the water bonds.
148      */
149     struct
150     {
151         real doh, dhh;
152     } settle;
153     struct
154     {
155         real b0A, cbA, betaA, b0B, cbB, betaB;
156     } morse;
157     struct
158     {
159         real pos0A[DIM], fcA[DIM], pos0B[DIM], fcB[DIM];
160     } posres;
161     struct
162     {
163         real pos0[DIM], r, k;
164         int  geom;
165     } fbposres;
166     struct
167     {
168         real rbcA[NR_RBDIHS], rbcB[NR_RBDIHS];
169     } rbdihs;
170     struct
171     {
172         real cbtcA[NR_CBTDIHS], cbtcB[NR_CBTDIHS];
173     } cbtdihs;
174     struct
175     {
176         real a, b, c, d, e, f;
177     } vsite;
178     struct
179     {
180         int  n;
181         real a;
182     } vsiten;
183     /* NOTE: npair is only set after reading the tpx file */
184     struct
185     {
186         real low, up1, up2, kfac;
187         int  type, label, npair;
188     } disres;
189     struct
190     {
191         real phiA, dphiA, kfacA, phiB, dphiB, kfacB;
192     } dihres;
193     struct
194     {
195         int  ex, power, label;
196         real c, obs, kfac;
197     } orires;
198     struct
199     {
200         int  table;
201         real kA;
202         real kB;
203     } tab;
204     struct
205     {
206         int cmapA, cmapB;
207     } cmap;
208     struct
209     {
210         real buf[MAXFORCEPARAM];
211     } generic; /* Conversion */
212 } t_iparams;
213
214 typedef int t_functype;
215
216 /* List of listed interactions, see description further down.
217  *
218  * TODO: Consider storing the function type as well.
219  * TODO: Consider providing per interaction access.
220  */
221 struct InteractionList
222 {
223     /* Returns the total number of elements in iatoms */
224     int size() const { return static_cast<int>(iatoms.size()); }
225
226     /* Returns whether the list is empty */
227     bool empty() const { return iatoms.empty(); }
228
229     /* Adds one interaction to the list */
230     template<std::size_t numAtoms>
231     void push_back(const int parameterType, const std::array<int, numAtoms>& atoms)
232     {
233         const std::size_t oldSize = iatoms.size();
234         iatoms.resize(iatoms.size() + 1 + numAtoms);
235         iatoms[oldSize] = parameterType;
236         for (std::size_t i = 0; i < numAtoms; i++)
237         {
238             iatoms[oldSize + 1 + i] = atoms[i];
239         }
240     }
241
242     /* Adds one interaction to the list */
243     void push_back(const int parameterType, const int numAtoms, const int* atoms)
244     {
245         const std::size_t oldSize = iatoms.size();
246         iatoms.resize(iatoms.size() + 1 + numAtoms);
247         iatoms[oldSize] = parameterType;
248         for (int i = 0; i < numAtoms; i++)
249         {
250             iatoms[oldSize + 1 + i] = atoms[i];
251         }
252     }
253
254     /* Appends \p ilist at the back of the list */
255     void append(const InteractionList& ilist)
256     {
257         iatoms.insert(iatoms.end(), ilist.iatoms.begin(), ilist.iatoms.end());
258     }
259
260     /* Clears the list */
261     void clear() { iatoms.clear(); }
262
263     /* List of interactions, see explanation further down */
264     std::vector<int> iatoms;
265 };
266
267 /* List of interaction lists, one list for each interaction type
268  *
269  * TODO: Consider only including entries in use instead of all F_NRE
270  */
271 using InteractionLists = std::array<InteractionList, F_NRE>;
272
273 /* Deprecated list of listed interactions */
274 struct t_ilist
275 {
276     /* Returns the total number of elements in iatoms */
277     int size() const { return nr; }
278
279     /* Returns whether the list is empty */
280     bool empty() const { return nr == 0; }
281
282     int      nr;
283     t_iatom* iatoms;
284     int      nalloc;
285 };
286
287 /* TODO: Remove t_ilist and remove templating on list type in mshift.cpp */
288
289 /*
290  * The structs InteractionList and t_ilist defines a list of atoms with their interactions.
291  * General field description:
292  *   int nr
293  *      the size (nr elements) of the interactions array (iatoms[]).
294  *   t_iatom *iatoms
295  *  specifies which atoms are involved in an interaction of a certain
296  *       type. The layout of this array is as follows:
297  *
298  *        +-----+---+---+---+-----+---+---+-----+---+---+---+-----+---+---+...
299  *        |type1|at1|at2|at3|type2|at1|at2|type1|at1|at2|at3|type3|at1|at2|
300  *        +-----+---+---+---+-----+---+---+-----+---+---+---+-----+---+---+...
301  *
302  *  So for interaction type type1 3 atoms are needed, and for type2 and
303  *      type3 only 2. The type identifier is used to select the function to
304  *      calculate the interaction and its actual parameters. This type
305  *      identifier is an index in a params[] and functype[] array.
306  */
307
308 /*! \brief Type for returning a list of InteractionList references
309  *
310  * TODO: Remove when the function type is made part of InteractionList
311  */
312 struct InteractionListHandle
313 {
314     const int               functionType; //!< The function type
315     const std::vector<int>& iatoms;       //!< Reference to interaction list
316 };
317
318 /*! \brief Returns a list of all non-empty InteractionList entries with any of the interaction flags in \p flags set
319  *
320  * \param[in] ilists  Set of interaction lists
321  * \param[in] flags   Bit mask with one or more IF_... bits set
322  */
323 static inline std::vector<InteractionListHandle> extractILists(const InteractionLists& ilists, int flags)
324 {
325     std::vector<InteractionListHandle> handles;
326     for (size_t ftype = 0; ftype < ilists.size(); ftype++)
327     {
328         if ((interaction_function[ftype].flags & flags) && !ilists[ftype].empty())
329         {
330             handles.push_back({ static_cast<int>(ftype), ilists[ftype].iatoms });
331         }
332     }
333     return handles;
334 }
335
336 /*! \brief Returns the stride for the iatoms array in \p ilistHandle
337  *
338  * \param[in] ilistHandle  The ilist to return the stride for
339  */
340 static inline int ilistStride(const InteractionListHandle& ilistHandle)
341 {
342     return 1 + NRAL(ilistHandle.functionType);
343 }
344
345 struct gmx_cmapdata_t
346 {
347     std::vector<real> cmap; /* Has length 4*grid_spacing*grid_spacing, */
348     /* there are 4 entries for each cmap type (V,dVdx,dVdy,d2dVdxdy) */
349 };
350
351 struct gmx_cmap_t
352 {
353     int                         grid_spacing = 0; /* Grid spacing */
354     std::vector<gmx_cmapdata_t> cmapdata; /* Lists of grids with actual, pre-interpolated data */
355 };
356
357
358 enum
359 {
360     ilsortUNKNOWN,
361     ilsortNO_FE,
362     ilsortFE_UNSORTED,
363     ilsortFE_SORTED
364 };
365
366 /* Struct with list of interaction parameters and lists of interactions
367  *
368  * TODO: Convert to a proper class with private data members so we can
369  * ensure that the free-energy sorting and sorting setting is consistent.
370  */
371 class InteractionDefinitions
372 {
373 public:
374     /* Constructor
375      *
376      * \param[in] ffparams  The interaction parameters, the lifetime of the created object should not exceed the lifetime of the passed parameters
377      */
378     InteractionDefinitions(const gmx_ffparams_t& ffparams);
379
380     // Clears data not read in from ffparams
381     void clear();
382
383     // The interaction parameters
384     const std::vector<t_iparams>& iparams;
385     // The function type per type
386     const std::vector<int>& functype;
387     // Position restraint interaction parameters
388     std::vector<t_iparams> iparams_posres;
389     // Flat-bottomed position restraint parameters
390     std::vector<t_iparams> iparams_fbposres;
391     // The list of interactions for each type. Note that some, such as LJ and COUL will have 0 entries.
392     std::array<InteractionList, F_NRE> il;
393     /* The number of non-perturbed interactions at the start of each entry in il */
394     std::array<int, F_NRE> numNonperturbedInteractions;
395     // The sorting state of interaction in il
396     int ilsort = ilsortUNKNOWN;
397     // The dihedral correction maps
398     gmx_cmap_t cmap_grid;
399 };
400
401 /* Deprecated interation definitions, used in t_topology */
402 struct t_idef
403 {
404     int         ntypes;
405     int         atnr;
406     t_functype* functype;
407     t_iparams*  iparams;
408     real        fudgeQQ;
409     t_iparams * iparams_posres, *iparams_fbposres;
410
411     t_ilist il[F_NRE];
412     int     ilsort;
413 };
414
415 /*
416  * The struct t_idef defines all the interactions for the complete
417  * simulation. The structure is setup in such a way that the multinode
418  * version of the program  can use it as easy as the single node version.
419  * General field description:
420  *   int ntypes
421  *      defines the number of elements in functype[] and param[].
422  *   int nodeid
423  *      the node id (if parallel machines)
424  *   int atnr
425  *      the number of atomtypes
426  *   t_functype *functype
427  *      array of length ntypes, defines for every force type what type of
428  *      function to use. Every "bond" with the same function but different
429  *      force parameters is a different force type. The type identifier in the
430  *      forceatoms[] array is an index in this array.
431  *   t_iparams *iparams
432  *      array of length ntypes, defines the parameters for every interaction
433  *      type. The type identifier in the actual interaction list
434  *      (ilist[ftype].iatoms[]) is an index in this array.
435  *   gmx_cmap_t cmap_grid
436  *      the grid for the dihedral pair correction maps.
437  *   t_iparams *iparams_posres, *iparams_fbposres
438  *      defines the parameters for position restraints only.
439  *      Position restraints are the only interactions that have different
440  *      parameters (reference positions) for different molecules
441  *      of the same type. ilist[F_POSRES].iatoms[] is an index in this array.
442  *   t_ilist il[F_NRE]
443  *      The list of interactions for each type. Note that some,
444  *      such as LJ and COUL will have 0 entries.
445  *   int ilsort
446  *      The state of the sorting of il, values are provided above.
447  */
448
449 namespace gmx
450 {
451 class TextWriter;
452 } // namespace gmx
453
454 void printInteractionParameters(gmx::TextWriter* writer, t_functype ftype, const t_iparams& iparams);
455 void pr_iparams(FILE* fp, t_functype ftype, const t_iparams& iparams);
456 void pr_ilist(FILE*                  fp,
457               int                    indent,
458               const char*            title,
459               const t_functype*      functype,
460               const InteractionList& ilist,
461               bool                   bShowNumbers,
462               bool                   bShowParameters,
463               const t_iparams*       iparams);
464 void pr_idef(FILE* fp, int indent, const char* title, const t_idef* idef, bool bShowNumbers, bool bShowParameters);
465
466 /*! \brief
467  * Properly initialize idef struct.
468  *
469  * \param[in] idef Pointer to idef struct to initialize.
470  */
471 void init_idef(t_idef* idef);
472
473 /*! \brief
474  * Properly clean up idef struct.
475  *
476  * \param[in] idef Pointer to idef struct to clean up.
477  */
478 void done_idef(t_idef* idef);
479
480 #endif