www.mooseframework.org
NumPicardIterations.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 // MOOSE includes
11 #include "NumPicardIterations.h"
12 #include "Transient.h"
13 #include "MooseApp.h"
14 
16 
17 template <>
20 {
22  return params;
23 }
24 
26  : GeneralPostprocessor(parameters), _transient_executioner(NULL)
27 {
28 }
29 
30 void
32 {
35  {
36  mooseError(
37  "The NumPicardIterations Postprocessor can only be used with a Transient Executioner");
38  }
39 }
40 
41 Real
43 {
45 }
Executioner * getExecutioner() const
Retrieve the Executioner for this App.
Definition: MooseApp.h:255
Transient executioners usually loop through a number of timesteps...
Definition: Transient.h:30
PicardSolve & picardSolve()
Return underlining PicardSolve object.
Definition: Executioner.h:111
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 >()
void mooseError(Args &&... args) const
Definition: MooseObject.h:147
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
unsigned int numPicardIts() const
Get the number of Picard iterations performed Because this returns the number of Picard iterations...
Definition: PicardSolve.h:54
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:177
Returns the number of Picard iterations taken by the underlying Transient Executioner as a Postproces...
registerMooseObject("MooseApp", NumPicardIterations)
InputParameters validParams< NumPicardIterations >()