src/gromacs/mdlib/mdatoms.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) 2010,2014,2015,2016,2017,2018, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_MDLIB_MDATOMS_H
  38 #define GMX_MDLIB_MDATOMS_H
  39
  40 #include <cstdio>
  41
  42 #include <memory>
  43 #include <vector>
  44
  45 #include "gromacs/gpu_utils/hostallocator.h"
  46 #include "gromacs/mdtypes/mdatom.h"
  47 #include "gromacs/utility/basedefinitions.h"
  48 #include "gromacs/utility/real.h"
  49 #include "gromacs/utility/unique_cptr.h"
  50
  51 struct gmx_mtop_t;
  52 struct t_inputrec;
  53
  54 namespace gmx
  55 {
  56
  57 /*! \libinternal
  58  * \brief Contains a C-style t_mdatoms while managing some of its
  59  * memory with C++ vectors with allocators.
  60  *
  61  * The group-scheme kernels need to use a plain C-style t_mdatoms, so
  62  * this type combines that with the memory management needed for
  63  * efficient PME on GPU transfers.
  64  *
  65  * \todo Refactor this class and rename MDAtoms once the group scheme
  66  * is removed. */
  67 class MDAtoms
  68 {
  69     //! C-style mdatoms struct.
  70     unique_cptr<t_mdatoms> mdatoms_;
  71     //! Memory for chargeA that can be set up for efficient GPU transfer.
  72     HostVector<real>       chargeA_;
  73     public:
  74         // TODO make this private
  75         //! Constructor.
  76         MDAtoms();
  77         //! Destructor.
  78         ~MDAtoms();
  79         //! Getter.
  80         t_mdatoms *mdatoms()
  81         {
  82             return mdatoms_.get();
  83         }
  84         /*! \brief Resizes memory.
  85          *
  86          * \throws std::bad_alloc  If out of memory.
  87          */
  88         void resize(int newSize);
  89         /*! \brief Reserves memory.
  90          *
  91          * \throws std::bad_alloc  If out of memory.
  92          */
  93         void reserve(int newCapacity);
  94         //! Builder function.
  95         friend std::unique_ptr<MDAtoms>
  96         makeMDAtoms(FILE *fp, const gmx_mtop_t &mtop, const t_inputrec &ir,
  97                     bool rankHasPmeGpuTask);
  98 };
  99
 100 //! Builder function for MdAtomsWrapper.
 101 std::unique_ptr<MDAtoms>
 102 makeMDAtoms(FILE *fp, const gmx_mtop_t &mtop, const t_inputrec &ir,
 103             bool useGpuForPme);
 104
 105 } // namespace
 106
 107 void atoms2md(const gmx_mtop_t *mtop, const t_inputrec *ir,
 108               int nindex, const int *index,
 109               int homenr,
 110               gmx::MDAtoms *mdAtoms);
 111 /* This routine copies the atoms->atom struct into md.
 112  * If index!=NULL only the indexed atoms are copied.
 113  * For the masses the A-state (lambda=0) mass is used.
 114  * Sets md->lambda = 0.
 115  * In free-energy runs, update_mdatoms() should be called after atoms2md()
 116  * to set the masses corresponding to the value of lambda at each step.
 117  */
 118
 119 void update_mdatoms(t_mdatoms *md, real lambda);
 120 /* When necessary, sets all the mass parameters to values corresponding
 121  * to the free-energy parameter lambda.
 122  * Sets md->lambda = lambda.
 123  */
 124
 125 #endif