ShyLU  Version of the Day
IQRSolver.h
Go to the documentation of this file.
1 //@HEADER
2 // ************************************************************************
3 //
4 // ShyLU: Hybrid preconditioner package
5 // Copyright 2012 Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
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 
50 #ifndef IQRSOLVER_H_
51 #define IQRSOLVER_H_
52 
53 #include <vector>
54 
55 #include <Epetra_BlockMap.h>
56 #include <Epetra_MultiVector.h>
57 #include <Epetra_Operator.h>
58 
59 #include <shylu_internal_gmres_tools.h>
60 #include <shylu_internal_gmres.h>
61 
62 #include <Ifpack_Preconditioner.h>
63 
65 #include <Teuchos_RCP.hpp>
66 
67 #include <shylu_probing_operator.h>
68 
69 namespace IQR {
70 
71 class IQRSolver {
72 public:
73  // Public type definitions
74  typedef IQR::GMRESManager<Epetra_BlockMap,
75  Epetra_MultiVector,
76  std::vector<std::vector<double> >,
77  std::vector<double> > GMRESStateManager;
78 
79  // Public constructor and destructor
80  IQRSolver(const Teuchos::ParameterList& pList);
81  virtual ~IQRSolver();
82 
83  // Public methods
84  int Solve(const ShyLU_Probing_Operator& S,
85  const Epetra_MultiVector& B,
86  Epetra_MultiVector & X);
87 
88 private:
89  // Private methods
90  int Compute(const ShyLU_Probing_Operator& S,
91  const Epetra_MultiVector& B,
92  Epetra_MultiVector & X);
93 
94  // Private data
95  Teuchos::RCP<GMRESStateManager> gmresStateManager_;
97  bool isComputed_;
98  double krylovDim_;
99  int numIter_;
100  bool doScaling_;
101  bool useFullIQR_;
102  std::string precType_;
103  std::string precAmesosType_;
104 };
105 
106 } /* namespace IQR */
107 
108 #endif /* IQRSOLVER_H_ */