src/gromacs/applied_forces/densityfittingforceprovider.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  37  * Declares force provider for density fitting
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \ingroup module_applied_forces
  41  */
  42 #ifndef GMX_APPLIED_FORCES_DENSITYFITTINGFORCEPROVIDER_H
  43 #define GMX_APPLIED_FORCES_DENSITYFITTINGFORCEPROVIDER_H
  44
  45 #include <memory>
  46
  47 #include "gromacs/domdec/localatomset.h"
  48 #include "gromacs/math/coordinatetransformation.h"
  49 #include "gromacs/math/exponentialmovingaverage.h"
  50 #include "gromacs/mdspan/extensions.h"
  51 #include "gromacs/mdtypes/iforceprovider.h"
  52 #include "gromacs/utility/classhelpers.h"
  53
  54 namespace gmx
  55 {
  56
  57 struct DensityFittingParameters;
  58
  59 /*! \internal
  60  * \brief Parameters defining the internal density fitting force provider state.
  61  */
  62 struct DensityFittingForceProviderState
  63 {
  64     /*! \brief The steps since the last force calculation.
  65      *  Used if density fitting is to be calculated every N steps.
  66      */
  67     std::int64_t stepsSinceLastCalculation_ = 0;
  68     //! The state of the exponential moving average of the similarity measure
  69     ExponentialMovingAverageState exponentialMovingAverageState_ = {};
  70     //! An additional factor scaling the force for adaptive force scaling
  71     real adaptiveForceConstantScale_ = 1.0_real;
  72 };
  73
  74 /*! \internal \brief
  75  * Implements IForceProvider for density-fitting forces.
  76  */
  77 class DensityFittingForceProvider final : public IForceProvider
  78 {
  79 public:
  80     //! Construct force provider for density fitting from its parameters
  81     DensityFittingForceProvider(const DensityFittingParameters&             parameters,
  82                                 basic_mdspan<const float, dynamicExtents3D> referenceDensity,
  83                                 const TranslateAndScale& transformationToDensityLattice,
  84                                 const LocalAtomSet&      localAtomSet,
  85                                 int                      pbcType,
  86                                 double                   simulationTimeStep,
  87                                 const DensityFittingForceProviderState& state);
  88     ~DensityFittingForceProvider();
  89     /*!\brief Calculate forces that maximise goodness-of-fit with a reference density map.
  90      * \param[in] forceProviderInput input for force provider
  91      * \param[out] forceProviderOutput output for force provider
  92      */
  93     void calculateForces(const ForceProviderInput& forceProviderInput,
  94                          ForceProviderOutput*      forceProviderOutput) override;
  95
  96     //! Return the state of the forceprovider.
  97     DensityFittingForceProviderState state();
  98
  99 private:
 100     class Impl;
 101     PrivateImplPointer<Impl> impl_;
 102 };
 103
 104 } // namespace gmx
 105
 106 #endif // GMX_APPLIED_FORCES_DENSITYFITTINGFORCEPROVIDER_H