aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Docs/source/building/building.rst1
-rw-r--r--Docs/source/building/rzgeometry.rst11
2 files changed, 12 insertions, 0 deletions
diff --git a/Docs/source/building/building.rst b/Docs/source/building/building.rst
index 620acc6bd..572ca4a16 100644
--- a/Docs/source/building/building.rst
+++ b/Docs/source/building/building.rst
@@ -83,6 +83,7 @@ Advanced building instructions
:maxdepth: 1
spectral
+ rzgeometry
gpu_local
python
spack
diff --git a/Docs/source/building/rzgeometry.rst b/Docs/source/building/rzgeometry.rst
new file mode 100644
index 000000000..0dc3783a7
--- /dev/null
+++ b/Docs/source/building/rzgeometry.rst
@@ -0,0 +1,11 @@
+Building WarpX to use RZ geometry
+=================================
+
+WarpX can be built to run with RZ geometry. Currently, this only allows pure axisymmetry (i.e. mode 0) with an FDTD solver.
+
+To select RZ geometry, set the flag USE_RZ = TRUE when compiling:
+::
+
+ make -j 4 USE_PSATD=TRUE
+
+The executable produced will have "RZ" as a suffix.