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,2019, 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  * \todo The group-scheme kernels needed a plain C-style t_mdatoms, so
  62  * this type combines that with the memory management needed for
  63  * efficient PME on GPU transfers. The mdatoms_ member should be
  64  * removed. */
  65 class MDAtoms
  66 {
  67     //! C-style mdatoms struct.
  68     unique_cptr<t_mdatoms> mdatoms_;
  69     //! Memory for chargeA that can be set up for efficient GPU transfer.
  70     gmx::PaddedHostVector<real> chargeA_;
  71
  72 public:
  73     // TODO make this private
  74     MDAtoms();
  75     ~MDAtoms();
  76     //! Getter.
  77     t_mdatoms* mdatoms() { return mdatoms_.get(); }
  78     //! Const getter.
  79     const t_mdatoms* mdatoms() const { return mdatoms_.get(); }
  80     /*! \brief Resizes memory.
  81      *
  82      * \throws std::bad_alloc  If out of memory.
  83      */
  84     void resize(int newSize);
  85     /*! \brief Reserves memory.
  86      *
  87      * \throws std::bad_alloc  If out of memory.
  88      */
  89     void reserve(int newCapacity);
  90     //! Builder function.
  91     friend std::unique_ptr<MDAtoms>
  92     makeMDAtoms(FILE* fp, const gmx_mtop_t& mtop, const t_inputrec& ir, bool rankHasPmeGpuTask);
  93 };
  94
  95 //! Builder function for MdAtomsWrapper.
  96 std::unique_ptr<MDAtoms> makeMDAtoms(FILE* fp, const gmx_mtop_t& mtop, const t_inputrec& ir, bool useGpuForPme);
  97
  98 } // namespace gmx
  99
 100 void atoms2md(const gmx_mtop_t* mtop,
 101               const t_inputrec* ir,
 102               int               nindex,
 103               const int*        index,
 104               int               homenr,
 105               gmx::MDAtoms*     mdAtoms);
 106 /* This routine copies the atoms->atom struct into md.
 107  * If index!=NULL only the indexed atoms are copied.
 108  * For the masses the A-state (lambda=0) mass is used.
 109  * Sets md->lambda = 0.
 110  * In free-energy runs, update_mdatoms() should be called after atoms2md()
 111  * to set the masses corresponding to the value of lambda at each step.
 112  */
 113
 114 void update_mdatoms(t_mdatoms* md, real lambda);
 115 /* When necessary, sets all the mass parameters to values corresponding
 116  * to the free-energy parameter lambda.
 117  * Sets md->lambda = lambda.
 118  */
 119
 120 #endif