Photonic-Architecture-Laboratories / si-photonics-toolkit

Photonic Integrated Design Package
MIT License
11 stars 0 forks source link

clarification of neff use with meshgrid() #28

Closed esmagden closed 1 year ago

esmagden commented 1 year ago

Currently, we have in the description of neff a use case where we pass 1D arrays of width and wavelength. Isn't it possible to also pass 2D arrays resulting from meshgrid()? That seems to be a more typical use case right?

We should also clarify the use cases fully:

1) width (scalar), wavelength (scalar) - scalar returned 2) width (scalar), wavelength (1D array) - 1D array returned (width is replicated) 3) width (1D array), wavelength (scalar) - 1D array returned (wavelength is replicated) 4) width (1D array), wavelength (1D array) - 1D array returned (nothing is replicated, both parameters are read element by element) 5) width (2D array), wavelength (2D array) - 2D array returned (same as 4) 6) width (scalar), wavelength (2D array) - 2D array returned (width should be replicated, same as in 2) 7) width (scalar), wavelength (2D array) - 2D array returned (width should be replicated, same as in 2)

It would be good to explain how use cases 2, 3, 6, and 7 do an automatic replication of the scalar parameter passed in.