src/gromacs/applied_forces/densityfitting/densityfittingamplitudelookup.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
  37  * Declares amplitude lookup for density fitting
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \ingroup module_applied_forces
  41  */
  42 #ifndef GMX_APPLIED_FORCES_DENSITYFITTINGAMPLITUDELOOKUP_H
  43 #define GMX_APPLIED_FORCES_DENSITYFITTINGAMPLITUDELOOKUP_H
  44
  45 #include <map>
  46 #include <memory>
  47 #include <vector>
  48
  49 #include "gromacs/utility/enumerationhelpers.h"
  50 #include "gromacs/utility/real.h"
  51
  52 namespace gmx
  53 {
  54
  55 template<typename>
  56 class ArrayRef;
  57
  58 /*! \brief
  59  * The methods that determine how amplitudes are spread on a grid in density guided simulations.
  60  */
  61 enum class DensityFittingAmplitudeMethod : int
  62 {
  63     Unity,  //!< same spread amplitude, unity, for all atoms
  64     Mass,   //!< atom mass is the spread amplitude
  65     Charge, //!< partial charge determines the spread amplitude
  66     Count
  67 };
  68
  69 class DensityFittingAmplitudeLookupImpl;
  70
  71 /*! \internal \brief Class that translates atom properties into amplitudes.
  72  *
  73  */
  74 class DensityFittingAmplitudeLookup
  75 {
  76 public:
  77     //! Construct force provider for density fitting from its parameters
  78     explicit DensityFittingAmplitudeLookup(const DensityFittingAmplitudeMethod& method);
  79     ~DensityFittingAmplitudeLookup();
  80     //! Copy constructor
  81     DensityFittingAmplitudeLookup(const DensityFittingAmplitudeLookup& other);
  82     //! Copy assignment
  83     DensityFittingAmplitudeLookup& operator=(const DensityFittingAmplitudeLookup& other);
  84     //! Move constructor
  85     DensityFittingAmplitudeLookup(DensityFittingAmplitudeLookup&& other) noexcept;
  86     //! Move assignment
  87     DensityFittingAmplitudeLookup& operator=(DensityFittingAmplitudeLookup&& other) noexcept;
  88     /*! \brief Return the amplitudes for spreading atoms of a given local index.
  89      * \param[in] chargeA Atom charges
  90      * \param[in] massT   Atom masses.
  91      * \param[in] localIndex the local atom indices
  92      * \returns amplitudes
  93      */
  94     const std::vector<real>& operator()(ArrayRef<const real> chargeA,
  95                                         ArrayRef<const real> massT,
  96                                         ArrayRef<const int>  localIndex);
  97
  98 private:
  99     std::unique_ptr<DensityFittingAmplitudeLookupImpl> impl_;
 100 };
 101
 102 } // namespace gmx
 103
 104 #endif // GMX_APPLIED_FORCES_DENSITYFITTINGAMPLITUDELOOKUP_H