src/gromacs/domdec/builder.h

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