src/gromacs/applied_forces/densityfittingoptions.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 options for density fitting
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \ingroup module_applied_forces
  41  */
  42 #ifndef GMX_APPLIED_FORCES_DENSITYFITTINGOPTIONS_H
  43 #define GMX_APPLIED_FORCES_DENSITYFITTINGOPTIONS_H
  44
  45 #include <string>
  46
  47 #include "gromacs/mdtypes/imdpoptionprovider.h"
  48
  49 #include "densityfittingparameters.h"
  50
  51 namespace gmx
  52 {
  53
  54 /*! \internal
  55  * \brief Input data storage for density fitting
  56  */
  57 class DensityFittingOptions final : public IMdpOptionProvider
  58 {
  59     public:
  60         //! From IMdpOptionProvider
  61         void initMdpTransform(IKeyValueTreeTransformRules * rules) override;
  62
  63         /*! \brief
  64          * Build mdp parameters for density fitting to be output after pre-processing.
  65          * \param[in, out] builder the builder for the mdp options output KV-tree.
  66          * \note This should be symmetrical to option initialization without
  67          *       employing manual prefixing with the section name string once
  68          *       the legacy code blocking this design is removed.
  69          */
  70         void buildMdpOutput(KeyValueTreeObjectBuilder *builder) const override;
  71
  72         /*! \brief
  73          * Connect option name and data.
  74          */
  75         void initMdpOptions(IOptionsContainerWithSections *options) override;
  76
  77         //! Report if this set of options is active
  78         bool active() const;
  79
  80         //! Process input options to parameters, including input file reading.
  81         const DensityFittingParameters &buildParameters();
  82
  83     private:
  84         const std::string        c_activeTag_ = "active";
  85         DensityFittingParameters parameters_;
  86 };
  87
  88 } // namespace gmx
  89
  90 #endif