www.mooseframework.org
RealFunctionControl.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 // MOOSE includes
11 #include "RealFunctionControl.h"
12 #include "Function.h"
13 
15 
16 template <>
19 {
21  params.addClassDescription(
22  "Sets the value of a 'Real' input parameters to the value of a provided function.");
23  params.addRequiredParam<FunctionName>(
24  "function", "The function to use for controlling the specified parameter.");
25  params.addRequiredParam<std::string>(
26  "parameter",
27  "The input parameter(s) to control. Specify a single parameter name and all "
28  "parameters in all objects matching the name will be updated");
29  return params;
30 }
31 
33  : Control(parameters), _function(getFunction("function"))
34 {
35 }
36 
37 void
39 {
40  Real value = _function.value(_t, Point());
41  setControllableValue<Real>("parameter", value);
42 }
virtual Real value(Real t, const Point &p)
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero...
Definition: Function.C:38
A basic control for changing an input parameter using a Function.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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...
virtual void execute() override
Execute the control.
InputParameters validParams< RealFunctionControl >()
Function & _function
The function to execute.
Base class for Control objects.
Definition: Control.h:37
registerMooseObject("MooseApp", RealFunctionControl)
InputParameters validParams< Control >()
Definition: Control.C:16
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...
RealFunctionControl(const InputParameters &parameters)
Class constructor.