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,2018, 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 /*! \libinternal \file
  38  * \brief
  39  * Declares functions for handling distance restraints.
  40  *
  41  * \inlibraryapi
  42  * \ingroup module_listed-forces
  43  */
  44 #ifndef GMX_LISTED_FORCES_DISRE_H
  45 #define GMX_LISTED_FORCES_DISRE_H
  46
  47 #include <cstdio>
  48
  49 #include "gromacs/topology/ifunc.h"
  50 #include "gromacs/utility/basedefinitions.h"
  51
  52 struct gmx_mtop_t;
  53 struct gmx_multisim_t;
  54 class history_t;
  55 struct t_commrec;
  56 struct t_inputrec;
  57 struct t_pbc;
  58 class t_state;
  59
  60 /*! \brief
  61  * Initiates *fcd data.
  62  *
  63  * Must be called once, nbonds is the number
  64  * of iatoms in the ilist of the idef struct.
  65  * When time averaging is used, the history is initialized in state,
  66  * unless it was read before from a checkpoint file.
  67  * The implementation of distance restraints with -multidir
  68  * must differ according to whether REMD is active.
  69  */
  70 void init_disres(FILE *fplog, const gmx_mtop_t *mtop,
  71                  t_inputrec *ir, const t_commrec *cr,
  72                  const gmx_multisim_t *ms,
  73                  t_fcdata *fcd, t_state *state, gmx_bool bIsREMD);
  74
  75 /*! \brief
  76  * Calculates r and r^-3 (inst. and time averaged) for all pairs
  77  * and the ensemble averaged r^-6 (inst. and time averaged) for all restraints
  78  */
  79 void calc_disres_R_6(const t_commrec *cr,
  80                      const gmx_multisim_t *ms,
  81                      int nfa, const t_iatom *fa,
  82                      const rvec *x, const t_pbc *pbc,
  83                      t_fcdata *fcd, history_t *hist);
  84
  85 //! Calculates the distance restraint forces, return the potential.
  86 t_ifunc ta_disres;
  87
  88 //! Copies the new time averages that have been calculated in calc_disres_R_6.
  89 void update_disres_history(t_fcdata *fcd, history_t *hist);
  90
  91 #endif