Fix: None -> Empty Element/Dist

`None` is a keyword in Python and thus should not be used as a class type for our empty element or our empty distribution. This fixes it by renaming both to `Empty`.
ECP-WarpX · Apr 29, 2024 · a6915b5 · a6915b5
1 parent de80f7a
commit a6915b5
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 20 deletions.
diff --git a/docs/source/usage/python.rst b/docs/source/usage/python.rst
@@ -401,7 +401,7 @@ This module provides particle beam distributions that can be used to initialize
    A K-V distribution transversely + a uniform distribution
    in t + a Gaussian distribution in pt.
 
-.. py:class:: impactx.distribution.None
+.. py:class:: impactx.distribution.Empty
 
    This distribution sets all values to zero.
 
@@ -564,7 +564,7 @@ This module provides elements for the accelerator lattice.
    :param dy: vertical translation error in m
    :param rotation: rotation error in the transverse plane [degrees]
 
-.. py::class:: impactx.elements.None
+.. py::class:: impactx.elements.Empty
 
    This element does nothing.
 

diff --git a/src/particles/distribution/All.H b/src/particles/distribution/All.H
@@ -14,7 +14,7 @@
 #include "Kurth4D.H"
 #include "Kurth6D.H"
 #include "KVdist.H"
-#include "None.H"
+#include "Empty.H"
 #include "Semigaussian.H"
 #include "Thermal.H"
 #include "Triangle.H"
@@ -26,7 +26,7 @@
 namespace impactx::distribution
 {
     using KnownDistributions = std::variant<
-        None, /* must be first, so KnownDistributions creates a default constructor */
+        Empty, /* must be first, so KnownDistributions creates a default constructor */
         Gaussian,
         Kurth4D,
         Kurth6D,

diff --git a/src/particles/distribution/None.H → src/particles/distribution/Empty.H b/src/particles/distribution/None.H → src/particles/distribution/Empty.H
@@ -7,8 +7,8 @@
  * Authors: Chad Mitchell, Axel Huebl
  * License: BSD-3-Clause-LBNL
  */
-#ifndef IMPACTX_DISTRIBUTION_NONE
-#define IMPACTX_DISTRIBUTION_NONE
+#ifndef IMPACTX_DISTRIBUTION_EMPTY_H
+#define IMPACTX_DISTRIBUTION_EMPTY_H
 
 #include "particles/ReferenceParticle.H"
 
@@ -18,11 +18,11 @@
 
 namespace impactx::distribution
 {
-    struct None
+    struct Empty
     {
         /** This distribution sets all values to zero.
          */
-        None()
+        Empty()
         {
         }
 
@@ -81,4 +81,4 @@ namespace impactx::distribution
 
 } // namespace impactx::distribution
 
-#endif // IMPACTX_DISTRIBUTION_NONE
+#endif // IMPACTX_DISTRIBUTION_EMPTY_H
diff --git a/src/particles/elements/All.H b/src/particles/elements/All.H
@@ -24,7 +24,7 @@
 #include "ExactSbend.H"
 #include "Kicker.H"
 #include "Multipole.H"
-#include "None.H"
+#include "Empty.H"
 #include "NonlinearLens.H"
 #include "Programmable.H"
 #include "Quad.H"
@@ -44,7 +44,7 @@
 namespace impactx
 {
     using KnownElements = std::variant<
-        None, /* must be first, so KnownElements creates a default constructor */
+        Empty, /* must be first, so KnownElements creates a default constructor */
         Aperture,
         Buncher,
         CFbend,

diff --git a/src/particles/elements/None.H → src/particles/elements/Empty.H b/src/particles/elements/None.H → src/particles/elements/Empty.H
@@ -7,8 +7,8 @@
  * Authors: Axel Huebl
  * License: BSD-3-Clause-LBNL
  */
-#ifndef IMPACTX_NONE_H
-#define IMPACTX_NONE_H
+#ifndef IMPACTX_ELEMENT_EMPTY_H
+#define IMPACTX_ELEMENT_EMPTY_H
 
 #include "particles/ImpactXParticleContainer.H"
 #include "mixin/thin.H"
@@ -20,7 +20,7 @@
 
 namespace impactx
 {
-    struct None
+    struct Empty
     : public elements::Thin,
       public elements::NoFinalize
     {
@@ -29,7 +29,7 @@ namespace impactx
 
         /** This element does nothing.
          */
-        None ()
+        Empty ()
         {
         }
 
@@ -81,4 +81,4 @@ namespace impactx
 
 } // namespace impactx
 
-#endif // IMPACTX_NONE_H
+#endif // IMPACTX_ELEMENT_EMPTY_H
diff --git a/src/python/distribution.cpp b/src/python/distribution.cpp
@@ -75,7 +75,7 @@ void init_distribution(py::module& m)
              "in t + a Gaussian distribution in pt"
         );
 
-    py::class_<distribution::None>(md, "None")
+    py::class_<distribution::Empty>(md, "Empty")
         .def(py::init<>(),
              "Sets all values to zero."
         );

diff --git a/src/python/elements.cpp b/src/python/elements.cpp
@@ -674,11 +674,11 @@ void init_elements(py::module& m)
     ;
     register_beamoptics_push(py_Multipole);
 
-    py::class_<None, elements::Thin> py_None(me, "None");
+    py::class_<Empty, elements::Thin> py_None(me, "Empty");
     py_None
         .def("__repr__",
-             [](None const & /* none */) {
-                 return std::string("<impactx.elements.None>");
+             [](Empty const & /* none */) {
+                 return std::string("<impactx.elements.Empty>");
              }
         )
         .def(py::init<>(),