Tidy: modernize-use-nullptr
[alexxy/gromacs.git] / src / gromacs / mdlib / mdsetup.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2016,2017, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS 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 GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35 #include "gmxpre.h"
36
37 #include "mdsetup.h"
38
39 #include "gromacs/domdec/domdec.h"
40 #include "gromacs/domdec/domdec_struct.h"
41 #include "gromacs/listed-forces/manage-threading.h"
42 #include "gromacs/mdlib/mdatoms.h"
43 #include "gromacs/mdlib/shellfc.h"
44 #include "gromacs/mdlib/vsite.h"
45 #include "gromacs/mdtypes/commrec.h"
46 #include "gromacs/mdtypes/forcerec.h"
47 #include "gromacs/mdtypes/inputrec.h"
48 #include "gromacs/pbcutil/mshift.h"
49 #include "gromacs/pbcutil/pbc.h"
50 #include "gromacs/topology/mtop_util.h"
51 #include "gromacs/topology/topology.h"
52 #include "gromacs/utility/gmxassert.h"
53 #include "gromacs/utility/smalloc.h"
54
55 /* TODO: Add a routine that collects the initial setup of the algorithms.
56  *
57  * The final solution should be an MD algorithm base class with methods
58  * for initialization and atom-data setup.
59  */
60
61 void mdAlgorithmsSetupAtomData(t_commrec         *cr,
62                                const t_inputrec  *ir,
63                                const gmx_mtop_t  *top_global,
64                                gmx_localtop_t    *top,
65                                t_forcerec        *fr,
66                                t_graph          **graph,
67                                t_mdatoms         *mdatoms,
68                                gmx_vsite_t       *vsite,
69                                gmx_shellfc_t     *shellfc)
70 {
71     bool  usingDomDec = DOMAINDECOMP(cr);
72
73     int   numAtomIndex, numHomeAtoms;
74     int  *atomIndex;
75
76     if (usingDomDec)
77     {
78         numAtomIndex = dd_natoms_mdatoms(cr->dd);
79         atomIndex    = cr->dd->gatindex;
80         numHomeAtoms = cr->dd->nat_home;
81     }
82     else
83     {
84         numAtomIndex = -1;
85         atomIndex    = nullptr;
86         numHomeAtoms = top_global->natoms;
87     }
88     atoms2md(top_global, ir, numAtomIndex, atomIndex, numHomeAtoms, mdatoms);
89
90     if (usingDomDec)
91     {
92         dd_sort_local_top(cr->dd, mdatoms, top);
93     }
94     else
95     {
96         /* Currently gmx_generate_local_top allocates and returns a pointer.
97          * We should implement a more elegant solution.
98          */
99         gmx_localtop_t *tmpTop;
100
101         tmpTop = gmx_mtop_generate_local_top(top_global, ir->efep != efepNO);
102         *top   = *tmpTop;
103         sfree(tmpTop);
104     }
105
106     if (vsite)
107     {
108         if (usingDomDec)
109         {
110             /* The vsites were already assigned by the domdec topology code.
111              * We only need to do the thread division here.
112              */
113             split_vsites_over_threads(top->idef.il, top->idef.iparams,
114                                       mdatoms, FALSE, vsite);
115         }
116         else
117         {
118             set_vsite_top(vsite, top, mdatoms, cr);
119         }
120     }
121
122     if (!usingDomDec && ir->ePBC != epbcNONE && !fr->bMolPBC)
123     {
124         GMX_ASSERT(graph != NULL, "We use a graph with PBC (no periodic mols) and without DD");
125
126         *graph = mk_graph(nullptr, &(top->idef), 0, top_global->natoms, FALSE, FALSE);
127     }
128     else if (graph != nullptr)
129     {
130         *graph = nullptr;
131     }
132
133     /* Note that with DD only flexible constraints, not shells, are supported
134      * and these don't require setup in make_local_shells().
135      */
136     if (!usingDomDec && shellfc)
137     {
138         make_local_shells(cr, mdatoms, shellfc);
139     }
140
141     setup_bonded_threading(fr, &top->idef);
142 }