Reference documentation for deal.II version GIT relicensing-822-gf1642d4ea5 2024-06-12 14:10:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
solver_control.h
Go to the documentation of this file.
1// ------------------------------------------------------------------------
2//
3// SPDX-License-Identifier: LGPL-2.1-or-later
4// Copyright (C) 1998 - 2023 by the deal.II authors
5//
6// This file is part of the deal.II library.
7//
8// Part of the source code is dual licensed under Apache-2.0 WITH
9// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10// governing the source code and code contributions can be found in
11// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12//
13// ------------------------------------------------------------------------
14
15#ifndef dealii_solver_control_h
16#define dealii_solver_control_h
17
18
19#include <deal.II/base/config.h>
20
22
23#include <vector>
24
26
27#ifndef DOXYGEN
29#endif
30
67{
68public:
73 enum State
74 {
81 };
82
83
84
95 {
96 public:
97 NoConvergence(const unsigned int last_step, const double last_residual)
100 {}
101
103
104 virtual void
105 print_info(std::ostream &out) const override
106 {
107 out
108 << "Iterative method reported convergence failure in step " << last_step
109 << ". The residual in the last step was " << last_residual << ".\n\n"
110 << "This error message can indicate that you have simply not allowed "
111 << "a sufficiently large number of iterations for your iterative solver "
112 << "to converge. This often happens when you increase the size of your "
113 << "problem. In such cases, the last residual will likely still be very "
114 << "small, and you can make the error go away by increasing the allowed "
115 << "number of iterations when setting up the SolverControl object that "
116 << "determines the maximal number of iterations you allow."
117 << "\n\n"
118 << "The other situation where this error may occur is when your matrix "
119 << "is not invertible (e.g., your matrix has a null-space), or if you "
120 << "try to apply the wrong solver to a matrix (e.g., using CG for a "
121 << "matrix that is not symmetric or not positive definite). In these "
122 << "cases, the residual in the last iteration is likely going to be large."
123 << std::endl;
124 }
125
129 const unsigned int last_step;
130
134 const double last_residual;
135 };
136
137
138
150 explicit SolverControl(const unsigned int n = 100,
151 const double tol = 1.e-10,
152 const bool log_history = false,
153 const bool log_result = true);
154
159 virtual ~SolverControl() override = default;
160
164 static void
166
170 void
172
190 virtual State
191 check(const unsigned int step, const double check_value);
192
196 State
197 last_check() const;
198
202 double
203 initial_value() const;
204
209 double
210 last_value() const;
211
215 unsigned int
216 last_step() const;
217
221 unsigned int
222 max_steps() const;
223
227 unsigned int
228 set_max_steps(const unsigned int);
229
235 void
237
242 void
244
248 double
249 tolerance() const;
250
254 double
255 set_tolerance(const double);
256
260 void
262
266 const std::vector<double> &
267 get_history_data() const;
268
274 double
275 average_reduction() const;
282 double
283 final_reduction() const;
284
290 double
291 step_reduction(unsigned int step) const;
292
296 void
297 log_history(const bool);
298
302 bool
303 log_history() const;
304
308 unsigned int
309 log_frequency(unsigned int);
310
314 void
315 log_result(const bool);
316
320 bool
321 log_result() const;
322
329
330protected:
334 unsigned int maxsteps;
335
339 double tol;
340
345
350
354 double lvalue;
355
359 unsigned int lstep;
360
366
371
379
384
388 unsigned int m_log_frequency;
389
396
401
408 std::vector<double> history_data;
409};
410
411
424{
425public:
431 explicit ReductionControl(const unsigned int maxiter = 100,
432 const double tolerance = 1.e-10,
433 const double reduce = 1.e-2,
434 const bool log_history = false,
435 const bool log_result = true);
436
441 explicit ReductionControl(const SolverControl &c);
442
448 operator=(const SolverControl &c);
449
454 virtual ~ReductionControl() override = default;
455
459 static void
461
465 void
467
473 virtual State
474 check(const unsigned int step, const double check_value) override;
475
479 double
480 reduction() const;
481
485 double
486 set_reduction(const double);
487
488protected:
492 double reduce;
493
499};
500
512{
513public:
518 explicit IterationNumberControl(const unsigned int maxiter = 100,
519 const double tolerance = 1e-12,
520 const bool log_history = false,
521 const bool log_result = true);
522
528
536
541 virtual ~IterationNumberControl() override = default;
542
548 virtual State
549 check(const unsigned int step, const double check_value) override;
550};
551
552
565{
566public:
573 explicit ConsecutiveControl(const unsigned int maxiter = 100,
574 const double tolerance = 1.e-10,
575 const unsigned int n_consecutive_iterations = 2,
576 const bool log_history = false,
577 const bool log_result = false);
578
583 explicit ConsecutiveControl(const SolverControl &c);
584
591 operator=(const SolverControl &c);
592
597 virtual ~ConsecutiveControl() override = default;
598
603 virtual State
604 check(const unsigned int step, const double check_value) override;
605
606protected:
612
617};
618
620//---------------------------------------------------------------------------
621
622#ifndef DOXYGEN
623
624inline unsigned int
626{
627 return maxsteps;
628}
629
630
631
632inline unsigned int
633SolverControl::set_max_steps(const unsigned int newval)
634{
635 unsigned int old = maxsteps;
637 return old;
638}
639
640
641
642inline void
644{
646 check_failure = true;
647}
648
649
650
651inline void
653{
656 check_failure = false;
657}
658
659
660
661inline double
663{
664 return tol;
665}
666
667
668
669inline double
670SolverControl::set_tolerance(const double t)
671{
672 double old = tol;
673 tol = t;
674 return old;
675}
676
677
678inline void
680{
682}
683
684
685
686inline bool
688{
689 return m_log_history;
690}
691
692
693inline void
695{
697}
698
699
700inline bool
702{
703 return m_log_result;
704}
705
706
707inline double
709{
710 return reduce;
711}
712
713
714inline double
716{
717 double old = reduce;
718 reduce = t;
719 return old;
720}
721
722#endif // DOXYGEN
723
725
726#endif
ConsecutiveControl & operator=(const SolverControl &c)
virtual ~ConsecutiveControl() override=default
unsigned int n_consecutive_iterations
unsigned int n_converged_iterations
virtual State check(const unsigned int step, const double check_value) override
IterationNumberControl & operator=(const SolverControl &c)
virtual State check(const unsigned int step, const double check_value) override
IterationNumberControl(const SolverControl &c)
virtual ~IterationNumberControl() override=default
double set_reduction(const double)
void parse_parameters(ParameterHandler &param)
virtual ~ReductionControl() override=default
double reduction() const
virtual State check(const unsigned int step, const double check_value) override
static void declare_parameters(ParameterHandler &param)
ReductionControl & operator=(const SolverControl &c)
NoConvergence(const unsigned int last_step, const double last_residual)
virtual void print_info(std::ostream &out) const override
virtual ~NoConvergence() noexcept override=default
void log_history(const bool)
static void declare_parameters(ParameterHandler &param)
State last_check() const
double average_reduction() const
virtual ~SolverControl() override=default
const std::vector< double > & get_history_data() const
void clear_failure_criterion()
unsigned int lstep
unsigned int last_step() const
double last_value() const
void log_result(const bool)
unsigned int m_log_frequency
unsigned int log_frequency(unsigned int)
virtual State check(const unsigned int step, const double check_value)
unsigned int maxsteps
void set_failure_criterion(const double rel_failure_residual)
bool log_history() const
void enable_history_data()
double step_reduction(unsigned int step) const
std::vector< double > history_data
double failure_residual
double relative_failure_residual
unsigned int set_max_steps(const unsigned int)
double set_tolerance(const double)
unsigned int max_steps() const
double initial_value() const
double tolerance() const
bool log_result() const
void parse_parameters(ParameterHandler &param)
double final_reduction() const
@ iterate
Continue iteration.
@ success
Stop iteration, goal reached.
@ failure
Stop iteration, goal not reached.
#define DEAL_II_NAMESPACE_OPEN
Definition config.h:502
#define DEAL_II_NAMESPACE_CLOSE
Definition config.h:503
#define DeclException0(Exception0)
Definition exceptions.h:471
static ::ExceptionBase & ExcHistoryDataRequired()
STL namespace.