From 001bf1e2eff28702084aa439b9b9a9fd648ef524 Mon Sep 17 00:00:00 2001 From: Jan Petykiewicz Date: Sun, 24 Sep 2017 19:14:30 -0700 Subject: [PATCH] Clarify eigensolver documentation --- fdfd_tools/waveguide_mode.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fdfd_tools/waveguide_mode.py b/fdfd_tools/waveguide_mode.py index fac43e2..c6b9900 100644 --- a/fdfd_tools/waveguide_mode.py +++ b/fdfd_tools/waveguide_mode.py @@ -45,7 +45,7 @@ def solve_waveguide_mode_2d(mode_number: int, ''' Shift by the absolute value of the largest eigenvalue, then find a few of the - largest (shifted) eigenvalues. The shift ensures that we find the largest + largest-magnitude (shifted) eigenvalues. The shift ensures that we find the largest _positive_ eigenvalues, since any negative eigenvalues will be shifted to the range 0 >= neg_eigval + abs(lm_eigval) > abs(lm_eigval) '''