[Draft] Elements: add ds() Function

To Do: - [ ] Python - [ ] Doc Strings
ECP-WarpX · Aug 31, 2022 · f33e63e · f33e63e
1 parent 6ca18ae
commit f33e63e
Show file tree

Hide file tree

Showing 9 changed files with 90 additions and 0 deletions.
diff --git a/src/particles/elements/ConstF.H b/src/particles/elements/ConstF.H
@@ -141,6 +141,16 @@ namespace impactx
             return m_nslice;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return m_ds;
+        }
+
     private:
         amrex::ParticleReal m_ds; //! segment length in m
         amrex::ParticleReal m_kx; //! focusing x strength in 1/m

diff --git a/src/particles/elements/DipEdge.H b/src/particles/elements/DipEdge.H
@@ -106,6 +106,16 @@ namespace impactx
             return 1;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return 0.0;
+        }
+
     private:
         amrex::ParticleReal m_psi; //! pole face angle in rad
         amrex::ParticleReal m_rc; //! bend radius in m

diff --git a/src/particles/elements/Drift.H b/src/particles/elements/Drift.H
@@ -133,6 +133,16 @@ namespace impactx
             return m_nslice;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return m_ds;
+        }
+
     private:
         amrex::ParticleReal m_ds; //! segment length in m
         int m_nslice; //! number of slices used for the application of space charge

diff --git a/src/particles/elements/Multipole.H b/src/particles/elements/Multipole.H
@@ -129,6 +129,16 @@ namespace impactx
             return 1;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return 0.0;
+        }
+
     private:
         int m_multipole; //! multipole index
         int m_mfactorial; //! factorial of multipole index

diff --git a/src/particles/elements/None.H b/src/particles/elements/None.H
@@ -69,6 +69,16 @@ namespace impactx
         {
             return 1;
         }
+
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return 0.0;
+        }
     };
 
 } // namespace impactx

diff --git a/src/particles/elements/NonlinearLens.H b/src/particles/elements/NonlinearLens.H
@@ -138,6 +138,16 @@ namespace impactx
             return 1;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return 0.0;
+        }
+
     private:
         amrex::ParticleReal m_knll; //! integrated strength of the nonlinear lens (m)
         amrex::ParticleReal m_cnll; //! distance of singularities from the origin (m)

diff --git a/src/particles/elements/Quad.H b/src/particles/elements/Quad.H
@@ -155,6 +155,16 @@ namespace impactx
             return m_nslice;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return m_ds;
+        }
+
     private:
         amrex::ParticleReal m_ds; //! segment length in m
         amrex::ParticleReal m_k; //! quadrupole strength in 1/m

diff --git a/src/particles/elements/Sbend.H b/src/particles/elements/Sbend.H
@@ -151,6 +151,16 @@ namespace impactx
             return m_nslice;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return m_ds;
+        }
+
     private:
         amrex::ParticleReal m_ds; //! segment length in m
         amrex::ParticleReal m_rc; //! bend radius in m

diff --git a/src/particles/elements/ShortRF.H b/src/particles/elements/ShortRF.H
@@ -107,6 +107,16 @@ namespace impactx
             return 1;
         }
 
+        /** ...
+         *
+         * @return ...
+         */
+        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
+        amrex::ParticleReal ds () const
+        {
+            return 0.0;
+        }
+
     private:
         amrex::ParticleReal m_V; //! normalized (max) RF voltage drop.
         amrex::ParticleReal m_k; //! RF wavenumber in 1/m.