Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_ScaledAdjointLinearOpBase_decl.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_SCALED_ADJOINT_LINEAR_OP_BASE_DECL_HPP
43#define THYRA_SCALED_ADJOINT_LINEAR_OP_BASE_DECL_HPP
44
45#include "Thyra_LinearOpBase.hpp"
46
47
48namespace Thyra {
49
50
72template<class Scalar>
73class ScaledAdjointLinearOpBase : virtual public LinearOpBase<Scalar> {
74public:
75
76#ifdef THYRA_INJECT_USING_DECLARATIONS
77 using LinearOpBase<Scalar>::apply;
78#endif
79
82
85 virtual Scalar overallScalar() const = 0;
86
89 virtual EOpTransp overallTransp() const = 0;
90
97
101
103
104};
105
106
141template<class Scalar>
142void unwrap(
143 const LinearOpBase<Scalar> &Op,
144 Scalar *scalar,
145 EOpTransp *transp,
146 const LinearOpBase<Scalar>* *origOp
147 );
148
149
185template<class Scalar>
186void unwrap(
187 const RCP<const LinearOpBase<Scalar> > &Op,
188 Scalar *scalar,
189 EOpTransp *transp,
190 RCP<const LinearOpBase<Scalar> > *origOp
191 );
192
193
194} // namespace Thyra
195
196
197#endif // THYRA_SCALED_ADJOINT_LINEAR_OP_BASE_DECL_HPP
Base class for all linear operators.
void apply(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
Apply the linear operator to a multi-vector : Y = alpha*op(M)*X + beta*Y.
Base class for LinearOpBase decorator subclasses that wrap a LinearOpBase object and adds on an extra...
virtual Scalar overallScalar() const =0
Return the overall scale factor.
virtual RCP< const LinearOpBase< Scalar > > getOrigOp() const =0
Return the const original linear operator origOp.
virtual RCP< LinearOpBase< Scalar > > getNonconstOrigOp()=0
Return the non-const original linear operator origOp.
virtual EOpTransp overallTransp() const =0
Return the overall transpose (adjoint) enum.
void unwrap(const LinearOpBase< Scalar > &Op, Scalar *scalar, EOpTransp *transp, const LinearOpBase< Scalar > **origOp)
Extract the overallScalar, overallTransp and const origOp from a const LinearOpBase object.
EOpTransp
Enumeration for determining how a linear operator is applied. `*.