src/gromacs/domdec/domdec_struct.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,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \libinternal \file
  38  * \brief Declares structures related to domain decomposition.
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  42  * \inlibraryapi
  43  * \ingroup module_domdec
  44  */
  45 #ifndef GMX_DOMDEC_DOMDEC_STRUCT_H
  46 #define GMX_DOMDEC_DOMDEC_STRUCT_H
  47
  48 #include <cstddef>
  49
  50 #include <memory>
  51 #include <vector>
  52
  53 #include "gromacs/math/vectypes.h"
  54 #include "gromacs/topology/block.h"
  55 #include "gromacs/utility/basedefinitions.h"
  56 #include "gromacs/utility/gmxmpi.h"
  57 #include "gromacs/utility/real.h"
  58
  59 //! Max number of zones in domain decomposition
  60 #define DD_MAXZONE  8
  61 //! Max number of izones in domain decomposition
  62 #define DD_MAXIZONE 4
  63
  64 struct AtomDistribution;
  65 struct gmx_domdec_comm_t;
  66 struct gmx_domdec_constraints_t;
  67 struct gmx_domdec_specat_comm_t;
  68 class gmx_ga2la_t;
  69 struct gmx_pme_comm_n_box_t;
  70 struct gmx_reverse_top_t;
  71 struct t_inputrec;
  72
  73 namespace gmx
  74 {
  75 template <typename T> class HashedMap;
  76 class LocalAtomSetManager;
  77 class GpuHaloExchange;
  78 }
  79
  80 typedef struct {
  81     /* j-zone start               */
  82     int  j0 = 0;
  83     /* j-zone end                 */
  84     int  j1 = 0;
  85     /* i-charge-group end         */
  86     int  cg1 = 0;
  87     /* j-charge-group start       */
  88     int  jcg0 = 0;
  89     /* j-charge-group end         */
  90     int  jcg1 = 0;
  91     /* Minimum shifts to consider */
  92     ivec shift0 = { };
  93     /* Maximum shifts to consider */
  94     ivec shift1 = { };
  95 } gmx_domdec_ns_ranges_t;
  96
  97 typedef struct {
  98     /* Zone lower corner in triclinic coordinates         */
  99     rvec x0 = { };
 100     /* Zone upper corner in triclinic coordinates         */
 101     rvec x1 = { };
 102     /* Zone bounding box lower corner in Cartesian coords */
 103     rvec bb_x0 = { };
 104     /* Zone bounding box upper corner in Cartesian coords */
 105     rvec bb_x1 = { };
 106 } gmx_domdec_zone_size_t;
 107
 108 struct gmx_domdec_zones_t {
 109     /* The number of zones including the home zone */
 110     int                    n = 0;
 111     /* The shift of the zones with respect to the home zone */
 112     ivec                   shift[DD_MAXZONE] = { };
 113     /* The charge group boundaries for the zones */
 114     int                    cg_range[DD_MAXZONE+1] = { };
 115     /* The number of neighbor search zones with i-particles */
 116     int                    nizone = 0;
 117     /* The neighbor search charge group ranges for each i-zone */
 118     gmx_domdec_ns_ranges_t izone[DD_MAXIZONE];
 119     /* Boundaries of the zones */
 120     gmx_domdec_zone_size_t size[DD_MAXZONE];
 121     /* The cg density of the home zone */
 122     real                   dens_zone0 = 0;
 123 };
 124
 125 struct gmx_ddbox_t {
 126     int  npbcdim;
 127     int  nboundeddim;
 128     rvec box0;
 129     rvec box_size;
 130     /* Tells if the box is skewed for each of the three cartesian directions */
 131     ivec tric_dir;
 132     rvec skew_fac;
 133     /* Orthogonal vectors for triclinic cells, Cartesian index */
 134     rvec v[DIM][DIM];
 135     /* Normal vectors for the cells walls */
 136     rvec normal[DIM];
 137 };
 138
 139 /*! \internal \brief Provides information about properties of the unit cell */
 140 struct UnitCellInfo
 141 {
 142     //! Constructor
 143     UnitCellInfo(const t_inputrec &ir);
 144
 145     //! We have PBC from dim 0 (X) up to npbcdim
 146     int  npbcdim;
 147     //! The system is bounded from 0 (X) to numBoundedDimensions
 148     int  numBoundedDimensions;
 149     //! Tells whether the box bounding the atoms is dynamic
 150     bool ddBoxIsDynamic;
 151     //! Screw PBC?
 152     bool haveScrewPBC;
 153 };
 154
 155 struct gmx_domdec_t { //NOLINT(clang-analyzer-optin.performance.Padding)
 156     //! Constructor, only partial for now
 157     gmx_domdec_t(const t_inputrec &ir);
 158
 159     /* The DD particle-particle nodes only */
 160     /* The communication setup within the communicator all
 161      * defined in dd->comm in domdec.c
 162      */
 163     int                    nnodes       = 0;
 164     MPI_Comm               mpi_comm_all = MPI_COMM_NULL;
 165     /* The local DD cell index and rank */
 166     ivec                   ci         = { 0, 0, 0 };
 167     int                    rank       = 0;
 168     ivec                   master_ci  = { 0, 0, 0 };
 169     int                    masterrank = 0;
 170     /* Communication with the PME only nodes */
 171     int                    pme_nodeid           = 0;
 172     gmx_bool               pme_receive_vir_ener = false;
 173     gmx_pme_comm_n_box_t  *cnb                  = nullptr;
 174     int                    nreq_pme             = 0;
 175     MPI_Request            req_pme[8];
 176
 177     /* Properties of the unit cell */
 178     UnitCellInfo unitCellInfo;
 179
 180     /* The communication setup, identical for each cell, cartesian index */
 181     ivec     nc   = { 0, 0, 0 };
 182     int      ndim = 0;
 183     ivec     dim  = { 0, 0, 0 }; /* indexed by 0 to ndim */
 184
 185     /* Forward and backward neighboring cells, indexed by 0 to ndim */
 186     int  neighbor[DIM][2] = { { 0, 0 },  { 0, 0 },  { 0, 0 } };
 187
 188     /* Only available on the master node */
 189     std::unique_ptr<AtomDistribution> ma;
 190
 191     /* Global atom number to interaction list */
 192     gmx_reverse_top_t  *reverse_top    = nullptr;
 193     int                 nbonded_global = 0;
 194     int                 nbonded_local  = 0;
 195
 196     /* Whether we have non-self exclusion */
 197     bool haveExclusions = false;
 198
 199     /* Vsite stuff */
 200     gmx::HashedMap<int>       *ga2la_vsite = nullptr;
 201     gmx_domdec_specat_comm_t  *vsite_comm  = nullptr;
 202     std::vector<int>           vsite_requestedGlobalAtomIndices;
 203
 204     /* Constraint stuff */
 205     gmx_domdec_constraints_t *constraints     = nullptr;
 206     gmx_domdec_specat_comm_t *constraint_comm = nullptr;
 207
 208     /* The number of home atom groups */
 209     int                           ncg_home = 0;
 210     /* Global atom group indices for the home and all non-home groups */
 211     std::vector<int>              globalAtomGroupIndices;
 212
 213     /* Index from the local atoms to the global atoms, covers home and received zones */
 214     std::vector<int> globalAtomIndices;
 215
 216     /* Global atom number to local atom number list */
 217     gmx_ga2la_t  *ga2la = nullptr;
 218
 219     /* Communication stuff */
 220     gmx_domdec_comm_t *comm = nullptr;
 221
 222     /* The partioning count, to keep track of the state */
 223     int64_t ddp_count = 0;
 224
 225     /* The managed atom sets that are updated in domain decomposition */
 226     gmx::LocalAtomSetManager * atomSets = nullptr;
 227
 228     /* gmx_pme_recv_f buffer */
 229     std::vector<gmx::RVec> pmeForceReceiveBuffer;
 230
 231     /* GPU halo exchange object */
 232     std::unique_ptr<gmx::GpuHaloExchange> gpuHaloExchange;
 233 };
 234
 235 //! Are we the master node for domain decomposition
 236 static inline bool DDMASTER(const gmx_domdec_t &dd)
 237 {
 238     return dd.rank == dd.masterrank;
 239 };
 240
 241 //! Are we the master node for domain decomposition, deprecated
 242 static inline bool DDMASTER(const gmx_domdec_t *dd)
 243 {
 244     return dd->rank == dd->masterrank;
 245 };
 246
 247 #endif