www.mooseframework.org
NumPicardIterations.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 // MOOSE includes
16 #include "NumPicardIterations.h"
17 #include "Transient.h"
18 #include "MooseApp.h"
19 
20 template <>
23 {
25  return params;
26 }
27 
29  : GeneralPostprocessor(parameters), _transient_executioner(NULL)
30 {
31 }
32 
33 void
35 {
38  {
39  mooseError(
40  "The NumPicardIterations Postprocessor can only be used with a Transient Executioner");
41  }
42 }
43 
44 Real
46 {
48 }
Transient executioners usually loop through a number of timesteps...
Definition: Transient.h:36
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Transient * _transient_executioner
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
NumPicardIterations(const InputParameters &parameters)
virtual Real getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
void mooseError(Args &&...args) const
Definition: MooseObject.h:80
Executioner * getExecutioner()
Retrieve the Executioner for this App.
Definition: MooseApp.h:233
InputParameters validParams< NumPicardIterations >()
Real numPicardIts()
Get the number of Picard iterations performed.
Definition: Transient.h:206