diff options
Diffstat (limited to 'Docs/source/developers')
| -rw-r--r-- | Docs/source/developers/dimensionality.rst | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/Docs/source/developers/dimensionality.rst b/Docs/source/developers/dimensionality.rst index ee98368d5..1ccdbba5d 100644 --- a/Docs/source/developers/dimensionality.rst +++ b/Docs/source/developers/dimensionality.rst @@ -13,6 +13,7 @@ Dimensions CMake Option ========== =================== **3D3V** ``WarpX_DIMS=3`` **2D3V** ``WarpX_DIMS=2`` +**1D3V** ``WarpX_DIMS=1`` **RZ** ``WarpX_DIMS=RZ`` ========== =================== @@ -23,31 +24,32 @@ Defines Depending on the build variant of WarpX, the following preprocessor macros will be set: -================== =========== =========== =========== -Macro 3D3V 2D3V RZ -================== =========== =========== =========== -``AMREX_SPACEDIM`` ``3`` ``2`` ``2`` -``WARPX_DIM_3D`` **defined** *undefined* *undefined* -``WARPX_DIM_XZ`` *undefined* **defined** *undefined* -``WARPX_DIM_RZ`` *undefined* *undefined* **defined** -================== =========== =========== =========== +================== =========== =========== =========== =========== +Macro 3D3V 2D3V 1D3V RZ +================== =========== =========== =========== =========== +``AMREX_SPACEDIM`` ``3`` ``2`` ``1`` ``2`` +``WARPX_DIM_3D`` **defined** *undefined* *undefined* *undefined* +``WARPX_DIM_1D_Z`` *undefined* *undefined* **defined** *undefined* +``WARPX_DIM_XZ`` *undefined* **defined** *undefined* *undefined* +``WARPX_DIM_RZ`` *undefined* *undefined* *undefined* **defined** +================== =========== =========== =========== =========== At the same time, the following conventions will apply: -==================== =========== =========== =========== -**Convention** **3D3V** **2D3V** **RZ** --------------------- ----------- ----------- ----------- +==================== =========== =========== =========== =========== +**Convention** **3D3V** **2D3V** **1D3V** **RZ** +-------------------- ----------- ----------- ----------- ----------- *Fields* ------------------------------------------------------------ -AMReX Box dimensions ``3`` ``2`` ``2`` -WarpX axis labels ``x, y, z`` ``x, z`` ``x, z`` --------------------- ----------- ----------- ----------- +------------------------------------------------------------------------ +AMReX Box dimensions ``3`` ``2`` ``1`` ``2`` +WarpX axis labels ``x, y, z`` ``x, z`` ``z`` ``x, z`` +-------------------- ----------- ----------- ----------- ----------- *Particles* ------------------------------------------------------------ -AMReX AoS ``.pos()`` ``0, 1, 2`` ``0, 1`` ``0, 1`` -WarpX position names ``x, y, z`` ``x, z`` ``r, z`` -extra SoA attribute ``theta`` -==================== =========== =========== =========== +------------------------------------------------------------------------ +AMReX AoS ``.pos()`` ``0, 1, 2`` ``0, 1`` ``0`` ``0, 1`` +WarpX position names ``x, y, z`` ``x, z`` ``z`` ``r, z`` +extra SoA attribute ``theta`` +==================== =========== =========== =========== =========== Please see the following sections for particle AoS and SoA details. @@ -55,3 +57,4 @@ Conventions ----------- In 2D3V, we assume that the position of a particle in ``y`` is equal to ``0``. +In 1D3V, we assume that the position of a particle in ``x`` and ``y`` is equal to ``0``. |