Interface for IterateType::PCG termination criterion policy classes. More...
#include <apcg.hh>
Detailed Description
class Kaskade::PCGTerminationCriterion< R >
Interface for IterateType::PCG termination criterion policy classes.
- Template Parameters
-
R a floating point type for real numbers
Definition at line 63 of file linalg/apcg.hh.
Public Types | |
| typedef R | Real |
| real field type More... | |
| typedef R | Real |
| real field type More... | |
Public Member Functions | |
| virtual void | clear ()=0 |
| re-initializes the termination criterion for a new IterateType::CG run More... | |
| virtual PCGTerminationCriterion< R > & | tolerance (Real tol)=0 |
| set requested tolerance More... | |
| virtual void | step (Real gamma2)=0 |
| supplies energy of step to the termination criterion More... | |
| virtual void | residual (Real sigma)=0 |
| supplies the preconditioned residual to the termination criterion More... | |
| virtual | operator bool () const =0 |
| termination decision More... | |
| virtual void | clear ()=0 |
| re-initializes the termination criterion for a new IterateType::CG run More... | |
| virtual void | setTolerance (Real tol)=0 |
| set requested tolerance More... | |
| virtual void | setLookAhead (int lah)=0 |
| set requested look-ahead count More... | |
| virtual void | addStepQuantities (Real stepLength, Real qAq, Real qPq, Real rPINVr)=0 |
| addStepQuantities supplies algorithmic quantities to the termination criterion More... | |
| virtual int | getMaxIterationSteps ()=0 |
| get the maximum number of allowed iteration steps More... | |
| virtual | operator bool ()=0 |
| termination decision More... | |
| virtual bool | minimalDecreaseAchieved () |
Member Typedef Documentation
◆ Real [1/2]
| typedef R Kaskade::PCGTerminationCriterion< R >::Real |
real field type
Definition at line 69 of file linalg/apcg.hh.
◆ Real [2/2]
| typedef R Kaskade::PCGTerminationCriterion< R >::Real |
real field type
Definition at line 28 of file cgTerminationCriteria.hh.
Member Function Documentation
◆ addStepQuantities()
|
pure virtual |
addStepQuantities supplies algorithmic quantities to the termination criterion
- Parameters
-
stepLength scaling for the conjugate search direction \(q\) qAq squared energy norm of the conjugate search direction \(q\) qPq squared \(P\)-norm, i. e. the norm induced by the preconditioner, of the conjugate search direction \(q\) rPINVr squared \(P^{-1}\)-norm of the residual
Implemented in Kaskade::StrakosTichyPTerminationCriterion< R >, and Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >.
◆ clear() [1/2]
|
pure virtual |
re-initializes the termination criterion for a new IterateType::CG run
Implemented in Kaskade::PCGCountingTerminationCriterion< R >, Kaskade::PCGEnergyErrorTerminationCriterion< R >, Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
Referenced by Kaskade::Pcg< X, Xstar >::apply(), and Kaskade::CGBase< X, Xstar, impl, TimerPolicy, Functor >::cgLoop().
◆ clear() [2/2]
|
pure virtual |
re-initializes the termination criterion for a new IterateType::CG run
Implemented in Kaskade::PCGCountingTerminationCriterion< R >, Kaskade::PCGEnergyErrorTerminationCriterion< R >, Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
◆ getMaxIterationSteps()
|
pure virtual |
get the maximum number of allowed iteration steps
Implemented in Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
Referenced by Kaskade::CGBase< X, Xstar, impl, TimerPolicy, Functor >::cgLoop().
◆ minimalDecreaseAchieved()
|
inlinevirtual |
Reimplemented in Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
Definition at line 69 of file cgTerminationCriteria.hh.
◆ operator bool() [1/2]
|
pure virtual |
termination decision
- Returns
- true if the iteration has reached the required accuracy
Implemented in Kaskade::PCGCountingTerminationCriterion< R >, and Kaskade::PCGEnergyErrorTerminationCriterion< R >.
◆ operator bool() [2/2]
|
pure virtual |
termination decision
- Returns
- true if the iteration has reached the required accuracy
Implemented in Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
◆ residual()
|
pure virtual |
supplies the preconditioned residual to the termination criterion
- Parameters
-
sigma the preconditioned residual norm
Implemented in Kaskade::PCGEnergyErrorTerminationCriterion< R >, and Kaskade::PCGCountingTerminationCriterion< R >.
Referenced by Kaskade::Pcg< X, Xstar >::apply().
◆ setLookAhead()
|
pure virtual |
set requested look-ahead count
- Parameters
-
lah the requested look-ahead count (positive integer)
Implemented in Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
◆ setTolerance()
|
pure virtual |
set requested tolerance
- Parameters
-
tol the requested tolerance (nonnegative)
Implemented in Kaskade::StrakosTichyEnergyErrorTerminationCriterion< R >, and Kaskade::StrakosTichyPTerminationCriterion< R >.
Referenced by Kaskade::CGBase< X, Xstar, impl, TimerPolicy, Functor >::apply().
◆ step()
|
pure virtual |
supplies energy of step to the termination criterion
- Parameters
-
gamma2 the energy \( \alpha^2 q^T A q \) of the step \( \alpha q \)
Implemented in Kaskade::PCGEnergyErrorTerminationCriterion< R >, and Kaskade::PCGCountingTerminationCriterion< R >.
Referenced by Kaskade::Pcg< X, Xstar >::apply().
◆ tolerance()
|
pure virtual |
set requested tolerance
- Parameters
-
tol the requested tolerance (nonnegative)
Implemented in Kaskade::PCGEnergyErrorTerminationCriterion< R >, and Kaskade::PCGCountingTerminationCriterion< R >.
Referenced by Kaskade::Pcg< X, Xstar >::apply().
The documentation for this class was generated from the following files:
