www.mooseframework.org
MooseParsedFunctionBase.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef MOOSEPARSEDFUNCTIONBASE_H
16 #define MOOSEPARSEDFUNCTIONBASE_H
17 
18 // Standard library
19 #include <vector>
20 #include <memory>
21 
22 // MOOSE includes
23 #include "MooseError.h"
24 
25 // Forward declarations
26 class FEProblemBase;
27 class InputParameters;
30 
31 template <typename T>
33 
40 template <>
42 
48 {
49 public:
54  MooseParsedFunctionBase(const InputParameters & parameters);
55 
59  virtual ~MooseParsedFunctionBase();
60 
61 protected:
70  const std::string verifyFunction(const std::string & function_str);
71 
74 
76  const std::vector<std::string> _vars;
77 
79  const std::vector<std::string> _vals;
80 
82  std::unique_ptr<MooseParsedFunctionWrapper> _function_ptr;
83 };
84 
85 #endif // MOOSEPARSEDFUNCTIONBASE_H
std::unique_ptr< MooseParsedFunctionWrapper > _function_ptr
Pointer to the Parsed function wrapper object for the scalar.
Adds user facing parameters for parsed function.
virtual ~MooseParsedFunctionBase()
Class destructor.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
FEProblemBase & _pfb_feproblem
Reference to the FEProblemBase class for this object.
const std::vector< std::string > _vals
Values passed by the user, they may be Reals for Postprocessors.
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
const std::string verifyFunction(const std::string &function_str)
A helper method to check if the function value contains quotes.
InputParameters validParams< MooseParsedFunctionBase >()
Creates the &#39;vars&#39; and &#39;vals&#39; parameters used by all ParsedFunctions, the parameters provided from th...
InputParameters validParams()
const std::vector< std::string > _vars
Variables passed to libMesh::ParsedFunction.
A wrapper class for creating and evaluating parsed functions via the libMesh::ParsedFunction interfac...
MooseParsedFunctionBase(const InputParameters &parameters)
Class constructor for the interface.