ControlOutput

under construction:Undocumented Class

The ControlOutput has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Outputs/ControlOutput

Input Parameters

  • end_stepTime step at which this output object stop operating

    C++ Type:int

    Description:Time step at which this output object stop operating

  • use_displacedFalseEnable/disable the use of the displaced mesh for outputting

    Default:False

    C++ Type:bool

    Description:Enable/disable the use of the displaced mesh for outputting

  • show_active_objectsTrueList active MooseObjects.

    Default:True

    C++ Type:bool

    Description:List active MooseObjects.

  • clear_after_outputTrueClear the active control display after each output.

    Default:True

    C++ Type:bool

    Description:Clear the active control display after each output.

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

    C++ Type:ExecFlagEnum

    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, FINAL, FAILED, CUSTOM.

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

    Default:INITIAL TIMESTEP_BEGIN

    C++ Type:ExecFlagEnum

    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, FINAL, FAILED, CUSTOM.

  • start_stepTime step at which this output object begins to operate

    C++ Type:int

    Description:Time step at which this output object begins to operate

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

  • time_tolerance1e-14Time tolerance utilized checking start and end times

    Default:1e-14

    C++ Type:double

    Description:Time tolerance utilized checking start and end times

  • start_timeTime at which this output object begins to operate

    C++ Type:double

    Description:Time at which this output object begins to operate

  • interval1The interval at which time steps are output to the solution file

    Default:1

    C++ Type:unsigned int

    Description:The interval at which time steps are output to the solution file

  • sync_timesTimes at which the output and solution is forced to occur

    C++ Type:std::vector

    Description:Times at which the output and solution is forced to occur

  • end_timeTime at which this output object stop operating

    C++ Type:double

    Description:Time at which this output object stop operating

  • sync_onlyFalseOnly export results at sync times

    Default:False

    C++ Type:bool

    Description:Only export results at sync times

Timing Parameters

References