SpatialOps
SpatialOpsDefs.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 The University of Utah
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to
6  * deal in the Software without restriction, including without limitation the
7  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8  * sell copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20  * IN THE SOFTWARE.
21  */
22 
23 #ifndef UT_SpatialOpsDefs_h
24 #define UT_SpatialOpsDefs_h
25 
26 #include <spatialops/SpatialOpsConfigure.h>
27 
30 namespace SpatialOps{
31 
32  //==================================================================
33 
44  struct XDIR{ enum{value=0}; };
45 
50  struct YDIR{ enum{value=1}; };
51 
56  struct ZDIR{ enum{value=2}; };
57 
62  struct NODIR{ enum{value=-10}; };
63  // end of Direction group.
65 
66 
67 
68 
78  struct Interpolant{};
79 
84  struct Extrapolant{};
85 
90  struct Gradient{};
91 
96  struct Divergence{};
97 
102  struct Filter{};
103 
108  struct Restriction{};
109 
110 
115  struct InterpolantX{ typedef XDIR DirT; };
120  struct InterpolantY{ typedef YDIR DirT; };
121 
126  struct InterpolantZ{ typedef ZDIR DirT; };
127 
132  struct GradientX{ typedef XDIR DirT; };
137  struct GradientY{ typedef YDIR DirT; };
138 
143  struct GradientZ{ typedef ZDIR DirT; };
144  // end of Operator Types group
146 
147 
159  enum BCSide{
163  };
164 
165 
169  enum BCType{
173  };
174  // end of boundary conditions group
176 
177  //==================================================================
178 
179 }
180 
181 #endif
Defines a type for Extrapolant operators.
Y-interpolant for use with FD operations whose src and dest fields are the same type.
Z-interpolant for use with FD operations whose src and dest fields are the same type.
Defines a type to represent no direction.
Defines a type for Filter operators.
for wide stencils where we set on a point rather than a face
Y-interpolant for use with FD operations whose src and dest fields are the same type.
Defines a type for Divergence operators.
X-interpolant for use with FD operations whose src and dest fields are the same type.
BCSide
Allows identification of whether we are setting the BC on the right or left side when using an operat...
X-interpolant for use with FD operations whose src and dest fields are the same type.
Defines a type for the x-direction.
Defines a type for the y-direction.
Unsupported boundary type.
Defines a type for Gradient operators.
Defines a type for the z-direction.
Defines a type for Restriction operators.
Defines a type for Interpolant operators.
Neumann boundary.
Dirichlet boundary.
Z-interpolant for use with FD operations whose src and dest fields are the same type.