ControlOutput

Output for displaying objects and parameters associated with the Control system.

Overview

The ControlOutput object, when enabled, will show the active parameters that are being controlled via the Controls System. This output can automatically be enabled from the command-line using the "–show-controls" flag.

Input Parameters

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
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, FAILED, CUSTOM
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.
clear_after_outputTrueClear the active control display after each output.
Default:True
C++ Type:bool
Options:
Description:Clear the active control display after each output.
end_stepTime step at which this output object stop operating
C++ Type:int
Options:
Description:Time step at which this output object stop operating
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
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, FAILED, CUSTOM
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.
show_active_objectsTrueList active MooseObjects.
Default:True
C++ Type:bool
Options:
Description:List active MooseObjects.
start_stepTime step at which this output object begins to operate
C++ Type:int
Options:
Description:Time step at which this output object begins to operate
use_displacedFalseEnable/disable the use of the displaced mesh for outputting
Default:False
C++ Type:bool
Options:
Description:Enable/disable the use of the displaced mesh for outputting

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.

Advanced Parameters

end_timeTime at which this output object stop operating
C++ Type:double
Options:
Description:Time at which this output object stop operating
interval1The interval at which time steps are output to the solution file
Default:1
C++ Type:unsigned int
Options:
Description:The interval at which time steps are output to the solution file
start_timeTime at which this output object begins to operate
C++ Type:double
Options:
Description:Time at which this output object begins to operate
sync_onlyFalseOnly export results at sync times
Default:False
C++ Type:bool
Options:
Description:Only export results at sync times
sync_timesTimes at which the output and solution is forced to occur
C++ Type:std::vector<double>
Options:
Description:Times at which the output and solution is forced to occur
time_tolerance1e-14Time tolerance utilized checking start and end times
Default:1e-14
C++ Type:double
Options:
Description:Time tolerance utilized checking start and end times

Timing Parameters

Input Files

(test/tests/controls/output/controllable.i)

(test/tests/controls/output/controllable.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 2
  ny = 2
  elem_type = QUAD4
  uniform_refine = 4
[]

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Kernels]
  [./diff]
    type = CoefDiffusion
    variable = u
    coef = 0.1
  [../]
  [./time]
    type = TimeDerivative
    variable = u
  [../]
[]

[BCs]
  [./left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  [../]
  [./right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 1
  [../]
[]

[Executioner]
  type = Transient
  num_steps = 3
  dt = 0.1
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[DiracKernels]
  [./test_object]
    type = MaterialPointSource
    point = '0.5 0.5 0'
    variable = u
  [../]
[]

[Materials]
  [./mat]
    type = GenericConstantMaterial
    prop_names = 'matp'
    prop_values = '1'
    block = 0
  [../]
[]

[Postprocessors]
  [./test_object]
    type = FunctionValuePostprocessor
    function = '2*(x+y)'
    point = '0.5 0.5 0'
  [../]
  [./other_point_test_object]
    type = FunctionValuePostprocessor
    function = '3*(x+y)'
    point = '0.5 0.5 0'
  [../]
[]

[Outputs]
  [./controls]
    type = ControlOutput
    clear_after_output = false
  [../]
[]

[Controls]
  [./point_control]
    type = TestControl
    test_type = 'point'
    parameter = '*/*/point'
    execute_on = 'initial'
  [../]
[]

Overview
Input Parameters
Input Files

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access