Thyra
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
core
src
interfaces
operator_vector
extended
Thyra_ScaledAdjointLinearOpBase_def.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_HPP
43
#define THYRA_SCALED_ADJOINT_LINEAR_OP_BASE_HPP
44
45
#include "Thyra_ScaledAdjointLinearOpBase_decl.hpp"
46
#include "Thyra_LinearOpBase.hpp"
47
48
49
template
<
class
Scalar>
50
void
Thyra::unwrap
(
51
const
LinearOpBase<Scalar>
&Op,
52
Scalar *scalar,
53
EOpTransp *transp,
54
const
LinearOpBase<Scalar>
* *origOp
55
)
56
{
57
#ifdef TEUCHOS_DEBUG
58
TEUCHOS_TEST_FOR_EXCEPT
( scalar==NULL );
59
TEUCHOS_TEST_FOR_EXCEPT
( transp==NULL );
60
TEUCHOS_TEST_FOR_EXCEPT
( origOp==NULL );
61
#endif
62
typedef
Teuchos::ScalarTraits<Scalar>
ST;
63
const
ScaledAdjointLinearOpBase<Scalar>
64
*saOp =
dynamic_cast<
const
ScaledAdjointLinearOpBase<Scalar>
*
>
(&Op);
65
if
(saOp) {
66
*scalar = saOp->
overallScalar
();
67
*transp = saOp->
overallTransp
();
68
*origOp = &*saOp->
getOrigOp
();
69
}
70
else
{
71
*scalar = ST::one();
72
*transp =
NOTRANS
;
73
*origOp = &Op;
74
}
75
}
76
77
78
template
<
class
Scalar>
79
void
Thyra::unwrap
(
80
const
RCP<
const
LinearOpBase<Scalar> > &Op,
81
Scalar *scalar,
82
EOpTransp *transp,
83
RCP<
const
LinearOpBase<Scalar> > *origOp
84
)
85
{
86
#ifdef TEUCHOS_DEBUG
87
TEUCHOS_TEST_FOR_EXCEPT
( scalar==NULL );
88
TEUCHOS_TEST_FOR_EXCEPT
( transp==NULL );
89
TEUCHOS_TEST_FOR_EXCEPT
( origOp==NULL );
90
#endif
91
typedef
Teuchos::ScalarTraits<Scalar>
ST;
92
RCP<const ScaledAdjointLinearOpBase<Scalar> >
93
saOp = Teuchos::rcp_dynamic_cast<const ScaledAdjointLinearOpBase<Scalar> >(Op);
94
if
(saOp.get()) {
95
*scalar = saOp->overallScalar();
96
*transp = saOp->overallTransp();
97
*origOp = saOp->getOrigOp();
98
}
99
else
{
100
*scalar = ST::one();
101
*transp =
NOTRANS
;
102
*origOp = Op;
103
}
104
}
105
106
107
//
108
// Explicit instant macro
109
//
110
111
#define THYRA_SCALED_ADJOINT_LINEAR_OP_BASE_INSTANT(SCALAR) \
112
\
113
template void unwrap( \
114
const LinearOpBase<SCALAR > &Op, \
115
SCALAR *scalar, \
116
EOpTransp *transp, \
117
const LinearOpBase<SCALAR >* *origOp \
118
); \
119
\
120
template void unwrap( \
121
const RCP<const LinearOpBase<SCALAR > > &Op, \
122
SCALAR *scalar, \
123
EOpTransp *transp, \
124
RCP<const LinearOpBase<SCALAR > > *origOp \
125
);
126
127
128
#endif
// THYRA_SCALED_ADJOINT_LINEAR_OP_BASE_HPP
Thyra::LinearOpBase
Base class for all linear operators.
Definition
Thyra_LinearOpBase_decl.hpp:191
Thyra::ScaledAdjointLinearOpBase
Base class for LinearOpBase decorator subclasses that wrap a LinearOpBase object and adds on an extra...
Definition
Thyra_ScaledAdjointLinearOpBase_decl.hpp:73
Thyra::ScaledAdjointLinearOpBase::overallScalar
virtual Scalar overallScalar() const =0
Return the overall scale factor.
Thyra::ScaledAdjointLinearOpBase::getOrigOp
virtual RCP< const LinearOpBase< Scalar > > getOrigOp() const =0
Return the const original linear operator origOp.
Thyra::ScaledAdjointLinearOpBase::overallTransp
virtual EOpTransp overallTransp() const =0
Return the overall transpose (adjoint) enum.
TEUCHOS_TEST_FOR_EXCEPT
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
Thyra::unwrap
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.
Definition
Thyra_ScaledAdjointLinearOpBase_def.hpp:50
Thyra::NOTRANS
NOTRANS
Type for the dimension of a vector space. `**/ typedef Teuchos::Ordinal Ordinal;.
Definition
Thyra_OperatorVectorTypes.hpp:162
Teuchos::ScalarTraits
Generated by
1.17.0