https://mooseframework.inl.gov
Loading...
Searching...
No Matches
IterationCountConvergence.h
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#pragma once
11
12#include "Convergence.h"
13
18{
19public:
21
23
24 virtual MooseConvergenceStatus checkConvergence(unsigned int n_iter) override final;
25
26protected:
34 virtual MooseConvergenceStatus checkConvergenceInner(unsigned int n_iter);
35
37 const unsigned int _min_iterations;
38
40 const unsigned int _max_iterations;
41
44};
Base class for convergence criteria.
Definition Convergence.h:26
MooseConvergenceStatus
Status returned by calls to checkConvergence.
Definition Convergence.h:34
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Checks convergence based on the iteration count.
virtual MooseConvergenceStatus checkConvergenceInner(unsigned int n_iter)
Inner check of convergence.
static InputParameters validParams()
virtual MooseConvergenceStatus checkConvergence(unsigned int n_iter) override final
Returns convergence status.
const bool _converge_at_max_iterations
Whether to converge at the maximum number of iterations.
const unsigned int _max_iterations
Maximum number of iterations.
const unsigned int _min_iterations
Minimum number of iterations.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131