AMReX_SPACE.H

Go to the documentation of this file.

 
#ifndef AMREX_SPACE_H
#define AMREX_SPACE_H
#include <AMReX_Config.H>
 
/* for backward compatibility */
#if defined(BL_SPACEDIM) && !defined(AMREX_SPACEDIM)
#define AMREX_SPACEDIM BL_SPACEDIM
#endif
#if !defined(BL_SPACEDIM)
#define BL_SPACEDIM AMREX_SPACEDIM
#endif
 
/*
 * \def AMREX_SPACEDIM
 *
 * The AMREX_SPACEDIM macro specifies the dimension of the AMReX library
 * to be built.  Acceptable values are either 1, 2, or 3.  This macro
 * must be set for every compilation as many of the data structures of
 * AMReX rely on it being set.
 *
 * Code that depends on the dimensionality of the problem that you're
 * trying to solve should be cast in terms of this macro.
 */
 
#if !defined(AMREX_SPACEDIM)
#error AMREX_SPACEDIM must be defined
#endif
 
#if  (AMREX_SPACEDIM != 1 && AMREX_SPACEDIM !=2 && AMREX_SPACEDIM != 3)
#error AMREX_SPACEDIM must be either 1, 2, or 3
#endif
 
/*
  The SpaceDim C++ integer constant specifies the dimension of the
  AMReX library to be built.  It is initialized to the value of
  the macro AMREX_SPACEDIM.  Hence it will have one of the values 1, 2, or 3.
 
  C++ code that depends on the dimensionality of the problem that
  you're trying to solve should be cast in terms of this constant,
  instead of the AMREX_SPACEDIM macro, if possible, as constants are
  visible to debuggers while macros are not.
*/
#ifdef __cplusplus
namespace amrex
{
    constexpr int SpaceDim = AMREX_SPACEDIM;
}
#endif
 
 
#if AMREX_SPACEDIM==1
 
#  define AMREX_D_EXPR(a,b,c) ((void)((a),0))
 
#  define AMREX_D_DECL(a,b,c) a
 
#  define AMREX_D_TERM(a,b,c) a
 
#  define AMREX_D_PICK(a,b,c) a
#elif AMREX_SPACEDIM==2
#  define AMREX_D_EXPR(a,b,c) ((void)((a),(b),0))
#  define AMREX_D_DECL(a,b,c) a,b
#  define AMREX_D_TERM(a,b,c) a b
#  define AMREX_D_PICK(a,b,c) b
#elif AMREX_SPACEDIM==3
#  define AMREX_D_EXPR(a,b,c) ((void)((a),(b),(c),0))
#  define AMREX_D_DECL(a,b,c) a,b,c
#  define AMREX_D_TERM(a,b,c) a b c
#  define AMREX_D_PICK(a,b,c) c
#endif
 
#if (AMREX_SPACEDIM == 1)
#  define AMREX_1D_ONLY(a) a
#  define AMREX_2D_ONLY(a) ((void)0)
#  define AMREX_3D_ONLY(a) ((void)0)
#elif (AMREX_SPACEDIM == 2)
#  define AMREX_1D_ONLY(a) ((void)0)
#  define AMREX_2D_ONLY(a) a
#  define AMREX_3D_ONLY(a) ((void)0)
#elif (AMREX_SPACEDIM == 3)
#  define AMREX_1D_ONLY(a) ((void)0)
#  define AMREX_2D_ONLY(a) ((void)0)
#  define AMREX_3D_ONLY(a) a
#endif
 
#ifdef __cplusplus
 
#if (AMREX_SPACEDIM == 1)
#define AMREX_1D_ONLY_ARGS(...) __VA_ARGS__ ,
#else
#define AMREX_1D_ONLY_ARGS(...)
#endif
 
#if (AMREX_SPACEDIM == 2)
#define AMREX_2D_ONLY_ARGS(...) __VA_ARGS__ ,
#else
#define AMREX_2D_ONLY_ARGS(...)
#endif
 
#if (AMREX_SPACEDIM == 3)
#define AMREX_3D_ONLY_ARGS(...) __VA_ARGS__ ,
#else
#define AMREX_3D_ONLY_ARGS(...)
#endif
 
#endif
 
#endif /*AMREX_SPACE_H*/