MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_EpetraOperator.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_EPETRAOPERATOR_HPP
47 #define MUELU_EPETRAOPERATOR_HPP
48 
50 
51 #include <Epetra_Operator.h>
52 #include "MueLu_Hierarchy.hpp"
53 //TODO: Kokkos headers
54 
55 #if defined(HAVE_MUELU_SERIAL) and defined(HAVE_MUELU_EPETRA)
56 
57 namespace MueLu {
58 
63  class EpetraOperator : public Epetra_Operator {
64  typedef double SC;
65  typedef int LO;
66  typedef int GO;
67  typedef Xpetra::EpetraNode NO;
68 
69  typedef Xpetra::Matrix<SC,LO,GO,NO> Matrix;
70  typedef MueLu::Hierarchy<SC,LO,GO,NO> Hierarchy;
71  typedef MueLu::Utilities<SC,LO,GO,NO> Utils;
72 
73  public:
74 
76 
77 
79  EpetraOperator(const RCP<Hierarchy>& H) : Hierarchy_(H) { }
80 
82  virtual ~EpetraOperator() { }
83 
85 
86  int SetUseTranspose(bool /* UseTransposeBool */) { return -1; }
87 
89 
90 
92 
100  int Apply(const Epetra_MultiVector& /* X */, Epetra_MultiVector& /* Y */) const { return -1; }
101 
103 
114  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
115 
117  /* Returns the quantity \f$ \| A \|_\infty\f$ such that
118  \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
119 
120  \warning This method must not be called unless HasNormInf() returns true.
121  */
122  double NormInf() const { return 0; }
124 
126 
127 
129  const char * Label() const { return "MueLu::Hierarchy"; }
130 
132  bool UseTranspose() const { return false; }
133 
135  bool HasNormInf() const { return 0; }
136 
138  const Epetra_Comm & Comm() const;
139 
141  const Epetra_Map & OperatorDomainMap() const;
142 
144  const Epetra_Map & OperatorRangeMap() const;
145 
147 
149 
150 
152  RCP<Hierarchy> GetHierarchy() const { return Hierarchy_; }
153 
155 
156 
157  private:
158 
159  RCP<Hierarchy> Hierarchy_;
160 
161  };
162 
163 } // namespace
164 
165 #endif // HAVE_MUELU_EPETRA and HAVE_MUELU_SERIAL
166 
167 #endif // MUELU_EPETRAOPERATOR_HPP
GlobalOrdinal GO
LocalOrdinal LO
EpetraOperatorT< int > EpetraOperator
Scalar SC
Node NO
MueLu utility class.
Provides methods to build a multigrid hierarchy and apply multigrid cycles.