src/gromacs/pulling/pullcoordexpressionparser.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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  *
  37  * \brief
  38  * Contains classes and methods related to use of MuParser in pulling
  39  *
  40  * \author Oliver Fleetwood <oliver.fleetwood@gmail.com>
  41  * \author Paul Bauer <paul.bauer.q@gmail.com>
  42  * \author Joe Jordan <ejjordan@kth.se>
  43  * \author Berk Hess <hess@kth.se>
  44  *
  45  */
  46 #ifndef GMX_PULL_PULLCOORDEXPRESSIONPARSER_H
  47 #define GMX_PULL_PULLCOORDEXPRESSIONPARSER_H
  48
  49 #include "config.h"
  50
  51 #include <memory>
  52 #include <string>
  53 #include <vector>
  54
  55 #if HAVE_MUPARSER
  56 #    include <muParser.h>
  57 #else
  58 namespace mu
  59 {
  60 //! Defines a dummy Parser type to reduce use of the preprocessor.
  61 using Parser = std::false_type;
  62 } // namespace mu
  63 #endif
  64
  65 struct pull_coord_work_t;
  66
  67 namespace gmx
  68 {
  69 template<typename>
  70 class ArrayRef;
  71
  72 /*! \brief Class with a mathematical expression and parser.
  73  * \internal
  74  *
  75  * The class handles parser instantiation from an mathematical expression, e.g. 'x1*x2',
  76  * and evaluates the expression given the variables' numerical values.
  77  *
  78  * Note that for performance reasons you should not create a new PullCoordExpressionParser
  79  * for every evaluation.
  80  * Instead, instantiate one PullCoordExpressionParser per expression,
  81  * then update the variables before the next evaluation.
  82  *
  83  */
  84 class PullCoordExpressionParser
  85 {
  86 public:
  87     //! Constructor which takes a mathematical expression and the number of variables as arguments
  88     PullCoordExpressionParser(const std::string& expression, int numVariables);
  89
  90     //! Evaluates the expression with the numerical values passed in \p variables.
  91     double evaluate(ArrayRef<const double> variables);
  92
  93 private:
  94     /*! \brief The mathematical expression, e.g. 'x1*x2' */
  95     std::string expression_;
  96
  97     /*! \brief A vector containing the numerical values of the variables before parser evaluation.
  98      *
  99      * muParser compiles the expression to bytecode, then binds to the memory address
 100      * of these vector elements, making the evaluations fast and memory efficient.
 101      * */
 102     std::vector<double> variableValues_;
 103
 104     /*! \brief The parser_ which compiles and evaluates the mathematical expression */
 105     std::unique_ptr<mu::Parser> parser_;
 106 };
 107
 108 } // namespace gmx
 109
 110 #endif // GMX_PULL_PULLCOORDEXPRESSIONPARSER_H