#include <convergence_check.h>
Inheritance diagram for ug::IConvergenceCheck< TVector >:
Public Member Functions | |
| virtual number | avg_rate () const =0 |
| virtual SmartPtr< IConvergenceCheck< TVector > > | clone ()=0 |
| clone the object | |
| virtual std::string | config_string () const =0 |
| returns information about configuration parameters | |
| virtual number | defect () const =0 |
| returns the current defect | |
| virtual int | get_offset () const =0 |
| get the current offset | |
| virtual bool | iteration_ended ()=0 |
| virtual bool | post ()=0 |
| virtual void | print_line (std::string line)=0 |
| prints a line | |
| virtual number | rate () const =0 |
| virtual number | reduction () const =0 |
| virtual void | set_info (std::string name)=0 |
| sets info string | |
| virtual void | set_name (std::string name)=0 |
| sets the name of the iteration | |
| virtual void | set_offset (int offset)=0 |
| sets the number of spaces printed before output information | |
| virtual void | set_symbol (char symbol)=0 |
| sets the symbol used for output | |
| virtual void | start (const TVector &d)=0 |
| computes the start defect and set it | |
| virtual void | start_defect (number defect)=0 |
| sets the given start defect | |
| virtual int | step () const =0 |
| returns the current number of steps | |
| virtual void | update (const TVector &d)=0 |
| computes the defect and sets it a the next defect value | |
| virtual void | update_defect (number defect)=0 |
| sets the update for the current defect | |
| virtual | ~IConvergenceCheck () |
| virtual destructor | |
Detailed Description
class ug::IConvergenceCheck< TVector >
This is the base class for a convergence checking object. An instance is passed to an iterative solver to control the convergence.
- Template Parameters
-
TVector vector type
Constructor & Destructor Documentation
◆ ~IConvergenceCheck()
|
inlinevirtual |
virtual destructor
Member Function Documentation
◆ avg_rate()
|
pure virtual |
◆ clone()
|
pure virtual |
clone the object
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::EnergyConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ config_string()
|
pure virtual |
returns information about configuration parameters
this should return necessary information about parameters and possibly calling config_string of subcomponents.
- Returns
- std::string necessary information about configuration parameters
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::EnergyConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ defect()
|
pure virtual |
returns the current defect
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ get_offset()
|
pure virtual |
get the current offset
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ iteration_ended()
|
pure virtual |
iteration_ended
Checks if the iteration must be ended. This can be due to convergence or divergence.
- Returns
- true if iteration ended false if iteration can and must be continued until convergence
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ post()
|
pure virtual |
post
post-processes the iteration. Some informative outputs of the status of the iteration after finishing the iteration can be placed here
- Returns
- true if iteration was successful false if iteration did not lead to a satisfying result
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ print_line()
|
pure virtual |
prints a line
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ rate()
|
pure virtual |
◆ reduction()
|
pure virtual |
◆ set_info()
|
pure virtual |
sets info string
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ set_name()
|
pure virtual |
sets the name of the iteration
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ set_offset()
|
pure virtual |
sets the number of spaces printed before output information
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ set_symbol()
|
pure virtual |
sets the symbol used for output
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ start()
|
pure virtual |
computes the start defect and set it
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::EnergyConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ start_defect()
|
pure virtual |
sets the given start defect
Implemented in ug::FixedConvergenceCheck< TVector >, ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ step()
|
pure virtual |
returns the current number of steps
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ update()
|
pure virtual |
computes the defect and sets it a the next defect value
Implemented in ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, ug::EnergyConvCheck< TVector >, ug::FixedConvergenceCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
◆ update_defect()
|
pure virtual |
sets the update for the current defect
Implemented in ug::FixedConvergenceCheck< TVector >, ug::AlgebraicConvCheck< TVector >, ug::StdConvCheck< TVector >, and ug::CompositeConvCheck< TVector, TDomain >.
The documentation for this class was generated from the following file:
- ugbase/lib_algebra/operator/convergence_check.h
