src/gromacs/ewald/pme-gpu.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017, 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 /*! \internal \file
  37  * \brief Implements high-level PME GPU functions which do not require GPU framework-specific code.
  38  *
  39  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  * \ingroup module_ewald
  41  */
  42
  43 #include "gmxpre.h"
  44
  45 #include "gromacs/ewald/pme.h"
  46 #include "gromacs/utility/exceptions.h"
  47 #include "gromacs/utility/fatalerror.h"
  48 #include "gromacs/utility/gmxassert.h"
  49
  50 #include "pme-gpu-internal.h"
  51 #include "pme-grid.h"
  52 #include "pme-internal.h"
  53 #include "pme-solve.h"
  54
  55 bool pme_gpu_task_enabled(const gmx_pme_t *pme)
  56 {
  57     return (pme != nullptr) && (pme->runMode != PmeRunMode::CPU);
  58 }
  59
  60 void pme_gpu_reset_timings(const gmx_pme_t *pme)
  61 {
  62     if (pme_gpu_active(pme))
  63     {
  64         pme_gpu_reset_timings(pme->gpu);
  65     }
  66 }
  67
  68 void pme_gpu_get_timings(const gmx_pme_t *pme, gmx_wallclock_gpu_pme_t *timings)
  69 {
  70     if (pme_gpu_active(pme))
  71     {
  72         pme_gpu_get_timings(pme->gpu, timings);
  73     }
  74 }
  75
  76 void pme_gpu_get_results(const gmx_pme_t *pme,
  77                          gmx_wallcycle_t  wcycle,
  78                          matrix           vir_q,
  79                          real            *energy_q)
  80 {
  81     GMX_ASSERT(pme_gpu_active(pme), "This should be a GPU run of PME but it is not enabled.");
  82
  83     const bool haveComputedEnergyAndVirial = pme->gpu->settings.stepFlags & GMX_PME_CALC_ENER_VIR;
  84     const bool haveComputedForces          = pme->gpu->settings.stepFlags & GMX_PME_CALC_F;
  85
  86     // The wallcycle hierarchy is messy - we pause ewcFORCE just to exclude the PME GPU sync time
  87     wallcycle_stop(wcycle, ewcFORCE);
  88
  89     wallcycle_start(wcycle, ewcWAIT_GPU_PME_GATHER);
  90     pme_gpu_finish_step(pme->gpu, haveComputedForces, haveComputedEnergyAndVirial);
  91     wallcycle_stop(wcycle, ewcWAIT_GPU_PME_GATHER);
  92
  93     wallcycle_start_nocount(wcycle, ewcFORCE);
  94
  95     if (haveComputedEnergyAndVirial)
  96     {
  97         if (pme->doCoulomb)
  98         {
  99             if (pme_gpu_performs_solve(pme->gpu))
 100             {
 101                 pme_gpu_get_energy_virial(pme->gpu, energy_q, vir_q);
 102             }
 103             else
 104             {
 105                 get_pme_ener_vir_q(pme->solve_work, pme->nthread, energy_q, vir_q);
 106             }
 107         }
 108         else
 109         {
 110             *energy_q = 0;
 111         }
 112     }
 113     /* No additional haveComputedForces code since forces are copied to the output host buffer with no transformation. */
 114 }