src/gromacs/pulling/transformationcoordinate.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2021, 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 /*! \internal \file
  36  *
  37  * \brief
  38  * Declares function for compute transformation coordinate values and forces
  39  *
  40  * \author Oliver Fleetwood <oliver.fleetwood@gmail.com>
  41  * \author Paul Bauer <paul.bauer.q@gmail.com>
  42  * \author Joe Jordan <ejjordan@kth.se>
  43  * \author Berk Hess <hess@kth.se>
  44  *
  45  */
  46 #ifndef GMX_PULL_TRANSFORMATIONCOORDINATE_H
  47 #define GMX_PULL_TRANSFORMATIONCOORDINATE_H
  48
  49 struct pull_t;
  50 struct pull_coord_work_t;
  51
  52 namespace gmx
  53 {
  54 template<typename>
  55 class ArrayRef;
  56
  57 /*! \brief Calculates pull->coord[coord_ind].spatialData.value for a transformation pull coordinate
  58  *
  59  * This requires the values of the pull coordinates of lower indices to be set
  60  * \param[in] coord  The (transformation) coordinate to compute the value for
  61  * \param[in] variableCoords  Pull coordinates used as variables, entries 0 to coord->coordIndex
  62  *                            will be used
  63  * \returns Transformation value for pull coordinate.
  64  */
  65 double getTransformationPullCoordinateValue(pull_coord_work_t*                coord,
  66                                             ArrayRef<const pull_coord_work_t> variableCoords);
  67
  68 /*! \brief Applies a force of a transformation pull coordinate and distributes it to pull coordinates of lower rank
  69  *
  70  * \param[in,out] pcrd            The transformation pull coordinate to act on
  71  * \param[in,out] variableCoords  List of variable coords up to the coord index of \p pcrd
  72  * \param[in] transformationCoordForce  The force working on coord \p pcrd
  73  */
  74 void applyTransformationPullCoordForce(pull_coord_work_t*               pcrd,
  75                                        gmx::ArrayRef<pull_coord_work_t> variableCoords,
  76                                        double                           transformationCoordForce);
  77
  78 } // namespace gmx
  79
  80 #endif // GMX_PULL_TRANSFORMATIONCOORDINATE_H