Ifpack Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
Ifpack_IKLU.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_IKLU_H
44#define IFPACK_IKLU_H
45
46#include "Ifpack_ConfigDefs.h"
47#include "Ifpack_CondestType.h"
48#include "Ifpack_ScalingType.h"
50#include "Ifpack_IKLU_Utils.h"
51#include "Epetra_Vector.h"
52#include "Epetra_CrsMatrix.h"
53#include "Epetra_Time.h"
54#include "Teuchos_RefCountPtr.hpp"
55
58class Epetra_Comm;
59class Epetra_Map;
61
62namespace Teuchos {
63 class ParameterList;
64}
65
67
80
81public:
82 // @{ Constructors and Destructors
85
87 virtual ~Ifpack_IKLU();
88
89 // @}
90 // @{ Construction methods
92 /* This method is only available if the Teuchos package is enabled.
93 This method recognizes five parameter names: level_fill, drop_tolerance,
94 absolute_threshold, relative_threshold and overlap_mode. These names are
95 case insensitive. For level_fill the ParameterEntry must have type int, the
96 threshold entries must have type double and overlap_mode must have type
97 Epetra_CombineMode.
98 */
99 int SetParameters(Teuchos::ParameterList& parameterlis);
100
102
108 int Initialize();
109
111 bool IsInitialized() const
112 {
113 return(IsInitialized_);
114 }
115
117
125 int Compute();
126
128 bool IsComputed() const {return(IsComputed_);};
129
130 // Mathematical functions.
131
133
141 int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
142
143 int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
144
146 double Condest(const Ifpack_CondestType CT = Ifpack_Cheap,
147 const int MaxIters = 1550,
148 const double Tol = 1e-9,
149 Epetra_RowMatrix* Matrix_in = 0);
150
152 double Condest() const
153 {
154 return(Condest_);
155 }
156
158
167 int SetUseTranspose(bool UseTranspose_in) {UseTranspose_ = UseTranspose_in; return(0);};
168
170 double NormInf() const {return(0.0);};
171
173 bool HasNormInf() const {return(false);};
174
176 bool UseTranspose() const {return(UseTranspose_);};
177
179 const Epetra_Map & OperatorDomainMap() const {return(A_.OperatorDomainMap());};
180
182 const Epetra_Map & OperatorRangeMap() const{return(A_.OperatorRangeMap());};
183
185 const Epetra_Comm & Comm() const{return(Comm_);};
186
189 {
190 return(A_);
191 }
192
194 const Epetra_CrsMatrix & L() const {return(*L_);};
195
197 const Epetra_CrsMatrix & U() const {return(*U_);};
198
200 const char* Label() const
201 {
202 return(Label_.c_str());
203 }
204
206 int SetLabel(const char* Label_in)
207 {
208 Label_ = Label_in;
209 return(0);
210 }
211
213 virtual std::ostream& Print(std::ostream& os) const;
214
216 virtual int NumInitialize() const
217 {
218 return(NumInitialize_);
219 }
220
222 virtual int NumCompute() const
223 {
224 return(NumCompute_);
225 }
226
228 virtual int NumApplyInverse() const
229 {
230 return(NumApplyInverse_);
231 }
232
234 virtual double InitializeTime() const
235 {
236 return(InitializeTime_);
237 }
238
240 virtual double ComputeTime() const
241 {
242 return(ComputeTime_);
243 }
244
246 virtual double ApplyInverseTime() const
247 {
248 return(ApplyInverseTime_);
249 }
250
252 virtual double InitializeFlops() const
253 {
254 return(0.0);
255 }
256
257 virtual double ComputeFlops() const
258 {
259 return(ComputeFlops_);
260 }
261
262 virtual double ApplyInverseFlops() const
263 {
264 return(ApplyInverseFlops_);
265 }
266
267 inline double LevelOfFill() const {
268 return(LevelOfFill_);
269 }
270
272 inline double RelaxValue() const {
273 return(Relax_);
274 }
275
277 inline double AbsoluteThreshold() const
278 {
279 return(Athresh_);
280 }
281
283 inline double RelativeThreshold() const
284 {
285 return(Rthresh_);
286 }
287
289 inline double DropTolerance() const
290 {
291 return(DropTolerance_);
292 }
293
295#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
296 int NumGlobalNonzeros() const {
297 // FIXME: diagonal of L_ should not be stored
298 return(L().NumGlobalNonzeros() + U().NumGlobalNonzeros() - L().NumGlobalRows());
299 }
300#endif
301 long long NumGlobalNonzeros64() const {
302 // FIXME: diagonal of L_ should not be stored
303 return(L().NumGlobalNonzeros64() + U().NumGlobalNonzeros64() - L().NumGlobalRows64());
304 }
305
307 int NumMyNonzeros() const {
308 return(L().NumMyNonzeros() + U().NumMyNonzeros());
309 }
310
311private:
312
313 // @}
314 // @{ Internal methods
315
318 A_(RHS.Matrix()),
319 Comm_(RHS.Comm()),
320 Time_(Comm())
321 {};
322
325 {
326 return(*this);
327 }
328
330 void Destroy();
331
332 // @}
333 // @{ Internal data
334
340 Teuchos::RefCountPtr<Epetra_CrsMatrix> L_;
342 Teuchos::RefCountPtr<Epetra_CrsMatrix> U_;
344 double Condest_;
346 double Relax_;
348 double Athresh_;
350 double Rthresh_;
356 std::string Label_;
372 mutable int NumApplyInverse_;
378 mutable double ApplyInverseTime_;
382 mutable double ApplyInverseFlops_;
387 Teuchos::RefCountPtr<Epetra_SerialComm> SerialComm_;
388 Teuchos::RefCountPtr<Epetra_Map> SerialMap_;
389
395
396}; // Ifpack_IKLU
397
398#endif /* IFPACK_IKLU_H */
Ifpack_CondestType
Ifpack_CondestType: enum to define the type of condition number estimate.
@ Ifpack_Cheap
cheap estimate
Ifpack_ScalingType enumerable type.
#define RHS(a)
Definition MatGenFD.c:60
Ifpack_IKLU: A class for constructing and using an incomplete LU factorization of a given Epetra_RowM...
Definition Ifpack_IKLU.h:79
int NumMyRows_
Number of local rows.
int NumMyNonzeros_
Number of local nonzeros.
double Condest_
Condition number estimate.
double DropTolerance_
Discards all elements below this tolerance.
Teuchos::RefCountPtr< Epetra_CrsMatrix > U_
U factor.
virtual double ApplyInverseTime() const
Returns the time spent in ApplyInverse().
csrn * csrnN_
Container for the L and U factor.
Ifpack_IKLU(const Ifpack_IKLU &RHS)
Copy constructor (should never be used)
bool IsInitialized() const
Returns true if the preconditioner has been successfully initialized.
virtual int NumCompute() const
Returns the number of calls to Compute().
long long NumGlobalNonzeros64() const
double DropTolerance() const
Gets the dropping tolerance.
virtual ~Ifpack_IKLU()
Ifpack_IKLU Destructor.
int SetUseTranspose(bool UseTranspose_in)
If set true, transpose of this operator will be applied.
const Epetra_RowMatrix & A_
reference to the matrix to be preconditioned.
bool IsComputed() const
If factor is completed, this query returns true, otherwise it returns false.
csr * csrA_
Containers for the matrix storage and permutation.
int Compute()
Compute IC factor U using the specified graph, diagonal perturbation thresholds and relaxation parame...
int NumApplyInverse_
Contains the number of successful call to ApplyInverse().
int SetParameters(Teuchos::ParameterList &parameterlis)
Set parameters using a Teuchos::ParameterList object.
double ComputeFlops_
Contains the number of flops for Compute().
int NumCompute_
Contains the number of successful call to Compute().
bool IsComputed_
true if this object has been computed
const Epetra_RowMatrix & Matrix() const
Returns a reference to the matrix to be preconditioned.
Epetra_Time Time_
Used for timing purposed.
const char * Label() const
Returns the label of this object.
double ComputeTime_
Contains the time for all successful calls to Compute().
bool IsInitialized_
true if this object has been initialized
int NumGlobalNonzeros() const
Returns the number of nonzero entries in the global graph.
virtual int NumInitialize() const
Returns the number of calls to Initialize().
int NumInitialize_
Contains the number of successful calls to Initialize().
double Athresh_
Absolute threshold.
bool HasNormInf() const
Returns false because this class cannot compute an Inf-norm.
double AbsoluteThreshold() const
Get absolute threshold value.
int NumMyNonzeros() const
Returns the number of nonzero entries in the local graph.
Ifpack_IKLU(const Epetra_RowMatrix *A)
Ifpack_IKLU constuctor with variable number of indices per row.
double NormInf() const
Returns 0.0 because this class cannot compute Inf-norm.
void Destroy()
Releases all allocated memory.
virtual double ComputeFlops() const
Returns the number of flops in the computation phase.
double RelativeThreshold() const
Get relative threshold value.
bool UseTranspose_
true if transpose has to be used.
Teuchos::RefCountPtr< Epetra_Map > SerialMap_
Teuchos::RefCountPtr< Epetra_SerialComm > SerialComm_
virtual double InitializeTime() const
Returns the time spent in Initialize().
bool UseTranspose() const
Returns the current UseTranspose setting.
double Condest() const
Returns the computed estimated condition number, or -1.0 if no computed.
virtual double ComputeTime() const
Returns the time spent in Compute().
double Relax_
relaxation value
int Initialize()
Initialize L and U with values from user matrix A.
double InitializeTime_
Contains the time for all successful calls to Initialize().
const Epetra_CrsMatrix & L() const
Returns a reference to the L factor.
std::string Label_
Label for this object.
Teuchos::RefCountPtr< Epetra_CrsMatrix > L_
L factor.
const Epetra_CrsMatrix & U() const
Returns a reference to the U factor.
double RelaxValue() const
Set relative threshold value.
const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this operator.
virtual int NumApplyInverse() const
Returns the number of calls to ApplyInverse().
const Epetra_Comm & Comm_
Reference to the communicator object.
const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this operator.
Ifpack_IKLU & operator=(const Ifpack_IKLU &)
operator= (should never be used)
double ApplyInverseTime_
Contains the time for all successful calls to ApplyInverse().
long long GlobalNonzeros_
Global number of nonzeros in L and U factors.
int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Ifpack_IKLU forward/back solve on a Epetra_MultiVector X in Y.
double ApplyInverseFlops_
Contain sthe number of flops for ApplyInverse().
double LevelOfFill_
Level-of-fill.
virtual double InitializeFlops() const
Returns the number of flops in the initialization phase.
const Epetra_Comm & Comm() const
Returns the Epetra_BlockMap object associated with the range of this matrix operator.
virtual std::ostream & Print(std::ostream &os) const
Prints basic information on iostream. This function is used by operator<<.
double LevelOfFill() const
double Rthresh_
Relative threshold.
int SetLabel(const char *Label_in)
Sets the label for this object.
virtual double ApplyInverseFlops() const
Returns the number of flops in the application of the preconditioner.
Ifpack_Preconditioner: basic class for preconditioning in Ifpack.