src/gromacs/gmxlib/restcbt.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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
  36
  37 /*! \libinternal \file
  38  *
  39  *
  40  * \brief
  41  * This file contains function declarations necessary
  42    for computations of forces due to restricted angle, restricted dihedral and
  43    combined bending-torsion potentials.
  44
  45  *
  46  * \author Nicolae Goga
  47  *
  48  * \inlibraryapi
  49  */
  50
  51 #ifndef _restcbt_h
  52 #define _restcbt_h
  53
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59
  60 /*! \brief This function computes factors needed for restricted angle potentials.
  61  *
  62  * The restricted angle potential is used in coarse-grained simulations to avoid singularities
  63  * when three particles align and the dihedral angle and dihedral potential cannot be calculated.
  64  * This potential is calculated using the formula:
  65  * \f[V_{\rm ReB}(\theta_i) = \frac{1}{2} k_{\theta} \frac{(\cos\theta_i - \cos\theta_0)^2}{\sin^2\theta_i}\f]
  66  * (see section "Restricted Bending Potential" from the manual).
  67  * The derivative of the restricted angle potential is calculated as:
  68  * \f[\frac{\partial V_{\rm ReB}(\theta_i)} {\partial \vec r_{k}} = \frac{dV_{\rm ReB}(\theta_i)}{dcos\theta_i} \frac{\partial cos\theta_i}{\partial \vec r_{k}}\f]
  69  * where all the derivatives of the bending angle with respect to Cartesian coordinates are calculated as in Allen & Tildesley (pp. 330-332)
  70  *
  71  *  \param[in]  type           type of force parameters
  72  *  \param[in]  forceparams    array of parameters for force computations
  73  *  \param[in]  delta_ante     distance between the first two particles
  74  *  \param[in]  delta_post     distance between the last two particles
  75  *  \param[out] prefactor      common term that comes in front of each force
  76  *  \param[out] ratio_ante     ratio of scalar products of delta_ante with delta_post
  77                               and delta_ante with delta_ante
  78  *  \param[out] ratio_post    ratio of scalar products of delta_ante with delta_post
  79                               and delta_post with delta_ante
  80  *  \param[out] v              contribution to energy   (see formula above)
  81  */
  82
  83
  84 void compute_factors_restangles(int type, const t_iparams forceparams[],
  85                                 rvec delta_ante,  rvec delta_post,
  86                                 real *prefactor, real *ratio_ante, real *ratio_post, real *v);
  87
  88
  89 /*! \brief Compute factors for restricted dihedral potentials.
  90  *
  91  * The restricted dihedral potential is the equivalent of the restricted bending potential
  92  * for the dihedral angle. It imposes the dihedral angle to have only one equilibrium value.
  93  * This potential is calculated using the formula:
  94  * \f[V_{\rm ReT}(\phi_i) = \frac{1}{2} k_{\phi} \frac{(\cos\phi_i - \cos\phi_0)^2}{\sin^2\phi_i}\f]
  95  * (see section "Proper dihedrals: Restricted torsion potential" from the manual).
  96  * The derivative of the restricted dihedral potential is calculated as:
  97  * \f[\frac{\partial V_{\rm ReT}(\phi_i)} {\partial \vec r_{k}} = \frac{dV_{\rm ReT}(\phi_i)}{dcos\phi_i} \frac{\partial cos\phi_i}{\partial \vec r_{k}}\f]
  98  * where all the derivatives of the dihedral angle with respect to Cartesian coordinates
  99  * are calculated as in Allen & Tildesley (pp. 330-332). Factors factor_phi_*  are coming from the
 100  * derivatives of the torsion angle (phi) with respect to the beads ai, aj, ak, al, (four) coordinates
 101  * and they are multiplied in the force computations with the particle distance
 102  * stored in parameters delta_ante, delta_crnt, delta_post.
 103  *
 104  *  \param[in]  type                             type of force parameters
 105  *  \param[in]  forceparams                      array of parameters for force computations
 106  *  \param[in]  delta_ante                       distance between the first two particles
 107  *  \param[in]  delta_crnt                       distance between the middle pair of particles
 108  *  \param[in]  delta_post                       distance between the last two particles
 109  *  \param[out] factor_phi_ai_ante               force factor for particle ai multiplied with delta_ante
 110  *  \param[out] factor_phi_ai_crnt               force factor for particle ai multiplied with delta_crnt
 111  *  \param[out] factor_phi_ai_post               force factor for particle ai multiplied with delta_post
 112  *  \param[out] factor_phi_aj_ante               force factor for particle aj multiplied with delta_ante
 113  *  \param[out] factor_phi_aj_crnt               force factor for particle aj multiplied with delta_crnt
 114  *  \param[out] factor_phi_aj_post               force factor for particle aj multiplied with delta_post
 115  *  \param[out] factor_phi_ak_ante               force factor for particle ak multiplied with delta_ante
 116  *  \param[out] factor_phi_ak_crnt               force factor for particle ak multiplied with delta_crnt
 117  *  \param[out] factor_phi_ak_post               force factor for particle ak multiplied with delta_post
 118  *  \param[out] factor_phi_al_ante               force factor for particle al multiplied with delta_ante
 119  *  \param[out] factor_phi_al_crnt               force factor for particle al multiplied with delta_crnt
 120  *  \param[out] factor_phi_al_post               force factor for particle al multiplied with delta_post
 121  *  \param[out] prefactor_phi                    multiplication constant of the torsion force
 122  *  \param[out] v                                contribution to energy  (see formula above)
 123  */
 124
 125 void compute_factors_restrdihs(int type,  const t_iparams forceparams[],
 126                                rvec delta_ante, rvec delta_crnt, rvec delta_post,
 127                                real *factor_phi_ai_ante, real *factor_phi_ai_crnt, real *factor_phi_ai_post,
 128                                real *factor_phi_aj_ante, real *factor_phi_aj_crnt, real *factor_phi_aj_post,
 129                                real *factor_phi_ak_ante, real *factor_phi_ak_crnt, real *factor_phi_ak_post,
 130                                real *factor_phi_al_ante, real *factor_phi_al_crnt, real *factor_phi_al_post,
 131                                real *prefactor_phi, real *v);
 132
 133 /*! \brief Compute factors for combined bending-torsion (CBT) potentials.
 134  *
 135  * The combined bending-torsion potential goes to zero in a very smooth manner, eliminating the numerical
 136  * instabilities, when three coarse-grained particles align and the dihedral angle and standard
 137  * dihedral potentials cannot be calculated. The CBT potential is calculated using the formula:
 138  * \f[V_{\rm CBT}(\theta_{i-1}, \theta_i, \phi_i) = k_{\phi} \sin^3\theta_{i-1} \sin^3\theta_{i}
 139  * \sum_{n=0}^4 { a_n \cos^n\phi_i}\f] (see section "Proper dihedrals: Combined bending-torsion potential" from the manual).
 140  * It contains in its expression not only the dihedral angle \f$\phi\f$
 141  * but also \f$\theta_{i-1}\f$ (denoted as theta_ante below) and \f$\theta_{i}\f$ (denoted as theta_post below)
 142  * --- the adjacent bending angles. The derivative of the CBT potential is calculated as:
 143  * \f[\frac{\partial V_{\rm CBT}(\theta_{i-1},\theta_i,\phi_i)} {\partial \vec r_{l}} =  \frac{\partial V_
 144  * {\rm CBT}}{\partial \theta_{i-1}} \frac{\partial \theta_{i-1}}{\partial \vec r_{l}} +
 145  * \frac{\partial V_{\rm CBT}}{\partial \phi_{i    }} \frac{\partial \phi_{i    }}{\partial \vec r_{l}}\f]
 146  * where all the derivatives of the angles with respect to Cartesian coordinates are calculated as
 147  * in Allen & Tildesley (pp. 330-332). Factors f_phi_* come from  the derivatives of the torsion angle
 148  * with respect to the beads ai, aj, ak, al (four) coordinates; f_theta_ante_* come from the derivatives of
 149  * the bending angle theta_ante (theta_{i-1} in formula above) with respect to the beads ai, aj, ak (three
 150  * particles) coordinates and f_theta_post_* come from the derivatives of  the bending angle theta_post
 151  * (theta_{i} in formula above) with respect to the beads aj, ak, al (three particles) coordinates.
 152  *
 153  *  \param[in]  type                             type of force parameters
 154  *  \param[in]  forceparams                      array of parameters for force computations
 155  *  \param[in]  delta_ante                       distance between the first two particles
 156  *  \param[in]  delta_crnt                       distance between the middle pair of particles
 157  *  \param[in]  delta_post                       distance between the last two particles
 158  *  \param[out]  f_phi_ai                        force for particle ai due to derivative in phi angle
 159  *  \param[out]  f_phi_aj                        force for particle aj due to derivative in phi angle
 160  *  \param[out]  f_phi_ak                        force for particle ak due to derivative in phi angle
 161  *  \param[out]  f_phi_al                        force for particle al due to derivative in phi angle
 162  *  \param[out]  f_theta_ante_ai                 force for particle ai due to derivative in theta_ante angle
 163  *  \param[out]  f_theta_ante_aj                 force for particle aj due to derivative in theta_ante angle
 164  *  \param[out]  f_theta_ante_ak                 force for particle ak due to derivative in theta_ante angle
 165  *  \param[out]  f_theta_post_aj                 force for particle aj due to derivative in theta_post angle
 166  *  \param[out]  f_theta_post_ak                 force for particle ak due to derivative in theta_post angle
 167  *  \param[out]  f_theta_post_al                 force for particle al due to derivative in theta_psot angle
 168  *  \param[out] v                                contribution to energy (see formula above)
 169  */
 170
 171 void compute_factors_cbtdihs(int type,  const t_iparams forceparams[],
 172                              rvec delta_ante, rvec delta_crnt, rvec delta_post,
 173                              rvec f_phi_ai, rvec f_phi_aj, rvec f_phi_ak, rvec f_phi_al,
 174                              rvec f_theta_ante_ai, rvec f_theta_ante_aj, rvec f_theta_ante_ak,
 175                              rvec f_theta_post_aj, rvec f_theta_post_ak, rvec f_theta_post_al,
 176                              real * v);
 177
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif  /* _restcbt_h */