Ifpack_CrsIlut.h

00001 /*@HEADER
00002 // ***********************************************************************
00003 // 
00004 //       Ifpack: Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2002) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 //@HEADER
00028 */
00029 
00030 #ifndef IFPACK_CRSILUT_H
00031 #define IFPACK_CRSILUT_H
00032 
00033 #include "Ifpack_ConfigDefs.h"
00034 #include "Ifpack_ScalingType.h"
00035 #include "Ifpack_OverlapGraph.h"
00036 #include "Ifpack_OverlapFactorObject.h"
00037 #include "Ifpack_OverlapSolveObject.h"
00038 #include "Epetra_CompObject.h"
00039 #include "Epetra_CrsMatrix.h"
00040 #include "Epetra_Object.h"
00041 class Epetra_Comm;
00042 class Epetra_Map;
00043 class Epetra_RowMatrix;
00044 class Epetra_Vector;
00045 class Epetra_MultiVector;
00046 
00048 
00049 
00050 
00051 class Ifpack_CrsIlut: public Epetra_Object, public Epetra_CompObject, public Ifpack_OverlapFactorObject, public Ifpack_OverlapSolveObject {
00052   
00053  public:
00055 
00057 
00063   Ifpack_CrsIlut(const Ifpack_OverlapGraph * OverlapGraph, double DropTol = 1.0E-4, 
00064          double FillTol = 1.0);
00065 
00067 
00074   Ifpack_CrsIlut(const Epetra_RowMatrix * UserMatrix, double DropTol = 1.0E-4, 
00075          double FillTol = 1.0);
00076   
00078   Ifpack_CrsIlut(const Ifpack_CrsIlut & Source);
00079   
00081   virtual ~Ifpack_CrsIlut();
00083 
00085 
00087   int SetDropTol(double DropTol) {DropTol_ = DropTol; return(0);};
00088 
00090   int SetFillTol(double FillTol) {FillTol_ = FillTol; return(0);};
00091 
00092 #ifdef HAVE_IFPACK_TEUCHOS
00093 
00094   /* This method is only available if the Teuchos package is enabled.
00095      This method recognizes two parameter names: drop_tolerance and
00096      fill_tolerance. These names are case insensitive. For both, the
00097      ParameterEntry must have type double.
00098   */
00099   int SetParameters(const Teuchos::ParameterList& parameterlist,
00100                     bool cerr_warning_if_unused=false);
00101 #endif
00102 
00103   
00105 
00107   double DropTol() const {return(DropTol_);};
00108 
00110   double FillTol() const {return(FillTol_);};
00112   
00113  protected:
00115 
00117   int ProcessOverlapMatrix(const Epetra_RowMatrix &A);
00119   int DerivedFactor();
00121 
00122  private:
00123 
00124  double DropTol_;
00125  double FillTol_;
00126 
00127 };
00128 
00129 #endif /* IFPACK_CRSILUT_H */

Generated on Thu Sep 18 12:37:07 2008 for IFPACK by doxygen 1.3.9.1