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 = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
69 #undef MUELU_LINEDETECTIONFACTORY_SHORT
70 #include "MueLu_UseShortNames.hpp"
71 
72  public:
73 
75 
76 
78 
80  virtual ~LineDetectionFactory() { }
81 
83 
85 
87 
88 
89  void DeclareInput(Level& currentLevel) const;
90 
92 
94 
95 
101  void Build(Level& currentLevel) const;
102 
104 
105  private:
106  void sort_coordinates(LO numCoords, LO* OrigLoc, Scalar* xvals, Scalar* yvals, Scalar* zvals, Scalar* xtemp, Scalar* ytemp, Scalar* ztemp, bool flipXY = false) const;
107 
108  LO ML_compute_line_info(LO LayerId[], LO VertLineId[],
109  LO Ndof, LO DofsPerNode,
110  LO MeshNumbering, LO NumNodesPerVertLine,
111  SC *xvals, SC *yvals, SC *zvals,
112  const Teuchos::Comm<int>& comm ) const ;
113 
114  void ML_az_dsort2(SC dlist[], LO N, LO list2[]) const;
115 
120  mutable LO Zorientation_;
121 
122  }; //class LineDetectionFactory
123 
124 } //namespace MueLu
125 
126 #define MUELU_LINEDETECTIONFACTORY_SHORT
127 #endif // MUELU_LINEDETECTIONFACTORY_DECL_HPP
void sort_coordinates(LO numCoords, LO *OrigLoc, Scalar *xvals, Scalar *yvals, Scalar *zvals, Scalar *xtemp, Scalar *ytemp, Scalar *ztemp, bool flipXY=false) const
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
LocalOrdinal LO
void Build(Level &currentLevel) const
Build method.
LO ML_compute_line_info(LO LayerId[], LO VertLineId[], LO Ndof, LO DofsPerNode, LO MeshNumbering, LO NumNodesPerVertLine, SC *xvals, SC *yvals, SC *zvals, const Teuchos::Comm< int > &comm) const
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Factory for building line detection information.
void ML_az_dsort2(SC dlist[], LO N, LO list2[]) const
Scalar SC
Base class for factories that use one level (currentLevel).
void DeclareInput(Level &currentLevel) const
Input.