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 
18 {
20  params.addClassDescription(
21  "Sets the value of a 'Real' input parameters to the value of a provided function.");
22  params.addRequiredParam<FunctionName>(
23  "function", "The function to use for controlling the specified parameter.");
24  params.addRequiredParam<std::string>(
25  "parameter",
26  "The input parameter(s) to control. Specify a single parameter name and all "
27  "parameters in all objects matching the name will be updated");
28  return params;
29 }
30 
32  : Control(parameters), _function(getFunction("function"))
33 {
34 }
35 
36 void
38 {
40  setControllableValue<Real>("parameter", value);
41 }
static InputParameters validParams()
Class constructor.
Definition: Control.C:15
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...
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
virtual void execute() override
Execute the control.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Base class for Control objects.
Definition: Control.h:32
registerMooseObject("MooseApp", RealFunctionControl)
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...
const Function & _function
The function to execute.
static InputParameters validParams()
Class constructor.
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:41
RealFunctionControl(const InputParameters &parameters)