MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_CoupledAggregationFactory_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_COUPLEDAGGREGATIONFACTORY_DEF_HPP
47 #define MUELU_COUPLEDAGGREGATIONFACTORY_DEF_HPP
48 
50 #include "MueLu_Level.hpp"
51 #include "MueLu_Graph.hpp"
52 #include "MueLu_Aggregates.hpp"
53 #include "MueLu_Monitor.hpp"
54 #include "MueLu_AmalgamationInfo.hpp"
55 
56 namespace MueLu {
57 
58  template <class LocalOrdinal, class GlobalOrdinal, class Node>
60  {
61  TEUCHOS_TEST_FOR_EXCEPTION(algo2_.GetMinNodesPerAggregate() != algo1_.GetMinNodesPerAggregate(), Exceptions::RuntimeError, "");
62  }
63 
64  template <class LocalOrdinal, class GlobalOrdinal, class Node>
66  Input(currentLevel, "Graph");
67  //Input(currentLevel, "UnAmalgamationInfo"); // TODO, only provided by CoalesceDropFactory2
68  }
69 
70  template <class LocalOrdinal, class GlobalOrdinal, class Node>
72  {
73  FactoryMonitor m(*this, "Build", currentLevel);
74 
75  RCP<Aggregates> aggregates;
76  {
77  //TODO check for reuse of aggregates here
78 
79  // Level Get
80  RCP<const GraphBase> graph = Get< RCP<GraphBase> >(currentLevel, "Graph");
81 
82  // Build
83  aggregates = rcp(new Aggregates(*graph));
84  aggregates->setObjectLabel("UC");
85 
86  algo1_.CoarsenUncoupled(*graph, *aggregates);
87  algo2_.AggregateLeftovers(*graph, *aggregates);
88 
89  }
90 
91  aggregates->AggregatesCrossProcessors(true);
92  aggregates->ComputeAggregateSizes(true/*forceRecompute*/);
93 
94  // Level Set
95  Set(currentLevel, "Aggregates", aggregates);
96 
97  if (IsPrint(Statistics0)) {
98  aggregates->describe(GetOStream(Statistics0), getVerbLevel());
99  }
100 
101  }
102 
103 } //namespace MueLu
104 
105 #endif // MUELU_COUPLEDAGGREGATIONFACTORY_DEF_HPP
Container class for aggregation information.
virtual void describe(Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
Timer to be used in factories. Similar to Monitor but with additional timers.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Teuchos::ArrayRCP< LO > ComputeAggregateSizes(bool forceRecompute=false) const
Compute sizes of aggregates.
Print statistics that do not involve significant additional computation.
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
void Build(Level &currentLevel) const
Build aggregates.
Exception throws to report errors in the internal logical of the program.
void AggregatesCrossProcessors(const bool &flag)
Record whether aggregates include DOFs from other processes.
void DeclareInput(Level &currentLevel) const
Input.