src/gromacs/mdlib/tests/settletestrunners.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 Declaration of the SETTLE tests runners.
  37  *
  38  * Declares the functions that do the buffer management and apply
  39  * SETTLE constraints ("test runners").
  40  *
  41  * \author Artem Zhmurov <zhmurov@gmail.com>
  42  * \ingroup module_mdlib
  43  */
  44
  45 #ifndef GMX_MDLIB_TESTS_SETTLETESTRUNNERS_H
  46 #define GMX_MDLIB_TESTS_SETTLETESTRUNNERS_H
  47
  48 #include "settletestdata.h"
  49
  50 struct t_pbc;
  51
  52 namespace gmx
  53 {
  54 namespace test
  55 {
  56
  57 /*! \brief Apply SETTLE using CPU version of the algorithm
  58  *
  59  * Initializes SETTLE object, applies algorithm, destroys the object. The coordinates, velocities
  60  * and virial are updated in the testData object.
  61  *
  62  * \param[in,out] testData          An object, containing all the data structures needed by SETTLE.
  63  * \param[in]     pbc               Periodic boundary setup.
  64  * \param[in]     updateVelocities  If the velocities should be updated.
  65  * \param[in]     calcVirial        If the virial should be computed.
  66  * \param[in]     testDescription   Brief description that will be printed in case of test failure.
  67  */
  68 void applySettle(SettleTestData*    testData,
  69                  t_pbc              pbc,
  70                  bool               updateVelocities,
  71                  bool               calcVirial,
  72                  const std::string& testDescription);
  73
  74 /*! \brief Apply SETTLE using GPU version of the algorithm
  75  *
  76  * Initializes SETTLE object, copied data to the GPU, applies algorithm, copies the data back,
  77  * destroys the object. The coordinates, velocities and virial are updated in the testData object.
  78  *
  79  * \param[in,out] testData          An object, containing all the data structures needed by SETTLE.
  80  * \param[in]     pbc               Periodic boundary setup.
  81  * \param[in]     updateVelocities  If the velocities should be updated.
  82  * \param[in]     calcVirial        If the virial should be computed.
  83  * \param[in]     testDescription   Brief description that will be printed in case of test failure.
  84  */
  85 void applySettleGpu(SettleTestData*    testData,
  86                     t_pbc              pbc,
  87                     bool               updateVelocities,
  88                     bool               calcVirial,
  89                     const std::string& testDescription);
  90
  91 } // namespace test
  92 } // namespace gmx
  93
  94 #endif // GMX_MDLIB_TESTS_SETTLETESTRUNNERS_H