PIDTransientControl

The PIDTransientControl object is designed to use the principle of Proportional Integral Derivative control to either: - control a "Real" parameter from the input file rather than use the constant value specified in the input file.

modify the value of a postprocessor, used in a PostprocessorDirichletBC for example, rather than use the computed/received value

This allows a simple 1D parametric optimization to make the output of a postprocessor match the target value.

The parameter $var element = document.getElementById("moose-equation-2fe063b0-00b4-4889-b41d-238a4d1bb149");katex.render("C", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is replaced at every time step $var element = document.getElementById("moose-equation-b5507b5f-fc5e-4f14-8b23-ff07f078f45a");katex.render("n", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , at time $var element = document.getElementById("moose-equation-d16f6043-f09f-483e-a5e2-79107e677dad");katex.render("t", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ , by: $var element = document.getElementById("moose-equation-134fabe5-5d18-477e-b139-525fe0bcadf5");katex.render("C_{n} = C_{n-1} + K_{integral} \\int_0^{t} pp(s) - target mathrm{d}s + K_{proportional} (pp(t) - target) + K_{derivative} \\dfrac{pp(t) - target}{dt}", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$

with $var element = document.getElementById("moose-equation-40a65bb9-414c-4f7d-99ba-0f025c902aff");katex.render("pp(t)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ the value at time $var element = document.getElementById("moose-equation-26582b1d-e490-400b-bff1-f62315f5482d");katex.render("t", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ of the postprocessor that we are trying to match to the $var element = document.getElementById("moose-equation-493ab909-a40f-41ec-800a-0705bce1a7e3");katex.render("target", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ value and $var element = document.getElementById("moose-equation-35b58484-3de2-4eee-a149-eaefdc8090d9");katex.render("K_{integral/proportional/derivative}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ the coefficients for the integral error, current error, and backward derivative respectively.

Input Parameters

K_derivativeThe coefficient multiplying the derivative term
C++ Type:double
Options:
Description:The coefficient multiplying the derivative term
K_integralThe coefficient multiplying the integral term
C++ Type:double
Options:
Description:The coefficient multiplying the integral term
K_proportionalThe coefficient multiplying the difference term
C++ Type:double
Options:
Description:The coefficient multiplying the difference term
postprocessorThe postprocessor to watch for controlling the specified parameter.
C++ Type:PostprocessorName
Options:
Description:The postprocessor to watch for controlling the specified parameter.
targetThe target value 1D time function for the postprocessor
C++ Type:FunctionName
Options:
Description:The target value 1D time function for the postprocessor

Required Parameters

depends_onThe Controls that this control relies upon (i.e. must execute before this one)
C++ Type:std::vector<std::string>
Options:
Description:The Controls that this control relies upon (i.e. must execute before this one)
execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:INITIAL TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, PRE_MULTIAPP_SETUP
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
parameterThe input parameter(s) to control. Specify a single parameter name and all parameters in all objects matching the name will be updated
C++ Type:std::string
Options:
Description:The input parameter(s) to control. Specify a single parameter name and all parameters in all objects matching the name will be updated
parameter_ppThe postprocessor to control. Should be accessed by reference by the objects depending on its value.
C++ Type:std::string
Options:
Description:The postprocessor to control. Should be accessed by reference by the objects depending on its value.
reset_every_timestepFalseReset the PID integral when changing timestep, for coupling iterations within a timestep
Default:False
C++ Type:bool
Options:
Description:Reset the PID integral when changing timestep, for coupling iterations within a timestep
reset_integral_windupTrueReset the PID integral when the error crosses zero and the integral is larger than the error.
Default:True
C++ Type:bool
Options:
Description:Reset the PID integral when the error crosses zero and the integral is larger than the error.
start_time-1.79769e+308The time to start the PID controller at
Default:-1.79769e+308
C++ Type:double
Options:
Description:The time to start the PID controller at
stop_time1.79769e+308The time to stop the PID controller at
Default:1.79769e+308
C++ Type:double
Options:
Description:The time to stop the PID controller at

Optional Parameters

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

Advanced Parameters

Input Files

(test/tests/controls/pid_control/pid_pp_control.i)
(test/tests/controls/pid_control/pid_control.i)

(test/tests/controls/pid_control/pid_pp_control.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
[]

[Variables]
  [u]
  []
[]

[Kernels]
  inactive = 'exception'
  [diff]
    type = CoefDiffusion
    variable = u
    coef = 1
  []

  [exception]
    type = NanKernel
    variable = 'u'
    timestep_to_nan = 2
  []
[]

[BCs]
  [left]
    type = PostprocessorDirichletBC
    variable = u
    boundary = 3
    postprocessor = received_bc
  []

  [right]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 1
  []
[]

[Functions]
  [conditional_function]
    type = ParsedFunction
    value = 't >= 1.9 & t < 2.1'
  []
[]

[Executioner]
  type = Transient

  solve_type = 'PJFNK'
  start_time = 0.0
  num_steps = 20
  dt = 1

  nl_abs_tol = 1e-10
  line_search = 'none'

  # For picard tests
  picard_abs_tol = 1e-3
[]

[Postprocessors]
  [integral]
    type = ElementIntegralVariablePostprocessor
    variable = u
  []
  [received_bc]
    type = Receiver
    default = 0
  []
[]

[Controls]
  inactive = 'make_crash'
  [integral_value]
    type = PIDTransientControl
    postprocessor = integral
    target = 1.5
    parameter_pp = 'received_bc'
    K_integral = -1
    K_proportional = -1
    K_derivative = -0.1
  []
  [make_crash]
    type = ConditionalFunctionEnableControl
    enable_objects = 'Kernels::exception'
    conditional_function = 'conditional_function'
    execute_on = 'timestep_begin'
  []
[]

[MultiApps]
  inactive = 'shortest_app'
  [shortest_app]
    type = TransientMultiApp
    input_files = 'pid_pp_control_subapp.i'
  []
[]

[Outputs]
  file_base = out
  exodus = false
  csv = true
[]

(test/tests/controls/pid_control/pid_control.i)

c = 0

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [diff]
    type = Diffusion
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = 3
    value = '${c}'
  []

  [right]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 1
  []
[]

[Executioner]
  type = Transient

  solve_type = 'PJFNK'
  start_time = 0.0
  end_time = 20
  dt = 1
[]

[Postprocessors]
  [integral]
    type = ElementIntegralVariablePostprocessor
    variable = u
  []
[]

[Controls]
  [integral_value]
    type = PIDTransientControl
    postprocessor = integral
    target = 1.5
    parameter = 'BCs/left/value'
    K_integral = -1
    K_proportional = -1
    K_derivative = -0.1
  []
[]

[Outputs]
  file_base = out
  exodus = false
  csv = true
[]

Input Parameters
Input Files

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