MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_PermutationFactory_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 /*
47  * MueLu_PermutationFactory_def.hpp
48  *
49  * Created on: Nov 28, 2012
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_PERMUTATIONFACTORY_DEF_HPP_
54 #define MUELU_PERMUTATIONFACTORY_DEF_HPP_
55 
56 #include <vector>
57 #include <queue>
58 
60 
61 #include <Xpetra_Map.hpp>
62 #include <Xpetra_StridedMap.hpp> // for nDofsPerNode...
63 #include <Xpetra_Vector.hpp>
64 #include <Xpetra_VectorFactory.hpp>
65 #include <Xpetra_Matrix.hpp>
66 #include <Xpetra_CrsMatrixWrap.hpp>
67 #include <Xpetra_Export.hpp>
68 #include <Xpetra_ExportFactory.hpp>
69 #include <Xpetra_Import.hpp>
70 #include <Xpetra_ImportFactory.hpp>
71 
72 #include "MueLu_Level.hpp"
73 #include "MueLu_Utilities.hpp"
74 #include "MueLu_Monitor.hpp"
75 
76 #include "MueLu_AlgebraicPermutationStrategy.hpp"
77 #include "MueLu_LocalPermutationStrategy.hpp"
78 
79 #undef DEBUG_OUTPUT
80 
81 namespace MueLu {
82 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
84  { }
85 
86 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
88 
89 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
91  RCP<ParameterList> validParamList = rcp(new ParameterList());
92 
93  validParamList->set< RCP<const FactoryBase> >("A", Teuchos::null, "Generating factory of the matrix A to be permuted.");
94 
95  validParamList->set< std::string > ("PermutationRowMapName", "", "Name of input row map for which rows the permutation shall be done. (default='')");
96  validParamList->set< RCP<const FactoryBase> >("PermutationRowMapFactory", Teuchos::null, "Generating factory of the input row map for the permutation.");
97 
98  validParamList->set< std::string > ("PermutationStrategy", "Algebraic", "Permutation strategy (default = 'Algebraic', 'Local'");
99 
100  return validParamList;
101 }
102 
103 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
105  Input(currentLevel, "A");
106 
107  const ParameterList & pL = GetParameterList();
108  std::string mapName = pL.get<std::string> ("PermutationRowMapName");
109  Teuchos::RCP<const FactoryBase> mapFactory = GetFactory ("PermutationRowMapFactory");
110 
111  if(mapName.length() > 0 ) {
112  currentLevel.DeclareInput(mapName,mapFactory.get(),this);
113  }
114 }
115 
116 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
118  FactoryMonitor m(*this, "Permutation Factory ", currentLevel);
119 
120  Teuchos::RCP<Matrix> A = Get< Teuchos::RCP<Matrix> > (currentLevel, "A");
121 
122  const ParameterList & pL = GetParameterList();
123  std::string mapName = pL.get<std::string> ("PermutationRowMapName");
124  Teuchos::RCP<const FactoryBase> mapFactory = GetFactory ("PermutationRowMapFactory");
125 
126  Teuchos::RCP<const Map> permRowMap = Teuchos::null;
127  if(mapName.length() > 0 ) {
128  permRowMap = currentLevel.Get<RCP<const Map> >(mapName,mapFactory.get());
129  } else {
130  permRowMap = A->getRowMap(); // use full row map of A
131  }
132 
133  std::string strStrategy = pL.get<std::string> ("PermutationStrategy");
134  if( strStrategy == "Algebraic" ) {
136  permStrat->BuildPermutation(A,permRowMap,currentLevel,this);
137  } else if( strStrategy == "Local" ) {
139  permStrat->BuildPermutation(A,permRowMap,currentLevel,this);
140  } else
142  std::logic_error,
143  "`PermutationStrategy' has incorrect value (" << strStrategy << ") in input to PermutationFactory."
144  << "Check the documentation for a list of valid choices");
145 
146  GetOStream(Runtime0) << "Using " << strStrategy << " permutation strategy." << std::endl;
147 
148 }
149 
150 } // namespace MueLu
151 
152 
153 #endif /* MUELU_PERMUTATIONFACTORY_DEF_HPP_ */
void BuildPermutation(const Teuchos::RCP< Matrix > &A, const Teuchos::RCP< const Map > &permRowMap, Level &currentLevel, const FactoryBase *genFactory) const
build permutation operators
void BuildPermutation(const Teuchos::RCP< Matrix > &A, const Teuchos::RCP< const Map > permRowMap, Level &currentLevel, const FactoryBase *genFactory) const
build permutation operators
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)
One-liner description of what is happening.
T * get() const
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.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void DeclareInput(const std::string &ename, const FactoryBase *factory, const FactoryBase *requestedBy=NoFactory::get())
Callback from FactoryBase::CallDeclareInput() and FactoryBase::DeclareInput()