www.mooseframework.org
NumResidualEvaluations.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 "NumResidualEvaluations.h"
12 #include "FEProblem.h"
13 #include "SubProblem.h"
14 #include "NonlinearSystem.h"
15 
17 
20 {
22  params.addClassDescription("Returns the total number of residual evaluations performed.");
23  return params;
24 }
25 
27  : GeneralPostprocessor(parameters)
28 {
29 }
30 
31 Real
33 {
34  return _fe_problem.getNonlinearSystemBase(_sys.number()).nResidualEvaluations();
35 }
NumResidualEvaluations(const InputParameters &parameters)
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
registerMooseObject("MooseApp", NumResidualEvaluations)
static InputParameters validParams()
NonlinearSystemBase & getNonlinearSystemBase(const unsigned int sys_num)
SystemBase & _sys
Reference to the system object for this user object.
Definition: UserObject.h:214
unsigned int number() const
Gets the number of this system.
Definition: SystemBase.C:1125
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Just returns the total number of Residual Evaluations performed.
FEProblemBase & _fe_problem
Reference to the FEProblemBase for this user object.
Definition: UserObject.h:210
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...