src/gromacs/applied_forces/densityfittingamplitudelookup.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020, 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
  48 #include "gromacs/utility/arrayref.h"
  49 #include "gromacs/utility/enumerationhelpers.h"
  50 #include "gromacs/utility/real.h"
  51
  52 struct t_mdatoms;
  53
  54 namespace gmx
  55 {
  56
  57 /*! \brief
  58  * The methods that determine how amplitudes are spread on a grid in density guided simulations.
  59  */
  60 enum class DensityFittingAmplitudeMethod : int
  61 {
  62     Unity,  //!< same spread amplitude, unity, for all atoms
  63     Mass,   //!< atom mass is the spread amplitude
  64     Charge, //!< partial charge determines the spread amplitude
  65     Count
  66 };
  67
  68 class DensityFittingAmplitudeLookupImpl;
  69
  70 /*! \internal \brief Class that translates atom properties into amplitudes.
  71  *
  72  */
  73 class DensityFittingAmplitudeLookup
  74 {
  75 public:
  76     //! Construct force provider for density fitting from its parameters
  77     explicit DensityFittingAmplitudeLookup(const DensityFittingAmplitudeMethod& method);
  78     ~DensityFittingAmplitudeLookup();
  79     //! Copy constructor
  80     DensityFittingAmplitudeLookup(const DensityFittingAmplitudeLookup& other);
  81     //! Copy assignment
  82     DensityFittingAmplitudeLookup& operator=(const DensityFittingAmplitudeLookup& other);
  83     //! Move constructor
  84     DensityFittingAmplitudeLookup(DensityFittingAmplitudeLookup&& other) noexcept;
  85     //! Move assignment
  86     DensityFittingAmplitudeLookup& operator=(DensityFittingAmplitudeLookup&& other) noexcept;
  87     /*! \brief Return the amplitudes for spreading atoms of a given local index.
  88      * \param[in] atoms the atom information
  89      * \param[in] localIndex the local atom indices
  90      * \returns amplitudes
  91      */
  92     const std::vector<real>& operator()(const t_mdatoms& atoms, ArrayRef<const int> localIndex);
  93
  94 private:
  95     std::unique_ptr<DensityFittingAmplitudeLookupImpl> impl_;
  96 };
  97
  98 } // namespace gmx
  99
 100 #endif // GMX_APPLIED_FORCES_DENSITYFITTINGAMPLITUDELOOKUP_H