src/gromacs/mdtypes/forcebuffers.h

   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
  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 "gromacs/gpu_utils/hostallocator.h"
  51 #include "gromacs/math/arrayrefwithpadding.h"
  52 #include "gromacs/math/vectypes.h"
  53 #include "gromacs/utility/arrayref.h"
  54 #include "gromacs/utility/classhelpers.h"
  55
  56 namespace gmx
  57 {
  58
  59 enum class PinningPolicy : int;
  60
  61 /*! \libinternal \brief A view of the force buffer
  62  *
  63  * This is used for read and/or write access to the force buffer.
  64  */
  65 class ForceBuffersView
  66 {
  67 public:
  68     //! Constructor, creates a view to \p force
  69     ForceBuffersView(const ArrayRefWithPadding<RVec>& force) : force_(force) {}
  70
  71     //! Copy constructor deleted to avoid creating non-const from const
  72     ForceBuffersView(const ForceBuffersView& o) = delete;
  73
  74     //! Move constructor deleted, but could be implemented
  75     ForceBuffersView(ForceBuffersView&& o) = delete;
  76
  77     ~ForceBuffersView() = default;
  78
  79     //! Copy assignment deleted to avoid creating non-const from const
  80     ForceBuffersView& operator=(const ForceBuffersView& v) = delete;
  81
  82     //! Move assignment, moves the view
  83     ForceBuffersView& operator=(ForceBuffersView&& v) = default;
  84
  85     //! Returns a const arrayref to the force buffer without padding
  86     ArrayRef<const RVec> force() const { return force_.unpaddedConstArrayRef(); }
  87
  88     //! Returns an arrayref to the force buffer without padding
  89     ArrayRef<RVec> force() { return force_.unpaddedArrayRef(); }
  90
  91     //! Returns an ArrayRefWithPadding to the force buffer
  92     ArrayRefWithPadding<RVec> forceWithPadding() { return force_; }
  93
  94 private:
  95     //! The force buffer
  96     ArrayRefWithPadding<RVec> force_;
  97 };
  98
  99 /*! \libinternal \brief Object that holds the force buffers
 100  *
 101  * More buffers can be added when needed. Those should also be added
 102  * to ForceBuffersView.
 103  * Can be pinned for efficient transfer to/from GPUs.
 104  * All access happens through the ForceBuffersView object.
 105  */
 106 class ForceBuffers
 107 {
 108 public:
 109     //! Constructor, creates an empty force buffer with pinning not active
 110     ForceBuffers(PinningPolicy pinningPolicy = PinningPolicy::CannotBePinned);
 111
 112     //! Copy constructor deleted, but could be implemented
 113     ForceBuffers(const ForceBuffers& o) = delete;
 114
 115     //! Move constructor deleted, but could be implemented
 116     ForceBuffers(ForceBuffers&& o) = delete;
 117
 118     ~ForceBuffers();
 119
 120     //! Copy assignment operator, sets the pinning policy to CannotBePinned
 121     ForceBuffers& operator=(ForceBuffers const& o);
 122
 123     //! Move assignment operator, deleted but could be implemented
 124     ForceBuffers& operator=(ForceBuffers&& o) = delete;
 125
 126     //! Returns a const view to the force buffers
 127     const ForceBuffersView& view() const { return view_; }
 128
 129     //! Returns a view to the force buffer
 130     ForceBuffersView& view() { return view_; }
 131
 132     //! Resize the force buffer
 133     void resize(int numAtoms);
 134
 135     /*! \brief Returns the active pinning policy.
 136      *
 137      * Does not throw.
 138      */
 139     PinningPolicy pinningPolicy() const;
 140
 141 private:
 142     //! The force buffer
 143     PaddedHostVector<RVec> force_;
 144     //! The view to the force buffer
 145     ForceBuffersView view_;
 146 };
 147
 148 } // namespace gmx
 149
 150 #endif