src/gromacs/domdec/mdsetup.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019,2020,2021, 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/ewald/pme.h"
  42 #include "gromacs/listed_forces/listed_forces.h"
  43 #include "gromacs/mdlib/constr.h"
  44 #include "gromacs/mdlib/mdatoms.h"
  45 #include "gromacs/mdlib/vsite.h"
  46 #include "gromacs/mdtypes/commrec.h"
  47 #include "gromacs/mdtypes/forcebuffers.h"
  48 #include "gromacs/mdtypes/forcerec.h"
  49 #include "gromacs/mdtypes/inputrec.h"
  50 #include "gromacs/mdtypes/interaction_const.h"
  51 #include "gromacs/mdtypes/mdatom.h"
  52 #include "gromacs/pbcutil/pbc.h"
  53 #include "gromacs/topology/mtop_util.h"
  54 #include "gromacs/topology/topology.h"
  55 #include "gromacs/utility/arrayref.h"
  56 #include "gromacs/utility/gmxassert.h"
  57 #include "gromacs/utility/smalloc.h"
  58
  59 namespace gmx
  60 {
  61
  62 /* TODO: Add a routine that collects the initial setup of the algorithms.
  63  *
  64  * The final solution should be an MD algorithm base class with methods
  65  * for initialization and atom-data setup.
  66  */
  67 void mdAlgorithmsSetupAtomData(const t_commrec*     cr,
  68                                const t_inputrec&    inputrec,
  69                                const gmx_mtop_t&    top_global,
  70                                gmx_localtop_t*      top,
  71                                t_forcerec*          fr,
  72                                ForceBuffers*        force,
  73                                MDAtoms*             mdAtoms,
  74                                Constraints*         constr,
  75                                VirtualSitesHandler* vsite,
  76                                gmx_shellfc_t*       shellfc)
  77 {
  78     bool usingDomDec = DOMAINDECOMP(cr);
  79
  80     int numAtomIndex;
  81     int numHomeAtoms;
  82     int numTotalAtoms;
  83
  84     if (usingDomDec)
  85     {
  86         numAtomIndex  = dd_natoms_mdatoms(*cr->dd);
  87         numHomeAtoms  = dd_numHomeAtoms(*cr->dd);
  88         numTotalAtoms = dd_natoms_mdatoms(*cr->dd);
  89     }
  90     else
  91     {
  92         numAtomIndex  = -1;
  93         numHomeAtoms  = top_global.natoms;
  94         numTotalAtoms = top_global.natoms;
  95     }
  96
  97     if (force != nullptr)
  98     {
  99         force->resize(numTotalAtoms);
 100     }
 101
 102     atoms2md(top_global,
 103              inputrec,
 104              numAtomIndex,
 105              usingDomDec ? cr->dd->globalAtomIndices : std::vector<int>(),
 106              numHomeAtoms,
 107              mdAtoms);
 108
 109     t_mdatoms* mdatoms = mdAtoms->mdatoms();
 110     if (usingDomDec)
 111     {
 112         dd_sort_local_top(*cr->dd, mdatoms, top);
 113     }
 114     else
 115     {
 116         gmx_mtop_generate_local_top(top_global, top, inputrec.efep != FreeEnergyPerturbationType::No);
 117     }
 118
 119     if (vsite)
 120     {
 121         vsite->setVirtualSites(top->idef.il, *mdatoms);
 122     }
 123
 124     /* Note that with DD only flexible constraints, not shells, are supported
 125      * and these don't require setup in make_local_shells().
 126      *
 127      * TODO: This should only happen in ShellFCElement (it is called directly by the modular
 128      *       simulator ShellFCElement already, but still used here by legacy simulators)
 129      */
 130     if (!usingDomDec && shellfc)
 131     {
 132         make_local_shells(cr, *mdatoms, shellfc);
 133     }
 134
 135     for (auto& listedForces : fr->listedForces)
 136     {
 137         listedForces.setup(top->idef, fr->natoms_force, fr->gpuBonded != nullptr);
 138     }
 139
 140     if (EEL_PME(fr->ic->eeltype) && (cr->duty & DUTY_PME))
 141     {
 142         /* This handles the PP+PME rank case where fr->pmedata is valid.
 143          * For PME-only ranks, gmx_pmeonly() has its own call to gmx_pme_reinit_atoms().
 144          */
 145         const int numPmeAtoms = numHomeAtoms - fr->n_tpi;
 146         gmx_pme_reinit_atoms(fr->pmedata, numPmeAtoms, mdatoms->chargeA, mdatoms->chargeB);
 147     }
 148
 149     if (constr)
 150     {
 151         constr->setConstraints(top,
 152                                mdatoms->nr,
 153                                mdatoms->homenr,
 154                                gmx::arrayRefFromArray(mdatoms->massT, mdatoms->nr),
 155                                gmx::arrayRefFromArray(mdatoms->invmass, mdatoms->nr),
 156                                mdatoms->nMassPerturbed != 0,
 157                                mdatoms->lambda,
 158                                mdatoms->cFREEZE ? gmx::arrayRefFromArray(mdatoms->cFREEZE, mdatoms->nr)
 159                                                 : gmx::ArrayRef<const unsigned short>());
 160     }
 161 }
 162
 163 } // namespace gmx