MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_TransPFactory_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_TRANSPFACTORY_DEF_HPP
47#define MUELU_TRANSPFACTORY_DEF_HPP
48
49#include <Teuchos_ParameterList.hpp>
50#include <Teuchos_Time.hpp>
51
52#include <Xpetra_Matrix.hpp>
53
55
57
59#include "MueLu_Monitor.hpp"
60#include "MueLu_PerfUtils.hpp"
61#include "MueLu_Utilities.hpp"
62
63namespace MueLu {
64
65 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
67 RCP<ParameterList> validParamList = rcp(new ParameterList());
68 validParamList->set< RCP<const FactoryBase> >("P", Teuchos::null, "Generating factory of the matrix P");
69
70 // Make sure we don't recursively validate options for the matrixmatrix kernels
71 ParameterList norecurse;
72 norecurse.disableRecursiveValidation();
73 validParamList->set<ParameterList> ("matrixmatrix: kernel params", norecurse, "MatrixMatrix kernel parameters");
74
75 return validParamList;
76 }
77
78 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
80 Input(coarseLevel, "P");
81 }
82
83 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
85 FactoryMonitor m(*this, "Transpose P", coarseLevel);
86 std::string label = "MueLu::TransP-" + Teuchos::toString(coarseLevel.GetLevelID());
87
88 RCP<Matrix> P = Get< RCP<Matrix> >(coarseLevel, "P");
89 // If we failed to create a valid P (e.g., # of global aggregates is zero), then we just bail here
90 // This level will ultimately be removed in MueLu_Hierarchy_defs.h via a resize()
91 if (P == Teuchos::null) return;
92
93 const Teuchos::ParameterList& pL = GetParameterList();
94
95 // Reuse pattern if available (multiple solve)
96 RCP<ParameterList> Tparams;
97 if(pL.isSublist("matrixmatrix: kernel params"))
98 Tparams=rcp(new ParameterList(pL.sublist("matrixmatrix: kernel params")));
99 else
100 Tparams= rcp(new ParameterList);
101
102 // By default, we don't need global constants for transpose
103 Tparams->set("compute global constants: temporaries",Tparams->get("compute global constants: temporaries",false));
104 Tparams->set("compute global constants",Tparams->get("compute global constants",false));
105
106 RCP<Matrix> R = Utilities::Transpose(*P, true,label,Tparams);
107
108 if (IsPrint(Statistics2)) {
109 RCP<ParameterList> params = rcp(new ParameterList());
110 params->set("printLoadBalancingInfo", true);
111 params->set("printCommInfo", true);
112 GetOStream(Statistics2) << PerfUtils::PrintMatrixInfo(*R, "R", params);
113 }
114
115 Set(coarseLevel, "R", R);
116
118 if (P->IsView("stridedMaps"))
119 R->CreateView("stridedMaps", P, true);
121
122 }
123
124} //namespace MueLu
125
126#endif // MUELU_TRANSPFACTORY_DEF_HPP
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
int GetLevelID() const
Return level number.
static std::string PrintMatrixInfo(const Matrix &A, const std::string &msgTag, RCP< const Teuchos::ParameterList > params=Teuchos::null)
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
static RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Transpose(Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, bool optimizeTranspose=false, const std::string &label=std::string(), const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Namespace for MueLu classes and methods.
@ Statistics2
Print even more statistics.