SetComponentBoolValueControl

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

commentnote

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]
  [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
    use_scalar_variables = false
  []

  [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
  []
[]

[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
  []
[]
(contrib/moose/modules/thermal_hydraulics/test/tests/controls/set_component_bool_value_control/test.i)

Input Parameters

  • componentThe name of the component to be controlled.

    C++ Type:std::string

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters