MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_ShiftedLaplacianOperator_decl.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 #ifndef MUELU_SHIFTEDLAPLACIANOPERATOR_DECL_HPP
47 #define MUELU_SHIFTEDLAPLACIANOPERATOR_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
51 #ifdef HAVE_MUELU_TPETRA
52 #include <Tpetra_Operator.hpp>
53 #include <Tpetra_MultiVector_decl.hpp>
54 #include "MueLu_Level.hpp"
55 #include "MueLu_Hierarchy_decl.hpp"
56 #include "MueLu_Utilities.hpp"
57 
58 // TODO: Kokkos headers
59 
60 namespace MueLu {
61 
65  template <class Scalar = Tpetra::Operator<>::scalar_type,
66  class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type,
67  class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type,
68  class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
70  : public Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>
71  {
72 
74  typedef Tpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> CrsMatrix;
75  typedef Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> MV;
76  typedef Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> OP;
78  public:
79 
81 
82 
85 
88  const RCP<Matrix> A, int cycles, int iters, int option, double tol) : Hierarchy_(H), A_(A), cycles_(cycles), iters_(iters), option_(option), tol_(tol)
89  {
90 
91  // setup 2-level correction
92  /*RCP< MueLu::Level > Level1 = H -> GetLevel(1);
93  R_ = Level1 -> Get< RCP<Matrix> >("R");
94  P_ = Level1 -> Get< RCP<Matrix> >("P");
95  //RCP<Matrix> AP = Level1 -> Get< RCP<Matrix> >("AP graph");
96  RCP<Matrix> AP;
97  AP = MUtils::Multiply(*A_, false, *P_, false, AP);
98  // Optimization storage option. If matrix is not changing later, allow this.
99  bool doOptimizedStorage = true;
100  // Reuse coarse matrix memory if available (multiple solve)
101  //RCP<Matrix> Ac = Level1 -> Get< RCP<Matrix> >("RAP graph");
102  RCP<Matrix> Ac;
103  Ac = MUtils::Multiply(*R_, false, *AP, false, Ac, true, doOptimizedStorage);
104  Ac_ = MUtils::Op2NonConstTpetraCrs(Ac);
105 
106  // Setup Belos for two-level correction
107  BelosList_ = rcp( new Teuchos::ParameterList("GMRES") );
108  BelosList_ -> set("Maximum Iterations", iters_ );
109  BelosList_ -> set("Convergence Tolerance", tol_ );
110  BelosLP_ = rcp( new Belos::LinearProblem<Scalar,MV,OP> );
111  BelosLP_ -> setOperator ( Ac_ );
112  BelosSM_ = rcp( new Belos::BlockGmresSolMgr<Scalar,MV,OP>(BelosLP_, BelosList_) );*/
113 
114  }
115 
116 
117 
120 
122 
125 
128 
130 
135  void apply(const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& X,
136  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& Y,
138  Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
139  Scalar beta = Teuchos::ScalarTraits<Scalar>::one()) const;
140 
142  bool hasTransposeApply() const;
143 
144  private:
145 
150 
151  //RCP< Belos::LinearProblem<Scalar,MV,OP> > BelosLP_;
152  //RCP< Belos::SolverManager<Scalar,MV,OP> > BelosSM_;
153 
154  // cycles -> number of V-cycles
155  // iters -> number of GMRES iterations per correction
156  // option -> 0 if no correction is desired
158  double tol_;
159 
160  };
161 
162 } // namespace
163 
164 #endif //ifdef HAVE_MUELU_TPETRA
165 
166 #endif // MUELU_SHIFTEDLAPLACIANOPERATOR_DECL_HPP
RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Ac_
Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > MV
MueLu::Utilities< Scalar, LocalOrdinal, GlobalOrdinal, Node > MUtils
Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > CrsMatrix
RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > R_
Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > OP
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Tpetra::Map object associated with the domain of this operator.
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 hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Matrix
Wraps an existing MueLu::Hierarchy as a Tpetra::Operator, with an optional two-level correction...
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Hierarchy_
RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > A_
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Tpetra::Map object associated with the range of this operator.
ShiftedLaplacianOperator(const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H)
Constructor.
ShiftedLaplacianOperator(const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H, const RCP< Matrix > A, int cycles, int iters, int option, double tol)
Auxiliary Constructor.
MueLu utility class.
RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > P_
Provides methods to build a multigrid hierarchy and apply multigrid cycles.