src/gromacs/domdec/domdec_constraints.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2005,2006,2007,2008,2009 by the GROMACS development team.
   5  * Copyright (c) 2010,2012,2013,2014,2015 by the GROMACS development team.
   6  * Copyright (c) 2018,2019,2020,2021, 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 /*! \internal \file
  38  *
  39  * \brief This file declares functions for domdec to use
  40  * while managing inter-atomic constraints.
  41  *
  42  * \author Berk Hess <hess@kth.se>
  43  * \ingroup module_domdec
  44  */
  45
  46 #ifndef GMX_DOMDEC_DOMDEC_CONSTRAINTS_H
  47 #define GMX_DOMDEC_DOMDEC_CONSTRAINTS_H
  48
  49 #include "gromacs/utility/arrayref.h"
  50
  51 namespace gmx
  52 {
  53 class Constraints;
  54 }
  55
  56 struct gmx_domdec_t;
  57 struct gmx_mtop_t;
  58 struct InteractionList;
  59
  60 /*! \brief Clears the local indices for the constraint communication setup */
  61 void dd_clear_local_constraint_indices(gmx_domdec_t* dd);
  62
  63 /*! \brief Sets up communication and atom indices for all local+connected constraints */
  64 int dd_make_local_constraints(struct gmx_domdec_t*           dd,
  65                               int                            at_start,
  66                               const struct gmx_mtop_t&       mtop,
  67                               const int*                     cginfo,
  68                               gmx::Constraints*              constr,
  69                               int                            nrec,
  70                               gmx::ArrayRef<InteractionList> il_local);
  71
  72 /*! \brief Initializes the data structures for constraint communication */
  73 void init_domdec_constraints(gmx_domdec_t* dd, const gmx_mtop_t& mtop);
  74
  75 #endif