FEI Version of the Day
fei_Solver_AztecOO.hpp
00001 /*
00002 // @HEADER
00003 // ************************************************************************
00004 //             FEI: Finite Element Interface to Linear Solvers
00005 //                  Copyright (2005) Sandia Corporation.
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the
00008 // U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Alan Williams (william@sandia.gov) 
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 */
00042 
00043 #ifndef _fei_Solver_AztecOO_h_
00044 #define _fei_Solver_AztecOO_h_
00045 
00046 
00047 #include <fei_trilinos_macros.hpp>
00048 
00049 #ifdef HAVE_FEI_AZTECOO
00050 
00051 #include <fei_macros.hpp>
00052 #include <fei_Solver.hpp>
00053 #include <fei_Logger.hpp>
00054 
00055 #ifdef HAVE_FEI_TEUCHOS
00056 namespace Teuchos {
00057   class ParameterList;
00058 }
00059 #endif
00060 
00061 class AztecOO;
00062 class Epetra_CrsMatrix;
00063 
00064 #ifdef HAVE_FEI_ML
00065 #include <ml_include.h>
00066 #include <ml_epetra_preconditioner.h>
00067 #endif
00068 
00071 class Solver_AztecOO : public fei::Solver, private fei::Logger {
00072  public:
00076   Solver_AztecOO();
00077 
00080   virtual ~Solver_AztecOO();
00081 
00096   int solve(fei::LinearSystem* linearSystem,
00097       fei::Matrix* preconditioningMatrix,
00098       int numParams,
00099       const char* const* solverParams,
00100       int& iterationsTaken,
00101       int& status);
00102 
00119   int solve(fei::LinearSystem* linearSystem,
00120       fei::Matrix* preconditioningMatrix,
00121       const fei::ParameterSet& parameterSet,
00122       int& iterationsTaken,
00123       int& status);
00124 
00125   AztecOO& getAztecOO();
00126 
00127   Teuchos::ParameterList& get_ParameterList();
00128 
00129   void setMaxIters(int maxits) {maxIters_ = maxits;}
00130   void setTolerance(double tol) {tolerance_ = tol;}
00131   void setUseTranspose(bool useTrans) {useTranspose_ = useTrans;}
00132 
00133   void setUseML(bool useml);
00134 
00135  private:
00136   int setup_ml_operator(AztecOO& azoo, Epetra_CrsMatrix* A);
00137 
00138  private:
00139   AztecOO* azoo_;
00140   double tolerance_;
00141   int maxIters_;
00142   bool useTranspose_;
00143   Teuchos::ParameterList* paramlist_;
00144 
00145   bool useML_;
00146 #ifdef HAVE_FEI_ML
00147   ML_Epetra::MultiLevelPreconditioner* ml_prec_;
00148   bool ml_defaults_set_;
00149   int *ml_aztec_options_;
00150   double *ml_aztec_params_;
00151 #endif
00152 
00153   std::string name_;
00154   std::string dbgprefix_;
00155 }; //class Solver_AztecOO
00156 
00157 #endif // HAVE_FEI_AZTECOO
00158 
00159 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends