ParsedFunctionControl

The ParsedFunctionControl class provides the ability to take a formula as a parameter and evaluate it as a function. The quantities that can be used are (a) functions, (b) post-processors, (c) scalar variables, (d) real-valued control data, and (e) bool-valued control data.

Input Parameters

functionThe function to be evaluated by this control.
C++ Type:FunctionExpression
Controllable:No
Description:The function to be evaluated by this control.

Required Parameters

depends_onThe Controls that this control relies upon (i.e. must execute before this one)
C++ Type:std::vector<std::string>
Controllable:No
Description:The Controls that this control relies upon (i.e. must execute before this one)
valsConstant numeric values, postprocessor names, or function names for vars.
C++ Type:std::vector<std::string>
Controllable:No
Description:Constant numeric values, postprocessor names, or function names for vars.
varsVariables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.
C++ Type:std::vector<std::string>
Controllable:No
Description:Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Controllable:No
Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

Input Files

(modules/thermal_hydraulics/test/tests/controls/parsed_function_control/test.i)

References

No citations exist within this document.

(modules/thermal_hydraulics/test/tests/controls/parsed_function_control/test.i)

# This test takes a value of (a) function, (b) postprocessor, (c) scalar variable,
# (d) real-valued control value and (f) bool-valued control value and evaluates it via
# ParsedFunctionControl object

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 1
[]

[Functions]
  [pps_fn]
    type = ConstantFunction
    value = 4
  []

  [fn]
    type = ConstantFunction
    value = 5
  []
[]

[AuxVariables]
  [sv]
    family = SCALAR
    order = FIRST
    initial_condition = 0
  []
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [diff]
    type = CoefDiffusion
    variable = u
    coef = 0.1
  []
  [time]
    type = TimeDerivative
    variable = u
  []
[]

[AuxScalarKernels]
  [sv_ak]
    type = ConstantScalarAux
    variable = sv
    value = 3
    execute_on = 'timestep_begin'
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  []
[]

[Components]
[]

[Postprocessors]
  [pps]
    type = FunctionValuePostprocessor
    function = pps_fn
    execute_on = 'timestep_begin'
  []

  [result]
    type = RealControlDataValuePostprocessor
    control_data_name = eval_ctrl:value
    execute_on = 'timestep_end'
  []
[]

[ControlLogic]
  [ctrl]
    type = GetFunctionValueControl
    function = 2
  []

  [trip]
    type = UnitTripControl
    condition = 't > 0'
  []

  [eval_ctrl]
    type = ParsedFunctionControl
    function = 'a + b + c + d + f'
    vars = 'a b c d f'
    vals = 'fn pps sv ctrl:value trip:state'
  []
[]

[Executioner]
  type = Transient
  dt = 0.1
  num_steps = 2
  abort_on_solve_fail = true
[]

[Outputs]
  csv = true
  show = 'result'
[]

Input Parameters
Input Files
References

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access