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