api/nblib/util/user.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020, 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  * \brief
  37  * Implements nblib utility functions
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  */
  45
  46 #include "nblib/util/internal.h"
  47 #include "nblib/util/user.h"
  48 #include "gromacs/random/tabulatednormaldistribution.h"
  49 #include "gromacs/random/threefry.h"
  50 #include "gromacs/utility/arrayref.h"
  51 #include "gromacs/utility/fatalerror.h"
  52
  53 namespace nblib
  54 {
  55
  56 namespace detail
  57 {
  58
  59 std::string next_token(std::string& s, const std::string& delimiter)
  60 {
  61     std::string token = s.substr(0, s.find(delimiter));
  62
  63     std::size_t next = s.find(delimiter);
  64     if (next == std::string::npos)
  65         s.clear();
  66     else
  67         s.erase(0, next + delimiter.length());
  68
  69     return token;
  70 }
  71
  72 } // namespace detail
  73
  74 //! Generates an array of particle velocities based on the Maxwell-Boltzmann distribution
  75 //! using temperature, masses and a random number generator
  76 static std::vector<Vec3> low_mspeed(real tempi, std::vector<real> const& masses, gmx::ThreeFry2x64<>* rng)
  77 {
  78     int                                    nrdf;
  79     real                                   boltz;
  80     real                                   ekin, temp;
  81     gmx::TabulatedNormalDistribution<real> normalDist;
  82
  83     std::vector<Vec3> velocities(masses.size());
  84
  85     boltz = BOLTZ * tempi;
  86     ekin  = 0.0;
  87     nrdf  = 0;
  88     for (size_t i = 0; i < masses.size(); i++)
  89     {
  90         real mass = masses[i];
  91         if (mass > 0)
  92         {
  93             rng->restart(i, 0);
  94             real sd = std::sqrt(boltz / mass);
  95             for (int m = 0; (m < dimSize); m++)
  96             {
  97                 velocities[i][m] = sd * normalDist(*rng);
  98                 ekin += 0.5 * mass * velocities[i][m] * velocities[i][m];
  99             }
 100             nrdf += dimSize;
 101         }
 102     }
 103     temp = (2.0 * ekin) / (nrdf * BOLTZ);
 104     if (temp > 0)
 105     {
 106         real scal = std::sqrt(tempi / temp);
 107         for (auto& vel : velocities)
 108         {
 109             for (int m = 0; (m < dimSize); m++)
 110             {
 111                 vel[m] *= scal;
 112             }
 113         }
 114     }
 115     fprintf(stderr, "Velocities were taken from a Maxwell distribution at %g K\n", tempi);
 116     if (debug)
 117     {
 118         fprintf(debug,
 119                 "Velocities were taken from a Maxwell distribution\n"
 120                 "Initial generated temperature: %12.5e (scaled to: %12.5e)\n",
 121                 temp, tempi);
 122     }
 123
 124     return velocities;
 125 }
 126
 127 //! Generate velocities from a Maxwell Boltzmann distribution, masses should be the
 128 //! same as the ones specified for the Topology object
 129 std::vector<Vec3> generateVelocity(real tempi, unsigned int seed, std::vector<real> const& masses)
 130 {
 131
 132     if (seed == 0)
 133     {
 134         seed = static_cast<int>(gmx::makeRandomSeed());
 135         fprintf(stderr, "Using random seed %u for generating velocities\n", seed);
 136     }
 137     gmx::ThreeFry2x64<> rng(seed, gmx::RandomDomain::MaxwellVelocities);
 138
 139     return low_mspeed(tempi, masses, &rng);
 140 }
 141
 142 //! Check within the container of gmx::RVecs for a NaN or inf
 143 bool isRealValued(gmx::ArrayRef<const Vec3> values)
 144 {
 145     for (auto val : values)
 146     {
 147         for (int m = 0; (m < dimSize); m++)
 148         {
 149             if (std::isnan(val[m]) or std::isinf(val[m]))
 150             {
 151                 return false;
 152             }
 153         }
 154     }
 155     return true;
 156 }
 157
 158 void zeroCartesianArray(gmx::ArrayRef<Vec3> cartesianArray)
 159 {
 160     std::fill(cartesianArray.begin(), cartesianArray.end(), Vec3{ 0, 0, 0 });
 161 }
 162
 163 } // namespace nblib