https://mooseframework.inl.gov
Loading...
Searching...
No Matches
NumResidualEvaluations.C
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
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
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
30
31Real
registerMooseObject("MooseApp", NumResidualEvaluations)
NonlinearSystemBase & getNonlinearSystemBase(const unsigned int sys_num)
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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.
unsigned int nResidualEvaluations() const
Return the total number of residual evaluations done so far in this calculation.
Just returns the total number of Residual Evaluations performed.
NumResidualEvaluations(const InputParameters &parameters)
static InputParameters validParams()
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
unsigned int number() const
Gets the number of this system.
FEProblemBase & _fe_problem
Reference to the FEProblemBase for this user object.
SystemBase & _sys
Reference to the system object for this user object.