src/gromacs/listed_forces/disre.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \libinternal \file
  39  * \brief
  40  * Declares functions for handling distance restraints.
  41  *
  42  * \inlibraryapi
  43  * \ingroup module_listed_forces
  44  */
  45 #ifndef GMX_LISTED_FORCES_DISRE_H
  46 #define GMX_LISTED_FORCES_DISRE_H
  47
  48 #include <cstdio>
  49
  50 #include "gromacs/topology/ifunc.h"
  51 #include "gromacs/utility/basedefinitions.h"
  52 #include "gromacs/utility/gmxmpi.h"
  53
  54 struct gmx_mtop_t;
  55 struct gmx_multisim_t;
  56 class history_t;
  57 struct t_commrec;
  58 struct t_disresdata;
  59 struct t_oriresdata;
  60 struct t_fcdata;
  61 struct t_inputrec;
  62 struct t_pbc;
  63 class t_state;
  64 enum class DDRole;
  65 enum class NumRanks;
  66
  67 namespace gmx
  68 {
  69 template<typename>
  70 class ArrayRef;
  71 } // namespace gmx
  72
  73 //! Whether distance restraints are called from mdrun or from an analysis tool
  74 enum class DisResRunMode
  75 {
  76     MDRun,
  77     AnalysisTool
  78 };
  79
  80 /*! \brief
  81  * Initiates *disresdata.
  82  *
  83  * Must be called once, nbonds is the number
  84  * of iatoms in the ilist of the idef struct.
  85  * When time averaging is used, the history is initialized in state,
  86  * unless it was read before from a checkpoint file.
  87  * The implementation of distance restraints with -multidir
  88  * must differ according to whether REMD is active.
  89  */
  90 void init_disres(FILE*                 fplog,
  91                  const gmx_mtop_t*     mtop,
  92                  t_inputrec*           ir,
  93                  DisResRunMode         disResRunMode,
  94                  DDRole                ddRole,
  95                  NumRanks              numRanks,
  96                  MPI_Comm              communicator,
  97                  const gmx_multisim_t* ms,
  98                  t_disresdata*         disresdata,
  99                  t_state*              state,
 100                  gmx_bool              bIsREMD);
 101
 102 /*! \brief
 103  * Calculates r and r^-3 (inst. and time averaged) for all pairs
 104  * and the ensemble averaged r^-6 (inst. and time averaged) for all restraints
 105  */
 106 void calc_disres_R_6(const t_commrec*      cr,
 107                      const gmx_multisim_t* ms,
 108                      int                   nfa,
 109                      const t_iatom*        fa,
 110                      const rvec*           x,
 111                      const t_pbc*          pbc,
 112                      t_disresdata*         disresdata,
 113                      const history_t*      hist);
 114
 115 //! Calculates the distance restraint forces, return the potential.
 116 real ta_disres(int                       nfa,
 117                const t_iatom*            forceatoms,
 118                const t_iparams*          ip,
 119                const rvec*               x,
 120                rvec4*                    f,
 121                rvec*                     fshift,
 122                const t_pbc*              pbc,
 123                real                      lambda,
 124                real*                     dvdlambda,
 125                gmx::ArrayRef<const real> charge,
 126                t_fcdata gmx_unused* fcd,
 127                t_disresdata*        disresdata,
 128                t_oriresdata gmx_unused* oriresdata,
 129                int*                     global_atom_index);
 130
 131 //! Copies the new time averages that have been calculated in calc_disres_R_6.
 132 void update_disres_history(const t_disresdata& disresdata, history_t* hist);
 133
 134 #endif