Fix: None -> Empty Element/Dist

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.
 

examples/aperture/run_aperture.py

@@ -7,7 +7,6 @@
 # -*- coding: utf-8 -*-
 
 import amrex.space3d as amr
-
 from impactx import ImpactX, distribution, elements
 
 # work-around for https://github.com/ECP-WarpX/impactx/issues/499

examples/fodo_tune/run_fodo_tune.py

@@ -7,7 +7,6 @@
 # -*- coding: utf-8 -*-
 
 import amrex.space3d as amr
-
 from impactx import ImpactX, distribution, elements
 
 sim = ImpactX()

examples/initialize_from_array/run_from_array.py

@@ -9,7 +9,6 @@
 import amrex.space3d as amr
 import numpy as np
 import transformation_utilities as pycoord
-
 from impactx import Config, ImpactX, elements
 
 ################

examples/optimize_triplet/run_triplet.py

@@ -7,11 +7,10 @@
 # -*- coding: utf-8 -*-
 
 import amrex.space3d as amr
-import numpy as np
-from scipy.optimize import minimize
-
 import impactx
+import numpy as np
 from impactx import ImpactX, distribution, elements
+from scipy.optimize import minimize
 
 # Call MPI_Init and MPI_Finalize only once:
 if impactx.Config.have_mpi:

examples/pytorch_surrogate_model/run_ml_surrogate_15_stage.py

@@ -20,8 +20,6 @@
 
 import numpy as np
 import scipy.optimize as opt
-from surrogate_model_definitions import surrogate_model
-
 from impactx import (
     Config,
     CoordSystem,
@@ -31,6 +29,7 @@
     distribution,
     elements,
 )
+from surrogate_model_definitions import surrogate_model
 
 try:
     import torch

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,

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

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,

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

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."
         );

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<>(),

src/python/impactx/__init__.pyi

@@ -17,7 +17,6 @@ from __future__ import annotations
 import os as os
 
 from amrex import space3d as amr
-
 from impactx.impactx_pybind import (
     Config,
     CoordSystem,

tests/python/conftest.py

@@ -3,9 +3,8 @@
 import os
 
 import amrex.space3d as amr
-import pytest
-
 import impactx
+import pytest
 
 if impactx.Config.have_mpi:
     from mpi4py import MPI  # noqa

tests/python/test_charge_deposition.py

@@ -11,12 +11,11 @@
 import math
 
 import amrex.space3d as amr
+import impactx
 import matplotlib.pyplot as plt
 import numpy as np
 from conftest import basepath
 
-import impactx
-
 
 def test_charge_deposition(save_png=True):
     """

tests/python/test_dataframe.py

@@ -11,7 +11,6 @@
 
 import matplotlib.pyplot as plt
 import pytest
-
 from impactx import ImpactX, amr, distribution, elements
 
 

tests/python/test_impactx.py

@@ -10,7 +10,6 @@
 import numpy as np
 import pytest
 from conftest import basepath
-
 from impactx import ImpactX, distribution, elements
 
 # FIXME in AMReX via https://github.com/AMReX-Codes/amrex/pull/3727

tests/python/test_transformation.py

@@ -8,7 +8,6 @@
 
 import numpy as np
 import pytest
-
 from impactx import CoordSystem, ImpactX, coordinate_transformation, distribution
 
 

tests/python/test_xopt.py

@@ -10,10 +10,9 @@
 import importlib
 
 import amrex.space3d as amr
+import impactx
 import numpy as np
 import pytest
-
-import impactx
 from impactx import ImpactX, distribution, elements
 
 # configure the test