UnitTripControl

Trips a boolean based on the evaluation of a parsed condition expression

This object defines a control logic boolean state that is set to true if the condition is true, and false if the condition is false. Using the "latch" parameter, the state can always remain true after a trip, or go back to false if the expression no longer evaluates to true.

Example input syntax

In this example, the value of the postprocessor a controls the trip of the ControlLogic trip_ctrl, when its value becomes larger than 0.6.

[Postprocessors]
  [a]
    type = FunctionValuePostprocessor
    function = fn
    execute_on = 'timestep_begin'
  []

  [trip_state]
    type = BoolControlDataValuePostprocessor
    control_data_name = trip_ctrl:state
    execute_on = 'timestep_end'
  []
[]

[ControlLogic]
  [trip_ctrl]
    type = UnitTripControl
    condition = 'a > 0.6'
    symbol_names = 'a'
    symbol_values = 'a'
  []
[]

Input Parameters

conditionThe condition that this trip unit uses to determine its state.
C++ Type:FunctionExpression
Controllable:No
Description:The condition that this trip unit uses to determine its state.

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)
latchFalseDetermines if the output of this control stays true after the trip went from false to true.
Default:False
C++ Type:bool
Controllable:No
Description:Determines if the output of this control stays true after the trip went from false to true.
symbol_namesSymbols (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:Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector.
symbol_valuesConstant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.
C++ Type:std::vector<std::string>
Controllable:No
Description:Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names.

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)
(modules/thermal_hydraulics/test/tests/controls/set_component_bool_value_control/test.i)
(modules/thermal_hydraulics/test/tests/controls/unit_trip_control/test.i)
(modules/thermal_hydraulics/test/tests/controls/set_bool_value_control/test.i)
(modules/thermal_hydraulics/test/tests/controls/terminate/terminate.i)

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

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

[Functions]
  [fn]
    type = ParsedFunction
    expression = 'sin(pi*t)'
  []
[]

[Variables]
  [u]
  []
[]

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

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

[Components]
[]

[Postprocessors]
  [a]
    type = FunctionValuePostprocessor
    function = fn
    execute_on = 'timestep_begin'
  []

  [trip_state]
    type = BoolControlDataValuePostprocessor
    control_data_name = trip_ctrl:state
    execute_on = 'timestep_end'
  []
[]

[ControlLogic]
  [trip_ctrl]
    type = UnitTripControl
    condition = 'a > 0.6'
    symbol_names = 'a'
    symbol_values = 'a'
  []
[]

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

[Outputs]
  csv = true
[]

(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'
    symbol_names = 'a b c d f'
    symbol_values = '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'
[]

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

# This is testing that the values set by SetComponentBoolValueControl are used.
# The `trip_ctrl` component produces a boolean value that is set in the
# `turbine` component to switch it on/off.

[GlobalParams]
  initial_p = 100.e3
  initial_vel = 1.0
  initial_T = 350.
  initial_vel_x = 0
  initial_vel_y = 0
  initial_vel_z = 0

  scaling_factor_1phase = '1 1e-2 1e-4'
  closures = simple_closures
[]

[FluidProperties]
  [fp]
    type = StiffenedGasFluidProperties
    gamma = 2.35
    q = -1167e3
    q_prime = 0
    p_inf = 1.e9
    cv = 1816
  []
[]

[Closures]
  [simple_closures]
    type = Closures1PhaseSimple
  []
[]

[Components]
  [inlet]
    type = InletStagnationPressureTemperature1Phase
    input = 'fch1:in'
    p0 = 100.e3
    T0 = 350.
  []

  [fch1]
    type = FlowChannel1Phase
    fp = fp
    position = '0 0 0'
    orientation = '1 0 0'
    length = 1.0
    n_elems = 10
    A    = 0.01
    D_h  = 0.1
    f = 0.01
  []

  [turbine]
    type = SimpleTurbine1Phase
    position = '1 0 0'
    connections = 'fch1:out fch2:in'
    volume = 1
    on = false
    power = 1
  []

  [fch2]
    type = FlowChannel1Phase
    fp = fp
    position = '1 0 0'
    orientation = '1 0 0'
    length = 1.0
    n_elems = 10
    A    = 0.01
    D_h  = 0.1
    f = 0.01
  []

  [outlet]
    type = Outlet1Phase
    input = 'fch2:out'
    p = 100.0e3
  []
[]

[Functions]
  [trip_fn]
    type = PiecewiseLinear
    xy_data = '
      0 1
      1 2'
  []
[]

[ControlLogic]
  [trip_ctrl]
    type = UnitTripControl
    condition = 'val > 1.5'
    symbol_names = 'val'
    symbol_values = 'trip_fn'
  []

  [set_comp_value]
    type = SetComponentBoolValueControl
    component = turbine
    parameter = on
    value = trip_ctrl:state
  []
[]

[Postprocessors]
  [on_ctrl]
    type = BoolComponentParameterValuePostprocessor
    component = turbine
    parameter = on
  []
[]

[Preconditioning]
  [SMP_PJFNK]
    type = SMP
    full = true
  []
[]

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

  solve_type = NEWTON
  line_search = 'basic'
  nl_rel_tol = 1e-6
  nl_abs_tol = 1e-5
  nl_max_its = 20

  l_tol = 1e-3
  l_max_its = 5

  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'

  start_time = 0.0
  end_time = 1
[]

[Outputs]
  [out]
    type = CSV
    show = 'on_ctrl'
  []
[]

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

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

[Functions]
  [fn]
    type = ParsedFunction
    expression = 'sin(pi*t)'
  []
[]

[Variables]
  [u]
  []
[]

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

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

[Components]
[]

[Postprocessors]
  [a]
    type = FunctionValuePostprocessor
    function = fn
    execute_on = 'timestep_begin'
  []

  [trip_state]
    type = BoolControlDataValuePostprocessor
    control_data_name = trip_ctrl:state
    execute_on = 'timestep_end'
  []
[]

[ControlLogic]
  [trip_ctrl]
    type = UnitTripControl
    condition = 'a > 0.6'
    symbol_names = 'a'
    symbol_values = 'a'
  []
[]

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

[Outputs]
  csv = true
[]

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

# This is testing that the values set by SetBoolValueControl are used.
# The values of function T0_fn are compared to a threshold and the boolean
# result is stored into an aux field via `BooleanValueTestAux`.

[GlobalParams]
  initial_p = 100.e3
  initial_vel = 1.0
  initial_T = 350.
  closures = simple_closures
[]

[FluidProperties]
  [fp]
    type = StiffenedGasFluidProperties
    gamma = 2.35
    q = -1167e3
    q_prime = 0
    p_inf = 1.e9
    cv = 1816
  []
[]

[Closures]
  [simple_closures]
    type = Closures1PhaseSimple
  []
[]

[Components]
  [pipe1]
    type = FlowChannel1Phase
    fp = fp
    position = '0 0 0'
    orientation = '1 0 0'
    length = 15.0
    n_elems = 10
    A    = 0.01
    D_h  = 0.1
    f = 0.01
  []

  [inlet]
    type = InletStagnationPressureTemperature1Phase
    input = 'pipe1:in'
    p0 = 100.e3
    T0 = 350.
  []
  [outlet]
    type = Outlet1Phase
    input = 'pipe1:out'
    p = 100.0e3
  []
[]

[AuxVariables]
  [aux]
  []
[]

[AuxKernels]
  [aux_kernel]
    type = BooleanValueTestAux
    variable = aux
    value = 1
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

[Functions]
  [T0_fn]
    type = PiecewiseLinear
    x = '0 1'
    y = '350 345'
  []
[]

[ControlLogic]
  [T_inlet_fn]
    type = GetFunctionValueControl
    function = T0_fn
  []

  [threshold_ctrl]
    type = UnitTripControl
    condition = 'T > 347.5'
    symbol_names = 'T'
    symbol_values = 'T_inlet_fn:value'
  []

  [set_bool_value]
    type = SetBoolValueControl
    parameter = AuxKernels/aux_kernel/value
    value = 'threshold_ctrl:state'
  []
[]

[Postprocessors]
  [aux]
    type = ElementAverageValue
    variable = aux
    execute_on = 'INITIAL TIMESTEP_END'
  []
[]

[Preconditioning]
  [SMP_PJFNK]
    type = SMP
    full = true
  []
[]

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

  solve_type = 'PJFNK'
  line_search = 'basic'
  nl_rel_tol = 1e-6
  nl_abs_tol = 1e-6
  nl_max_its = 20

  l_tol = 1e-3
  l_max_its = 5

  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'

  start_time = 0.0
  end_time = 1

  automatic_scaling = true
[]

[Outputs]
  csv = true
[]

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

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
[]

[Variables]
  [u]
  []
[]

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

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

[Postprocessors]
  [dt_pp]
    type = TimestepSize
  []
[]

[Components]
[]

[ControlLogic]
  [threshold]
    type = UnitTripControl
    condition = 'dt_pp > 3'
    symbol_names = 'dt_pp'
    symbol_values = 'dt_pp'
  []

  [terminate]
    type = TerminateControl
    input = threshold:state
    termination_message = 'Threshold exceeded'
  []
[]

[Functions]
  [dt_fn]
    type = ParsedFunction
    expression = '1 + t'
  []
[]

[Executioner]
  type = Transient
  [TimeStepper]
    type = FunctionDT
    function = dt_fn
  []
  num_steps = 10
  abort_on_solve_fail = true
[]

Example input syntax
Input Parameters
Input Files