www.mooseframework.org
include
postprocessors
NumNonlinearIterations.h
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
#pragma once
11
12
#include "
GeneralPostprocessor.h
"
13
18
class
NumNonlinearIterations
:
public
GeneralPostprocessor
19
{
20
public
:
21
static
InputParameters
validParams
();
22
23
NumNonlinearIterations
(
const
InputParameters
&
parameters
);
24
28
virtual
void
timestepSetup
()
override
;
29
30
virtual
void
initialize
()
override
{}
31
virtual
void
execute
()
override
{}
32
virtual
void
finalize
()
override
;
33
37
virtual
Real
getValue
()
const override
;
38
39
protected
:
41
FEProblemBase
*
_fe_problem
;
42
44
bool
_accumulate_over_step
;
45
47
unsigned
int
_num_iters
;
48
50
Real
_time
;
51
};
NumNonlinearIterations::timestepSetup
virtual void timestepSetup() override
Initialization to be done at each timestep.
Definition:
NumNonlinearIterations.C:42
NumNonlinearIterations::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
NumNonlinearIterations.h:30
NumNonlinearIterations::NumNonlinearIterations
NumNonlinearIterations(const InputParameters ¶meters)
Definition:
NumNonlinearIterations.C:30
NumNonlinearIterations
NumNonlinearIterations is a postprocessor that reports the number of nonlinear iterations.
Definition:
NumNonlinearIterations.h:18
NumNonlinearIterations::validParams
static InputParameters validParams()
Definition:
NumNonlinearIterations.C:19
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:63
NumNonlinearIterations::_time
Real _time
Stores the last time this was executed.
Definition:
NumNonlinearIterations.h:50
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
FEProblemBase
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition:
FEProblemBase.h:148
NumNonlinearIterations::_num_iters
unsigned int _num_iters
Stores the nonlinear iteration count.
Definition:
NumNonlinearIterations.h:47
NumNonlinearIterations::finalize
virtual void finalize() override
This is called after execute() and after threadJoin()! This is probably where you want to do MPI comm...
Definition:
NumNonlinearIterations.C:52
NumNonlinearIterations::_fe_problem
FEProblemBase * _fe_problem
Pointer to the FEProblemBase.
Definition:
NumNonlinearIterations.h:41
NumNonlinearIterations::_accumulate_over_step
bool _accumulate_over_step
True if we should accumulate over all nonlinear solves done as part of Picard iterations in a step...
Definition:
NumNonlinearIterations.h:44
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GeneralPostprocessor.h
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
NumNonlinearIterations::getValue
virtual Real getValue() const override
Get the number of nonlinear iterations.
Definition:
NumNonlinearIterations.C:61
NumNonlinearIterations::execute
virtual void execute() override
Execute method.
Definition:
NumNonlinearIterations.h:31
Generated on Thu Apr 18 2024 15:23:09 for www.mooseframework.org by
1.8.14