src/gromacs/listed_forces/position_restraints.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,2017,2019,2020, 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  *
  39  * \brief This file contains declarations necessary for low-level
  40  * functions for computing energies and forces for position
  41  * restraints.
  42  *
  43  * \author Mark Abraham <mark.j.abraham@gmail.com>
  44  * \inlibraryapi
  45  * \ingroup module_listed_forces
  46  */
  47
  48 #ifndef GMX_LISTED_FORCES_POSITION_RESTRAINTS_H
  49 #define GMX_LISTED_FORCES_POSITION_RESTRAINTS_H
  50
  51 #include <stdio.h>
  52
  53 #include "gromacs/math/vectypes.h"
  54 #include "gromacs/utility/real.h"
  55
  56 struct gmx_enerdata_t;
  57 struct gmx_wallcycle;
  58 struct t_forcerec;
  59 class InteractionDefinitions;
  60 struct t_lambda;
  61 struct t_nrnb;
  62 struct t_pbc;
  63
  64 namespace gmx
  65 {
  66 class ForceWithVirial;
  67 }
  68
  69 /*! \brief Helper function that wraps calls to posres */
  70 void posres_wrapper(t_nrnb*                       nrnb,
  71                     const InteractionDefinitions& idef,
  72                     const struct t_pbc*           pbc,
  73                     const rvec*                   x,
  74                     gmx_enerdata_t*               enerd,
  75                     const real*                   lambda,
  76                     const t_forcerec*             fr,
  77                     gmx::ForceWithVirial*         forceWithVirial);
  78
  79 /*! \brief Helper function that wraps calls to posres for free-energy
  80     pertubation */
  81 void posres_wrapper_lambda(struct gmx_wallcycle*         wcycle,
  82                            const t_lambda*               fepvals,
  83                            const InteractionDefinitions& idef,
  84                            const struct t_pbc*           pbc,
  85                            const rvec                    x[],
  86                            gmx_enerdata_t*               enerd,
  87                            const real*                   lambda,
  88                            const t_forcerec*             fr);
  89
  90 /*! \brief Helper function that wraps calls to fbposres for
  91     free-energy perturbation */
  92 void fbposres_wrapper(t_nrnb*                       nrnb,
  93                       const InteractionDefinitions& idef,
  94                       const struct t_pbc*           pbc,
  95                       const rvec*                   x,
  96                       gmx_enerdata_t*               enerd,
  97                       const t_forcerec*             fr,
  98                       gmx::ForceWithVirial*         forceWithVirial);
  99
 100 #endif