SetComponentBoolValueControl

buildconstruction:Undocumented Class

The SetComponentBoolValueControl has not been documented. The content contained on this page includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Control to set a boolean value of a component parameter

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

Input Files

References

No citations exist within this document.