Clarify eigensolver documentation

This commit is contained in:
Jan Petykiewicz 2017-09-24 19:14:30 -07:00
parent 17fa2aa3d3
commit 001bf1e2ef

View File

@ -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)
'''