ConditionalFunctionEnableControl

Control for enabling/disabling objects when a function value is true

ConditionalFunctionEnableControl objects derive from ConditionalEnableControl.

ConditionalFunctionEnableControl objects allow MOOSE objects to be enabled or disabled according to the value of a Function.

Input Parameters

  • conditional_functionThe function to give a true or false value

    C++ Type:FunctionName

    Controllable:No

    Description:The function to give a true or false value

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)

  • disable_objectsA list of object tags to disable.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:A list of object tags to disable.

  • enable_objectsA list of object tags to enable.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:A list of object tags to enable.

  • execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS, PRE_MULTIAPP_SETUP

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM, ALWAYS.

  • reverse_on_falseTrueWhen true, the disable/enable lists are set to opposite values when the specified condition is false.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:When true, the disable/enable lists are set to opposite values when the specified condition is false.

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