src/gromacs/mdlib/vcm.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,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, 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 #ifndef GMX_MDLIB_VCM_H
  39 #define GMX_MDLIB_VCM_H
  40
  41 #include <stdio.h>
  42
  43 #include <vector>
  44
  45 #include "gromacs/math/vectypes.h"
  46 #include "gromacs/mdtypes/md_enums.h"
  47 #include "gromacs/utility/real.h"
  48
  49 struct SimulationGroups;
  50 struct t_inputrec;
  51 struct t_mdatoms;
  52
  53 namespace gmx
  54 {
  55 template<typename T>
  56 class ArrayRef;
  57 }
  58
  59 struct t_vcm_thread
  60 {
  61     //! Linear momentum
  62     rvec p = { 0 };
  63     //! Center of mass
  64     rvec x = { 0 };
  65     //! Angular momentum
  66     rvec j = { 0 };
  67     //! Moment of inertia
  68     tensor i = { { 0 } };
  69     //! Mass
  70     real mass = 0;
  71 };
  72
  73 struct t_vcm
  74 {
  75     //! Number of groups
  76     int nr = 0;
  77     //! Size of group arrays
  78     int size = 0;
  79     //! Stride for thread data
  80     int stride = 0;
  81     //! One of the enums above
  82     ComRemovalAlgorithm mode = ComRemovalAlgorithm::Linear;
  83     //! The number of dimensions for corr.
  84     int ndim = 0;
  85     //! The time step for COMM removal
  86     real timeStep = 0;
  87     //! Number of degrees of freedom
  88     std::vector<real> group_ndf;
  89     //! Mass per group
  90     std::vector<real> group_mass;
  91     //! Linear momentum per group
  92     std::vector<gmx::RVec> group_p;
  93     //! Linear velocity per group
  94     std::vector<gmx::RVec> group_v;
  95     //! Center of mass per group
  96     std::vector<gmx::RVec> group_x;
  97     //! Angular momentum per group
  98     std::vector<gmx::RVec> group_j;
  99     //! Angular velocity (omega)
 100     std::vector<gmx::RVec> group_w;
 101     //! Moment of inertia per group
 102     tensor* group_i = nullptr;
 103     //! These two are copies to pointers in
 104     std::vector<char*> group_name;
 105     //! Tells whether dimensions are frozen per freeze group
 106     ivec* nFreeze = nullptr;
 107     //! Temporary data per thread and group
 108     std::vector<t_vcm_thread> thread_vcm;
 109
 110     //! Tell whether the integrator conserves momentum
 111     bool integratorConservesMomentum = false;
 112
 113     t_vcm(const SimulationGroups& groups, const t_inputrec& ir);
 114     ~t_vcm();
 115 };
 116
 117 /* print COM removal info to log */
 118 void reportComRemovalInfo(FILE* fp, const t_vcm& vcm);
 119
 120
 121 /* Do a per group center of mass things */
 122 void calc_vcm_grp(const t_mdatoms&               md,
 123                   gmx::ArrayRef<const gmx::RVec> x,
 124                   gmx::ArrayRef<const gmx::RVec> v,
 125                   t_vcm*                         vcm);
 126
 127 /* Set the COM velocity to zero and potentially correct the COM position.
 128  *
 129  * Processes the kinetic energy reduced over MPI before removing COM motion.
 130  * With mode linear, nullptr can be passed for x.
 131  * With acceleration correction nullptr should be passed for x at initialization
 132  * and a pointer to the coordinates at normal MD steps.
 133  * When fplog != nullptr, a warning is printed to fplog with high COM velocity.
 134  */
 135 void process_and_stopcm_grp(FILE*                    fplog,
 136                             t_vcm*                   vcm,
 137                             const t_mdatoms&         mdatoms,
 138                             gmx::ArrayRef<gmx::RVec> x,
 139                             gmx::ArrayRef<gmx::RVec> v);
 140
 141 #endif