src/gromacs/mdlib/tests/leapfrogtestrunners.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,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 /*! \internal \file
  36  * \brief Leap-Frog tests runners.
  37  *
  38  * Declares test runner class for Leap-Frog algorithm. The test runners abstract
  39  * class is used to unify the interfaces for CPU and GPU implementations of the
  40  * Leap-Frog algorithm. This allows to run the same test on the same data using
  41  * different implementations of the parent class, that inherit its interfaces.
  42  *
  43  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  * \ingroup module_mdlib
  45  */
  46 #ifndef GMX_MDLIB_TESTS_LEAPFROGTESTRUNNERS_H
  47 #define GMX_MDLIB_TESTS_LEAPFROGTESTRUNNERS_H
  48
  49 #include "config.h"
  50
  51 #include "gromacs/math/vec.h"
  52
  53 #include "testutils/test_device.h"
  54
  55 #include "leapfrogtestdata.h"
  56
  57 /*
  58  * LeapFrog is available with CUDA and SYCL.
  59  */
  60 #define GPU_LEAPFROG_SUPPORTED (GMX_GPU_CUDA || GMX_GPU_SYCL)
  61
  62 namespace gmx
  63 {
  64 namespace test
  65 {
  66
  67 /* \brief LeapFrog integrator test runner interface.
  68  *
  69  * Wraps the actual implementation of LeapFrog algorithm into common interface.
  70  */
  71 class ILeapFrogTestRunner
  72 {
  73 public:
  74     //! Virtual destructor
  75     virtual ~ILeapFrogTestRunner() {}
  76     /*! \brief The abstract function that runs the integrator for a given number of steps.
  77      *
  78      * Should be overriden.
  79      *
  80      * \param[in]     testData  Data needed for the integrator
  81      * \param[in]     numSteps  Total number of steps to run integration for.
  82      */
  83     virtual void integrate(LeapFrogTestData* testData, int numSteps) = 0;
  84
  85     /*! \brief Get the human-friendly description of hardware used by the runner.
  86      *
  87      * \returns String with description of the hardware.
  88      */
  89     virtual std::string hardwareDescription() = 0;
  90 };
  91
  92 // Runner for the CPU version of Leap-Frog.
  93 class LeapFrogHostTestRunner : public ILeapFrogTestRunner
  94 {
  95 public:
  96     //! Constructor.
  97     LeapFrogHostTestRunner() {}
  98     /*! \brief Integrate on the CPU for a given number of steps.
  99      *
 100      * Will update the test data with the integration result.
 101      *
 102      * \param[in]     testData  Data needed for the integrator
 103      * \param[in]     numSteps  Total number of steps to run integration for.
 104      */
 105     void integrate(LeapFrogTestData* testData, int numSteps) override;
 106     /*! \brief Get the hardware description
 107      *
 108      * \returns "CPU" string.
 109      */
 110     std::string hardwareDescription() override { return "CPU"; }
 111 };
 112
 113 // Runner for the CPU version of Leap-Frog.
 114 class LeapFrogDeviceTestRunner : public ILeapFrogTestRunner
 115 {
 116 public:
 117     /*! \brief Constructor. Keeps a copy of the hardware context.
 118      *
 119      * \param[in] testDevice The device hardware context to be used by the runner.
 120      */
 121     LeapFrogDeviceTestRunner(const TestDevice& testDevice) : testDevice_(testDevice) {}
 122     /*! \brief Integrate on the GPU for a given number of steps.
 123      *
 124      * Copies data from CPU to GPU, integrates the equation of motion
 125      * for requested number of steps using Leap-Frog algorithm, copies
 126      * the result back.
 127      *
 128      * \param[in]     testData  Data needed for the integrator
 129      * \param[in]     numSteps  Total number of steps to run integration for.
 130      */
 131     void integrate(LeapFrogTestData* testData, int numSteps) override;
 132     /*! \brief Get the hardware description
 133      *
 134      * \returns A string with GPU description.
 135      */
 136     std::string hardwareDescription() override { return testDevice_.description(); }
 137
 138 private:
 139     //! Test device to be used in the runner.
 140     const TestDevice& testDevice_;
 141 };
 142
 143 } // namespace test
 144 } // namespace gmx
 145
 146 #endif // GMX_MDLIB_TESTS_LEAPFROGTESTRUNNERS_H