https://mooseframework.inl.gov
Loading...
Searching...
No Matches
MooseParsedFunction.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
12// MOOSE includes
13#include "Function.h"
15
25{
26public:
32
34
35 using Function::value;
43 virtual Real value(Real t, const Point & pt) const override;
44
50 virtual RealGradient gradient(Real t, const Point & p) const override;
51
59 virtual Real timeDerivative(Real t, const Point & p) const override;
60
65 virtual RealVectorValue vectorValue(Real t, const Point & p) const override;
66
70 virtual void initialSetup() override;
71
72protected:
74 std::string _value;
75
76 friend class ParsedFunctionTest;
77};
Base class for function objects.
Definition Function.h:30
virtual RealGradient gradient(Real t, const Point &p) const
Function objects can optionally provide a gradient at a point.
Definition Function.C:62
virtual Real value(Real t, const Point &p) const
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero,...
Definition Function.C:30
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
Adds user facing parameters for parsed function.
This class is used to evaluate symbolic equations passed in to Moose through the input file.
virtual RealVectorValue vectorValue(Real t, const Point &p) const override
Method invalid for ParsedGradFunction.
static InputParameters validParams()
Created from MooseSystem via the FunctionFactory.
virtual RealGradient gradient(Real t, const Point &p) const override
Evaluate the gradient of the function.
virtual Real timeDerivative(Real t, const Point &p) const override
Evaluate the time derivative of the function.
virtual Real value(Real t, const Point &pt) const override
Evaluate the equation at the given location.
virtual void initialSetup() override
Creates the parsed function.
std::string _value
The function defined by the user.