Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_TpetraThyraWrappers_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_TPETRA_THYRA_WRAPPERS_HPP
43#define THYRA_TPETRA_THYRA_WRAPPERS_HPP
44
45
46#include "Thyra_TpetraThyraWrappers.hpp"
47#include "Thyra_TpetraVectorSpace.hpp"
48#include "Thyra_TpetraVector.hpp"
49#include "Thyra_TpetraMultiVector.hpp"
50#include "Thyra_TpetraLinearOp.hpp"
51
52
53namespace Thyra {
54
55
56template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
58getOrCreateTpetraVectorSpace(
59 const RCP<const VectorSpaceBase<Scalar> > space,
60 const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > &tpetraMap
61 )
62{
63 using Teuchos::rcp_dynamic_cast;
64 typedef TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> TpetraVectorSpace_t;
65 RCP<const TpetraVectorSpace_t> tpetraSpace;
66 if (nonnull(space)) {
67 tpetraSpace = rcp_dynamic_cast<const TpetraVectorSpace_t>(space, true);
68 }
69 else {
70 tpetraSpace = tpetraVectorSpace<Scalar>(tpetraMap);
71 }
72 return tpetraSpace;
73}
74
75
76template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
78getOrCreateLocallyReplicatedTpetraVectorSpace(
79 const RCP<const VectorSpaceBase<Scalar> > space,
80 const RCP<const Teuchos::Comm<int> > &tpetraComm,
81 const int numCols
82 )
83{
84 using Teuchos::rcp_dynamic_cast;
85 typedef TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> TpetraVectorSpace_t;
86 RCP<const TpetraVectorSpace_t> tpetraSpace;
87 if (nonnull(space)) {
88 tpetraSpace = rcp_dynamic_cast<const TpetraVectorSpace_t>(space, true);
89 }
90 else {
91 tpetraSpace = tpetraVectorSpace<Scalar>(
92 Tpetra::createLocalMapWithNode<LocalOrdinal,GlobalOrdinal,Node>(
93 numCols, tpetraComm
94 )
95 );
96 }
97 return tpetraSpace;
98}
99
100} // namespace Thyra
101
102
103template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
106 const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > &tpetraMap
107 )
108{
109 return tpetraVectorSpace<Scalar>(tpetraMap);
110}
111
112
113template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
116 const RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector_in,
117 const RCP<const VectorSpaceBase<Scalar> > space_in
118 )
119{
120 return tpetraVector(
121 getOrCreateTpetraVectorSpace(space_in, tpetraVector_in->getMap()),
122 tpetraVector_in
123 );
124}
125
126
127template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
130 const RCP<const Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector_in,
131 const RCP<const VectorSpaceBase<Scalar> > space
132 )
133{
134 return constTpetraVector(
135 getOrCreateTpetraVectorSpace(space, tpetraVector_in->getMap()),
136 tpetraVector_in
137 );
138}
139
140
141template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
144 const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector_in,
145 const RCP<const VectorSpaceBase<Scalar> > rangeSpace,
146 const RCP<const VectorSpaceBase<Scalar> > domainSpace
147 )
148{
149 return tpetraMultiVector(
150 getOrCreateTpetraVectorSpace(rangeSpace, tpetraMultiVector_in->getMap()),
151 getOrCreateLocallyReplicatedTpetraVectorSpace<Scalar, LocalOrdinal, GlobalOrdinal, Node>(
152 domainSpace, tpetraMultiVector_in->getMap()->getComm(),
153 tpetraMultiVector_in->getNumVectors()
154 ),
155 tpetraMultiVector_in
156 );
157}
158
159
160template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
163 const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector_in,
164 const RCP<const VectorSpaceBase<Scalar> > rangeSpace,
165 const RCP<const VectorSpaceBase<Scalar> > domainSpace
166 )
167{
168 return constTpetraMultiVector(
169 getOrCreateTpetraVectorSpace(rangeSpace, tpetraMultiVector_in->getMap()),
170 getOrCreateLocallyReplicatedTpetraVectorSpace<Scalar, LocalOrdinal, GlobalOrdinal, Node>(
171 domainSpace, tpetraMultiVector_in->getMap()->getComm(),
172 tpetraMultiVector_in->getNumVectors()
173 ),
174 tpetraMultiVector_in
175 );
176}
177
178
179template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
182 const RCP<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator_in,
183 const RCP<const VectorSpaceBase<Scalar> > rangeSpace,
184 const RCP<const VectorSpaceBase<Scalar> > domainSpace
185 )
186{
187 Teuchos::RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraRangeSpace = getOrCreateTpetraVectorSpace(rangeSpace, tpetraOperator_in->getRangeMap());
188 Teuchos::RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraDomainSpace = getOrCreateTpetraVectorSpace(domainSpace, tpetraOperator_in->getDomainMap());
189
190 return tpetraLinearOp<Scalar,LocalOrdinal,GlobalOrdinal,Node>(
191 tpetraRangeSpace,
192 tpetraDomainSpace,
193 tpetraOperator_in
194 );
195}
196
197
198template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
201 const RCP<const Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraOperator_in,
202 const RCP<const VectorSpaceBase<Scalar> > rangeSpace,
203 const RCP<const VectorSpaceBase<Scalar> > domainSpace
204 )
205{
206 Teuchos::RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraRangeSpace = getOrCreateTpetraVectorSpace(rangeSpace, tpetraOperator_in->getRangeMap());
207 Teuchos::RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraDomainSpace = getOrCreateTpetraVectorSpace(domainSpace, tpetraOperator_in->getDomainMap());
208 return constTpetraLinearOp<Scalar,LocalOrdinal,GlobalOrdinal,Node>(
209 tpetraRangeSpace,
210 tpetraDomainSpace,
211 tpetraOperator_in
212 );
213}
214
215
216namespace Thyra {
217
218template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
219RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
226
227
228template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
236
237
238template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
246
247
248template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
252{
253
254#ifdef THYRA_DEBUG
255 TEUCHOS_ASSERT(nonnull(mv));
256#endif
257
258 using Teuchos::rcp_dynamic_cast;
259
261 ThyraTpetraMultiVector_t;
263 rcp_dynamic_cast<ThyraTpetraMultiVector_t>(mv);
264 if (nonnull(tmv)) {
265 return tmv->getTpetraMultiVector();
266 }
267
269 ThyraTpetraVector_t;
270 const RCP<ThyraTpetraVector_t> tv =
271 rcp_dynamic_cast<ThyraTpetraVector_t>(mv);
272 if (nonnull(tv)) {
273 return tv->getTpetraVector();
274 }
275
276 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
277 "Error, the input mv = " << mv->description() << " does not support the"
278 " Thyra::TpetraMultiVector or the Thyra::TpetraVector interfaces!");
279
281
282}
283
284
285template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
289{
290
291#ifdef THYRA_DEBUG
292 TEUCHOS_ASSERT(nonnull(mv));
293#endif
294
295 using Teuchos::rcp_dynamic_cast;
296
298 ThyraTpetraMultiVector_t;
300 rcp_dynamic_cast<const ThyraTpetraMultiVector_t>(mv);
301 if (nonnull(tmv)) {
302 return tmv->getConstTpetraMultiVector();
303 }
304
306 ThyraTpetraVector_t;
308 rcp_dynamic_cast<const ThyraTpetraVector_t>(mv);
309 if (nonnull(tv)) {
310 return tv->getConstTpetraVector();
311 }
312
313 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
314 "Error, the input mv = " << mv->description() << " does not support the"
315 " Thyra::TpetraMultiVector or the Thyra::TpetraVector interfaces!");
316
318
319}
320
321
322template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
330
331
332template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
340
341
342} // namespace Thyra
343
344
345#endif // THYRA_TPETRA_THYRA_WRAPPERS_HPP
Base class for all linear operators.
Interface for a collection of column vectors called a multi-vector.
Concrete Thyra::LinearOpBase subclass for Tpetra::Operator.
RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraOperator() const
Get embedded const Tpetra::Operator.
RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraOperator()
Get embedded non-const Tpetra::Operator.
Concrete implementation of Thyra::MultiVector in terms of Tpetra::MultiVector.
static RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getTpetraMap(const RCP< const VectorSpaceBase< Scalar > > &vs)
Get a const Tpetra::Map from a const Thyra::VectorSpaceBase object.
static RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraOperator(const RCP< const LinearOpBase< Scalar > > &op)
Get a const Tpetra::Operator from a const Thyra::LinearOpBase object.
static RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraOperator(const RCP< LinearOpBase< Scalar > > &op)
Get a non-const Tpetra::Operator from a non-const Thyra::LinearOpBase object.
static RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraMultiVector(const RCP< const MultiVectorBase< Scalar > > &mv)
Get a const Tpetra::MultiVector from a const Thyra::MultiVectorBase object.
static RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraVector(const RCP< VectorBase< Scalar > > &v)
Get a non-const Tpetra::Vector from a non-const Thyra::VectorBase object.
static RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraMultiVector(const RCP< MultiVectorBase< Scalar > > &mv)
Get a non-const Tpetra::MultiVector from a non-const Thyra::MultiVectorBase object.
static RCP< const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraVector(const RCP< const VectorBase< Scalar > > &v)
Get a const Tpetra::Vector from a const Thyra::VectorBase object.
Concrete implementation of an SPMD vector space for Tpetra.
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getTpetraMap() const
Get the embedded Tpetra::Map.
Concrete Thyra::SpmdVectorBase using Tpetra::Vector.
RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraVector()
Get the embedded non-const Tpetra::Vector.
RCP< const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraVector() const
Get the embedded non-const Tpetra::Vector.
Abstract interface for finite-dimensional dense vectors.
Abstract interface for objects that represent a space for vectors.
#define TEUCHOS_ASSERT(assertion_test)
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
bool nonnull(const std::shared_ptr< T > &p)
RCP< const VectorBase< Scalar > > createConstVector(const RCP< const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVector, const RCP< const VectorSpaceBase< Scalar > > space=Teuchos::null)
RCP< const MultiVectorBase< Scalar > > createConstMultiVector(const RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraMultiVector, const RCP< const VectorSpaceBase< Scalar > > rangeSpace=Teuchos::null, const RCP< const VectorSpaceBase< Scalar > > domainSpace=Teuchos::null)
RCP< const VectorSpaceBase< Scalar > > createVectorSpace(const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &tpetraMap)
Create a Thyra::VectorSpaceBase object given a Tpetra::Map.
RCP< VectorBase< Scalar > > createVector(const RCP< Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVector, const RCP< const VectorSpaceBase< Scalar > > space=Teuchos::null)
RCP< MultiVectorBase< Scalar > > createMultiVector(const RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraMultiVector, const RCP< const VectorSpaceBase< Scalar > > rangeSpace=Teuchos::null, const RCP< const VectorSpaceBase< Scalar > > domainSpace=Teuchos::null)
RCP< LinearOpBase< Scalar > > createLinearOp(const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator, const RCP< const VectorSpaceBase< Scalar > > rangeSpace=Teuchos::null, const RCP< const VectorSpaceBase< Scalar > > domainSpace=Teuchos::null)
RCP< const LinearOpBase< Scalar > > createConstLinearOp(const RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator, const RCP< const VectorSpaceBase< Scalar > > rangeSpace=Teuchos::null, const RCP< const VectorSpaceBase< Scalar > > domainSpace=Teuchos::null)
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
T_To & dyn_cast(T_From &from)