SetComponentBoolValueControl

Control to set a boolean value of a component parameter with control data boolean

note

ControlData is only defined by the thermal hydraulics module control logic.

Example input syntax

In this example, the on parameter of the turbine component using the state ControlData of the trip_ctrl ControlLogic.

[Components<<<{"href": "../../syntax/Components/index.html"}>>>]
  [inlet]
    type = InletStagnationPressureTemperature1Phase<<<{"description": "Boundary condition with prescribed stagnation pressure and temperature for 1-phase flow channels.", "href": "../components/InletStagnationPressureTemperature1Phase.html"}>>>
    input<<<{"description": "Name of the input"}>>> = 'fch1:in'
    p0<<<{"description": "Prescribed stagnation pressure [Pa]"}>>> = 100.e3
    T0<<<{"description": "Prescribed stagnation temperature [K]"}>>> = 350.
  []

  [fch1]
    type = FlowChannel1Phase<<<{"description": "1-phase 1D flow channel", "href": "../components/FlowChannel1Phase.html"}>>>
    fp<<<{"description": "Fluid properties user object"}>>> = fp
    position<<<{"description": "Start position of axis in 3-D space [m]"}>>> = '0 0 0'
    orientation<<<{"description": "Direction of flow channel from start position to end position (no need to normalize). For curved flow channels, it is the (tangent) direction at the start position."}>>> = '1 0 0'
    length<<<{"description": "Length of each axial section [m]"}>>> = 1.0
    n_elems<<<{"description": "Number of elements in each axial section"}>>> = 10
    A<<<{"description": "Area of the flow channel, can be a constant or a function"}>>> = 0.01
    D_h<<<{"description": "Hydraulic diameter [m]"}>>> = 0.1
    f<<<{"description": "Wall friction factor [-]"}>>> = 0.01
  []

  [turbine]
    type = SimpleTurbine1Phase<<<{"description": "Simple turbine model that extracts prescribed power from the working fluid", "href": "../components/SimpleTurbine1Phase.html"}>>>
    position<<<{"description": "Spatial position of the center of the junction [m]"}>>> = '1 0 0'
    connections<<<{"description": "Junction connections"}>>> = 'fch1:out fch2:in'
    volume<<<{"description": "Volume of the junction [m^3]"}>>> = 1
    on<<<{"description": "Flag determining if turbine is operating or not [-]"}>>> = false
    power<<<{"description": "Turbine power [W]"}>>> = 1
  []

  [fch2]
    type = FlowChannel1Phase<<<{"description": "1-phase 1D flow channel", "href": "../components/FlowChannel1Phase.html"}>>>
    fp<<<{"description": "Fluid properties user object"}>>> = fp
    position<<<{"description": "Start position of axis in 3-D space [m]"}>>> = '1 0 0'
    orientation<<<{"description": "Direction of flow channel from start position to end position (no need to normalize). For curved flow channels, it is the (tangent) direction at the start position."}>>> = '1 0 0'
    length<<<{"description": "Length of each axial section [m]"}>>> = 1.0
    n_elems<<<{"description": "Number of elements in each axial section"}>>> = 10
    A<<<{"description": "Area of the flow channel, can be a constant or a function"}>>> = 0.01
    D_h<<<{"description": "Hydraulic diameter [m]"}>>> = 0.1
    f<<<{"description": "Wall friction factor [-]"}>>> = 0.01
  []

  [outlet]
    type = Outlet1Phase<<<{"description": "Boundary condition with prescribed pressure for 1-phase flow channels.", "href": "../components/Outlet1Phase.html"}>>>
    input<<<{"description": "Name of the input"}>>> = 'fch2:out'
    p<<<{"description": "Prescribed pressure [Pa]"}>>> = 100.0e3
  []
[]

[ControlLogic<<<{"href": "../../syntax/ControlLogic/index.html"}>>>]
  [trip_ctrl]
    type = UnitTripControl<<<{"description": "Trips a boolean based on the evaluation of a parsed condition expression", "href": "UnitTripControl.html"}>>>
    condition<<<{"description": "The condition that this trip unit uses to determine its state."}>>> = 'val > 1.5'
    symbol_names<<<{"description": "Symbols (excluding t,x,y,z) that are bound to the values provided by the corresponding items in the vals vector."}>>> = 'val'
    symbol_values<<<{"description": "Constant numeric values, postprocessor names, function names, and scalar variables corresponding to the symbols in symbol_names."}>>> = 'trip_fn'
  []

  [set_comp_value]
    type = SetComponentBoolValueControl<<<{"description": "Control to set a boolean value of a component parameter with control data boolean", "href": "SetComponentBoolValueControl.html"}>>>
    component<<<{"description": "The name of the component to be controlled."}>>> = turbine
    parameter<<<{"description": "The name of the parameter in the component to be controlled."}>>> = on
    value<<<{"description": "The name of control data to be set in the component."}>>> = trip_ctrl:state
  []
[]

Input Parameters

componentThe name of the component to be controlled.
C++ Type:std::string
Controllable:No
Description:The name of the component to be controlled.
parameterThe name of the parameter in the component to be controlled.
C++ Type:std::string
Controllable:No
Description:The name of the parameter in the component to be controlled.
valueThe name of control data to be set in the component.
C++ Type:std::string
Controllable:No
Description:The name of control data to be set in the component.

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)

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

(moose/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'
  []
[]

Example input syntax
Input Parameters