Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_PreconditionerBase.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Thyra: Interfaces and Support for Abstract Numerical Algorithms
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 Roscoe A. Bartlett (bartlettra@ornl.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef THYRA_PRECONDITIONER_BASE_HPP
43#define THYRA_PRECONDITIONER_BASE_HPP
44
45#include "Thyra_OperatorSolveTypes.hpp"
46#include "Teuchos_Describable.hpp"
47
48
49namespace Thyra {
50
51
88template<class Scalar>
90{
91public:
92
95
99 virtual bool isLeftPrecOpConst() const = 0;
100
109
114
118 virtual bool isRightPrecOpConst() const = 0;
119
128
133
137 virtual bool isUnspecifiedPrecOpConst() const = 0;
138
143
152
154
155private:
156
157 // Not defined and not to be called
159 operator=(const PreconditionerBase<Scalar>&);
160
161};
162
163
164} // namespace Thyra
165
166
167#endif // THYRA_PRECONDITIONER_BASE_HPP
Simple interface class to access a precreated preconditioner as one or more linear operators objects ...
virtual Teuchos::RCP< LinearOpBase< Scalar > > getNonconstLeftPrecOp()=0
Return a non-const left preconditioner linear operator if one is designed or targeted to be applied o...
virtual Teuchos::RCP< const LinearOpBase< Scalar > > getUnspecifiedPrecOp() const =0
Return a const generic preconditioner linear operator that is not designed or targeted to be applied ...
virtual bool isLeftPrecOpConst() const =0
Return if the underlying left preconditioner operator is const-only or allows non-const access.
virtual Teuchos::RCP< const LinearOpBase< Scalar > > getLeftPrecOp() const =0
Return a const left preconditioner linear operator if one is designed or targeted to be applied on th...
virtual Teuchos::RCP< LinearOpBase< Scalar > > getNonconstUnspecifiedPrecOp()=0
Return a non-const generic preconditioner linear operator that is not designed or targeted to be appl...
virtual bool isRightPrecOpConst() const =0
Return if the underlying right preconditioner operator is const-only or allows non-const access.
virtual Teuchos::RCP< LinearOpBase< Scalar > > getNonconstRightPrecOp()=0
Return a non-const right preconditioner linear operator if one is designed or targeted to be applied ...
virtual Teuchos::RCP< const LinearOpBase< Scalar > > getRightPrecOp() const =0
Return a const right preconditioner linear operator if one is designed or targeted to be applied on t...
virtual bool isUnspecifiedPrecOpConst() const =0
Return if the underlying unspecified preconditioner operator is const-only or allows non-const access...