Ifpack Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Ifpack_Preconditioner.h
Go to the documentation of this file.
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack: Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2002) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK_PRECONDITIONER_H
44 #define IFPACK_PRECONDITIONER_H
45 
46 #include "Ifpack_ConfigDefs.h"
47 #include "Ifpack_CondestType.h"
48 #include "Epetra_Object.h"
49 #include "Epetra_Operator.h"
50 #include "Teuchos_ParameterList.hpp"
51 class Epetra_RowMatrix;
52 
54 
137 
138 public:
139 
141  virtual int SetParameters(Teuchos::ParameterList& List) = 0;
142 
144  virtual int Initialize() = 0;
145 
147  virtual bool IsInitialized() const = 0;
148 
150  virtual int Compute() = 0;
151 
153  virtual bool IsComputed() const = 0;
154 
156  virtual double Condest(const Ifpack_CondestType CT = Ifpack_Cheap,
157  const int MaxIters = 1550,
158  const double Tol = 1e-9,
159  Epetra_RowMatrix* Matrix = 0) = 0;
160 
162  virtual double Condest() const = 0;
163 
165  virtual int ApplyInverse(const Epetra_MultiVector& X,
166  Epetra_MultiVector& Y) const = 0;
167 
169  virtual const Epetra_RowMatrix& Matrix() const = 0;
170 
172  virtual int NumInitialize() const = 0;
173 
175  virtual int NumCompute() const = 0;
176 
178  virtual int NumApplyInverse() const = 0;
179 
181  virtual double InitializeTime() const = 0;
182 
184  virtual double ComputeTime() const = 0;
185 
187  virtual double ApplyInverseTime() const = 0;
188 
190  virtual double InitializeFlops() const = 0;
191 
193  virtual double ComputeFlops() const = 0;
194 
196  virtual double ApplyInverseFlops() const = 0;
197 
199  virtual std::ostream& Print(std::ostream& os) const = 0;
200 
201 };
202 
203 inline std::ostream& operator<<(std::ostream& os, const Ifpack_Preconditioner& obj)
204 {
205  return(obj.Print(os));
206 }
207 
208 #endif // IFPACK_PRECONDITIONER_H
virtual int NumInitialize() const =0
Returns the number of calls to Initialize().
virtual double ComputeTime() const =0
Returns the time spent in Compute().
virtual double ComputeFlops() const =0
Returns the number of flops in the computation phase.
virtual double ApplyInverseTime() const =0
Returns the time spent in ApplyInverse().
virtual double ApplyInverseFlops() const =0
Returns the number of flops in the application of the preconditioner.
virtual const Epetra_RowMatrix & Matrix() const =0
Returns a pointer to the matrix to be preconditioned.
virtual bool IsInitialized() const =0
Returns true if the preconditioner has been successfully initialized, false otherwise.
virtual std::ostream & Print(std::ostream &os) const =0
Prints basic information on iostream. This function is used by operator&lt;&lt;.
virtual int Initialize()=0
Computes all it is necessary to initialize the preconditioner.
virtual double InitializeTime() const =0
Returns the time spent in Initialize().
Ifpack_CondestType
Ifpack_CondestType: enum to define the type of condition number estimate.
virtual int SetParameters(Teuchos::ParameterList &List)=0
Sets all parameters for the preconditioner.
virtual double Condest() const =0
Returns the computed condition number estimate, or -1.0 if not computed.
Ifpack_Preconditioner: basic class for preconditioning in Ifpack.
virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const =0
Applies the preconditioner to vector X, returns the result in Y.
std::ostream & operator<<(std::ostream &os, const Ifpack_Container &obj)
virtual double InitializeFlops() const =0
Returns the number of flops in the initialization phase.
cheap estimate
virtual int NumCompute() const =0
Returns the number of calls to Compute().
virtual bool IsComputed() const =0
Returns true if the preconditioner has been successfully computed, false otherwise.
virtual int Compute()=0
Computes all it is necessary to apply the preconditioner.
virtual int NumApplyInverse() const =0
Returns the number of calls to ApplyInverse().