MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_SchurComplementFactory_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 #ifndef MUELU_SCHURCOMPLEMENTFACTORY_DEF_HPP_
47 #define MUELU_SCHURCOMPLEMENTFACTORY_DEF_HPP_
48 
51 #include <Xpetra_VectorFactory.hpp>
52 #include <Xpetra_MatrixFactory.hpp>
53 #include <Xpetra_Matrix.hpp>
54 #include <Xpetra_MatrixMatrix.hpp>
55 #include <Xpetra_CrsMatrixWrap.hpp>
57 #include <Xpetra_CrsMatrix.hpp>
58 #include "MueLu_Level.hpp"
59 #include "MueLu_Monitor.hpp"
60 #include "MueLu_Utilities.hpp"
61 //#include "MueLu_HierarchyHelpers.hpp"
62 
63 #include "MueLu_SchurComplementFactory.hpp"
64 
65 namespace MueLu {
66 
67  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
69  RCP<ParameterList> validParamList = rcp(new ParameterList());
70 
72 
73  validParamList->set<RCP<const FactoryBase> >("A", NoFactory::getRCP()/*null*/, "Generating factory of the matrix A used for building Schur complement\n"
74  "(must be a 2x2 blocked operator)");
75  validParamList->set<SC> ("omega", one, "Scaling parameter in S = A(1,1) - 1/omega A(1,0) diag{A(0,0)}^{-1} A(0,1)");
76  validParamList->set<bool> ("lumping", false, "Use lumping to construct diag(A(0,0)), i.e. use row sum of the abs values on the diagonal "
77  "as approximation of A00 (and A00^{-1})");
78  validParamList->set<bool> ("fixing", false, "Fix diagonal by replacing small entries with 1.0");
79 
80  return validParamList;
81  }
82 
83  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
85  Input(currentLevel, "A");
86  }
87 
88  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
90  FactoryMonitor m(*this, "Build", currentLevel);
91 
92  typedef Teuchos::ScalarTraits<SC> STS;
93  SC zero = STS::zero(), one = STS::one();
94 
95  RCP<Matrix> A = Get<RCP<Matrix> >(currentLevel, "A");
96  RCP<BlockedCrsMatrix> bA = rcp_dynamic_cast<BlockedCrsMatrix>(A);
98  "MueLu::SchurComplementFactory::Build: input matrix A is not of type BlockedCrsMatrix!");
99 
100  TEUCHOS_TEST_FOR_EXCEPTION(bA->Rows() != 2 || bA->Cols() != 2, Exceptions::RuntimeError,
101  "MueLu::SchurComplementFactory::Build: input matrix A is a " << bA->Rows() << "x" << bA->Cols() << " block matrix. We expect a 2x2 blocked operator.");
102 
103  RCP<Matrix> A00 = bA->getMatrix(0,0);
104  RCP<Matrix> A01 = bA->getMatrix(0,1);
105  RCP<Matrix> A10 = bA->getMatrix(1,0);
106  RCP<Matrix> A11 = bA->getMatrix(1,1);
107 
108  RCP<BlockedCrsMatrix> bA01 = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(A01);
109  bool bIsBlocked = (bA01 == Teuchos::null ? false : true);
110 
111  const ParameterList& pL = GetParameterList();
112  SC omega = pL.get<Scalar>("omega");
113 
115  "MueLu::SchurComplementFactory::Build: Scaling parameter omega must not be zero to avoid division by zero.");
116 
117  RCP<Matrix> S = Teuchos::null;
118  // only if the off-diagonal blocks A10 and A01 are non-zero we have to do the MM multiplication
119  if(A01.is_null() == false && A10.is_null() == false) {
120  bool lumping = pL.get<bool>("lumping");
121  bool fixing = pL.get<bool>("fixing");
122  RCP<Vector> diag = Teuchos::null;
123  if (!lumping) {
124  diag = VectorFactory::Build(A00->getRangeMap(), true);
125  A00->getLocalDiagCopy(*diag);
126  } else {
127  RCP<BlockedCrsMatrix> bA00 = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(A00);
128  TEUCHOS_TEST_FOR_EXCEPTION(bA00.is_null()==false, MueLu::Exceptions::RuntimeError,"MueLu::SchurComplementFactory::Build: Mass lumping not implemented. Implement a mass lumping kernel!");
130  }
131  // invert diagonal vector. Replace all entries smaller than 1e-4 by one!
132  RCP<Vector> D = (!fixing ? Utilities::GetInverse(diag) : Utilities::GetInverse(diag, 1e-4, one));
133  // scale with -1/omega
134  D->scale(Teuchos::as<Scalar>(-one/omega));
135  // left scale matrix T with (scaled) diagonal D
136  // Copy the value of A01 so we can do the left scale.
137  RCP<Matrix> T = MatrixFactory::BuildCopy(A01);
138  T->leftScale(*D);
139 
140  // build Schur complement operator
141  if (!bIsBlocked) {
142  TEUCHOS_TEST_FOR_EXCEPTION(T->getRangeMap()->isSameAs(*(A10->getDomainMap())) == false, Exceptions::RuntimeError,
143  "MueLu::SchurComplementFactory::Build: RangeMap of A01 and domain map of A10 are not the same.");
144  RCP<ParameterList> myparams = rcp(new ParameterList);
145  S = Xpetra::MatrixMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Multiply(*A10, false, *T, false, GetOStream(Statistics2),true,true,std::string("SchurComplementFactory"),myparams);
146 
147  } else {
148  // nested blocking
149  RCP<BlockedCrsMatrix> bA10 = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(A10);
150  RCP<BlockedCrsMatrix> bT = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(T);
151 
152  TEUCHOS_TEST_FOR_EXCEPTION(bA01->Rows() != bA10->Cols(), Exceptions::RuntimeError,
153  "MueLu::SchurComplementFactory::Build: Block rows and cols of A01 and A10 are not compatible.");
154  TEUCHOS_TEST_FOR_EXCEPTION(bA01->Rows() != bT->Rows() || bA01->Cols() != bT->Cols(), Exceptions::RuntimeError,
155  "MueLu::SchurComplementFactory::Build: The scaled A01 operator has " << bT->Rows() << "x" << bT->Cols() << " blocks, "
156  "but should have " << bA01->Rows() << "x" << bA01->Cols() << " blocks.");
157  TEUCHOS_TEST_FOR_EXCEPTION(bA01->Cols() != bA10->Rows(), Exceptions::RuntimeError,
158  "MueLu::SchurComplementFactory::Build: Block rows and cols of A01 and A10 are not compatible.");
159 
161  }
162 
163  if (!A11.is_null()) {
164  T = Teuchos::null;
165  Xpetra::MatrixMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::TwoMatrixAdd(*A11, false, one, *S, false, one, T, GetOStream(Statistics2));
166  T->fillComplete();
167  S.swap(T);
168 
169  TEUCHOS_TEST_FOR_EXCEPTION(A11->getRangeMap()->isSameAs(*(S->getRangeMap())) == false, Exceptions::RuntimeError,
170  "MueLu::SchurComplementFactory::Build: RangeMap of A11 and S are not the same.");
171  TEUCHOS_TEST_FOR_EXCEPTION(A11->getDomainMap()->isSameAs(*(S->getDomainMap())) == false, Exceptions::RuntimeError,
172  "MueLu::SchurComplementFactory::Build: DomainMap of A11 and S are not the same.");
173  }
174 
175  }
176  else {
177  if (!A11.is_null()) {
178  S = MatrixFactory::BuildCopy(A11);
179  } else {
180  S = MatrixFactory::Build(A11->getRowMap(), 10 /*A11->getNodeMaxNumRowEntries()*/);
181  S->fillComplete(A11->getDomainMap(),A11->getRangeMap());
182  }
183  }
184 
185  // Check whether Schur complement operator is a 1x1 block matrix.
186  // If so, unwrap it and return the CrsMatrix based Matrix object
187  // We need this, as single-block smoothers expect it this way.
188  // In case of Thyra GIDs we obtain a Schur complement operator in Thyra GIDs
189  // This may make some special handling in feeding the SchurComplement solver Apply routine
190  // necessary!
191  if (bIsBlocked) {
192  RCP<BlockedCrsMatrix> bS = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(S);
193 
194  if (bS != Teuchos::null && bS->Rows() == 1 && bS->Cols() == 1) {
195  RCP<Matrix> temp = bS->getCrsMatrix();
196  S.swap(temp);
197  }
198  }
199  // NOTE: "A" generated by this factory is actually the Schur complement
200  // matrix, but it is required as all smoothers expect "A"
201  Set(currentLevel, "A", S);
202  }
203 
204 } // namespace MueLu
205 
206 #endif /* MUELU_SCHURCOMPLEMENTFACTORY_DEF_HPP_ */
Exception indicating invalid cast attempted.
T & get(const std::string &name, T def_value)
ParameterList & set(std::string const &name, T const &value, std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
Timer to be used in factories. Similar to Monitor but with additional timers.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
void swap(RCP< T > &r_ptr)
static Teuchos::ArrayRCP< Scalar > GetLumpedMatrixDiagonal(const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A)
void DeclareInput(Level &currentLevel) const
Input.
Print even more statistics.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &currentLevel) const
Build an object with this factory.
static RCP< BlockedCrsMatrix > TwoMatrixMultiplyBlock(const BlockedCrsMatrix &A, bool transposeA, const BlockedCrsMatrix &B, bool transposeB, Teuchos::FancyOStream &fos, bool doFillComplete=true, bool doOptimizeStorage=true)
static void TwoMatrixAdd(const Matrix &A, bool transposeA, SC alpha, Matrix &B, SC beta)
static void Multiply(const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, Matrix &C, bool call_FillComplete_on_result=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)
Scalar SC
static Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > GetInverse(Teuchos::RCP< const Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > v, Magnitude tol=Teuchos::ScalarTraits< Scalar >::eps()*100, Scalar tolReplacement=Teuchos::ScalarTraits< Scalar >::zero())
Exception throws to report errors in the internal logical of the program.
static const RCP< const NoFactory > getRCP()
Static Get() functions.
bool is_null() const