src/gromacs/mdtypes/forcebuffers.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, 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
  36 /*! \libinternal \file
  37  *
  38  * \brief
  39  * This file contains the definition of a container for force buffers.
  40  *
  41  * \author Berk Hess
  42  *
  43  * \inlibraryapi
  44  * \ingroup module_mdtypes
  45  */
  46
  47 #ifndef GMX_MDTYPES_FORCEBUFFERS_H
  48 #define GMX_MDTYPES_FORCEBUFFERS_H
  49
  50 #include <memory>
  51
  52 #include "gromacs/gpu_utils/hostallocator.h"
  53 #include "gromacs/math/vectypes.h"
  54
  55 namespace gmx
  56 {
  57 template<typename T>
  58 class ArrayRef;
  59 template<typename T>
  60 class ArrayRefWithPadding;
  61
  62 enum class PinningPolicy : int;
  63
  64 /*! \libinternal \brief A view of the force buffer
  65  *
  66  * This is used for read and/or write access to the force buffer.
  67  */
  68 class ForceBuffersView
  69 {
  70 public:
  71     //! Constructor, creates a view to \p force
  72     ForceBuffersView(const ArrayRefWithPadding<RVec>& force,
  73                      const ArrayRefWithPadding<RVec>& forceMtsCombined,
  74                      const bool                       useForceMtsCombined) :
  75         force_(force), forceMtsCombined_(forceMtsCombined), useForceMtsCombined_(useForceMtsCombined)
  76     {
  77     }
  78
  79     //! Copy constructor deleted to avoid creating non-const from const
  80     ForceBuffersView(const ForceBuffersView& o) = delete;
  81
  82     //! Move constructor deleted, but could be implemented
  83     ForceBuffersView(ForceBuffersView&& o) = delete;
  84
  85     ~ForceBuffersView() = default;
  86
  87     //! Copy assignment deleted to avoid creating non-const from const
  88     ForceBuffersView& operator=(const ForceBuffersView& v) = delete;
  89
  90     //! Move assignment, moves the view
  91     ForceBuffersView& operator=(ForceBuffersView&& v) = default;
  92
  93     //! Returns a const arrayref to the force buffer without padding
  94     ArrayRef<const RVec> force() const { return force_.unpaddedConstArrayRef(); }
  95
  96     //! Returns an arrayref to the force buffer without padding
  97     ArrayRef<RVec> force() { return force_.unpaddedArrayRef(); }
  98
  99     //! Returns an ArrayRefWithPadding to the force buffer
 100     ArrayRefWithPadding<RVec> forceWithPadding() { return force_; }
 101
 102     //! Returns a const arrayref to the MTS force buffer without padding
 103     ArrayRef<const RVec> forceMtsCombined() const
 104     {
 105         GMX_ASSERT(useForceMtsCombined_, "Need the MTS buffer");
 106         return forceMtsCombined_.unpaddedConstArrayRef();
 107     }
 108
 109     //! Returns an arrayref to the MTS force buffer without padding
 110     ArrayRef<RVec> forceMtsCombined()
 111     {
 112         GMX_ASSERT(useForceMtsCombined_, "Need the MTS buffer");
 113         return forceMtsCombined_.unpaddedArrayRef();
 114     }
 115
 116     //! Returns an ArrayRefWithPadding to the MTS force buffer
 117     ArrayRefWithPadding<RVec> forceMtsCombinedWithPadding()
 118     {
 119         GMX_ASSERT(useForceMtsCombined_, "Need the MTS buffer");
 120         return forceMtsCombined_;
 121     }
 122
 123 private:
 124     //! The force buffer
 125     ArrayRefWithPadding<RVec> force_;
 126     //! The force buffer for combined fast and slow forces with MTS
 127     ArrayRefWithPadding<RVec> forceMtsCombined_;
 128     // GCC 9 complains about unused attribute "unused" as it never warns about unused members,
 129     // while clang requires it to avoid -Wunused
 130 #pragma GCC diagnostic push
 131 #pragma GCC diagnostic ignored "-Wattributes"
 132     //! Whether we use forceMtsCombined_
 133     gmx_used_in_debug bool useForceMtsCombined_;
 134 #pragma GCC diagnostic pop
 135 };
 136
 137 /*! \libinternal \brief Object that holds the force buffers
 138  *
 139  * Contains a normal force buffer and optionally a force buffer for combined fast and slow
 140  * forces for use with multiple time stepping.
 141  * More buffers can be added when needed. Those should also be added
 142  * to ForceBuffersView.
 143  * The force buffer (not forceMtsCombined) can be pinned for efficient transfer to/from GPUs.
 144  * All access happens through the ForceBuffersView object.
 145  */
 146 class ForceBuffers
 147 {
 148 public:
 149     //! Constructor, creates an empty force buffer with pinning not active and no MTS force buffer
 150     ForceBuffers();
 151
 152     /*! \brief Constructor, with options for using the MTS force buffer and the pinning policy
 153      *
 154      * \param[in] useForceMtsCombined  Whether to enable use of the forceMtsCombined buffer
 155      * \param[in] pinningPolicy        The pinning policy for the force (not MTS) buffer
 156      */
 157     ForceBuffers(bool useForceMtsCombined, PinningPolicy pinningPolicy);
 158
 159     //! Copy constructor deleted, but could be implemented
 160     ForceBuffers(const ForceBuffers& o) = delete;
 161
 162     //! Move constructor deleted, but could be implemented
 163     ForceBuffers(ForceBuffers&& o) = delete;
 164
 165     ~ForceBuffers();
 166
 167     //! Copy assignment operator, sets the pinning policy to CannotBePinned
 168     ForceBuffers& operator=(ForceBuffers const& o);
 169
 170     //! Move assignment operator, deleted but could be implemented
 171     ForceBuffers& operator=(ForceBuffers&& o) = delete;
 172
 173     //! Returns a const view to the force buffers
 174     const ForceBuffersView& view() const { return view_; }
 175
 176     //! Returns a view to the force buffer
 177     ForceBuffersView& view() { return view_; }
 178
 179     //! Resize the force buffer
 180     void resize(int numAtoms);
 181
 182     /*! \brief Returns the active pinning policy.
 183      *
 184      * Does not throw.
 185      */
 186     PinningPolicy pinningPolicy() const;
 187
 188 private:
 189     //! The force buffer
 190     PaddedHostVector<RVec> force_;
 191     //! Force buffer with combined fast and slow forces for use with multiple time stepping
 192     PaddedHostVector<RVec> forceMtsCombined_;
 193     //! The view to the force buffer
 194     ForceBuffersView view_;
 195     //! Whether we use forceMtsCombined_
 196     bool useForceMtsCombined_;
 197 };
 198
 199 } // namespace gmx
 200
 201 #endif