Macros for specifying sets of faces of the computational domain,

e.g. for use with boundary conditions.  For now it contains only
CCTK_ALL_FACES.


git-svn-id: http://svn.cactuscode.org/flesh/trunk@3140 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 34 insertions, 0 deletions

diff --git a/src/include/cctk_Faces.h b/src/include/cctk_Faces.h
new file mode 100644
index 00000000..4125b480
--- /dev/null
+++ b/src/include/cctk_Faces.h
@@ -0,0 +1,34 @@
+ /*@@
+   @header    cctk_Faces.h
+   @date      11 Feb 2003
+   @author    David Rideout
+   @desc 
+              Macros for generic specification of sets of 'faces' of an 
+	      'n-cube'
+   @enddesc 
+   @version   $Header$
+ @@*/
+
+#ifndef _CCTK_FACES_H_
+#define _CCTK_FACES_H_ 1
+
+/* The set of all faces */
+#define CCTK_ALL_FACES 0
+
+/* Here will be placed macros which provide a user friendly interface
+ * to a general specification for expressing sets of faces of an
+ * n-dimensional rectangle.  Each face will be assigned one bit in a
+ * word.  Then one can bitwise-or a number of these together to
+ * specify a set of faces.  The macros will make this user-friendly
+ * somehow (and accessible to Fortran).
+ * 
+ * Example:
+ *
+ * #define FACE0 1>>0
+ * #define FACE1 1>>1
+ * etc.
+ *
+ * where FACE0 may be the negative x-face, FACE1 the positive x-face, etc.
+ */
+
+#endif /* _CCTK_FACES_H_ */