Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_TpetraLinearOp_decl.hpp
1// @HEADER
2// *****************************************************************************
3// Thyra: Interfaces and Support for Abstract Numerical Algorithms
4//
5// Copyright 2004 NTESS and the Thyra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef THYRA_TPETRA_LINEAR_OP_DECL_HPP
11#define THYRA_TPETRA_LINEAR_OP_DECL_HPP
12
13#include "Thyra_LinearOpDefaultBase.hpp"
14#include "Thyra_TpetraVectorSpace_decl.hpp"
15#include "Thyra_ScaledLinearOpBase.hpp"
16#include "Thyra_RowStatLinearOpBase.hpp"
17#include "Tpetra_Operator.hpp"
18#include "Tpetra_CrsMatrix.hpp"
19#include "Teuchos_ConstNonconstObjectContainer.hpp"
20
21#if defined(HAVE_THYRA_EPETRA) && defined(HAVE_TPETRA_EPETRA)
22# define HAVE_THYRA_TPETRA_EPETRA
23#endif
24
25#ifdef HAVE_THYRA_TPETRA_EPETRA
26# include "Thyra_EpetraLinearOpBase.hpp"
27# include "Tpetra_EpetraRowMatrix.hpp"
28#endif
29
30
31namespace Thyra {
32
33
40template <class Scalar, class LocalOrdinal, class GlobalOrdinal=LocalOrdinal,
41 class Node=Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
43 : virtual public Thyra::LinearOpDefaultBase<Scalar>,
44 virtual public ScaledLinearOpBase<Scalar>,
45 virtual public Thyra::RowStatLinearOpBase<Scalar>
46#ifdef HAVE_THYRA_TPETRA_EPETRA
47 , virtual public EpetraLinearOpBase
48#endif
49{
50public:
51
54
57
59
61 void initialize(
62 const RCP<const VectorSpaceBase<Scalar> > &rangeSpace,
63 const RCP<const VectorSpaceBase<Scalar> > &domainSpace,
64 const RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator
65 );
66
68 void constInitialize(
69 const RCP<const VectorSpaceBase<Scalar> > &rangeSpace,
70 const RCP<const VectorSpaceBase<Scalar> > &domainSpace,
71 const RCP<const Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator
72 );
73
77
81
83
86
89
92
94
95#ifdef HAVE_THYRA_TPETRA_EPETRA
96
99
101 void getNonconstEpetraOpView(
102 const Ptr<RCP<Epetra_Operator> > &epetraOp,
103 const Ptr<EOpTransp> &epetraOpTransp,
104 const Ptr<EApplyEpetraOpAs> &epetraOpApplyAs,
105 const Ptr<EAdjointEpetraOp> &epetraOpAdjointSupport
106 );
108 void getEpetraOpView(
109 const Ptr<RCP<const Epetra_Operator> > &epetraOp,
110 const Ptr<EOpTransp> &epetraOpTransp,
111 const Ptr<EApplyEpetraOpAs> &epetraOpApplyAs,
112 const Ptr<EAdjointEpetraOp> &epetraOpAdjointSupport
113 ) const;
114
116
117#endif // HAVE_THYRA_TPETRA_EPETRA
118
119protected:
120
123
125 bool opSupportedImpl(Thyra::EOpTransp M_trans) const;
126
128 void applyImpl(
129 const Thyra::EOpTransp M_trans,
132 const Scalar alpha,
133 const Scalar beta
134 ) const;
135
137
140
142 virtual bool supportsScaleLeftImpl() const;
143
145 virtual bool supportsScaleRightImpl() const;
146
148 virtual void scaleLeftImpl(const VectorBase<Scalar> &row_scaling);
149
151 virtual void scaleRightImpl(const VectorBase<Scalar> &col_scaling);
152
154
157
159 virtual bool rowStatIsSupportedImpl(
160 const RowStatLinearOpBaseUtils::ERowStat rowStat) const;
161
163 virtual void getRowStatImpl(
164 const RowStatLinearOpBaseUtils::ERowStat rowStat,
165 const Ptr<VectorBase<Scalar> > &rowStatVec) const;
166
168
169private:
170
172 rangeSpace_;
173
175 domainSpace_;
176
178 tpetraOperator_;
179
180#ifdef HAVE_THYRA_TPETRA_EPETRA
181 mutable RCP<Epetra_Operator> epetraOp_;
182#endif
183
184 template<class TpetraOperator_t>
185 void initializeImpl(
186 const RCP<const VectorSpaceBase<Scalar> > &rangeSpace,
187 const RCP<const VectorSpaceBase<Scalar> > &domainSpace,
188 const RCP<TpetraOperator_t> &tpetraOperator
189 );
190
191};
192
193
198template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
200tpetraLinearOp(
201 const RCP<const VectorSpaceBase<Scalar> > &rangeSpace,
202 const RCP<const VectorSpaceBase<Scalar> > &domainSpace,
203 const RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator);
204
205
210template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
212constTpetraLinearOp(
213 const RCP<const VectorSpaceBase<Scalar> > &rangeSpace,
214 const RCP<const VectorSpaceBase<Scalar> > &domainSpace,
215 const RCP<const Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator);
216
217
218} // namespace Thyra
219
220
221#endif // THYRA_TPETRA_LINEAR_OP_DECL_HPP
Node subclass that provides a good default implementation for the describe() function.
Interface for a collection of column vectors called a multi-vector.
Interface for exxtracting row statistics as a VectorBase from a supporting LinearOpBase object.
Applies left or right sclaing to the linear operator.
Concrete Thyra::LinearOpBase subclass for Tpetra::Operator.
virtual bool rowStatIsSupportedImpl(const RowStatLinearOpBaseUtils::ERowStat rowStat) const
void applyImpl(const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase< Scalar > &X_in, const Teuchos::Ptr< Thyra::MultiVectorBase< Scalar > > &Y_inout, const Scalar alpha, const Scalar beta) const
bool opSupportedImpl(Thyra::EOpTransp M_trans) const
virtual bool supportsScaleLeftImpl() const
RCP< const Thyra::VectorSpaceBase< Scalar > > range() const
TpetraLinearOp()
Construct to uninitialized.
virtual void getRowStatImpl(const RowStatLinearOpBaseUtils::ERowStat rowStat, const Ptr< VectorBase< Scalar > > &rowStatVec) const
virtual void scaleLeftImpl(const VectorBase< Scalar > &row_scaling)
virtual void scaleRightImpl(const VectorBase< Scalar > &col_scaling)
void initialize(const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
Initialize.
RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraOperator() const
Get embedded const Tpetra::Operator.
void constInitialize(const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
Initialize.
virtual bool supportsScaleRightImpl() const
RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraOperator()
Get embedded non-const Tpetra::Operator.
RCP< const Thyra::VectorSpaceBase< Scalar > > domain() const
Abstract interface for finite-dimensional dense vectors.
Abstract interface for objects that represent a space for vectors.
EOpTransp
Enumeration for determining how a linear operator is applied. `*.