src/gromacs/pulling/pull_internal.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,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 /*! \internal \file
  40  *
  41  *
  42  * \brief
  43  * This file contains datatypes and function declarations for internal
  44    use in the pull code.
  45  *
  46  * \author Berk Hess
  47  */
  48
  49 #ifndef GMX_PULLING_PULL_INTERNAL_H
  50 #define GMX_PULLING_PULL_INTERNAL_H
  51
  52 #include "config.h"
  53
  54 #include <memory>
  55 #include <vector>
  56
  57 #include "gromacs/domdec/localatomset.h"
  58 #include "gromacs/mdtypes/pull_params.h"
  59 #include "gromacs/utility/gmxmpi.h"
  60
  61 /*! \brief Determines up to what local atom count a pull group gets processed single-threaded.
  62  *
  63  * We set this limit to 1 with debug to catch bugs.
  64  * On Haswell with GCC 5 the cross-over point is around 400 atoms,
  65  * independent of thread count and hyper-threading.
  66  */
  67 #ifdef NDEBUG
  68 static const int c_pullMaxNumLocalAtomsSingleThreaded = 100;
  69 #else
  70 static const int c_pullMaxNumLocalAtomsSingleThreaded = 1;
  71 #endif
  72
  73 class PullHistory;
  74
  75 enum
  76 {
  77     epgrppbcNONE,
  78     epgrppbcREFAT,
  79     epgrppbcCOS,
  80     epgrppbcPREVSTEPCOM
  81 };
  82
  83 /*! \internal
  84  * \brief Pull group data used during pulling
  85  */
  86 struct pull_group_work_t
  87 {
  88     /*! \brief Constructor
  89      *
  90      * \param[in] params                  The group parameters set by the user
  91      * \param[in] atomSet                 The global to local atom set manager
  92      * \param[in] setPbcRefToPrevStepCOM Does this pull group use the COM from the previous step as reference position?
  93      */
  94     pull_group_work_t(const t_pull_group& params, gmx::LocalAtomSet atomSet, bool setPbcRefToPrevStepCOM);
  95
  96     /* Data only modified at initialization */
  97     const t_pull_group params;   /**< The pull group parameters */
  98     const int          epgrppbc; /**< The type of pbc for this pull group, see enum above */
  99     bool               needToCalcCom; /**< Do we need to calculate the COM? (Not for group 0 or if only used as cylinder group) */
 100     std::vector<real>  globalWeights; /**< Weights per atom set by the user and/or mass/friction coefficients, if empty all weights are equal */
 101
 102     /* Data modified only at init or at domain decomposition */
 103     gmx::LocalAtomSet                  atomSet;      /**< Global to local atom set mapper */
 104     std::vector<real>                  localWeights; /**< Weights for the local atoms */
 105     std::unique_ptr<gmx::LocalAtomSet> pbcAtomSet;   /**< Keeps index of the pbc reference atom.
 106                                                           The stored LocalAtomSet consists of exactly   one atom when pbc reference atom is required.
 107                                                           When no pbc refence atom is used, this   pointer   shall be null. */
 108
 109     /* Data, potentially, changed at every pull call */
 110     real mwscale; /**< mass*weight scaling factor 1/sum w m */
 111     real wscale;  /**< scaling factor for the weights: sum w m/sum w w m */
 112     real invtm;   /**< inverse total mass of the group: 1/wscale sum w m */
 113     std::vector<gmx::BasicVector<double>> mdw; /**< mass*gradient(weight) for atoms */
 114     std::vector<double>                   dv;  /**< distance to the other group(s) along vec */
 115     dvec                                  x;   /**< COM before update */
 116     dvec                                  xp;  /**< COM after update before constraining */
 117     dvec                                  x_prev_step; /**< center of mass of the previous step */
 118 };
 119
 120 /* Struct describing the instantaneous spatial layout of a pull coordinate */
 121 struct PullCoordSpatialData
 122 {
 123     dvec   dr01;       /* The direction vector of group 1 relative to group 0 */
 124     dvec   dr23;       /* The direction vector of group 3 relative to group 2 */
 125     dvec   dr45;       /* The direction vector of group 5 relative to group 4 */
 126     dvec   vec;        /* The pull direction */
 127     double vec_len;    /* Length of vec for direction-relative */
 128     dvec   ffrad;      /* conversion factor from vec to radial force */
 129     double cyl_dev;    /* The deviation from the reference position */
 130     dvec   planevec_m; /* Normal of plane for groups 0, 1, 2, 3 for geometry dihedral */
 131     dvec   planevec_n; /* Normal of plane for groups 2, 3, 4, 5 for geometry dihedral */
 132
 133     double value; /* The current value of the coordinate, units of nm or rad */
 134 };
 135
 136 /* Struct with parameters and force evaluation local data for a pull coordinate */
 137 struct pull_coord_work_t
 138 {
 139     /* Constructor */
 140     pull_coord_work_t(const t_pull_coord& params) :
 141         params(params),
 142         value_ref(0),
 143         spatialData(),
 144         scalarForce(0),
 145         bExternalPotentialProviderHasBeenRegistered(false)
 146     {
 147     }
 148
 149     const t_pull_coord params; /* Pull coordinate parameters */
 150
 151     double value_ref; /* The reference value, usually init+rate*t, units of nm or rad */
 152
 153     PullCoordSpatialData spatialData; /* Data defining the current geometry */
 154
 155     double scalarForce; /* Scalar force for this cooordinate */
 156
 157     /* For external-potential coordinates only, for checking if a provider has been registered */
 158     bool bExternalPotentialProviderHasBeenRegistered;
 159 };
 160
 161 /* Struct for storing vectorial forces for a pull coordinate */
 162 struct PullCoordVectorForces
 163 {
 164     dvec force01; /* Force due to the pulling/constraining for groups 0, 1 */
 165     dvec force23; /* Force for groups 2 and 3 */
 166     dvec force45; /* Force for groups 4 and 5 */
 167 };
 168
 169 /* Struct for sums over (local) atoms in a pull group */
 170 struct ComSums
 171 {
 172     /* For normal weighting */
 173     double sum_wm;   /* Sum of weight*mass        */
 174     double sum_wwm;  /* Sum of weight*weight*mass */
 175     dvec   sum_wmx;  /* Sum of weight*mass*x      */
 176     dvec   sum_wmxp; /* Sum of weight*mass*xp     */
 177
 178     /* For cosine weighting */
 179     double sum_cm;  /* Sum of cos(x)*mass          */
 180     double sum_sm;  /* Sum of sin(x)*mass          */
 181     double sum_ccm; /* Sum of cos(x)*cos(x)*mass   */
 182     double sum_csm; /* Sum of cos(x)*sin(x)*mass   */
 183     double sum_ssm; /* Sum of sin(x)*sin(x)*mass   */
 184     double sum_cmp; /* Sum of cos(xp)*sin(xp)*mass */
 185     double sum_smp; /* Sum of sin(xp)*sin(xp)*mass */
 186
 187     /* Dummy data to ensure adjacent elements in an array are separated
 188      * by a cache line size, max 128 bytes.
 189      * TODO: Replace this by some automated mechanism.
 190      */
 191     int dummy[32];
 192 };
 193
 194 /*! \brief The normal COM buffer needs 3 elements per group */
 195 static constexpr int c_comBufferStride = 3;
 196
 197 /*! \brief The cylinder buffer needs 9 elements per group */
 198 static constexpr int c_cylinderBufferStride = 9;
 199
 200 struct pull_comm_t
 201 {
 202     gmx_bool bParticipateAll; /* Do all ranks always participate in pulling? */
 203     gmx_bool bParticipate;    /* Does our rank participate in pulling? */
 204 #if GMX_MPI
 205     MPI_Comm mpi_comm_com; /* Communicator for pulling */
 206 #endif
 207     int  nparticipate; /* The number of ranks participating */
 208     bool isMasterRank; /* Tells whether our rank is the master rank and thus should add the pull virial */
 209
 210     int64_t setup_count; /* The number of decomposition calls */
 211     int64_t must_count;  /* The last count our rank needed to be part */
 212
 213     /* Buffers for parallel reductions */
 214     std::vector<gmx::RVec>                pbcAtomBuffer; /* COM calculation buffer */
 215     std::vector<gmx::BasicVector<double>> comBuffer;     /* COM calculation buffer */
 216     std::vector<double> cylinderBuffer; /* cylinder ref. groups calculation buffer */
 217 };
 218
 219 // The COM pull force calculation data structure
 220 // TODO Convert this into a ForceProvider
 221 struct pull_t
 222 {
 223     /* Global parameters */
 224     pull_params_t params; /* The pull parameters, from inputrec */
 225
 226     gmx_bool bPotential;  /* Are there coordinates with potential? */
 227     gmx_bool bConstraint; /* Are there constrained coordinates? */
 228     gmx_bool bAngle;      /* Are there angle geometry coordinates? */
 229
 230     int      ePBC;      /* the boundary conditions */
 231     int      npbcdim;   /* do pbc in dims 0 <= dim < npbcdim */
 232     gmx_bool bRefAt;    /* do we need reference atoms for a group COM ? */
 233     int      cosdim;    /* dimension for cosine weighting, -1 if none */
 234     gmx_bool bCylinder; /* Is group 0 a cylinder group? */
 235
 236     /* Parameters + dynamic data for groups */
 237     std::vector<pull_group_work_t> group; /* The pull group param and work data */
 238     std::vector<pull_group_work_t> dyna;  /* Dynamic groups for geom=cylinder */
 239
 240     /* Parameters + dynamic data for coordinates */
 241     std::vector<pull_coord_work_t> coord; /* The pull group param and work data */
 242
 243     /* Global dynamic data */
 244     gmx_bool bSetPBCatoms; /* Do we need to set x_pbc for the groups? */
 245
 246     int                  nthreads; /* Number of threads used by the pull code */
 247     std::vector<ComSums> comSums;  /* Work array for summing for COM, 1 entry per thread */
 248
 249     pull_comm_t comm; /* Communication parameters, communicator and buffers */
 250
 251     FILE* out_x; /* Output file for pull data */
 252     FILE* out_f; /* Output file for pull data */
 253
 254     bool bXOutAverage; /* Output average pull coordinates */
 255     bool bFOutAverage; /* Output average pull forces */
 256
 257     PullHistory* coordForceHistory; /* Pull coordinate and force history */
 258
 259     /* The number of coordinates using an external potential */
 260     int numCoordinatesWithExternalPotential;
 261     /* Counter for checking external potential registration */
 262     int numUnregisteredExternalPotentials;
 263     /* */
 264     int numExternalPotentialsStillToBeAppliedThisStep;
 265 };
 266
 267 /*! \brief Copies the pull group COM of the previous step from the checkpoint state to the pull state
 268  *
 269  * \param[in]   pull  The COM pull force calculation data structure
 270  * \param[in]   state The global state container
 271  */
 272 void setPrevStepPullComFromState(struct pull_t* pull, const t_state* state);
 273
 274 /*! \brief Resizes the vector, in the state container, containing the COMs from the previous step
 275  *
 276  * \param[in]   state The global state container
 277  * \param[in]   pull  The COM pull force calculation data structure
 278  */
 279 void allocStatePrevStepPullCom(t_state* state, const pull_t* pull);
 280
 281
 282 #endif