clarify forward/backward mode coefficients (#2616)

* clarify forward/backward mode coefficients * Update simulation.py * Update doc/docs/Python_User_Interface.md
NanoComp · Sep 7, 2023 · 8d2fd8d · 8d2fd8d
1 parent d07df02
commit 8d2fd8d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/docs/Python_User_Interface.md b/doc/docs/Python_User_Interface.md
@@ -1419,7 +1419,7 @@ following fields:
 + `alpha`: the complex eigenmode coefficients as a 3d NumPy array of size
   (`len(bands)`, `flux.nfreqs`, `2`). The last/third dimension refers to modes
   propagating in the forward (+) or backward (-) directions defined relative to
-  the mode's dominant wavevector.
+  the sign of the propagation constant β of the mode (the wavevector component in the direction perpendicular to the mode-monitor plane).
 + `vgrp`: the group velocity as a NumPy array.
 + `kpoints`: a list of `mp.Vector3`s of the `kpoint` used in the mode calculation.
 + `kdom`: a list of `mp.Vector3`s of the mode's dominant wavevector.

diff --git a/python/simulation.py b/python/simulation.py
@@ -4145,7 +4145,7 @@ def get_eigenmode_coefficients(
         + `alpha`: the complex eigenmode coefficients as a 3d NumPy array of size
           (`len(bands)`, `flux.nfreqs`, `2`). The last/third dimension refers to modes
           propagating in the forward (+) or backward (-) directions defined relative to
-          the mode's dominant wavevector.
+          the sign of the propagation constant β of the mode (the wavevector component in the direction perpendicular to the mode-monitor plane).
         + `vgrp`: the group velocity as a NumPy array.
         + `kpoints`: a list of `mp.Vector3`s of the `kpoint` used in the mode calculation.
         + `kdom`: a list of `mp.Vector3`s of the mode's dominant wavevector.