- inputThe boolean chain control data to determine if tripped
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:The boolean chain control data to determine if tripped
UnitTripChainControl
This ChainControl produces a boolean trip chain control data, which is initially false but upon being triggered, becomes true for the remainder of the simulation. This trip value is named <control>:tripped, where <control> is the user-given name of the UnitTripChainControl. The trip is determined by the value of the input boolean value given by "input" and "trip_on_true". If trip_on_true is set to true, then the trip occurs when the input value is true; else it occurs when the input value is false.
schooltip:Converting to boolean control data
This object requires the input data to have type bool. If you have a data of type Real, you can convert using RealToBoolChainControl.
Input 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)
- 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
Unit:(no unit assumed)
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.
- trip_on_trueTrueIf set to 'true', the trip occurs if the input has a value of 'true'; else the trip occurs if the input has a value of 'false'.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If set to 'true', the trip occurs if the input has a value of 'true'; else the trip occurs if the input has a value of 'false'.
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