MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_Types.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_TYPES_HPP
47 #define MUELU_TYPES_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
51 namespace MueLu {
52  enum CycleType {
55  };
56 
57  enum PreOrPost {
58  PRE = 0x1,
59  POST = 0x2,
60  BOTH = 0x3
61  };
62 
63  // In the algorithm, aggStat[] = READY/NOTSEL/SELECTED indicates whether a node has been aggregated
64  enum NodeState {
65  READY = 1, // indicates that a node is available to be
66  // selected as a root node of an aggregate
67 
68  NOTSEL = 2, // indicates that a node has been rejected as a root node.
69  // This could perhaps be because if this node had been
70  // selected a small aggregate would have resulted
71  // This is Phase 1 specific
72 
73  AGGREGATED = 3, // indicates that a node has been assigned
74  // to an aggregate
75 
76  ONEPT = 4, // indicates that a node shall be preserved over
77  // all multigrid levels as 1 point aggregate
78 
79  IGNORED = 5, // indicates that the node is removed from consideration,
80  // and is not aggregated
81 
82  BOUNDARY = 6, // node is a Dirichlet node
83  // During aggregation, it is transformed either to AGGREGATED
84  // or to IGNORED
85  INTERFACE = 7 // node is chosen as root node on an interface where coordinated
86  // coarsening across the interface is required.
87  };
88 
89  // This is use by the structured aggregation index manager to keep track of the underlying mesh
90  // layout.
91  enum IndexingType {
92  UNCOUPLED = 1, // indicates that the underlying mesh is treated independently from rank to rank
93 
94  LOCALLEXI = 2, // local lexicographic indexing of the mesh, this is similar to uncoupled but
95  // extra data is used to compute indices accross ranks
96 
97  GLOBALLEXI = 3 // global lexicographic indexing of the mesh means that the mesh is ordered
98  // lexicographically accorss and subsequently split among ranks.
99  };
100 
101 }
102 
103 #endif //ifndef MUELU_TYPES_HPP