IterationInfo

A Reporter object for tracking iteration information, such as the number of linear and non-linear iterations. The "items" parameter controls the items computed.

Example Input Syntax

The following input file snippet demonstrates the use of the IterationInfo object.

[Reporters/iteration_info]
  [Reporters/iteration_info]
    type = IterationInfo
  []
[]

Input Parameters

execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, 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, CUSTOM.
itemsThe iteration information to output, if nothing is provided everything will be output.
C++ Type:MultiMooseEnum
Options:time, timestep, num_linear_iterations, num_nonlinear_iterations, num_picard_iterations
Description:The iteration information to output, if nothing is provided everything will be output.

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Options:
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
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.
force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
Default:False
C++ Type:bool
Options:
Description:Forces the GeneralUserObject to be executed in PREAUX
force_preicFalseForces the GeneralUserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Options:
Description:Forces the GeneralUserObject to be executed in PREIC during initial setup
outputsVector of output names were you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Options:
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Options:
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

Input Files

(test/tests/reporters/iteration_info/iteration_info_steady.i)
(test/tests/reporters/iteration_info/iteration_info.i)

(test/tests/reporters/iteration_info/iteration_info.i)

[Mesh]
  [generate]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 10
  []
[]

[Variables/u][]

[Kernels]
  [diff]
    type = ADDiffusion
    variable = u
  []
  [time]
    type = ADTimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 10
  []
[]

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

[Reporters/iteration_info]
    type = IterationInfo
[]

[Outputs]
  [out]
    type = JSON
    execute_system_information_on = NONE
  []
[]

(test/tests/reporters/iteration_info/iteration_info_steady.i)

[Mesh]
  [generate]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 10
  []
[]

[Variables/u][]

[Kernels]
  [diff]
    type = ADDiffusion
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 10
  []
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Reporters/iteration_info]
    type = IterationInfo
[]

[Outputs]
  [out]
    type = JSON
    execute_system_information_on = NONE
  []
[]

(test/tests/reporters/iteration_info/iteration_info.i)

[Mesh]
  [generate]
    type = GeneratedMeshGenerator
    dim = 1
    nx = 10
  []
[]

[Variables/u][]

[Kernels]
  [diff]
    type = ADDiffusion
    variable = u
  []
  [time]
    type = ADTimeDerivative
    variable = u
  []
[]

[BCs]
  [left]
    type = DirichletBC
    variable = u
    boundary = left
    value = 0
  []
  [right]
    type = DirichletBC
    variable = u
    boundary = right
    value = 10
  []
[]

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

[Reporters/iteration_info]
    type = IterationInfo
[]

[Outputs]
  [out]
    type = JSON
    execute_system_information_on = NONE
  []
[]

Example Input Syntax
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