api/nblib/kerneloptions.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 /*! \inpublicapi \file
  36  * \brief
  37  * Implements nblib kernel setup options
  38  *
  39  * \author Berk Hess <hess@kth.se>
  40  * \author Victor Holanda <victor.holanda@cscs.ch>
  41  * \author Joe Jordan <ejjordan@kth.se>
  42  * \author Prashanth Kanduri <kanduri@cscs.ch>
  43  * \author Sebastian Keller <keller@cscs.ch>
  44  */
  45 #ifndef NBLIB_KERNELOPTIONS_H
  46 #define NBLIB_KERNELOPTIONS_H
  47
  48 #include <memory>
  49
  50 #include "nblib/basicdefinitions.h"
  51
  52 namespace nblib
  53 {
  54
  55 //! Enum for selecting the SIMD kernel type
  56 enum class SimdKernels : int
  57 {
  58     SimdAuto,
  59     SimdNo,
  60     Simd4XM,
  61     Simd2XMM,
  62     Count
  63 };
  64
  65 //! Enum for selecting the combination rule
  66 enum class CombinationRule : int
  67 {
  68     Geometric,
  69     LorentzBerthelot,
  70     None,
  71     Count
  72 };
  73
  74 //! Enum for selecting coulomb type
  75 enum class CoulombType : int
  76 {
  77     Pme,
  78     Cutoff,
  79     ReactionField,
  80     Count
  81 };
  82
  83 /*! \internal \brief
  84  * The options for the nonbonded kernel caller
  85  */
  86 struct NBKernelOptions final
  87 {
  88     //! Whether to use a GPU, currently GPUs are not supported
  89     bool useGpu = false;
  90     //! The number of OpenMP threads to use
  91     int numOpenMPThreads = 1;
  92     //! The SIMD type for the kernel
  93     SimdKernels nbnxmSimd = SimdKernels::SimdAuto;
  94     //! The LJ combination rule
  95     CombinationRule ljCombinationRule = CombinationRule::Geometric;
  96     //! Use i-cluster half-LJ optimization for clusters with <= half LJ
  97     bool useHalfLJOptimization = false;
  98     //! The pairlist and interaction cut-off
  99     real pairlistCutoff = 1.0;
 100     //! Whether to compute energies (shift forces for virial are always computed on CPU)
 101     bool computeVirialAndEnergy = false;
 102     //! The Coulomb interaction function
 103     CoulombType coulombType = CoulombType::Pme;
 104     //! Whether to use tabulated PME grid correction instead of analytical, not applicable with simd=no
 105     bool useTabulatedEwaldCorr = false;
 106     //! The number of iterations for each kernel
 107     int numIterations = 100;
 108     //! Print cycles/pair instead of pairs/cycle
 109     bool cyclesPerPair = false;
 110     //! The time step
 111     real timestep = 0.001;
 112 };
 113
 114 } // namespace nblib
 115
 116 #endif // NBLIB_KERNELOPTIONS_H