Thyra Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_TpetraEuclideanScalarProd_def.hpp
Go to the documentation of this file.
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_EUCLIDEAN_SCALAR_PROD_DEF_HPP
43 #define THYRA_TPETRA_EUCLIDEAN_SCALAR_PROD_DEF_HPP
44 
47 #include "Thyra_TpetraVector.hpp"
48 
49 
50 namespace Thyra {
51 
52 
53 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
55  const MultiVectorBase<Scalar>& X,
56  const MultiVectorBase<Scalar>& Y,
57  const ArrayView<Scalar>& scalarProds_out
58  ) const
59 {
60  typedef Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> TMV;
61  Teuchos::RCP<const TMV> X_tpetra = this->getConstTpetraMultiVector(Teuchos::rcpFromRef(X));
62  Teuchos::RCP<const TMV> Y_tpetra = this->getConstTpetraMultiVector(Teuchos::rcpFromRef(Y));
63 
64  if (nonnull(X_tpetra) && nonnull(Y_tpetra)) {
65  // Which one do we want transposed?
66  // Tpetra transposes the argument of dot.
67  // Below is the order from TpetraVectorSpace::scalarProdsImpl,
68  // so this would transpose Y. However, Thyra::dots (which calls
69  // the RTOp) transposes the first argument, so scalarProdsImpl
70  // in EuclideanScalarProd transposes X...
71  X_tpetra->dot(*Y_tpetra, scalarProds_out);
72  } else {
73  // If one of the casts succeeded, sync that MV to host space
74 #ifdef KOKKOS_ENABLE_DEPRECATED_CODE
75  if (nonnull(X_tpetra))
76  Teuchos::rcp_const_cast<TMV>(X_tpetra)->template sync<Kokkos::HostSpace>();
77  if (nonnull(Y_tpetra))
78  Teuchos::rcp_const_cast<TMV>(Y_tpetra)->template sync<Kokkos::HostSpace>();
79 #else
80  if (nonnull(X_tpetra))
81  Teuchos::rcp_const_cast<TMV>(X_tpetra)->sync_host ();
82  if (nonnull(Y_tpetra))
83  Teuchos::rcp_const_cast<TMV>(Y_tpetra)->sync_host ();
84 #endif
85 
86  EuclideanScalarProd<Scalar>::scalarProdsImpl(X, Y, scalarProds_out);
87  }
88 }
89 
90 
91 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
94 getConstTpetraMultiVector(const RCP<const MultiVectorBase<Scalar> >& mv) const
95 {
96  using Teuchos::rcp_dynamic_cast;
99 
100  RCP<const TMV> tmv = rcp_dynamic_cast<const TMV>(mv);
101  if (nonnull(tmv)) {
102  return tmv->getConstTpetraMultiVector();
103  }
104 
105  RCP<const TV> tv = rcp_dynamic_cast<const TV>(mv);
106  if (nonnull(tv)) {
107  return tv->getConstTpetraVector();
108  }
109 
110  return Teuchos::null;
111 }
112 
113 
114 } // end namespace Thyra
115 
116 
117 #endif // THYRA_EUCLIDEAN_SCALAR_PROD_DEF_HPP
Concrete implementation of Thyra::MultiVector in terms of Tpetra::MultiVector.
Concrete Thyra::SpmdVectorBase using Tpetra::Vector.
bool nonnull(const boost::shared_ptr< T > &p)
virtual void scalarProdsImpl(const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y, const ArrayView< Scalar > &scalarProds) const
If X and Y are both Tpetra wrappers, computes the pair-wise scalar products directly with Tpetra call...
Teuchos::RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraMultiVector(const RCP< const MultiVectorBase< Scalar > > &mv) const