Update instructions in containers.rst
[gromacs.git] / src / gromacs / domdec / redistribute.h
blob68d8bd9c6ec924821cf42829fa57458efced6718
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2018,2019,2020, 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.
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.
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.
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.
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.
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.
35 /*! \internal \file
37 * \brief Declares the atom redistribution function.
39 * \author Berk Hess <hess@kth.se>
40 * \ingroup module_domdec
42 #ifndef GMX_DOMDEC_DOMDEC_REDISTRIBUTE_H
43 #define GMX_DOMDEC_DOMDEC_REDISTRIBUTE_H
45 #include <cstdio>
47 #include "gromacs/math/vectypes.h"
48 #include "gromacs/utility/basedefinitions.h"
50 struct gmx_domdec_t;
51 struct t_forcerec;
52 struct t_nrnb;
53 class t_state;
55 /*! \brief Redistribute the atoms to their, new, local domains */
56 void dd_redistribute_cg(FILE* fplog,
57 int64_t step,
58 gmx_domdec_t* dd,
59 ivec tric_dir,
60 t_state* state,
61 t_forcerec* fr,
62 t_nrnb* nrnb,
63 int* ncg_moved);
65 #endif