Merge pull request ComputationalRadiationPhysics#5425 from PrometheusPi/add_check_picmi_laser_origin_focus_direction

add test to picmi Gauss laser

Author: chillenzer

lib/python/picongpu/picmi/gaussian_laser.py

@@ -29,6 +29,17 @@ def scalarProduct(self, a: typing.List[float], b: typing.List[float]) -> float:
 
         return result
 
+    def crossProduct(self, a: typing.List[float], b: typing.List[float]) -> typing.List[float]:
+        assert len(a) == len(b) == 3, "the cross product is only defined for 3d vectors"
+        return [a[1] * b[2] - a[2] * b[1], a[2] * b[0] - a[0] * b[2], a[0] * b[1] - a[1] * b[0]]
+
+    def difference(self, a: typing.List[float], b: typing.List[float]) -> typing.List[float]:
+        assert len(a) == len(b), "the difference between two vectors is only defined if they have the same length"
+        result = []
+        for i in range(len(a)):
+            result.append(a[i] - b[i])
+        return result
+
     @staticmethod
     def testRelativeError(trueValue, testValue, relativeErrorLimit):
         return abs((testValue - trueValue) / trueValue) < relativeErrorLimit
@@ -140,6 +151,14 @@ def get_as_pypicongpu(self) -> laser.GaussianLaser:
             1e-9,
         ), "polarization vector must be normalized"
 
+        # check that propagation_direction is parallel to the difference of focal_position and centroid_position
+        diff_vec = self.difference(self.focal_position, self.centroid_position)
+        cross_vec = self.crossProduct(diff_vec, self.propagation_direction)
+        length_of_cross_product = self.scalarProduct(cross_vec, cross_vec)
+
+        assert length_of_cross_product < 1e-5, "propagation_direction must connect centroid_position and focus_position"
+        del (diff_vec, cross_vec, length_of_cross_product)  # clean up
+
         pypicongpu_laser = laser.GaussianLaser()
         pypicongpu_laser.wavelength = self.wavelength
         pypicongpu_laser.waist = self.waist

test/python/picongpu/quick/picmi/gaussian_laser.py

@@ -22,7 +22,7 @@ def test_basic(self):
             propagation_direction=[0, 1, 0],
             polarization_direction=[0, 0, 1],
             focal_position=[5, 4, 5],
-            centroid_position=[0, 0, 0],
+            centroid_position=[5, 0, 5],
             E0=5,
             picongpu_laguerre_modes=[2.0, 3.0],
             picongpu_laguerre_phases=[4.0, 5.0],
@@ -76,7 +76,7 @@ def test_values_focal_pos(self):
             2,
             3,
             focal_position=[1, 2, -5],
-            centroid_position=[0.5, 0, 0.5],
+            centroid_position=[1, 0, -5],
             propagation_direction=[0, 1, 0],
             polarization_direction=[1, 0, 0],
             E0=1,