Update instructions in containers.rst
[gromacs.git] / src / gromacs / domdec / builder.h
blob01239c8058a5c9c5b2048de02acd7c2aea310f41
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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 /*! \libinternal \file
37 * \brief This file declares a builder class for the manager
38 * of domain decomposition
40 * \author Berk Hess <hess@kth.se>
41 * \author Mark Abraham <mark.j.abraham@gmail.com>
42 * \inlibraryapi
43 * \ingroup module_domdec
46 #ifndef GMX_DOMDEC_BUILDER_H
47 #define GMX_DOMDEC_BUILDER_H
49 #include "gromacs/math/vectypes.h"
50 #include "gromacs/utility/basedefinitions.h"
51 #include "gromacs/utility/classhelpers.h"
53 struct gmx_domdec_t;
54 struct gmx_mtop_t;
55 struct t_commrec;
56 struct t_inputrec;
58 namespace gmx
60 class MDLogger;
61 class LocalAtomSetManager;
62 struct DomdecOptions;
63 struct MdrunOptions;
65 template<typename T>
66 class ArrayRef;
68 /*! \libinternal
69 * \brief Builds a domain decomposition management object
71 * This multi-phase construction needs first a decision about the
72 * duty(s) of each rank, and then perhaps to be advised of GPU streams
73 * for transfer operations. */
74 class DomainDecompositionBuilder
76 public:
77 //! Constructor
78 DomainDecompositionBuilder(const MDLogger& mdlog,
79 t_commrec* cr,
80 const DomdecOptions& options,
81 const MdrunOptions& mdrunOptions,
82 const gmx_mtop_t& mtop,
83 const t_inputrec& ir,
84 const matrix box,
85 ArrayRef<const RVec> xGlobal);
86 //! Destructor
87 ~DomainDecompositionBuilder();
88 //! Build the resulting DD manager
89 gmx_domdec_t* build(LocalAtomSetManager* atomSets);
91 private:
92 class Impl;
93 //! Pimpl to hide implementation details
94 PrivateImplPointer<Impl> impl_;
97 } // namespace gmx
99 #endif