SetValueChainControl

SetRealValueChainControl

This ChainControl sets the value of one or more parameters of type Real from a Real-valued ChainControlData.

Input Parameters

parameterParameter(s) to control
C++ Type:std::string
Controllable:No
Description:Parameter(s) to control
valueControl data to use for the value of the parameter(s)
C++ Type:std::string
Controllable:No
Description:Control data to use for the value of the parameter(s)

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)
execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:INITIAL TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, PRE_MULTIAPP_SETUP
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

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

(test/tests/chaincontrols/set_value_chain_control/set_real_value_chain_control.i)

SetBoolValueChainControl

This ChainControl sets the value of one or more parameters of type bool from a bool-valued ChainControlData.

Input Parameters

parameterParameter(s) to control
C++ Type:std::string
Controllable:No
Description:Parameter(s) to control
valueControl data to use for the value of the parameter(s)
C++ Type:std::string
Controllable:No
Description:Control data to use for the value of the parameter(s)

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)
execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:INITIAL TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, PRE_MULTIAPP_SETUP
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

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

(test/tests/chaincontrols/set_value_chain_control/set_bool_value_chain_control.i)

(test/tests/chaincontrols/set_value_chain_control/set_real_value_chain_control.i)

# Tests SetRealValueChainControl
#
# The following test function is used:
#    f(t) = t + 5
# Note controls execute BEFORE post-processors, except for INITIAL, so here
# the initial PP value is incorrect, but the others are correct:
#   INITIAL:
#     test_pp <- test_pp:value = 0
#     get_fn_ctrl:value <- f(0) = 5
#     set_value_ctrl: test_pp:value <- get_fn_ctrl:value = 5
#   TIMESTEP_END (t = 1):
#     get_fn_ctrl:value <- f(1) = 6
#     set_value_ctrl: test_pp:value <- get_fn_ctrl:value = 6
#     test_pp <- test_pp:value = 6

!include base.i

[ChainControls]
  [get_fn_ctrl]
    type = GetFunctionValueChainControl
    function = test_fn
    point = '1 0 0'
    execute_on = 'INITIAL TIMESTEP_END'
  []
  [set_value_ctrl]
    type = SetRealValueChainControl
    parameter = Postprocessors/test_pp/value
    value = get_fn_ctrl:value
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

[Postprocessors]
  [test_pp]
    type = ConstantPostprocessor
    value = 0
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

(test/tests/chaincontrols/set_value_chain_control/set_bool_value_chain_control.i)

# Tests SetBoolValueChainControl
#
# The "enable" parameter of the PP "test_pp" will be controlled to disable it.
# When a PP is disabled, it will retain its last executed value.
#
# The following test function is used:
#    f(t) = t + 5
# Note controls execute BEFORE post-processors, except for INITIAL, so here
# the initial PP value is incorrect, but the others are correct:
#   INITIAL:
#     test_pp <- f(0) = 5
#     set_value_ctrl: test_pp:enable <- false
#   TIMESTEP_END (t = 1):
#     set_value_ctrl: test_pp:enable <- false
#     test_pp (no update to value since disabled; keep value of 5)

!include base.i

[ChainControls]
  [false_ctrl]
    type = ConstantBoolChainControl
    value = false
    execute_on = 'INITIAL TIMESTEP_END'
  []
  [set_value_ctrl]
    type = SetBoolValueChainControl
    parameter = Postprocessors/test_pp/enable
    value = false_ctrl:value
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

[Postprocessors]
  [test_pp]
    type = FunctionValuePostprocessor
    function = test_fn
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

SetRealValueChainControl
Input Parameters
Input Files
SetBoolValueChainControl
Input Parameters
Input Files