SpatialOps
FVStaggeredLocationTypes.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 FVStaggeredLocationTypes_h
24 #define FVStaggeredLocationTypes_h
25 
26 #include <spatialops/SpatialOpsConfigure.h>
29 
30 
39 namespace SpatialOps{
40 
41 
42  // FaceDir: The direction relative to its volume field that this field is staggered.
43  //
44  // Offset : The offset of this field relative to a scalar volume center.
45  //
46  // BCExtra: If a physical BC is present in the given direction, this
47  // typedef provides a way to determine the number of extra
48  // points in this field relative to a scalar volume field.
49 
64  struct SSurfX{ typedef XDIR FaceDir; typedef IndexTriplet<-1, 0, 0> Offset; typedef IndexTriplet<1,0,0> BCExtra; };
65  struct SSurfY{ typedef YDIR FaceDir; typedef IndexTriplet< 0,-1, 0> Offset; typedef IndexTriplet<0,1,0> BCExtra; };
66  struct SSurfZ{ typedef ZDIR FaceDir; typedef IndexTriplet< 0, 0,-1> Offset; typedef IndexTriplet<0,0,1> BCExtra; };
67 
81  struct XVol { typedef NODIR FaceDir; typedef IndexTriplet<-1, 0, 0> Offset; typedef IndexTriplet<1,0,0> BCExtra; };
83  struct XSurfY{ typedef YDIR FaceDir; typedef IndexTriplet<-1,-1, 0> Offset; typedef IndexTriplet<0,1,0> BCExtra; };
84  struct XSurfZ{ typedef ZDIR FaceDir; typedef IndexTriplet<-1, 0,-1> Offset; typedef IndexTriplet<0,0,1> BCExtra; };
85 
99  struct YVol { typedef NODIR FaceDir; typedef IndexTriplet< 0,-1, 0> Offset; typedef IndexTriplet<0,1,0> BCExtra; };
100  struct YSurfX{ typedef XDIR FaceDir; typedef IndexTriplet<-1,-1, 0> Offset; typedef IndexTriplet<1,0,0> BCExtra; };
102  struct YSurfZ{ typedef ZDIR FaceDir; typedef IndexTriplet< 0,-1,-1> Offset; typedef IndexTriplet<0,0,1> BCExtra; };
103 
117  struct ZVol { typedef NODIR FaceDir; typedef IndexTriplet< 0, 0,-1> Offset; typedef IndexTriplet<0,0,1> BCExtra; };
118  struct ZSurfX{ typedef XDIR FaceDir; typedef IndexTriplet<-1, 0,-1> Offset; typedef IndexTriplet<1,0,0> BCExtra; };
119  struct ZSurfY{ typedef YDIR FaceDir; typedef IndexTriplet< 0,-1,-1> Offset; typedef IndexTriplet<0,1,0> BCExtra; };
121 
122  struct Vertex{ typedef NODIR FaceDir; typedef IndexTriplet<-1,-1,-1> Offset; typedef IndexTriplet<1,1,1> BCExtra; };
123 
129 
130 }// namespace SpatialOps
131 
136 #endif
Type traits for a x-staggered volume field.
Type traits for a y-staggered volume field.
Type traits for an x-surface field on a x-staggered volume.
Type traits for a z-staggered volume field.
Type traits for an z-surface field on a y-staggered volume.
Type traits for a scalar volume field.
Type traits for a single value field.
Used for specifying field type traits.
Definition: IndexTriplet.h:121
Defines a type to represent no direction.
Type traits for an y-surface field on a z-staggered volume.
Type traits for an y-surface field on a x-staggered volume.
Type traits for an x-surface field on a scalar volume.
Type traits for an x-surface field on a y-staggered volume.
Type traits for an z-surface field on a z-staggered volume.
Type traits for an z-surface field on a x-staggered volume.
Defines a type for the x-direction.
Defines a type for the y-direction.
Defines a type for the z-direction.
Type traits for an y-surface field on a scalar volume.
Type traits for an y-surface field on a y-staggered volume.
Type traits for an x-surface field on a z-staggered volume.
Type traits for an z-surface field on a scalar volume.