MueLu Version of the Day
Loading...
Searching...
No Matches
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"
64
65
66namespace MueLu {
67
73 template <class Scalar,
74 class LocalOrdinal,
75 class GlobalOrdinal,
76 class Node>
78
79#undef MUELU_MAXWELL_UTILS_SHORT
81
82 public:
83 typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
84 // typedef typename Teuchos::ScalarTraits<Scalar>::coordinateType coordinateType;
85 // typedef typename Xpetra::MultiVector<coordinateType,LO,GO,NO> RealValuedMultiVector;
86
88 static void detectBoundaryConditionsSM(RCP<Matrix> & SM_Matrix,
89 RCP<Matrix> & D0_Matrix,
90 magnitudeType rowSumTol,
91 bool useKokkos_,
92 Kokkos::View<bool*, typename Node::device_type> & BCrowsKokkos,
93 Kokkos::View<bool*, typename Node::device_type> & BCcolsKokkos,
94 Kokkos::View<bool*, typename Node::device_type> & BCdomainKokkos,
95 int & BCedges,
96 int & BCnodes,
97 Teuchos::ArrayRCP<bool> & BCrows,
98 Teuchos::ArrayRCP<bool> & BCcols,
99 Teuchos::ArrayRCP<bool> & BCdomain,
100 bool & allEdgesBoundary,
101 bool & allNodesBoundary);
102
104 static void removeExplicitZeros(Teuchos::ParameterList &parameterList,
105 RCP<Matrix> & D0_Matrix,
106 RCP<Matrix> & SM_Matrix,
107 RCP<Matrix> & M1_Matrix,
108 RCP<Matrix> & Ms_Matrix);
109
110 static void removeExplicitZeros(Teuchos::ParameterList &parameterList,
111 RCP<Matrix> & D0_Matrix,
112 RCP<Matrix> & SM_Matrix) {
113 RCP<Matrix> dummy;
114 removeExplicitZeros(parameterList,D0_Matrix,SM_Matrix,dummy,dummy);
115 }
116
118 static void setMatvecParams(Matrix& A, RCP<ParameterList> matvecParams);
119
120
121 // Performs an RAP
122 static RCP<Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
123 PtAPWrapper(RCP<Matrix>& A,RCP<Matrix>& P, Teuchos::ParameterList &params, std::string & label);
124
125 };
126
127} // namespace
128
129#define MUELU_MAXWELL_UTILS_SHORT
130#endif // MUELU_MAXWELL_UTILS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Utility functions for Maxwell.
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.
Teuchos::ScalarTraits< Scalar >::magnitudeType magnitudeType
static void detectBoundaryConditionsSM(RCP< Matrix > &SM_Matrix, RCP< Matrix > &D0_Matrix, magnitudeType rowSumTol, bool useKokkos_, Kokkos::View< bool *, typename Node::device_type > &BCrowsKokkos, Kokkos::View< bool *, typename Node::device_type > &BCcolsKokkos, Kokkos::View< bool *, typename Node::device_type > &BCdomainKokkos, int &BCedges, int &BCnodes, Teuchos::ArrayRCP< bool > &BCrows, Teuchos::ArrayRCP< bool > &BCcols, Teuchos::ArrayRCP< bool > &BCdomain, bool &allEdgesBoundary, bool &allNodesBoundary)
Detect Dirichlet boundary conditions.
static void removeExplicitZeros(Teuchos::ParameterList &parameterList, RCP< Matrix > &D0_Matrix, RCP< Matrix > &SM_Matrix)
static RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > PtAPWrapper(RCP< Matrix > &A, RCP< Matrix > &P, Teuchos::ParameterList &params, std::string &label)
static void setMatvecParams(Matrix &A, RCP< ParameterList > matvecParams)
Sets matvec params on a matrix.
Verbose class for MueLu classes.
Namespace for MueLu classes and methods.