MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_ScaledNullspaceFactory_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_SCALEDNULLSPACEFACTORY_DEF_HPP
47#define MUELU_SCALEDNULLSPACEFACTORY_DEF_HPP
48
49#include <Xpetra_Matrix.hpp>
50#include <Xpetra_MatrixUtils.hpp>
51#include <Xpetra_MultiVectorFactory.hpp>
52#include <Xpetra_BlockedMultiVector.hpp>
53#include <Xpetra_VectorFactory.hpp>
54
56#include "MueLu_Level.hpp"
57#include "MueLu_Monitor.hpp"
58
59namespace MueLu {
60
61 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
63 RCP<ParameterList> validParamList = rcp(new ParameterList());
64 validParamList->set< std::string >("Fine level nullspace", "Nullspace", "Variable name which is used to store null space multi vector on the finest level (default=\"Nullspace\").");
65
66 validParamList->set< RCP<const FactoryBase> >("A", Teuchos::null, "Generating factory of the fine level matrix (only needed if default null space is generated)");
67 validParamList->set< RCP<const FactoryBase> >("Nullspace", Teuchos::null, "Generating factory of the fine level null space");
68
69 return validParamList;
70 }
71
72 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
74 // Scaled Nullspace always needs A & a Nullspace from somewhere
75 Input(currentLevel, "A");
76 Input(currentLevel, "Nullspace");
77 }
78
79 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
81 FactoryMonitor m(*this, "Build", currentLevel);
82
83 RCP<MultiVector> nullspace, tentativeNullspace;
84
85 //TEUCHOS_TEST_FOR_EXCEPTION(currentLevel.GetLevelID() != 0, Exceptions::RuntimeError, "MueLu::ScaledNullspaceFactory::Build(): ScaledNullspaceFactory can be used for finest level (LevelID == 0) only.");
86
87 if (currentLevel.GetLevelID() == 0) {
88 if (currentLevel.IsAvailable("Nullspace", NoFactory::get())) {
89 // When a fine nullspace have already been defined by user using Set("Nullspace", ...) or
90 // Set("Nullspace1", ...), we use it.
91 tentativeNullspace = currentLevel.Get< RCP<MultiVector> >("Nullspace", NoFactory::get());
92 } else {
93 // A User "Nullspace" (nspName) is not available (use factory)
94 tentativeNullspace = currentLevel.Get< RCP<MultiVector> >("Nullspace", GetFactory("Nullspace").get());
95
96 } // end if "Nullspace" not available
97 } else {
98 tentativeNullspace = currentLevel.Get< RCP<MultiVector> >("Nullspace", GetFactory("Nullspace").get());
99 }
100
101
102 // Scale!
103 RCP<Matrix> A = Get< RCP<Matrix> >(currentLevel, "A");
104
105 // determine numPDEs
106 LocalOrdinal numPDEs = 1;
107 if(A->IsView("stridedMaps")==true) {
108 Xpetra::viewLabel_t oldView = A->SwitchToView("stridedMaps"); // note: "stridedMaps are always non-overlapping (correspond to range and domain maps!)
109 TEUCHOS_TEST_FOR_EXCEPTION(Teuchos::rcp_dynamic_cast<const StridedMap>(A->getRowMap()) == Teuchos::null, Exceptions::BadCast, "MueLu::ScaledNullspaceFactory::Build: cast to strided row map failed.");
110 numPDEs = Teuchos::rcp_dynamic_cast<const StridedMap>(A->getRowMap())->getFixedBlockSize();
111 oldView = A->SwitchToView(oldView);
112 }
113
114 GetOStream(Runtime1) << "ScaledNullspaceFactory: Generating scaled nullspace, blocksize = "<< tentativeNullspace->getNumVectors() <<std::endl;
115 nullspace = MultiVectorFactory::Build(tentativeNullspace->getMap(), tentativeNullspace->getNumVectors());
116 *nullspace = *tentativeNullspace; // Copy the tentative nullspace
117 RCP<MultiVector> blockDiagonal = MultiVectorFactory::Build(A->getDomainMap(), numPDEs);
118
119 Xpetra::MatrixUtils<Scalar,LocalOrdinal,GlobalOrdinal,Node>::extractBlockDiagonal(*A,*blockDiagonal);
120 Xpetra::MatrixUtils<Scalar,LocalOrdinal,GlobalOrdinal,Node>::inverseScaleBlockDiagonal(*blockDiagonal,true,*nullspace);
121
122 // provide "Scaled Nullspace" variable on current level (used by TentativePFactory)
123 Set(currentLevel, "Scaled Nullspace", nullspace);
124
125 } // Build
126
127} //namespace MueLu
128
129#endif // MUELU_SCALEDNULLSPACEFACTORY_DEF_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
Exception indicating invalid cast attempted.
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
bool IsAvailable(const std::string &ename, const FactoryBase *factory=NoFactory::get()) const
Test whether a need's value has been saved.
int GetLevelID() const
Return level number.
T & Get(const std::string &ename, const FactoryBase *factory=NoFactory::get())
Get data without decrementing associated storage counter (i.e., read-only access)....
static const NoFactory * get()
RCP< const ParameterList > GetValidParameterList() const
Define valid parameters for internal factory parameters.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &currentLevel) const
Build an object with this factory.
Namespace for MueLu classes and methods.
@ Runtime1
Description of what is happening (more verbose)