MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_AggregationExportFactory_decl.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_AggregationExportFactory_decl.hpp
48  *
49  * Created on: Feb 10, 2012
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_AGGREGATIONEXPORTFACTORY_DECL_HPP_
54 #define MUELU_AGGREGATIONEXPORTFACTORY_DECL_HPP_
55 
56 #include <Xpetra_Matrix_fwd.hpp>
58 
59 #include "MueLu_ConfigDefs.hpp"
61 #include "MueLu_VisualizationHelpers.hpp"
63 #include "MueLu_Aggregates_fwd.hpp"
64 #include "MueLu_Graph_fwd.hpp"
65 #include "MueLu_GraphBase.hpp"
68 #include "MueLu_Utilities_fwd.hpp"
69 
70 namespace MueLu {
71 
72  class Level;
73 
107  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
108  class AggregationExportFactory : public TwoLevelFactoryBase, public VisualizationHelpers<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
109 #undef MUELU_AGGREGATIONEXPORTFACTORY_SHORT
110 #include "MueLu_UseShortNames.hpp"
111 
112  public:
114 
115 
118  doFineGraphEdges_(false),
119  doCoarseGraphEdges_(false),
120  numNodes_(0),
121  numAggs_(0),
122  dims_(0),
123  myRank_(-1),
124  aggsOffset_(0)
125  { }
126 
130 
132 
134 
135 
136  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
137 
139 
141 
144  void Build(Level &fineLevel, Level &coarseLevel) const;
145 
147 
148  private:
149  //Break different viz styles into separate functions for organization:
150  void doJacksPlus_(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
151  void doConvexHulls(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
152  #ifdef HAVE_MUELU_CGAL
153  void doAlphaHulls_(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
154  void doAlphaHulls2D_(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
155  void doAlphaHulls3D_(std::vector<int>& vertices, std::vector<int>& geomSizes) const;
156  #endif
157  void doGraphEdges_(std::ofstream& fout, Teuchos::RCP<Matrix>& A, Teuchos::RCP<GraphBase>& G, bool fine, int dofs) const; //add geometry to display node connections from a matrix. Connections in graph but not matrix have different color.
158 
159  // write VTK data
160  void writeFile_(std::ofstream& fout, std::string styleName, std::vector<int>& vertices, std::vector<int>& geomSizes) const;
161  void buildColormap_() const;
162  void writePVTU_(std::ofstream& pvtu, std::string baseFname, int numProcs) const;
163 
164  static const int CONTRAST_1_ = -1;
165  static const int CONTRAST_2_ = -2;
166  static const int CONTRAST_3_ = -3;
167 
168  //Data that the different styles need to have available when building geometry
177  mutable std::vector<bool> isRoot_;
178  mutable bool doFineGraphEdges_;
179  mutable bool doCoarseGraphEdges_;
180  mutable int numNodes_;
181  mutable int numAggs_;
182  mutable int dims_;
183  mutable int myRank_;
184  mutable Teuchos::RCP<const Map> nodeMap_; //map used in A and Coordinates to map local ordinals to global ordinals. Need the whole map especially if it's not contiguous.
186  mutable int aggsOffset_; //in a global list of aggregates, the offset of local aggregate indices
187  }; // class AggregationExportFactory
188 } // namespace MueLu
189 
190 #define MUELU_AGGREGATIONEXPORTFACTORY_SHORT
191 
192 #endif /* MUELU_AGGREGATIONEXPORTFACTORY_DECL_HPP_ */
Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > yCoords_
void doAlphaHulls3D_(std::vector< int > &vertices, std::vector< int > &geomSizes) const
void doAlphaHulls_(std::vector< int > &vertices, std::vector< int > &geomSizes) const
void doConvexHulls(std::vector< int > &vertices, std::vector< int > &geomSizes) const
void doGraphEdges_(std::ofstream &fout, Teuchos::RCP< Matrix > &A, Teuchos::RCP< GraphBase > &G, bool fine, int dofs) const
void writeFile_(std::ofstream &fout, std::string styleName, std::vector< int > &vertices, std::vector< int > &geomSizes) const
Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > zCoords_
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 writePVTU_(std::ofstream &pvtu, std::string baseFname, int numProcs) const
Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > cz_
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > cy_
Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > xCoords_
void doJacksPlus_(std::vector< int > &vertices, std::vector< int > &geomSizes) const
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void doAlphaHulls2D_(std::vector< int > &vertices, std::vector< int > &geomSizes) const
Teuchos::ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::coordinateType > cx_