src/gromacs/mdlib/lincs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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  * \brief Declares interface to LINCS code.
  37  *
  38  * \author Berk Hess <hess@kth.se>
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_mdlib
  41  * \inlibraryapi
  42  */
  43
  44 #ifndef GMX_MDLIB_LINCS_H
  45 #define GMX_MDLIB_LINCS_H
  46
  47 #include <cstdio>
  48
  49 #include "gromacs/math/vectypes.h"
  50 #include "gromacs/utility/arrayref.h"
  51 #include "gromacs/utility/basedefinitions.h"
  52 #include "gromacs/utility/real.h"
  53
  54 struct gmx_mtop_t;
  55 struct gmx_multisim_t;
  56 class InteractionDefinitions;
  57 struct t_commrec;
  58 struct t_inputrec;
  59 struct t_nrnb;
  60 struct t_pbc;
  61
  62 namespace gmx
  63 {
  64 template<typename>
  65 class ArrayRefWithPadding;
  66 template<typename>
  67 class ArrayRef;
  68 enum class ConstraintVariable : int;
  69 class Lincs;
  70 template<typename>
  71 class ListOfLists;
  72 class ObservablesReducerBuilder;
  73
  74 /*! \brief Return the data for determining constraint RMS relative deviations. */
  75 ArrayRef<real> lincs_rmsdData(Lincs* lincsd);
  76
  77 /*! \brief Return the RMSD of the constraint. */
  78 real lincs_rmsd(const Lincs* lincsd);
  79
  80 /*! \brief Initializes and returns the lincs data struct. */
  81 Lincs* init_lincs(FILE*                            fplog,
  82                   const gmx_mtop_t&                mtop,
  83                   int                              nflexcon_global,
  84                   ArrayRef<const ListOfLists<int>> atomsToConstraintsPerMolType,
  85                   bool                             bPLINCS,
  86                   int                              nIter,
  87                   int                              nProjOrder,
  88                   ObservablesReducerBuilder*       observablesReducerBuilder);
  89
  90 /*! \brief Destructs the lincs object when it is not nullptr. */
  91 void done_lincs(Lincs* li);
  92
  93 /*! \brief Initialize lincs stuff */
  94 void set_lincs(const InteractionDefinitions& idef,
  95                int                           numAtoms,
  96                ArrayRef<const real>          invmass,
  97                real                          lambda,
  98                bool                          bDynamics,
  99                const t_commrec*              cr,
 100                Lincs*                        li);
 101
 102 /*! \brief Applies LINCS constraints.
 103  *
 104  * \returns true if the constraining succeeded. */
 105 bool constrain_lincs(bool                            computeRmsd,
 106                      const t_inputrec&               ir,
 107                      int64_t                         step,
 108                      Lincs*                          lincsd,
 109                      ArrayRef<const real>            invmass,
 110                      const t_commrec*                cr,
 111                      const gmx_multisim_t*           ms,
 112                      ArrayRefWithPadding<const RVec> x,
 113                      ArrayRefWithPadding<RVec>       xprime,
 114                      ArrayRef<RVec>                  min_proj,
 115                      const matrix                    box,
 116                      t_pbc*                          pbc,
 117                      bool                            hasMassPerturbed,
 118                      real                            lambda,
 119                      real*                           dvdlambda,
 120                      real                            invdt,
 121                      ArrayRef<RVec>                  v,
 122                      bool                            bCalcVir,
 123                      tensor                          vir_r_m_dr,
 124                      ConstraintVariable              econq,
 125                      t_nrnb*                         nrnb,
 126                      int                             maxwarn,
 127                      int*                            warncount);
 128
 129 } // namespace gmx
 130
 131 #endif