2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 /*! \libinternal \file
38 * \brief Declares structures related to domain decomposition.
40 * \author Berk Hess <hess@kth.se>
41 * \author David van der Spoel <david.vanderspoel@icm.uu.se>
43 * \ingroup module_domdec
45 #ifndef GMX_DOMDEC_DOMDEC_STRUCT_H
46 #define GMX_DOMDEC_DOMDEC_STRUCT_H
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"
59 //! Max number of zones in domain decomposition
61 //! Max number of izones in domain decomposition
64 struct AtomDistribution
;
65 struct gmx_domdec_comm_t
;
66 struct gmx_domdec_constraints_t
;
67 struct gmx_domdec_specat_comm_t
;
69 struct gmx_pme_comm_n_box_t
;
70 struct gmx_reverse_top_t
;
75 template <typename T
> class HashedMap
;
76 class LocalAtomSetManager
;
84 /* i-charge-group end */
86 /* j-charge-group start */
88 /* j-charge-group end */
90 /* Minimum shifts to consider */
92 /* Maximum shifts to consider */
94 } gmx_domdec_ns_ranges_t
;
97 /* Zone lower corner in triclinic coordinates */
99 /* Zone upper corner in triclinic coordinates */
101 /* Zone bounding box lower corner in Cartesian coords */
103 /* Zone bounding box upper corner in Cartesian coords */
105 } gmx_domdec_zone_size_t
;
107 struct gmx_domdec_zones_t
{
108 /* The number of zones including the home zone */
110 /* The shift of the zones with respect to the home zone */
111 ivec shift
[DD_MAXZONE
] = { };
112 /* The charge group boundaries for the zones */
113 int cg_range
[DD_MAXZONE
+1] = { };
114 /* The number of neighbor search zones with i-particles */
116 /* The neighbor search charge group ranges for each i-zone */
117 gmx_domdec_ns_ranges_t izone
[DD_MAXIZONE
];
118 /* Boundaries of the zones */
119 gmx_domdec_zone_size_t size
[DD_MAXZONE
];
120 /* The cg density of the home zone */
129 /* Tells if the box is skewed for each of the three cartesian directions */
132 /* Orthogonal vectors for triclinic cells, Cartesian index */
134 /* Normal vectors for the cells walls */
138 /*! \internal \brief Provides information about properties of the unit cell */
142 UnitCellInfo(const t_inputrec
&ir
);
144 //! We have PBC from dim 0 (X) up to npbcdim
146 //! The system is bounded from 0 (X) to numBoundedDimensions
147 int numBoundedDimensions
;
148 //! Tells whether the box bounding the atoms is dynamic
154 struct gmx_domdec_t
{ //NOLINT(clang-analyzer-optin.performance.Padding)
155 //! Constructor, only partial for now
156 gmx_domdec_t(const t_inputrec
&ir
);
158 /* The DD particle-particle nodes only */
159 /* The communication setup within the communicator all
160 * defined in dd->comm in domdec.c
163 MPI_Comm mpi_comm_all
= MPI_COMM_NULL
;
164 /* Use MPI_Sendrecv communication instead of non-blocking calls */
165 gmx_bool bSendRecv2
= FALSE
;
166 /* The local DD cell index and rank */
167 ivec ci
= { 0, 0, 0 };
169 ivec master_ci
= { 0, 0, 0 };
171 /* Communication with the PME only nodes */
173 gmx_bool pme_receive_vir_ener
= false;
174 gmx_pme_comm_n_box_t
*cnb
= nullptr;
176 MPI_Request req_pme
[8];
178 /* Properties of the unit cell */
179 UnitCellInfo unitCellInfo
;
181 /* The communication setup, identical for each cell, cartesian index */
182 ivec nc
= { 0, 0, 0 };
184 ivec dim
= { 0, 0, 0 }; /* indexed by 0 to ndim */
186 /* Forward and backward neighboring cells, indexed by 0 to ndim */
187 int neighbor
[DIM
][2] = { { 0, 0 }, { 0, 0 }, { 0, 0 } };
189 /* Only available on the master node */
190 std::unique_ptr
<AtomDistribution
> ma
;
192 /* Global atom number to interaction list */
193 gmx_reverse_top_t
*reverse_top
= nullptr;
194 int nbonded_global
= 0;
195 int nbonded_local
= 0;
197 /* The number of inter charge-group exclusions */
198 int n_intercg_excl
= 0;
201 gmx::HashedMap
<int> *ga2la_vsite
= nullptr;
202 gmx_domdec_specat_comm_t
*vsite_comm
= nullptr;
203 std::vector
<int> vsite_requestedGlobalAtomIndices
;
205 /* Constraint stuff */
206 gmx_domdec_constraints_t
*constraints
= nullptr;
207 gmx_domdec_specat_comm_t
*constraint_comm
= nullptr;
209 /* The number of home atom groups */
211 /* Global atom group indices for the home and all non-home groups */
212 std::vector
<int> globalAtomGroupIndices
;
214 /* Index from the local atoms to the global atoms, covers home and received zones */
215 std::vector
<int> globalAtomIndices
;
217 /* Global atom number to local atom number list */
218 gmx_ga2la_t
*ga2la
= nullptr;
220 /* Communication stuff */
221 gmx_domdec_comm_t
*comm
= nullptr;
223 /* The partioning count, to keep track of the state */
224 int64_t ddp_count
= 0;
226 /* The managed atom sets that are updated in domain decomposition */
227 gmx::LocalAtomSetManager
* atomSets
= nullptr;
229 /* gmx_pme_recv_f buffer */
230 std::vector
<gmx::RVec
> pmeForceReceiveBuffer
;
233 //! Are we the master node for domain decomposition
234 static inline bool DDMASTER(const gmx_domdec_t
&dd
)
236 return dd
.rank
== dd
.masterrank
;
239 //! Are we the master node for domain decomposition, deprecated
240 static inline bool DDMASTER(const gmx_domdec_t
*dd
)
242 return dd
->rank
== dd
->masterrank
;