Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Trilinos_Details_LinearSolver.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) 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#ifndef TRILINOS_DETAILS_LINEARSOLVER_HPP
43#define TRILINOS_DETAILS_LINEARSOLVER_HPP
44
55
56#include "TeuchosRemainder_config.h"
57#include "Teuchos_RCP.hpp"
58
59namespace Teuchos {
60 // Forward declaration of ParameterList. If you actually want to
61 // _use_ ParameterList, you MUST include Teuchos_ParameterList.hpp.
62 class ParameterList;
63} // namespace Teuchos
64
67namespace Trilinos {
68
75namespace Details {
76
145template<class MV, class OP, class NormType>
147public:
149 virtual ~LinearSolver () {}
150
176 virtual void setMatrix (const Teuchos::RCP<const OP>& A) = 0;
177
187 virtual Teuchos::RCP<const OP> getMatrix () const = 0;
188
203 virtual void solve (MV& X, const MV& B) = 0;
204
227 virtual void setParameters (const Teuchos::RCP<Teuchos::ParameterList>& params) = 0;
228
246 virtual void symbolic () = 0;
247
261 virtual void numeric () = 0;
262};
263
264} // namespace Details
265} // namespace Trilinos
266
267#endif // TRILINOS_DETAILS_LINEARSOLVER_HPP
Reference-counted pointer class and non-member templated function implementations.
Smart reference counting pointer class for automatic garbage collection.
Interface for a method for solving linear system(s) AX=B.
virtual void numeric()=0
Set up any part of the solve that depends on both the structure and the numerical values of the input...
virtual void symbolic()=0
Set up any part of the solve that depends on the structure of the input matrix, but not its numerical...
virtual void setMatrix(const Teuchos::RCP< const OP > &A)=0
Set the solver's matrix.
virtual void solve(MV &X, const MV &B)=0
Solve the linear system(s) AX=B.
virtual Teuchos::RCP< const OP > getMatrix() const =0
Get a pointer to this solver's matrix.
virtual ~LinearSolver()
Destructor (virtual for memory safety of derived classes).
virtual void setParameters(const Teuchos::RCP< Teuchos::ParameterList > &params)=0
Set this solver's parameters.
Namespace of implementation details.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Namespace of things generally useful to many Trilinos packages.