MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_LineDetectionFactory_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 #ifndef MUELU_LINEDETECTIONFACTORY_DECL_HPP
47 #define MUELU_LINEDETECTIONFACTORY_DECL_HPP
48 
49 // same as in SemiCoarsenPFactory (TODO rework this)
50 #define VERTICAL 1
51 #define HORIZONTAL 2
52 #define GRID_SUPPLIED -1
53 
54 #include "MueLu_ConfigDefs.hpp"
56 
57 #include "MueLu_Level_fwd.hpp"
59 
60 namespace MueLu {
61 
67  template <class Scalar = DefaultScalar,
70  class Node = DefaultNode>
72 #undef MUELU_LINEDETECTIONFACTORY_SHORT
73 #include "MueLu_UseShortNames.hpp"
74 
75  public:
76 
78  using CoordinateMultiVector = typename Xpetra::MultiVector<coordinate_type, LO, GO, NO>;
79 
81 
82 
84 
86  virtual ~LineDetectionFactory() { }
87 
89 
91 
93 
94 
95  void DeclareInput(Level& currentLevel) const;
96 
98 
100 
101 
107  void Build(Level& currentLevel) const;
108 
110 
111  private:
112  void sort_coordinates(LO numCoords, LO* OrigLoc,
113  coordinate_type* xvals,
114  coordinate_type* yvals,
115  coordinate_type* zvals,
116  coordinate_type* xtemp,
117  coordinate_type* ytemp,
118  coordinate_type* ztemp,
119  bool flipXY = false) const;
120 
121  LO ML_compute_line_info(LO LayerId[], LO VertLineId[],
122  LO Ndof, LO DofsPerNode,
123  LO MeshNumbering, LO NumNodesPerVertLine,
124  coordinate_type *xvals, coordinate_type *yvals, coordinate_type *zvals,
125  const Teuchos::Comm<int>& comm ) const ;
126 
127  void ML_az_dsort2(coordinate_type dlist[], LO N, LO list2[]) const;
128 
133  mutable LO Zorientation_;
134 
135  }; //class LineDetectionFactory
136 
137 } //namespace MueLu
138 
139 #define MUELU_LINEDETECTIONFACTORY_SHORT
140 #endif // MUELU_LINEDETECTIONFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
typename Teuchos::ScalarTraits< SC >::coordinateType coordinate_type
MueLu::DefaultNode Node
void Build(Level &currentLevel) const
Build method.
void ML_az_dsort2(coordinate_type dlist[], LO N, LO list2[]) const
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void sort_coordinates(LO numCoords, LO *OrigLoc, coordinate_type *xvals, coordinate_type *yvals, coordinate_type *zvals, coordinate_type *xtemp, coordinate_type *ytemp, coordinate_type *ztemp, bool flipXY=false) const
Factory for building line detection information.
LO ML_compute_line_info(LO LayerId[], LO VertLineId[], LO Ndof, LO DofsPerNode, LO MeshNumbering, LO NumNodesPerVertLine, coordinate_type *xvals, coordinate_type *yvals, coordinate_type *zvals, const Teuchos::Comm< int > &comm) const
Base class for factories that use one level (currentLevel).
typename Xpetra::MultiVector< coordinate_type, LO, GO, NO > CoordinateMultiVector
void DeclareInput(Level &currentLevel) const
Input.