Chombo + EB: SPACE.H Source File

00001 #ifdef CH_LANG_CC
00002 /*
00003  *      _______              __
00004  *     / ___/ /  ___  __ _  / /  ___
00005  *    / /__/ _ \/ _ \/  V \/ _ \/ _ \
00006  *    \___/_//_/\___/_/_/_/_.__/\___/
00007  *    Please refer to Copyright.txt, in Chombo's root directory.
00008  */
00009 #endif
00010 
00011 #ifndef _SPACE_H_
00012 #define _SPACE_H_
00013 
00014 #ifdef HAVE_CONFIG_H
00015 #include <autoconfig.H>
00016 #endif
00017 
00018 #ifdef CH_LANG_CC
00019 # include "MayDay.H"
00020 #endif
00021 
00022 # include "CH_assert.H"
00023 
00024 #include "NamespaceHeader.H"
00025 
00026 #if !defined(CH_LANG_FORT) || defined(CH_LANG_CC)
00027 
00028 /**
00029   The SpaceDim C++ integer constant specifies the dimension of the
00030   Chombo library to be built.  It is initialized to the value of
00031   the macro CH_SPACEDIM.  Hence it will have one of the values 1, 2, or 3.
00032 
00033   C++ code that depends on the dimensionality of the problem that
00034   you're trying to solve should be cast in terms of this constant,
00035   instead of the CH_SPACEDIM macro, if possible, as constants are
00036   visible to debuggers while macros are not.
00037 */
00038    const int SpaceDim = CH_SPACEDIM;
00039 #endif
00040 
00041 #ifdef DOXYGEN
00042 /** \defgroup macros Chombo Macros
00043  */
00044 
00045 /**
00046 @ingroup macros
00047 compile-time cpp macro that controls the dimensionality of
00048     the Chombo package.  */
00049 #define CH_SPACEDIM
00050 #undef  CH_SPACEDIM
00051 #define CH_SPACEDIM 3
00052 #endif
00053 
00054 #if ! defined(CH_SPACEDIM)
00055 #error CH_SPACEDIM must be defined
00056 #endif
00057 
00058 #if (CH_SPACEDIM < 1 || CH_SPACEDIM > 6)
00059 #error CH_SPACEDIM must be either 1, 2, 3, 4, 5, or 6
00060 #endif
00061 
00062 #ifdef DOXYGEN
00063 #undef CH_SPACEDIM
00064 #endif
00065 
00066 #include "NamespaceFooter.H"
00067 
00068 #endif
00069 #ifdef CH_LANG_CC
00070 // That matches the include guard.  The rest of this file is all macros
00071 // whose definitions depend on CH_SPACEDIM.  In CH_MULTIDIM mode, we want
00072 // to rescan these macros after every time CH_SPACEDIM has changed.
00073 // Of course, if CH_MULTIDIM is not defined, we want to scan just once.
00074 #endif
00075 
00076 #ifndef LAST_SPACE_H_SPACEDIM
00077 #define LAST_SPACE_H_SPACEDIM 0
00078 #endif
00079 
00080 #if CH_SPACEDIM != LAST_SPACE_H_SPACEDIM
00081 #undef  LAST_SPACE_H_SPACEDIM
00082 
00083 #ifdef D_EXPR6
00084 #undef D_EXPR
00085 #undef D_DECL
00086 #undef D_TERM
00087 #undef D_INVTERM
00088 #undef D_SELECT
00089 #undef D_EXPR6
00090 #undef D_DECL6
00091 #undef D_TERM6
00092 #undef D_INVTERM6
00093 #undef D_SELECT6
00094 #endif
00095 
00096 #if CH_SPACEDIM==1
00097 #  define D_EXPR(a,b,c) ((void)((a),0))
00098 #  define D_DECL(a,b,c) a
00099 #  define D_TERM(a,b,c) a
00100 #  define D_INVTERM(a,b,c) a
00101 #  define D_SELECT(a,b,c) a
00102 #  define D_EXPR6(a,b,c,d,e,f) ((void)((a),0))
00103 #  define D_DECL6(a,b,c,d,e,f) a
00104 #  define D_TERM6(a,b,c,d,e,f) a
00105 #  define D_INVTERM6(a,b,c,d,e,f) a
00106 #  define D_SELECT6(a,b,c,d,e,f) a
00107 #  define LAST_SPACE_H_SPACEDIM 1
00108 
00109 #elif CH_SPACEDIM==2
00110 #  define D_EXPR(a,b,c) ((void)((a),(b),0))
00111 #  define D_DECL(a,b,c) a,b
00112 #  define D_TERM(a,b,c) a b
00113 #  define D_INVTERM(a,b,c) b a
00114 #  define D_SELECT(a,b,c) b
00115 #  define D_EXPR6(a,b,c,d,e,f) ((void)((a),(b),0))
00116 #  define D_DECL6(a,b,c,d,e,f) a,b
00117 #  define D_TERM6(a,b,c,d,e,f) a b
00118 #  define D_INVTERM6(a,b,c,d,e,f) b a
00119 #  define D_SELECT6(a,b,c,d,e,f) b
00120 #  define LAST_SPACE_H_SPACEDIM 2
00121 
00122 #elif CH_SPACEDIM==3
00123 #ifdef DOXYGEN
00124 /**
00125 @ingroup macros
00126 
00127   The D_EXPR(a,b,c) macro expands to a comma expression that will
00128   evaluate SpaceDim of its arguments, counting from the left; i.e.
00129   CH_SPACEDIM==1 implies only `a' is evaluated, CH_SPACEDIM==2
00130   implies both `a' and `b', and CH_SPACEDIM==3 implies all three
00131   arguments are evaluated.  This macro can be used to enhance
00132   the portability of code that works with structures whose size
00133   depends on CH_SPACEDIM.
00134 
00135   For example:
00136 
00137      D_EXPR(vect[0] *= s, vect[1] *= s, vect[2] *= s);
00138 
00139   More explicitly, this macro evaluates to one of
00140 
00141      ((void)((a),0))
00142 
00143      ((void)((a),(b),0))
00144 
00145      ((void)((a),(b),(c),0))
00146 
00147   corresponding to CH_SPACEDIM values of 1, 2, or 3.
00148 */
00149 #endif
00150 #  define D_EXPR(a,b,c) ((void)((a),(b),(c),0))
00151 #  define D_EXPR6(a,b,c,d,e,f) ((void)((a),(b),(c),0))
00152 
00153 #ifdef DOXYGEN
00154 /**
00155 @ingroup macros
00156 
00157   The D_DECL(a,b,c) macro expands to a comma-separated list of
00158   1, 2, or all 3 of the arguments of the call, depending on the
00159   value of CH_SPACEDIM.  This can be used to write portable
00160   function calls that depend on 1, 2, or 3 arguments, corresponding
00161   to the value of CH_SPACEDIM.
00162 
00163   For example:
00164 
00165      return IntVect(D_DECL(p[0] + s, p[1] + s, p[2] + s));
00166 
00167   More explicitly, this macro evaluates to one of
00168 
00169      a
00170 
00171      a,b
00172 
00173      a,b,c
00174 
00175   corresponding to CH_SPACEDIM values of 1, 2, or 3.
00176 */
00177 #endif
00178 #  define D_DECL(a,b,c) a,b,c
00179 #  define D_DECL6(a,b,c,d,e,f) a,b,c
00180 
00181 #ifdef DOXYGEN
00182 /**
00183 @ingroup macros
00184    define D_TERM(a,b,c) a b c
00185 
00186   More explicitly, this macro evaluates to one of
00187 
00188      a
00189 
00190      a b
00191 
00192      a b c
00193 
00194     corresponding to CH_SPACEDIM values of 1, 2, or 3.
00195 
00196     handy for situations like:
00197 
00198     Real norm = sqrt(D_TERM(u[0]*u[0],+u[1]*u[1],+u[2]*u[2]));
00199 */
00200 #endif
00201 #  define D_TERM(a,b,c) a b c
00202 #  define D_TERM6(a,b,c,d,e,f) a b c
00203 
00204 #ifdef DOXYGEN
00205 /**
00206 @ingroup macros
00207    define D_INVTERM(a,b,c) c b a
00208 
00209   More explicitly, this macro evaluates to one of
00210 
00211      a
00212 
00213      b a
00214 
00215      c b a
00216 
00217     corresponding to CH_SPACEDIM values of 1, 2, or 3.
00218 
00219     handy for situations like declaring nested loops where you want (a)
00220     to be the innermost or last for loop statement:
00221 
00222     {
00223       D_INVTERM(
00224         for (int i0 = 0; i0 != n0; ++i0)
00225           {
00226             data[(i2*n1 + i1)*n0 + i0] = val;
00227           },
00228         for (int i1 = 0; i1 != n1; ++i1) {,
00229         for (int i2 = 0; i2 != n2; ++i2) {)
00230     D_TERM(},},})
00231 */
00232 #endif
00233 #  define D_INVTERM(a,b,c) c b a
00234 #  define D_INVTERM6(a,b,c,d,e,f) c b a
00235 
00236 #ifdef DOXYGEN
00237 /**
00238 @ingroup macros
00239    define D_SELECT(a,b,c) a b c
00240 
00241   More explicitly, this macro evaluates to one of
00242 
00243      a
00244 
00245      b
00246 
00247      c
00248 
00249     corresponding to CH_SPACEDIM values of 1, 2, or 3.
00250 */
00251 #endif
00252 #  define D_SELECT(a,b,c) c
00253 #  define D_SELECT6(a,b,c,d,e,f) c
00254 
00255 #  define LAST_SPACE_H_SPACEDIM 3
00256 
00257 #ifdef DOXYGEN
00258 /** higher-dimensional (up to 6D) extensions of the original macros
00259    (note that the original macros are no longer defined once dim>3)
00260  */
00261 #endif
00262 #elif CH_SPACEDIM==4
00263 #  define D_EXPR6(a,b,c,d,e,f) ((void)((a),(b),(c),(d),0))
00264 #  define D_DECL6(a,b,c,d,e,f) a,b,c,d
00265 #  define D_TERM6(a,b,c,d,e,f) a b c d
00266 #  define D_INVTERM6(a,b,c,d,e,f) d c b a
00267 #  define D_SELECT6(a,b,c,d,e,f) d
00268 #  define LAST_SPACE_H_SPACEDIM 4
00269 
00270 #elif CH_SPACEDIM==5
00271 #  define D_EXPR6(a,b,c,d,e,f) ((void)((a),(b),(c),(d),(e),0))
00272 #  define D_DECL6(a,b,c,d,e,f) a,b,c,d,e
00273 #  define D_TERM6(a,b,c,d,e,f) a b c d e
00274 #  define D_INVTERM6(a,b,c,d,e,f) e d c b a
00275 #  define D_SELECT6(a,b,c,d,e,f) e
00276 #  define LAST_SPACE_H_SPACEDIM 5
00277 
00278 #elif CH_SPACEDIM==6
00279 #  define D_EXPR6(a,b,c,d,e,f) ((void)((a),(b),(c),(d),(e),(f),0))
00280 #  define D_DECL6(a,b,c,d,e,f) a,b,c,d,e,f
00281 #  define D_TERM6(a,b,c,d,e,f) a b c d e f
00282 #  define D_INVTERM6(a,b,c,d,e,f) f e d c b a
00283 #  define D_SELECT6(a,b,c,d,e,f) f
00284 #  define LAST_SPACE_H_SPACEDIM 6
00285 
00286 #else /* matches elif CH_SPACEDIM==3 */
00287 // note that D_TERM, D_DECL, D_EXPR, D_SELECT are not defined for DIM>3
00288 #  define LAST_SPACE_H_SPACEDIM CH_SPACEDIM
00289 #endif
00290 #endif /* matches CH_SPACEDIM != LAST_SPACE_H_SPACEDIM */