Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
GetFunctionValueChainControl.C
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 
11 #include "Function.h"
12 
14 
17 {
19  params.addClassDescription("Creates a control data and populates it by evaluating a Function.");
20  params.addRequiredParam<FunctionName>("function", "Function to be evaluated");
21  params.addParam<Point>("point", Point(), "Spatial point at which to evaluate the function");
22  return params;
23 }
24 
26  : ChainControl(parameters),
27  _value(declareChainControlData<Real>("value")),
28  _function(getFunction("function")),
29  _point(getParam<Point>("point"))
30 {
31 }
32 
33 void
35 {
37 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
GetFunctionValueChainControl(const InputParameters &parameters)
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
static InputParameters validParams()
Definition: ChainControl.C:14
virtual void execute() override
Execute the control.
Real & _value
The new control data.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
registerMooseObject("MooseApp", GetFunctionValueChainControl)
Creates a control data and populates it by evaluating a Function.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object...
const Function & _function
Function to be evaluated.
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:44
Control that additionally provides the capability to produce/consume data values, to allow control op...
Definition: ChainControl.h:21
const Point _point
Spatial point at which to evaluate the function.