MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_TpetraOperator_def.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 
47 #ifndef MUELU_TPETRAOPERATOR_DEF_HPP
48 #define MUELU_TPETRAOPERATOR_DEF_HPP
49 
50 #include "MueLu_ConfigDefs.hpp"
51 
52 #ifdef HAVE_MUELU_TPETRA
53 
54 #include <Xpetra_BlockedMap.hpp>
55 #include <Xpetra_Matrix.hpp>
56 #include <Xpetra_CrsMatrixWrap.hpp>
58 #include <Xpetra_Operator.hpp>
59 #include <Xpetra_TpetraMultiVector.hpp>
60 
62 #include "MueLu_Hierarchy.hpp"
63 #include "MueLu_Utilities.hpp"
64 
65 
66 namespace MueLu {
67 
68 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
74 
75  RCP<const Map> domainMap;
76  if(!Hierarchy_.is_null()) domainMap = Hierarchy_->GetLevel(0)->template Get<RCP<Matrix> >("A")->getDomainMap();
77  else domainMap = Operator_->getDomainMap();
78 
79 
80  RCP<const BlockedMap> bDomainMap = Teuchos::rcp_dynamic_cast<const BlockedMap>(domainMap);
81  if(bDomainMap.is_null() == false) {
82  return Xpetra::toTpetraNonZero(bDomainMap->getFullMap());
83  }
84  return Xpetra::toTpetraNonZero(domainMap);
85 }
86 
87 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
92 
93 
94  RCP<const Map> rangeMap;
95  if(!Hierarchy_.is_null()) rangeMap = Hierarchy_->GetLevel(0)->template Get<RCP<Matrix> >("A")->getRangeMap();
96  else rangeMap = Operator_->getRangeMap();
97 
98  RCP<const BlockedMap> bRangeMap = Teuchos::rcp_dynamic_cast<const BlockedMap>(rangeMap);
99  if(bRangeMap.is_null() == false) {
100  return Xpetra::toTpetraNonZero(bRangeMap->getFullMap());
101  }
102  return Xpetra::toTpetraNonZero(rangeMap);
103 }
104 
105 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
106 void TpetraOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node>::apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& X,
107  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& Y,
108  Teuchos::ETransp /* mode */, Scalar /* alpha */, Scalar /* beta */) const {
109  typedef Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> TMV;
111 
112  try {
113  TMV& temp_x = const_cast<TMV &>(X);
114  const XTMV tX(rcpFromRef(temp_x));
115  XTMV tY(rcpFromRef(Y));
116 
117  tY.putScalar(Teuchos::ScalarTraits<Scalar>::zero());
118  if(!Hierarchy_.is_null())
119  Hierarchy_->Iterate(tX, tY, 1, true);
120  else
121  Operator_->apply(tX, tY);
122 
123  } catch (std::exception& e) {
124  std::cerr << "MueLu::TpetraOperator::apply : detected an exception" << std::endl
125  << e.what() << std::endl;
126  throw;
127  }
128 }
129 
130 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
132  return false;
133 }
134 
135 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
138  return Hierarchy_;
139 }
140 
141 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
144  return Operator_;
145 }
146 
147 #ifdef HAVE_MUELU_DEPRECATED_CODE
148 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
149 template <class NewNode>
151 MUELU_DEPRECATED
153  if(!Hierarchy_.is_null())
154  return Teuchos::rcp (new TpetraOperator<Scalar, LocalOrdinal, GlobalOrdinal, NewNode> (Hierarchy_->template clone<NewNode> (new_node)));
155  else
156  return Teuchos::null;
157 }
158 #endif
159 
160 
161 } // namespace
162 #endif //ifdef HAVE_MUELU_TPETRA
163 
164 #endif //ifdef MUELU_TPETRAOPERATOR_DEF_HPP
bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > toTpetraNonZero(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map)
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Tpetra::Map object associated with the range of this operator.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > GetOperator() const
Direct access to the underlying MueLu::Operator.
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Tpetra::Map object associated with the domain of this operator.
Wraps an existing MueLu::Hierarchy as a Tpetra::Operator.
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > GetHierarchy() const
Direct access to the underlying MueLu::Hierarchy.
void apply(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::one()) const
Returns in Y the result of a Tpetra::Operator applied to a Tpetra::MultiVector X. ...
bool is_null() const