InputFileFormatter
This class produces a dump of the InputParameters that appears like the normal input file syntax.
This formatter is used for the --show-input command line option, described here. It is also available for the application developer, either directly or using an AdvancedOutput.
Example output
The snippet below shows the output for --show-input for the boundary condition and executioner blocks of the simple_diffusion test, shown further below. We can see additional metadata about each object, some default parameters that are not explicitly written in the input files, as well as disabled invalid parameters.
[BCs]
[./left]
boundary = left
control_tags = INVALID
displacements = INVALID
enable = 1
extra_matrix_tags = INVALID
extra_vector_tags = INVALID
implicit = 1
inactive = (no_default)
isObjectAction = 1
matrix_tags = system
seed = 0
type = DirichletBC
use_displaced_mesh = 0
variable = u
vector_tags = nontime
diag_save_in = INVALID
preset = 1
save_in = INVALID
value = 0
[../]
[./right]
boundary = right
control_tags = INVALID
displacements = INVALID
enable = 1
extra_matrix_tags = INVALID
extra_vector_tags = INVALID
implicit = 1
inactive = (no_default)
isObjectAction = 1
matrix_tags = system
seed = 0
type = DirichletBC
use_displaced_mesh = 0
variable = u
vector_tags = nontime
diag_save_in = INVALID
preset = 1
save_in = INVALID
value = 1
[../]
[]
[Executioner]
auto_preconditioning = 1
inactive = (no_default)
isObjectAction = 1
type = Steady
accept_on_max_fixed_point_iteration = 0
accept_on_max_picard_iteration = 0
auto_advance = INVALID
automatic_scaling = INVALID
compute_initial_residual_before_preset_bcs = 0
compute_scaling_once = 1
contact_line_search_allowed_lambda_cuts = 2
contact_line_search_ltol = INVALID
control_tags = (no_default)
custom_abs_tol = 1e-50
custom_pp = INVALID
custom_rel_tol = 1e-08
direct_pp_value = 0
disable_fixed_point_residual_norm_check = 0
disable_picard_residual_norm_check = 0
enable = 1
fixed_point_abs_tol = 1e-50
fixed_point_algorithm = picard
fixed_point_force_norms = 0
fixed_point_max_its = 1
fixed_point_min_its = 1
fixed_point_rel_tol = 1e-08
l_abs_tol = 1e-50
l_max_its = 10000
l_tol = 1e-05
line_search = default
line_search_package = petsc
max_xfem_update = 4294967295
mffd_type = wp
n_max_nonlinear_pingpong = 100
nl_abs_div_tol = 1e+50
nl_abs_step_tol = 0
nl_abs_tol = 1e-50
nl_div_tol = 1e+10
nl_forced_its = 0
nl_max_funcs = 10000
nl_max_its = 50
nl_rel_step_tol = 0
nl_rel_tol = 1e-08
num_grids = 1
off_diagonals_in_auto_scaling = 0
outputs = INVALID
petsc_options = INVALID
petsc_options_iname = '-pc_type -pc_hypre_type'
petsc_options_value = 'hypre boomeramg'
picard_abs_tol = 1e-50
picard_custom_pp = INVALID
picard_force_norms = 0
picard_max_its = 1
picard_rel_tol = 1e-08
relaxation_factor = 1
relaxed_variables = (no_default)
resid_vs_jac_scaling_param = 0
restart_file_base = (no_default)
scaling_group_variables = INVALID
skip_exception_check = 0
snesmf_reuse_base = 1
solve_type = PJFNK
splitting = INVALID
time = 0
transformed_postprocessors = (no_default)
transformed_variables = (no_default)
update_xfem_at_timestep_begin = 0
verbose = 0
[]
Input file used to show to formatting
[Mesh<<<{"href": "../../../syntax/Mesh/index.html"}>>>]
type = GeneratedMesh
dim = 2
nx = 10
ny = 10
[]
[Variables<<<{"href": "../../../syntax/Variables/index.html"}>>>]
[u]
[]
[]
[Kernels<<<{"href": "../../../syntax/Kernels/index.html"}>>>]
[diff]
type = Diffusion<<<{"description": "The Laplacian operator ($-\\nabla \\cdot \\nabla u$), with the weak form of $(\\nabla \\phi_i, \\nabla u_h)$.", "href": "../../kernels/Diffusion.html"}>>>
variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
[]
[]
[BCs<<<{"href": "../../../syntax/BCs/index.html"}>>>]
[left]
type = DirichletBC<<<{"description": "Imposes the essential boundary condition $u=g$, where $g$ is a constant, controllable value.", "href": "../../bcs/DirichletBC.html"}>>>
variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = left
value<<<{"description": "Value of the BC"}>>> = 0
[]
[right]
type = DirichletBC<<<{"description": "Imposes the essential boundary condition $u=g$, where $g$ is a constant, controllable value.", "href": "../../bcs/DirichletBC.html"}>>>
variable<<<{"description": "The name of the variable that this residual object operates on"}>>> = u
boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = right
value<<<{"description": "Value of the BC"}>>> = 1
[]
[]
[Executioner<<<{"href": "../../../syntax/Executioner/index.html"}>>>]
type = Steady
solve_type = 'PJFNK'
petsc_options_iname = '-pc_type -pc_hypre_type'
petsc_options_value = 'hypre boomeramg'
[]
[Outputs<<<{"href": "../../../syntax/Outputs/index.html"}>>>]
exodus<<<{"description": "Output the results using the default settings for Exodus output."}>>> = true
[]