rename nonaxisymmetric, axisymmetric to off-axis, on-axis in script f…

…ilename, within the script, and in plot titles
NanoComp · Jan 10, 2025 · 4fd9c08 · 4fd9c08
1 parent 8d5ebda
commit 4fd9c08
Show file tree

Hide file tree

Showing 7 changed files with 321 additions and 16 deletions.
diff --git a/doc/docs/Python_Tutorials/Near_to_Far_Field_Spectra.md b/doc/docs/Python_Tutorials/Near_to_Far_Field_Spectra.md
diff --git a/doc/docs/images/dipole_radiation_pattern_off_axis.png b/doc/docs/images/dipole_radiation_pattern_off_axis.png
diff --git a/doc/docs/images/dipole_radiation_pattern_on_axis.png b/doc/docs/images/dipole_radiation_pattern_on_axis.png
diff --git a/doc/docs/images/radiation_pattern_axisymmetric_dipole.png b/doc/docs/images/radiation_pattern_axisymmetric_dipole.png
diff --git a/doc/docs/images/radiation_pattern_nonaxisymmetric_dipole.png b/doc/docs/images/radiation_pattern_nonaxisymmetric_dipole.png
diff --git a/...s/dipole_in_vacuum_cyl_nonaxisymmetric.py → ...examples/dipole_in_vacuum_cyl_off_axis.py b/...s/dipole_in_vacuum_cyl_nonaxisymmetric.py → ...examples/dipole_in_vacuum_cyl_off_axis.py
@@ -1,4 +1,4 @@
-"""Radiation pattern of a nonaxisymmetric dipole in cylindrical coordinates.
+"""Radiation pattern of an off-axis dipole in cylindrical coordinates.
 
 Tutorial Reference:
 
@@ -59,11 +59,11 @@ def plot_radiation_pattern(dipole_pol: str, radial_flux: np.ndarray):
     ax.grid(True)
     ax.set_rlabel_position(22)
     ax.set_ylabel("radial flux (a.u.)")
-    ax.set_title("radiation pattern (φ = 0) of a nonaxisymmetric {dipole_name} dipole")
+    ax.set_title(f"radiation pattern (φ = 0) of an off-axis {dipole_name} dipole")
 
     if mp.am_master():
         fig.savefig(
-            "dipole_radiation_pattern_nonaxisymmetric.png",
+            "dipole_radiation_pattern_off_axis.png",
             dpi=150,
             bbox_inches="tight",
         )
@@ -134,7 +134,7 @@ def get_farfields(
 def dipole_in_vacuum(
     dipole_pol: str, dipole_pos_r: mp.Vector3, m: int
 ) -> Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray]:
-    """Computes the far fields of a nonaxisymmetric point source.
+    """Computes the far fields of an off-axis point source.
 
     Args:
         dipole_pol: the dipole polarization.
@@ -292,7 +292,7 @@ def flux_from_farfields(e_field: np.ndarray, h_field: np.ndarray) -> float:
 
     if mp.am_master():
         np.savez(
-            "dipole_farfields_nonaxisymmetric.npz",
+            "dipole_farfields_off_axis.npz",
             AZIMUTHAL_RAD=AZIMUTHAL_RAD,
             FARFIELD_RADIUS_UM=FARFIELD_RADIUS_UM,
             PML_UM=PML_UM,

diff --git a/...ples/dipole_in_vacuum_cyl_axisymmetric.py → .../examples/dipole_in_vacuum_cyl_on_axis.py b/...ples/dipole_in_vacuum_cyl_axisymmetric.py → .../examples/dipole_in_vacuum_cyl_on_axis.py
@@ -1,4 +1,4 @@
-"""Radiation pattern of an axisymmetric dipole in cylindrical coordinates.
+"""Radiation pattern of an on-axis dipole in cylindrical coordinates.
 
 Tutorial Reference:
 
@@ -60,11 +60,11 @@ def plot_radiation_pattern(dipole_pol: str, radial_flux: np.ndarray):
     ax.grid(True)
     ax.set_rlabel_position(22)
     ax.set_ylabel("radial flux (a.u.)")
-    ax.set_title("radiation pattern (φ = 0) of an axisymmetric {dipole_name} dipole")
+    ax.set_title("radiation pattern (φ = 0) of an on-axis {dipole_name} dipole")
 
     if mp.am_master():
         fig.savefig(
-            "dipole_radiation_pattern_axisymmetric.png",
+            "dipole_radiation_pattern_on_axis.png",
             dpi=150,
             bbox_inches="tight",
         )
@@ -133,7 +133,7 @@ def get_farfields(
 
 
 def dipole_in_vacuum(dipole_pol: str, m: int) -> Tuple[np.ndarray, np.ndarray]:
-    """Computes the far fields of an axisymmetric point source.
+    """Computes the far fields of an on-axis point source.
 
     Args:
         dipole_pol: the polarization of the electric dipole. Either x or z.
@@ -273,7 +273,7 @@ def flux_from_farfields(e_field: np.ndarray, h_field: np.ndarray) -> float:
 
     if mp.am_master():
         np.savez(
-            "dipole_farfields_axisymmetric.npz",
+            "dipole_farfields_on_axis.npz",
             AZIMUTHAL_RAD=AZIMUTHAL_RAD,
             FARFIELD_RADIUS_UM=FARFIELD_RADIUS_UM,
             PML_UM=PML_UM,