Reference documentation for deal.II version 9.6.0

#include <deal.II/lac/solver_control.h>
Public Types  
enum  State { iterate = 0 , success , failure } 
Public Member Functions  
ConsecutiveControl (const unsigned int maxiter=100, const double tolerance=1.e10, const unsigned int n_consecutive_iterations=2, const bool log_history=false, const bool log_result=false)  
ConsecutiveControl (const SolverControl &c)  
ConsecutiveControl &  operator= (const SolverControl &c) 
virtual  ~ConsecutiveControl () override=default 
virtual State  check (const unsigned int step, const double check_value) override 
void  parse_parameters (ParameterHandler ¶m) 
State  last_check () const 
double  initial_value () const 
double  last_value () const 
unsigned int  last_step () const 
unsigned int  max_steps () const 
unsigned int  set_max_steps (const unsigned int) 
void  set_failure_criterion (const double rel_failure_residual) 
void  clear_failure_criterion () 
double  tolerance () const 
double  set_tolerance (const double) 
void  enable_history_data () 
const std::vector< double > &  get_history_data () const 
double  average_reduction () const 
double  final_reduction () const 
double  step_reduction (unsigned int step) const 
void  log_history (const bool) 
bool  log_history () const 
unsigned int  log_frequency (unsigned int) 
void  log_result (const bool) 
bool  log_result () const 
template<class Archive >  
void  serialize (Archive &ar, const unsigned int version) 
Subscriptor functionality  
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.  
void  subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const 
void  unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const 
unsigned int  n_subscriptions () const 
template<typename StreamType >  
void  list_subscribers (StreamType &stream) const 
void  list_subscribers () const 
Static Public Member Functions  
static void  declare_parameters (ParameterHandler ¶m) 
static ::ExceptionBase &  ExcHistoryDataRequired () 
static ::ExceptionBase &  ExcInUse (int arg1, std::string arg2, std::string arg3) 
static ::ExceptionBase &  ExcNoSubscriber (std::string arg1, std::string arg2) 
Protected Attributes  
unsigned int  n_consecutive_iterations 
unsigned int  n_converged_iterations 
unsigned int  maxsteps 
double  tol 
State  lcheck 
double  initial_val 
double  lvalue 
unsigned int  lstep 
bool  check_failure 
double  relative_failure_residual 
double  failure_residual 
bool  m_log_history 
unsigned int  m_log_frequency 
bool  m_log_result 
bool  history_data_enabled 
std::vector< double >  history_data 
Private Types  
using  map_value_type = decltype(counter_map)::value_type 
using  map_iterator = decltype(counter_map)::iterator 
Private Member Functions  
void  check_no_subscribers () const noexcept 
Private Attributes  
std::atomic< unsigned int >  counter 
std::map< std::string, unsigned int >  counter_map 
std::vector< std::atomic< bool > * >  validity_pointers 
const std::type_info *  object_info 
Static Private Attributes  
static std::mutex  mutex 
Specialization of SolverControl
which returns SolverControl::State::success if and only if a certain positive number of consecutive iterations satisfy the specified tolerance. This is useful in cases when solving nonlinear problems using inexact Hessian.
For example: The requested number of consecutively converged iterations is 2, the tolerance is 0.2. The ConsecutiveControl will return SolverControl::State::success only at the last step in the sequence 0.5, 0.0005, 1.0, 0.05, 0.01.
Definition at line 564 of file solver_control.h.

privateinherited 
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.

privateinherited 
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.

inherited 
Enum denoting the different states a solver can be in. See the general documentation of this class for more information.
Enumerator  

iterate  Continue iteration. 
success  Stop iteration, goal reached. 
failure  Stop iteration, goal not reached. 
Definition at line 73 of file solver_control.h.

explicit 
Constructor. n_consecutive_iterations
is the number of consecutive iterations which should satisfy the prescribed tolerance for convergence. Other arguments have the same meaning as those of the constructor of the SolverControl.
Definition at line 349 of file solver_control.cc.

explicit 
Initialize with a SolverControl object. The result will emulate SolverControl by setting n_consecutive_iterations
to one.
Definition at line 365 of file solver_control.cc.

overridevirtualdefault 
Virtual destructor is needed as there are virtual functions in this class.
ConsecutiveControl & ConsecutiveControl::operator=  (  const SolverControl &  c  ) 
Assign a SolverControl object to ConsecutiveControl. The result of the assignment will emulate SolverControl by setting n_consecutive_iterations
to one.
Definition at line 374 of file solver_control.cc.

overridevirtual 
Decide about success or failure of an iteration, see the class description above.
Reimplemented from SolverControl.
Definition at line 385 of file solver_control.cc.

staticinherited 
Interface to parameter file.
Definition at line 206 of file solver_control.cc.

inherited 
Read parameters from file.
Definition at line 217 of file solver_control.cc.

inherited 
Return the result of the last check operation.
Definition at line 108 of file solver_control.cc.

inherited 
Return the initial convergence criterion.
Definition at line 115 of file solver_control.cc.

inherited 
Return the convergence value of last iteration step for which check
was called by the solver.
Definition at line 122 of file solver_control.cc.

inherited 
Number of last iteration step.
Definition at line 129 of file solver_control.cc.

inherited 
Maximum number of steps.
Change maximum number of steps.

inherited 
Enables the failure check. Solving is stopped with ReturnState
failure
if residual>failure_residual
with failure_residual := rel_failure_residual*first_residual
.

inherited 
Disables failure check and resets relative_failure_residual
and failure_residual
to zero.

inherited 
Tolerance.

inherited 
Change tolerance.

inherited 
Enables writing residuals of each step into a vector for later analysis.
Definition at line 147 of file solver_control.cc.

inherited 
Provide read access to the collected residual data.
Definition at line 155 of file solver_control.cc.

inherited 
Average error reduction over all steps.
Requires enable_history_data()
Definition at line 171 of file solver_control.cc.

inherited 
Error reduction of the last step; for stationary iterations, this approximates the norm of the iteration matrix.
Requires enable_history_data()
Definition at line 199 of file solver_control.cc.

inherited 
Error reduction of any iteration step.
Requires enable_history_data()
Definition at line 187 of file solver_control.cc.

inherited 
Log each iteration step. Use log_frequency
for skipping steps.

inherited 
Return the log_history
flag.
Set logging frequency.
Definition at line 136 of file solver_control.cc.

inherited 
Log start and end step.

inherited 
Return the log_result
flag.

inherited 
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 135 of file subscriptor.cc.

inherited 
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.

inlineinherited 
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 300 of file subscriptor.h.

inlineinherited 
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.

inherited 
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.

inlineinherited 
Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.
Definition at line 309 of file subscriptor.h.

privatenoexceptinherited 
Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.
Definition at line 52 of file subscriptor.cc.

protected 
The number of consecutive iterations which should satisfy the prescribed tolerance for convergence.
Definition at line 611 of file solver_control.h.

protected 
Counter for the number of consecutively converged iterations.
Definition at line 616 of file solver_control.h.

protectedinherited 
Maximum number of steps.
Definition at line 334 of file solver_control.h.

protectedinherited 
Prescribed tolerance to be achieved.
Definition at line 339 of file solver_control.h.

protectedinherited 
Result of last check operation.
Definition at line 344 of file solver_control.h.

protectedinherited 
Initial value.
Definition at line 349 of file solver_control.h.

protectedinherited 
Last value of the convergence criterion.
Definition at line 354 of file solver_control.h.

protectedinherited 
Last step.
Definition at line 359 of file solver_control.h.

protectedinherited 
Is set to true
by set_failure_criterion
and enables failure checking.
Definition at line 365 of file solver_control.h.

protectedinherited 
Stores the rel_failure_residual
set by set_failure_criterion
Definition at line 370 of file solver_control.h.

protectedinherited 
failure_residual
equals the first residual multiplied by relative_crit
set by set_failure_criterion
(see there).
Until the first residual is known it is 0.
Definition at line 378 of file solver_control.h.

protectedinherited 
Log convergence history to deallog
.
Definition at line 383 of file solver_control.h.

protectedinherited 
Log only every nth step.
Definition at line 388 of file solver_control.h.

protectedinherited 
Log iteration result to deallog
. If true, after finishing the iteration, a statement about failure or success together with lstep
and lvalue
are logged.
Definition at line 395 of file solver_control.h.

protectedinherited 
Control over the storage of history data. Set by enable_history_data().
Definition at line 400 of file solver_control.h.

protectedinherited 
Vector storing the result after each iteration step for later statistical analysis.
Use of this vector is enabled by enable_history_data().
Definition at line 408 of file solver_control.h.

mutableprivateinherited 
Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).
The creator (and owner) of an object is counted in the map below if HE manages to supply identification.
We use the mutable
keyword in order to allow subscription to constant objects also.
This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic
class template.
Definition at line 218 of file subscriptor.h.

mutableprivateinherited 
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.

mutableprivateinherited 
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.

mutableprivateinherited 
Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.
Definition at line 248 of file subscriptor.h.

staticprivateinherited 
A mutex used to ensure data consistency when accessing the mutable
members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers()
.
Definition at line 271 of file subscriptor.h.