MueLu  Version of the Day
MueLu_Maxwell_Utils_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_MAXWELL_UTILS_DECL_HPP
47 #define MUELU_MAXWELL_UTILS_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #include "MueLu_BaseClass.hpp"
51 
52 #include "Xpetra_Map_fwd.hpp"
53 #include "Xpetra_Matrix_fwd.hpp"
54 #include "Xpetra_MatrixFactory_fwd.hpp"
55 #include "Xpetra_MultiVectorFactory_fwd.hpp"
56 #include "Xpetra_VectorFactory_fwd.hpp"
57 #include "Xpetra_CrsMatrixWrap_fwd.hpp"
58 
59 #include "MueLu_Level_fwd.hpp"
61 #include "MueLu_Utilities_fwd.hpp"
62 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
64 #endif
65 
66 // Stratimikos
67 #if defined(HAVE_MUELU_STRATIMIKOS) && defined(HAVE_MUELU_THYRA)
68 #include <Thyra_LinearOpWithSolveBase.hpp>
69 #endif
70 
71 
72 namespace MueLu {
73 
79  template <class Scalar,
80  class LocalOrdinal,
81  class GlobalOrdinal,
82  class Node>
83  class Maxwell_Utils : public VerboseObject {
84 
85 #undef MUELU_MAXWELL_UTILS_SHORT
86 #include "MueLu_UseShortNames.hpp"
87 
88  public:
89  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
90  // typedef typename Teuchos::ScalarTraits<Scalar>::coordinateType coordinateType;
91  // typedef typename Xpetra::MultiVector<coordinateType,LO,GO,NO> RealValuedMultiVector;
92 
94  static void detectBoundaryConditionsSM(RCP<Matrix> & SM_Matrix,
95  RCP<Matrix> & D0_Matrix,
96  magnitudeType rowSumTol,
98  bool useKokkos_,
102 #endif
103  int & BCedges,
104  int & BCnodes,
105  Teuchos::ArrayRCP<bool> & BCrows,
106  Teuchos::ArrayRCP<bool> & BCcols,
107  Teuchos::ArrayRCP<bool> & BCdomain,
108  bool & allEdgesBoundary,
109  bool & allNodesBoundary);
110 
112  static void removeExplicitZeros(Teuchos::ParameterList &parameterList,
113  RCP<Matrix> & D0_Matrix,
114  RCP<Matrix> & SM_Matrix,
115  RCP<Matrix> & M1_Matrix,
116  RCP<Matrix> & Ms_Matrix);
117 
118  static void removeExplicitZeros(Teuchos::ParameterList &parameterList,
119  RCP<Matrix> & D0_Matrix,
120  RCP<Matrix> & SM_Matrix) {
121  RCP<Matrix> dummy;
122  removeExplicitZeros(parameterList,D0_Matrix,SM_Matrix,dummy,dummy);
123  }
124 
126  static void setMatvecParams(Matrix& A, RCP<ParameterList> matvecParams);
127 
128 #if defined(HAVE_MUELU_STRATIMIKOS) && defined(HAVE_MUELU_THYRA)
129  // Sets up a stratimikos preconditioner
130  static RCP<Thyra::PreconditionerBase<Scalar> > setupStratimikosPreconditioner(RCP<Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A,
131  RCP<ParameterList> params);
132  #endif
133 
134 
135  };
136 
137 
138 
139 } // namespace
140 
141 #define MUELU_REFMAXWELL_SHORT
142 #endif // MUELU_REFMAXWELL_DECL_HPP
static void removeExplicitZeros(Teuchos::ParameterList &parameterList, RCP< Matrix > &D0_Matrix, RCP< Matrix > &SM_Matrix)
MueLu::DefaultLocalOrdinal LocalOrdinal
static void removeExplicitZeros(Teuchos::ParameterList &parameterList, RCP< Matrix > &D0_Matrix, RCP< Matrix > &SM_Matrix, RCP< Matrix > &M1_Matrix, RCP< Matrix > &Ms_Matrix)
Remove explicit zeros.
Namespace for MueLu classes and methods.
MueLu::DefaultNode Node
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Teuchos::ScalarTraits< Scalar >::magnitudeType magnitudeType
static void setMatvecParams(Matrix &A, RCP< ParameterList > matvecParams)
Sets matvec params on a matrix.
static void detectBoundaryConditionsSM(RCP< Matrix > &SM_Matrix, RCP< Matrix > &D0_Matrix, magnitudeType rowSumTol, int &BCedges, int &BCnodes, Teuchos::ArrayRCP< bool > &BCrows, Teuchos::ArrayRCP< bool > &BCcols, Teuchos::ArrayRCP< bool > &BCdomain, bool &allEdgesBoundary, bool &allNodesBoundary)
Detect Dirichlet boundary conditions.