Line data Source code
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
11 : #include "DefaultNonlinearConvergence.h"
12 : #include "FEProblemBase.h"
13 : #include "PetscSupport.h"
14 : #include "NonlinearSystemBase.h"
15 : #include "ConvergenceIterationTypes.h"
16 :
17 : #include "libmesh/equation_systems.h"
18 :
19 : // PETSc includes
20 : #include <petsc.h>
21 : #include <petscmat.h>
22 : #include <petscsnes.h>
23 :
24 : registerMooseObject("MooseApp", DefaultNonlinearConvergence);
25 :
26 : InputParameters
27 131933 : DefaultNonlinearConvergence::validParams()
28 : {
29 131933 : InputParameters params = DefaultConvergenceBase::validParams();
30 131933 : params += FEProblemSolve::feProblemDefaultConvergenceParams();
31 :
32 395799 : params.addPrivateParam<bool>("added_as_default", false);
33 :
34 131933 : params.addClassDescription("Default convergence criteria for FEProblem.");
35 :
36 131933 : return params;
37 0 : }
38 :
39 65810 : DefaultNonlinearConvergence::DefaultNonlinearConvergence(const InputParameters & parameters)
40 : : DefaultConvergenceBase(parameters),
41 197430 : _fe_problem(*getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
42 131620 : _nl_abs_div_tol(getSharedExecutionerParam<Real>("nl_abs_div_tol")),
43 131620 : _nl_rel_div_tol(getSharedExecutionerParam<Real>("nl_div_tol")),
44 65810 : _div_threshold(std::numeric_limits<Real>::max()),
45 131620 : _nl_forced_its(getSharedExecutionerParam<unsigned int>("nl_forced_its")),
46 131620 : _nl_max_pingpong(getSharedExecutionerParam<unsigned int>("n_max_nonlinear_pingpong")),
47 65810 : _nl_current_pingpong(0)
48 : {
49 65810 : EquationSystems & es = _fe_problem.es();
50 :
51 65810 : es.parameters.set<unsigned int>("nonlinear solver maximum iterations") =
52 197430 : getSharedExecutionerParam<unsigned int>("nl_max_its");
53 65810 : es.parameters.set<unsigned int>("nonlinear solver maximum function evaluations") =
54 197430 : getSharedExecutionerParam<unsigned int>("nl_max_funcs");
55 65810 : es.parameters.set<Real>("nonlinear solver absolute residual tolerance") =
56 197430 : getSharedExecutionerParam<Real>("nl_abs_tol");
57 65810 : es.parameters.set<Real>("nonlinear solver relative residual tolerance") =
58 197430 : getSharedExecutionerParam<Real>("nl_rel_tol");
59 65810 : es.parameters.set<Real>("nonlinear solver divergence tolerance") =
60 197430 : getSharedExecutionerParam<Real>("nl_div_tol");
61 65810 : es.parameters.set<Real>("nonlinear solver absolute step tolerance") =
62 197430 : getSharedExecutionerParam<Real>("nl_abs_step_tol");
63 65810 : es.parameters.set<Real>("nonlinear solver relative step tolerance") =
64 197430 : getSharedExecutionerParam<Real>("nl_rel_step_tol");
65 65810 : }
66 :
67 : void
68 56162 : DefaultNonlinearConvergence::checkIterationType(IterationType it_type) const
69 : {
70 56162 : DefaultConvergenceBase::checkIterationType(it_type);
71 :
72 56162 : if (it_type != ConvergenceIterationTypes::NONLINEAR)
73 3 : mooseError("DefaultNonlinearConvergence can only be used with nonlinear solves.");
74 56159 : }
75 :
76 : bool
77 729746 : DefaultNonlinearConvergence::checkResidualConvergence(const unsigned int iter,
78 : const Real fnorm,
79 : const Real ref_norm,
80 : const Real rel_tol,
81 : const Real abs_tol,
82 : std::ostringstream & oss)
83 : {
84 729746 : if (fnorm < abs_tol)
85 : {
86 143850 : oss << "Converged due to absolute residual " << fnorm << " < absolute tolerance (" << abs_tol
87 143850 : << ")\n";
88 143850 : return true;
89 : }
90 585896 : else if (iter && fnorm <= ref_norm * rel_tol)
91 : {
92 139484 : oss << "Converged due to relative/normalized residual norm " << fnorm / ref_norm
93 139484 : << " < relative tolerance (" << rel_tol << ")\n";
94 139484 : return true;
95 : }
96 : else
97 446412 : return false;
98 : }
99 :
100 : Convergence::MooseConvergenceStatus
101 748785 : DefaultNonlinearConvergence::checkConvergence(unsigned int iter)
102 : {
103 748785 : TIME_SECTION(_perfid_check_convergence);
104 :
105 748785 : NonlinearSystemBase & system = _fe_problem.currentNonlinearSystem();
106 748785 : MooseConvergenceStatus status = MooseConvergenceStatus::ITERATING;
107 :
108 : // Needed by ResidualReferenceConvergence
109 748785 : nonlinearConvergenceSetup();
110 :
111 748785 : SNES snes = system.getSNES();
112 :
113 : // ||u||
114 : PetscReal xnorm;
115 748785 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetSolutionNorm(snes, &xnorm));
116 :
117 : // ||r||
118 : PetscReal fnorm;
119 748785 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetFunctionNorm(snes, &fnorm));
120 :
121 : // ||du||
122 : PetscReal snorm;
123 748785 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetUpdateNorm(snes, &snorm));
124 :
125 : // Get current number of function evaluations done by SNES
126 : PetscInt nfuncs;
127 748785 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetNumberFunctionEvals(snes, &nfuncs));
128 :
129 : // Get tolerances from SNES
130 : PetscReal abs_tol, rel_tol, rel_step_tol;
131 : PetscInt max_its, max_funcs;
132 748785 : LibmeshPetscCallA(
133 : _fe_problem.comm().get(),
134 : SNESGetTolerances(snes, &abs_tol, &rel_tol, &rel_step_tol, &max_its, &max_funcs));
135 :
136 : #if !PETSC_VERSION_LESS_THAN(3, 8, 4)
137 748785 : PetscBool force_iteration = PETSC_FALSE;
138 748785 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetForceIteration(snes, &force_iteration));
139 :
140 : // if PETSc says to force iteration, then force at least one iteration
141 748785 : if (force_iteration && !(_nl_forced_its))
142 734 : _nl_forced_its = 1;
143 :
144 : // if specified here to force iteration, but PETSc doesn't know, tell it
145 748785 : if (!force_iteration && (_nl_forced_its))
146 : {
147 164 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESSetForceIteration(snes, PETSC_TRUE));
148 : }
149 : #endif
150 :
151 : // See if SNESSetFunctionDomainError() has been called.
152 : // Note: SNESSetFunctionDomainError() and SNESGetFunctionDomainError() were added
153 : // in different releases of PETSc. The latter was removed in PETSc 3.25.0.
154 : #if PETSC_VERSION_LESS_THAN(3, 25, 0)
155 : PetscBool domainerror;
156 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetFunctionDomainError(snes, &domainerror));
157 : if (domainerror)
158 : status = MooseConvergenceStatus::DIVERGED;
159 : #else
160 : SNESConvergedReason reason;
161 748785 : LibmeshPetscCallA(_fe_problem.comm().get(), SNESGetConvergedReason(snes, &reason));
162 748785 : if (reason == SNES_DIVERGED_FUNCTION_DOMAIN)
163 0 : status = MooseConvergenceStatus::DIVERGED;
164 : #endif
165 :
166 : Real fnorm_old;
167 : // This is the first residual before any iterations have been done, but after
168 : // solution-modifying objects (if any) have been imposed on the solution vector.
169 : // We save it, and use it to detect convergence if system.usePreSMOResidual() == false.
170 748785 : if (iter == 0)
171 : {
172 285602 : system.setInitialResidual(fnorm);
173 285602 : fnorm_old = fnorm;
174 285602 : _nl_current_pingpong = 0;
175 : }
176 : else
177 463183 : fnorm_old = system._last_nl_rnorm;
178 :
179 : // Check for nonlinear residual ping-pong.
180 : // Ping-pong will always start from a residual increase
181 748785 : if ((_nl_current_pingpong % 2 == 1 && !(fnorm > fnorm_old)) ||
182 744784 : (_nl_current_pingpong % 2 == 0 && fnorm > fnorm_old))
183 8616 : _nl_current_pingpong += 1;
184 : else
185 740169 : _nl_current_pingpong = 0;
186 :
187 748785 : const auto ref_residual = system.referenceResidual();
188 748785 : std::ostringstream oss;
189 748785 : if (iter < _nl_forced_its)
190 1536 : oss << "Number of forced iterations not yet reached: " << iter << " < " << _nl_forced_its
191 1536 : << '\n';
192 747249 : else if (fnorm != fnorm)
193 : {
194 0 : oss << "Failed to converge, residual norm is NaN\n";
195 0 : status = MooseConvergenceStatus::DIVERGED;
196 : }
197 747249 : else if (checkResidualConvergence(iter, fnorm, ref_residual, rel_tol, abs_tol, oss))
198 284977 : status = MooseConvergenceStatus::CONVERGED;
199 462272 : else if (nfuncs >= max_funcs)
200 : {
201 0 : oss << "Exceeded maximum number of residual evaluations: " << nfuncs << " > " << max_funcs
202 0 : << '\n';
203 0 : status = MooseConvergenceStatus::DIVERGED;
204 : }
205 462272 : else if ((iter >= _nl_forced_its) && iter && fnorm > system._last_nl_rnorm &&
206 5095 : fnorm >= _div_threshold)
207 : {
208 0 : oss << "Nonlinear solve was blowing up!\n";
209 0 : status = MooseConvergenceStatus::DIVERGED;
210 : }
211 462272 : else if (snorm < rel_step_tol * xnorm)
212 : {
213 0 : oss << "Converged due to small update length: " << snorm << " < " << rel_step_tol << " * "
214 0 : << xnorm << '\n';
215 0 : status = MooseConvergenceStatus::CONVERGED;
216 : }
217 462272 : else if (_nl_rel_div_tol > 0 && fnorm > ref_residual * _nl_rel_div_tol)
218 : {
219 2 : oss << "Diverged due to relative residual " << ref_residual << " > divergence tolerance "
220 2 : << _nl_rel_div_tol << " * relative residual " << ref_residual << '\n';
221 2 : status = MooseConvergenceStatus::DIVERGED;
222 : }
223 462270 : else if (_nl_abs_div_tol > 0 && fnorm > _nl_abs_div_tol)
224 : {
225 9 : oss << "Diverged due to residual " << fnorm << " > absolute divergence tolerance "
226 9 : << _nl_abs_div_tol << '\n';
227 9 : status = MooseConvergenceStatus::DIVERGED;
228 : }
229 462261 : else if (_nl_current_pingpong > _nl_max_pingpong)
230 : {
231 9 : oss << "Diverged due to maximum nonlinear residual pingpong achieved" << '\n';
232 9 : status = MooseConvergenceStatus::DIVERGED;
233 : }
234 :
235 748785 : system._last_nl_rnorm = fnorm;
236 748785 : system._current_nl_its = static_cast<unsigned int>(iter);
237 :
238 748785 : std::string msg;
239 748785 : msg = oss.str();
240 748785 : if (_app.multiAppLevel() > 0)
241 383940 : MooseUtils::indentMessage(_app.name(), msg);
242 748785 : if (msg.length() > 0)
243 : #if !PETSC_VERSION_LESS_THAN(3, 17, 0)
244 286533 : LibmeshPetscCallA(_fe_problem.comm().get(), PetscInfo(snes, "%s", msg.c_str()));
245 : #else
246 : LibmeshPetscCallA(_fe_problem.comm().get(), PetscInfo(snes, msg.c_str()));
247 : #endif
248 :
249 748785 : verboseOutput(oss);
250 :
251 748785 : return status;
252 748785 : }
|
