src/gromacs/mdlib/lincs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 struct t_blocka;
  57 struct t_commrec;
  58 struct t_idef;
  59 struct t_inputrec;
  60 struct t_mdatoms;
  61 struct t_nrnb;
  62 struct t_pbc;
  63
  64 namespace gmx
  65 {
  66
  67 enum class ConstraintVariable : int;
  68
  69 /* Abstract type for LINCS that is defined only in the file that uses it */
  70 class Lincs;
  71
  72 /*! \brief Return the data for determining constraint RMS relative deviations. */
  73 ArrayRef<real> lincs_rmsdData(Lincs* lincsd);
  74
  75 /*! \brief Return the RMSD of the constraint. */
  76 real lincs_rmsd(const Lincs* lincsd);
  77
  78 /*! \brief Initializes and returns the lincs data struct. */
  79 Lincs* init_lincs(FILE*                    fplog,
  80                   const gmx_mtop_t&        mtop,
  81                   int                      nflexcon_global,
  82                   ArrayRef<const t_blocka> at2con,
  83                   bool                     bPLINCS,
  84                   int                      nIter,
  85                   int                      nProjOrder);
  86
  87 /*! \brief Destructs the lincs object when it is not nullptr. */
  88 void done_lincs(Lincs* li);
  89
  90 /*! \brief Initialize lincs stuff */
  91 void set_lincs(const t_idef& idef, const t_mdatoms& md, bool bDynamics, const t_commrec* cr, Lincs* li);
  92
  93 /*! \brief Applies LINCS constraints.
  94  *
  95  * \returns true if the constraining succeeded. */
  96 bool constrain_lincs(bool                  computeRmsd,
  97                      const t_inputrec&     ir,
  98                      int64_t               step,
  99                      Lincs*                lincsd,
 100                      const t_mdatoms&      md,
 101                      const t_commrec*      cr,
 102                      const gmx_multisim_t* ms,
 103                      const rvec*           x,
 104                      rvec*                 xprime,
 105                      rvec*                 min_proj,
 106                      const matrix          box,
 107                      t_pbc*                pbc,
 108                      real                  lambda,
 109                      real*                 dvdlambda,
 110                      real                  invdt,
 111                      rvec*                 v,
 112                      bool                  bCalcVir,
 113                      tensor                vir_r_m_dr,
 114                      ConstraintVariable    econq,
 115                      t_nrnb*               nrnb,
 116                      int                   maxwarn,
 117                      int*                  warncount);
 118
 119 } // namespace gmx
 120
 121 #endif