jan/fdfd_tools
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

Comment cleanup

Browse Source
This commit is contained in:
jan 2016-07-18 21:10:02 -07:00
parent c2d43b01df
commit 85880c859e
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
fdfd_tools/grid.py
View File

@ -21,9 +21,9 @@ def prepare_s_function(ln_R: float = -16,
:param ln_R: Natural logarithm of the desired reflectance :param ln_R: Natural logarithm of the desired reflectance
:param m: Polynomial order for the PML (imaginary part increases as distance ** m) :param m: Polynomial order for the PML (imaginary part increases as distance ** m)
:return: An s_function, which takes an ndarray (distances) and returns an ndarray (complex part of :return: An s_function, which takes an ndarray (distances) and returns an ndarray (complex part
the cell width; needs to be divided by sqrt(epilon_effective) * real(omega)) before of the cell width; needs to be divided by sqrt(epilon_effective) * real(omega))
use. before use.
""" """
def s_factor(distance: numpy.ndarray) -> numpy.ndarray: def s_factor(distance: numpy.ndarray) -> numpy.ndarray:
s_max = (m + 1) * ln_R / 2 # / 2 because we assume periodic boundaries s_max = (m + 1) * ln_R / 2 # / 2 because we assume periodic boundaries
@ -96,11 +96,11 @@ def stretch_with_scpml(dxes: dx_lists_t,
:param axis: axis to stretch (0=x, 1=y, 2=z) :param axis: axis to stretch (0=x, 1=y, 2=z)
:param polarity: direction to stretch (-1 for -ve, +1 for +ve) :param polarity: direction to stretch (-1 for -ve, +1 for +ve)
:param omega: Angular frequency for the simulation :param omega: Angular frequency for the simulation
:param epsilon_effective: Effective epsilon of the PML. Match this to the material at the edge of your grid. :param epsilon_effective: Effective epsilon of the PML. Match this to the material at the
Default 1. edge of your grid. Default 1.
:param thickness: number of cells to use for pml (default 10) :param thickness: number of cells to use for pml (default 10)
:param s_function: s_function created by prepare_s_function(...), allowing customization of pml parameters. :param s_function: s_function created by prepare_s_function(...), allowing customization
Default uses prepare_s_function() with no parameters. of pml parameters. Default uses prepare_s_function() with no parameters.
:return: Complex cell widths :return: Complex cell widths
""" """
if s_function is None: if s_function is None: