src/gromacs/mdtypes/pullhistory.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019, 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 /*! \libinternal \file
  37  *
  38  *
  39  * \brief
  40  * This file contains datatypes for pull statistics history.
  41  *
  42  * \author Magnus Lundborg, Berk Hess
  43  *
  44  * \inlibraryapi
  45  * \ingroup module_mdtypes
  46  */
  47
  48 #ifndef GMX_MDLIB_PULLHISTORY_H
  49 #define GMX_MDLIB_PULLHISTORY_H
  50
  51 #include <vector>
  52
  53 //! \cond INTERNAL
  54
  55 //! \brief Contains the sum of coordinate observables to enable calculation of the average of pull data.
  56 class PullCoordinateHistory
  57 {
  58 public:
  59     double value;       //!< The sum of the current value of the coordinate, units of nm or rad.
  60     double valueRef;    //!< The sum of the reference value of the coordinate, units of nm or rad.
  61     double scalarForce; //!< The sum of the scalar force of the coordinate.
  62     dvec   dr01;        //!< The sum of the direction vector of group 1 relative to group 0.
  63     dvec   dr23;        //!< The sum of the direction vector of group 3 relative to group 2.
  64     dvec   dr45;        //!< The sum of the direction vector of group 5 relative to group 4.
  65     dvec   dynaX;       //!< The sum of the coordinate of the dynamic groups for geom=cylinder.
  66
  67     //! Constructor
  68     PullCoordinateHistory() : value(0), valueRef(0), scalarForce(0), dr01(), dr23(), dr45(), dynaX()
  69     {
  70     }
  71 };
  72
  73 //! \brief Contains the sum of group observables to enable calculation of the average of pull data.
  74 class PullGroupHistory
  75 {
  76 public:
  77     dvec x; //!< The sum of the coordinates of the group.
  78
  79     //! Constructor
  80     PullGroupHistory() : x() {}
  81 };
  82
  83
  84 //! \brief Pull statistics history, to allow output of average pull data.
  85 class PullHistory
  86 {
  87 public:
  88     int numValuesInXSum; //!< Number of values of the coordinate values in the pull sums.
  89     int numValuesInFSum; //!< Number of values in the pull force sums.
  90     std::vector<PullCoordinateHistory> pullCoordinateSums; //!< The container of the sums of the values of the pull coordinate, also contains the scalar force.
  91     std::vector<PullGroupHistory> pullGroupSums; //!< The container of the sums of the values of the pull group.
  92
  93     //! Constructor
  94     PullHistory() : numValuesInXSum(0), numValuesInFSum(0) {}
  95 };
  96
  97 //! \endcond
  98
  99 #endif