www.mooseframework.org
Functions
PetscOutput.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< PetscOutput > ()
 

Function Documentation

Definition at line 25 of file PetscOutput.C.

Referenced by validParams< FileOutput >(), validParams< TopResidualDebugOutput >(), and validParams< VariableResidualNormsDebugOutput >().

26 {
28 
29 // Toggled for outputting nonlinear and linear residuals, only if we have PETSc
30 #ifdef LIBMESH_HAVE_PETSC
31  params.addParam<bool>(
32  "output_linear", false, "Specifies whether output occurs on each linear residual evaluation");
33  params.addParam<bool>("output_nonlinear",
34  false,
35  "Specifies whether output occurs on each nonlinear residual evaluation");
36 
37  // **** DEPRECATED PARAMETERS ****
38  params.addDeprecatedParam<bool>(
39  "linear_residuals",
40  false,
41  "Specifies whether output occurs on each linear residual evaluation",
42  "Please use 'output_linear' to get this behavior.");
43  params.addDeprecatedParam<bool>(
44  "nonlinear_residuals",
45  false,
46  "Specifies whether output occurs on each nonlinear residual evaluation",
47  "Please use 'output_nonlinear' to get this behavior.");
48  // Psuedo time step divisors
49  params.addParam<Real>(
50  "nonlinear_residual_dt_divisor",
51  1000,
52  "Number of divisions applied to time step when outputting non-linear residuals");
53  params.addParam<Real>(
54  "linear_residual_dt_divisor",
55  1000,
56  "Number of divisions applied to time step when outputting linear residuals");
57 
58  // Start times for residual output
59  params.addParam<Real>(
60  "linear_residual_start_time",
61  "Specifies a start time to begin output on each linear residual evaluation");
62  params.addParam<Real>(
63  "nonlinear_residual_start_time",
64  "Specifies a start time to begin output on each nonlinear residual evaluation");
65 
66  // End time for residual output
67  /* Note, No default is given here so that in Peacock giant numbers do not show up by default, the
68  * defaults are set in the initialization list */
69  params.addParam<Real>("linear_residual_end_time",
70  "Specifies an end time to begin output on each linear residual evaluation");
71  params.addParam<Real>(
72  "nonlinear_residual_end_time",
73  "Specifies an end time to begin output on each nonlinear residual evaluation");
74 
75  params.addParamNamesToGroup("linear_residuals nonlinear_residuals linear_residual_start_time "
76  "nonlinear_residual_start_time linear_residual_end_time "
77  "nonlinear_residual_end_time nonlinear_residual_dt_divisor "
78  "linear_residual_dt_divisor",
79  "PETSc");
80 #endif
81 
82  return params;
83 }
void addDeprecatedParam(const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< Output >()
Definition: Output.C:34
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...