Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_Details_LinearSolver_decl.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) 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 
46 
47 #ifndef IFPACK2_DETAILS_LINEARSOLVER_DECL_HPP
48 #define IFPACK2_DETAILS_LINEARSOLVER_DECL_HPP
49 
50 #include "Ifpack2_ConfigDefs.hpp"
53 #include "Teuchos_Describable.hpp"
54 
55 namespace Ifpack2 {
56 namespace Details {
57 
104 template<class SC, class LO, class GO, class NT>
106  public Trilinos::Details::LinearSolver<Tpetra::MultiVector<SC, LO, GO, NT>,
107  Tpetra::Operator<SC, LO, GO, NT>,
108  typename Tpetra::MultiVector<SC, LO, GO, NT>::mag_type>,
109  virtual public Teuchos::Describable
110 {
111 public:
113  typedef Tpetra::Operator<SC, LO, GO, NT> OP;
114  typedef Tpetra::MultiVector<SC, LO, GO, NT> MV;
115 
127  LinearSolver (const Teuchos::RCP<prec_type>& solver, const std::string& solverName);
128 
130  virtual ~LinearSolver () {}
131 
136  void setMatrix (const Teuchos::RCP<const OP>& A);
137 
140 
142  void solve (MV& X, const MV& B);
143 
146 
148  void symbolic ();
149 
151  void numeric ();
152 
154  std::string description () const;
155 
157  void
159  const Teuchos::EVerbosityLevel verbLevel =
161 
162 private:
164  Teuchos::RCP<prec_type> solver_;
166  std::string solverName_;
169 };
170 
171 } // namespace Details
172 } // namespace Ifpack2
173 
174 #endif // IFPACK2_DETAILS_LINEARSOLVER_DECL_HPP
virtual ~LinearSolver()
Destructor (virtual for memory safety).
Definition: Ifpack2_Details_LinearSolver_decl.hpp:130
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:68
void solve(MV &X, const MV &B)
Solve the linear system AX=B for X.
Definition: Ifpack2_Details_LinearSolver_def.hpp:135
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Implementation of Teuchos::Describable::describe.
Definition: Ifpack2_Details_LinearSolver_def.hpp:207
Teuchos::RCP< const OP > getMatrix() const
Get the solver&#39;s matrix.
Definition: Ifpack2_Details_LinearSolver_def.hpp:128
void symbolic()
Precompute for matrix structure changes.
Definition: Ifpack2_Details_LinearSolver_def.hpp:160
void setMatrix(const Teuchos::RCP< const OP > &A)
Set the solver&#39;s matrix.
Definition: Ifpack2_Details_LinearSolver_def.hpp:89
Ifpack2&#39;s implementation of Trilinos::Details::LinearSolver interface.
Definition: Ifpack2_Details_LinearSolver_decl.hpp:105
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
void setParameters(const Teuchos::RCP< Teuchos::ParameterList > &params)
Set the solver&#39;s parameters.
Definition: Ifpack2_Details_LinearSolver_def.hpp:152
void numeric()
Precompute for matrix values&#39; changes.
Definition: Ifpack2_Details_LinearSolver_def.hpp:177
static const EVerbosityLevel verbLevel_default
std::string description() const
Implementation of Teuchos::Describable::description.
Definition: Ifpack2_Details_LinearSolver_def.hpp:194
LinearSolver(const Teuchos::RCP< prec_type > &solver, const std::string &solverName)
Constructor.
Definition: Ifpack2_Details_LinearSolver_def.hpp:67