www.mooseframework.org
Functions
TransientMultiApp.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< TransientMultiApp > ()
 

Function Documentation

Definition at line 31 of file TransientMultiApp.C.

Referenced by validParams< AutoPositionsMultiApp >().

32 {
35 
36  params.addParam<bool>("sub_cycling",
37  false,
38  "Set to true to allow this MultiApp to take smaller "
39  "timesteps than the rest of the simulation. More "
40  "than one timestep will be performed for each "
41  "'master' timestep");
42 
43  params.addParam<bool>("interpolate_transfers",
44  false,
45  "Only valid when sub_cycling. This allows "
46  "transferred values to be interpolated "
47  "over the time frame the MultiApp is "
48  "executing over when sub_cycling");
49 
50  params.addParam<bool>("detect_steady_state",
51  false,
52  "If true then while sub_cycling a steady state check will be "
53  "done. In this mode output will only be done once the "
54  "MultiApp reaches the target time or steady state is reached");
55 
56  params.addParam<Real>("steady_state_tol",
57  1e-8,
58  "The relative difference between the new "
59  "solution and the old solution that will be "
60  "considered to be at steady state");
61 
62  params.addParam<bool>("output_sub_cycles", false, "If true then every sub-cycle will be output.");
63  params.addParam<bool>(
64  "print_sub_cycles", true, "Toggle the display of sub-cycles on the screen.");
65 
66  params.addParam<unsigned int>(
67  "max_failures", 0, "Maximum number of solve failures tolerated while sub_cycling.");
68 
69  params.addParam<bool>("tolerate_failure",
70  false,
71  "If true this MultiApp won't participate in dt "
72  "decisions and will always be fast-forwarded to "
73  "the current time.");
74 
75  params.addParam<bool>(
76  "catch_up",
77  false,
78  "If true this will allow failed solves to attempt to 'catch up' using smaller timesteps.");
79 
80  params.addParam<Real>("max_catch_up_steps",
81  2,
82  "Maximum number of steps to allow an app to take "
83  "when trying to catch back up after a failed "
84  "solve.");
85 
86  return params;
87 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< MultiApp >()
Definition: MultiApp.C:46
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...
InputParameters validParams< TransientInterface >()