`#include <Ifpack_Preconditioner.h>`

Inheritance diagram for Ifpack_Preconditioner:

## Public Member Functions | |

virtual int | SetParameters (Teuchos::ParameterList &List)=0 |

Sets all parameters for the preconditioner. | |

virtual int | Initialize ()=0 |

Computes all it is necessary to initialize the preconditioner. | |

virtual bool | IsInitialized () const =0 |

Returns true if the preconditioner has been successfully initialized, false otherwise. | |

virtual int | Compute ()=0 |

Computes all it is necessary to apply the preconditioner. | |

virtual bool | IsComputed () const =0 |

Returns true if the preconditioner has been successfully computed, false otherwise. | |

virtual double | Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix=0)=0 |

Computes the condition number estimate, returns its value. | |

virtual double | Condest () const =0 |

Returns the computed condition number estimate, or -1.0 if not computed. | |

virtual int | ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const =0 |

Applies the preconditioner to vector X, returns the result in Y. | |

virtual const Epetra_RowMatrix & | Matrix () const =0 |

Returns a pointer to the matrix to be preconditioned. | |

virtual int | NumInitialize () const =0 |

Returns the number of calls to Initialize(). | |

virtual int | NumCompute () const =0 |

Returns the number of calls to Compute(). | |

virtual int | NumApplyInverse () const =0 |

Returns the number of calls to ApplyInverse(). | |

virtual double | InitializeTime () const =0 |

Returns the time spent in Initialize(). | |

virtual double | ComputeTime () const =0 |

Returns the time spent in Compute(). | |

virtual double | ApplyInverseTime () const =0 |

Returns the time spent in ApplyInverse(). | |

virtual double | InitializeFlops () const =0 |

Returns the number of flops in the initialization phase. | |

virtual double | ComputeFlops () const =0 |

Returns the number of flops in the computation phase. | |

virtual double | ApplyInverseFlops () const =0 |

Returns the number of flops in the application of the preconditioner. | |

virtual ostream & | Print (std::ostream &os) const =0 |

Prints basic information on iostream. This function is used by operator<<. |

Class Ifpack_Preconditioner is a pure virtual class, and it defines the structure of all Ifpack preconditioners.

This class is a simple extension to Epetra_Operator. It provides the following additional methods:

- Initialize() performs all operations based on the graph of the matrix (without considering the numerical values);
- IsInitialized() returns true if the preconditioner has been successfully initialized;
- Compute() computes all is required to apply the preconditioner, using matrix values (and assuming that the sparsity of the matrix has not been changed);
- IsComputed() should return true if the preconditioner has been successfully computed, false otherwise.
- Condest() returns an estimation of the condition number, or -1.0 if not available
- Matrix() returns a reference to the matrix to be preconditioned.

It is required that Compute() call Initialize() if IsInitialized() returns false. The preconditioner is applied by ApplyInverse() (which returns if IsComputed() is false). Every time that Initialize() is called, the object destroys all the previously allocated information, and re-initialize the preconditioner. Every time Compute() is called, the object re-computed the actual values of the preconditioner.

**Estimating Preconditioner Condition Numbers**

The condition of a matrix , called , is defined as in some appropriate norm . gives some indication of how many accurate floating point digits can be expected from operations involving the matrix and its inverse. A condition number approaching the accuracy of a given floating point number system, about 15 decimal digits in IEEE double precision, means that any results involving or may be meaningless.

Method Compute() can be use to estimate of the condition number. Compute() requires one parameter, of type Ifpack_CondestType (default value is Ifpack_Cheap; other valid choices are Ifpack_CG and Ifpack_GMRES).

While Ifpack_CG and Ifpack_GMRES construct and AztecOO solver, and use methods AZ_cg_condnum and AZ_gmres_condnum to evaluate an accurate (but very expensive) estimate of the condition number, Ifpack_Cheap computes , which is only a very crude estimation of the actual condition number. Note that this estimated number can be less than 1.0. However, this approach has the following advantages:

- since finding such that is a basic kernel for applying the preconditioner, computing this estimate of is performed by setting , calling the solve kernel to compute and then computing ;
- the only cost is one application of the preconditioner.

If this estimate is very large, the application of the computed preconditioner may generate large numerical errors. Hence, the user may check this number, and decide to recompute the preconditioner is the computed estimate is larger than a given threshold. This is particularly useful in ICT and RILUK factorizations, as for ill-conditioned matrices, we often have difficulty computing usable incomplete factorizations. The most common source of problems is that the factorization may encounter a small or zero pivot, in which case the factorization can fail, or even if the factorization succeeds, the factors may be so poorly conditioned that use of them in the iterative phase produces meaningless results. Before we can fix this problem, we must be able to detect it.

**Note:**- If IFPACK is configured with Teuchos support, method SetParameters() should be adopted. Otherwise, users can set parameters (one at-a-time), using methods SetParameter(), for integers and doubles.

**Date:**- Sep-04

Definition at line 123 of file Ifpack_Preconditioner.h.

The documentation for this class was generated from the following file:

Generated on Tue Jul 13 09:27:14 2010 for IFPACK by 1.4.7