Inputs: `geometry.dims` option (#2685)

* Docs: `geometry.dims` option

Add a new, required option to specify the geometry of an
inputs file at runtime.

* Check & Report Runtime Dims Mismatch

* Examples: add `geometry.dims`

* Deprecation Warning: `geometry.coord_sys`

* PICMI: `geometry.dims`

* Improve error message

sounds a bit better

* Improve Doc Description

Co-authored-by: Revathi  Jambunathan <41089244+RevathiJambunathan@users.noreply.github.com>

Co-authored-by: Revathi  Jambunathan <41089244+RevathiJambunathan@users.noreply.github.com>

1 files changed, 5 insertions, 5 deletions

diff --git a/Python/pywarpx/_libwarpx.py b/Python/pywarpx/_libwarpx.py
index 5ffb74360..2c942c49d 100755
--- a/Python/pywarpx/_libwarpx.py
+++ b/Python/pywarpx/_libwarpx.py
@@ -84,16 +84,16 @@ class LibWarpX():
         # --- The geometry must be setup before the lib warpx shared object can be loaded.
         try:
             _prob_lo = geometry.prob_lo
-            _coord_sys = geometry.coord_sys
+            _dims = geometry.dims
         except AttributeError:
             raise Exception('The shared object could not be loaded. The geometry must be setup before the WarpX shared object can be accessesd. The geometry determines which version of the shared object to load.')
 
-        if _coord_sys == 0:
-            self.geometry_dim = '%dd'%len(_prob_lo)
-        elif _coord_sys == 1:
+        if _dims == 'RZ':
             self.geometry_dim = 'rz'
+        elif (_dims == '1' or _dims == '2' or _dims == '3'):
+            self.geometry_dim = '%dd'%len(_prob_lo)
         else:
-            raise Exception('Undefined coordinate system %d'%_coord_sys)
+            raise Exception('Undefined geometry %d'%_dims)
 
         # this is a plain C/C++ shared library, not a Python module
         if os.name == 'nt':