make vectorization docs point to the right functions

This commit is contained in:
jan 2021-07-05 14:58:14 -07:00
parent 61c85fc654
commit 8faefff98d
2 changed files with 2 additions and 2 deletions

View File

@ -3,7 +3,7 @@ Sparse matrix operators for use with electromagnetic wave equations.
These functions return sparse-matrix (`scipy.sparse.spmatrix`) representations of These functions return sparse-matrix (`scipy.sparse.spmatrix`) representations of
a variety of operators, intended for use with E and H fields vectorized using the a variety of operators, intended for use with E and H fields vectorized using the
`meanas.vec()` and `meanas.unvec()` functions. `meanas.fdmath.vectorization.vec()` and `meanas.fdmath.vectorization.unvec()` functions.
E- and H-field values are defined on a Yee cell; `epsilon` values should be calculated for E- and H-field values are defined on a Yee cell; `epsilon` values should be calculated for
cells centered at each E component (`mu` at each H component). cells centered at each E component (`mu` at each H component).

View File

@ -74,7 +74,7 @@ def generic(omega: complex,
""" """
Conjugate gradient FDFD solver using CSR sparse matrices. Conjugate gradient FDFD solver using CSR sparse matrices.
All ndarray arguments should be 1D arrays, as returned by `meanas.vec()`. All ndarray arguments should be 1D arrays, as returned by `meanas.fdmath.vectorization.vec()`.
Args: Args:
omega: Complex frequency to solve at. omega: Complex frequency to solve at.