ElectroMagneticPython 2.2.3__py3-none-any.whl → 2.2.4__py3-none-any.whl

EMpy/_version.py

@@ -1,5 +1,6 @@
-# file generated by setuptools-scm
+# file generated by vcs-versioning
 # don't change, don't track in version control
+from __future__ import annotations
 
 __all__ = [
     "__version__",
@@ -10,25 +11,14 @@ __all__ = [
     "commit_id",
 ]
 
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-    COMMIT_ID = Union[str, None]
-else:
-    VERSION_TUPLE = object
-    COMMIT_ID = object
-
 version: str
 __version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-commit_id: COMMIT_ID
-__commit_id__: COMMIT_ID
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
 
-__version__ = version = '2.2.3'
-__version_tuple__ = version_tuple = (2, 2, 3)
+__version__ = version = '2.2.4'
+__version_tuple__ = version_tuple = (2, 2, 4)
 
-__commit_id__ = commit_id = None
+__commit_id__ = commit_id = 'gd8c276251'

EMpy/constants.py

@@ -1,5 +1,3 @@
-# pylint: disable=C0301
-
 """Useful constants.
 
 Constants used in mathematics and electromagnetism.

EMpy/devices.py

@@ -1,5 +1,3 @@
-# pylint: disable=C0302,W0622,W1001,R0902,R0903,W0201,R0913,R0914,C0325,W0221
-
 """Set of objects and functions to describe the behaviour of some
 widely known devices and build new ones.
 
@@ -62,7 +60,7 @@ class DeviceMatrix:
         return self.__data
 
     def setdata(self, value):
-        self.__data = numpy.asmatrix(value)
+        self.__data = numpy.array(value)
 
     __data = None
     data = property(fget=getdata, fset=setdata, doc="data")
@@ -137,6 +135,7 @@ class TransferMatrix(DeviceMatrix):
 
         Notation::
 
+
             b12 = H1 a12 and d12 = H2 c12, but b12 == c12,
 
         therefore::
@@ -153,7 +152,7 @@ class TransferMatrix(DeviceMatrix):
 
         """
 
-        return TransferMatrix(M.to_transfer().data * self.data)
+        return TransferMatrix(M.to_transfer().data @ self.data)
 
 
 class ChainMatrix(DeviceMatrix):
@@ -227,7 +226,7 @@ class ChainMatrix(DeviceMatrix):
 
         """
 
-        return ChainMatrix(self.data * M.to_chain().data)
+        return ChainMatrix(self.data @ M.to_chain().data)
 
 
 def composeTM(A, B):

EMpy/materials.py

@@ -1,5 +1,3 @@
-# pylint: disable=W0622,R0903,R0902,R0913,W0633
-
 """Functions and objects to manipulate materials.
 
 A material is an object with a refractive index function.

EMpy/modesolvers/FD.py

@@ -1,7 +1,3 @@
-# pylint: disable=line-too-long,too-many-locals,too-many-statements,too-many-branches
-# pylint: disable=redefined-builtin,wildcard-import,unused-wildcard-import
-# pylint: disable=attribute-defined-outside-init,too-many-instance-attributes
-# pylint: disable=arguments-differ,too-many-arguments
 """Finite Difference Modesolver.
 
 @see: Fallahkhair, "Vector Finite Difference Modesolver for Anisotropic Dielectric Waveguides",

EMpy/transfer_matrix.py

@@ -39,8 +39,8 @@ class IsotropicTransferMatrix(TransferMatrix):
 
         INPUT
         multilayer = Multilayer obj describing the sequence of layers.
-        theta_inc = angle of the incident wave (in radiant) wrt the
-        normal.
+        theta_inc = angle of the incident wave (in radians) wrt the
+        normal, measured in the first layer (multilayer[0]).
         """
         if not multilayer.isIsotropic():
             raise ValueError(
@@ -118,12 +118,14 @@ class IsotropicTransferMatrix(TransferMatrix):
 
             Rs[iwl] = np.absolute(rs) ** 2
             Ts[iwl] = (
-                np.absolute((n[-1] * np.cos(theta[-1])) / (n[0] * np.cos(theta[0])))
+                np.real(n[-1] * np.cos(theta[-1]))
+                / np.real(n[0] * np.cos(theta[0]))
                 * np.absolute(ts) ** 2
             )
             Rp[iwl] = np.absolute(rp) ** 2
             Tp[iwl] = (
-                np.absolute((n[-1] * np.cos(theta[-1])) / (n[0] * np.cos(theta[0])))
+                np.real(np.conj(n[-1]) * np.cos(theta[-1]))
+                / np.real(np.conj(n[0]) * np.cos(theta[0]))
                 * np.absolute(tp) ** 2
             )
 
@@ -160,7 +162,9 @@ class AnisotropicTransferMatrix(TransferMatrix):
         INPUT
         multilayer = Multilayer obj describing the sequence of layers.
         theta_inc_x and theta_inc_y = angles of the incident wave (in
-        radiant) wrt the normal.
+        radians) wrt the normal in vacuum, i.e. kx = k0 * sin(theta_inc_x)
+        and ky = k0 * sin(theta_inc_y) (unlike IsotropicTransferMatrix,
+        where theta_inc is measured in multilayer[0]).
         """
         TransferMatrix.__init__(self, multilayer)
         self.theta_inc_x = theta_inc_x

EMpy/utils.py

@@ -1,5 +1,3 @@
-# pylint: disable=R0913,R0914,W0201,W0622,C0302,R0902,R0903,W1001,W0612,W0613
-
 """Useful functions and objects used more or less everywhere."""
 
 __author__ = "Lorenzo Bolla"

{electromagneticpython-2.2.3.dist-info → electromagneticpython-2.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ElectroMagneticPython
-Version: 2.2.3
+Version: 2.2.4
 Summary: EMpy - ElectroMagnetic Python
 Author-email: Lorenzo Bolla <code@lbolla.info>
 License-Expression: MIT

{electromagneticpython-2.2.3.dist-info → electromagneticpython-2.2.4.dist-info}/RECORD

@@ -1,18 +1,18 @@
 EMpy/RCWA.py,sha256=ORsYHvt1p7TIR3vKYQfhigRH1RnHyAX98kkGMkmxIi0,32673
 EMpy/__init__.py,sha256=aAaHG0VlGltUrWWZ4JMlVms2HDGj7RZ3CYNKqpZVYtM,1285
-EMpy/_version.py,sha256=KPjL9Q7mJ1mOq60evnMRyAe7ifMMp2BfVmDRydV9x98,704
-EMpy/constants.py,sha256=x1N8eRXQW_gdr1557n7tvUXiM4RW_Fc_EydLd5AUC1o,723
-EMpy/devices.py,sha256=Tu7CVvrhqfHBSf1EiDNPnUG4Dn6MDb6qgg2VpafmdHs,37760
-EMpy/materials.py,sha256=pgEM4Izy6HTA87Rl_GtNiiq5AKzc3M54fVFPFRnA8_I,10682
+EMpy/_version.py,sha256=L0uLqtm_cNa8ezMmrDendz17E_txW-SkqG84SLLwt1o,528
+EMpy/constants.py,sha256=kYVVAdOENFthm_Aqt5oT4eMOmbMNdkvpM2t1r-_IShE,698
+EMpy/devices.py,sha256=08LN_Nas0cpzQVj-J3x25AdObycwm_0b6k3s_dw2w6c,37679
+EMpy/materials.py,sha256=2TSTVY5R6tw5auHyWJcvFHSgMA2KANbCCbziuRO0GyY,10633
 EMpy/scattering.py,sha256=1rY8_TI0kzTLYwpFSSXndaO9FzDzVPRVow55vzIDQiM,7339
-EMpy/transfer_matrix.py,sha256=wSFqcEQYNUV4oM5SlZkglwRVyU5_w5dvRENXHfRXQpQ,14582
-EMpy/utils.py,sha256=hIZ07CqM1lhRTIujbReGldlBkUjzI3iXAyAReEATBqA,41762
-EMpy/modesolvers/FD.py,sha256=vKQOTgXY3-KzODAX0IOAfLbcFHUbpRt0MgteRLU3vjk,79281
+EMpy/transfer_matrix.py,sha256=0xqCbNvlxSQxqcWXm0Q_O0e9NWWvKPMlfZY36HIXAnk,14848
+EMpy/utils.py,sha256=BWgKxpdS29OXWkLp13Ft00ef-vzR8COZO1hn8KsASPc,41683
+EMpy/modesolvers/FD.py,sha256=oBlMSP1F1Ja1NIiIQcxUm-ZWHYYrKQHZaPxQ0ZuPMfY,78988
 EMpy/modesolvers/FMM.py,sha256=Z0HL_QGeJoQC9vyY2obBomcey0ZzVT5YZmD2-hABqZ8,78351
 EMpy/modesolvers/__init__.py,sha256=rg8pzFcZd7cihqfXYj0sQamogjtMV3ObNXCNbFD3bu0,222
 EMpy/modesolvers/geometries.py,sha256=X8Jd1iNoPRl5ibZiaKG13lHDIzejQ6PfrB6Zbe_c5lg,7906
 EMpy/modesolvers/interface.py,sha256=spMy30TFedYXJHcoV3yUdGkycGt5cplJUCeZui6a5MY,2397
-electromagneticpython-2.2.3.dist-info/licenses/LICENSE,sha256=NlQFsrkwMvQ2aD8531IDm6Rk01KzlI42HVzK5M1Hpw8,1065
+electromagneticpython-2.2.4.dist-info/licenses/LICENSE,sha256=NlQFsrkwMvQ2aD8531IDm6Rk01KzlI42HVzK5M1Hpw8,1065
 examples/ex_APRR.py,sha256=f3-LOPoLNSxjqfwAJJNjVSnKYB88CIULhbjzkzdavXA,459
 examples/ex_NRR.py,sha256=NVs4UASVdwiogZDSOfGAoSnbBByhB8EBLu4x3CDOnyE,900
 examples/ex_RCWA.py,sha256=05Cvv3BqFgSDn_u2iZsV65HdmvVbNljgJfISaPsqd1o,2733
@@ -27,7 +27,7 @@ examples/ex_modesolver_4.py,sha256=9JUjg6NK7IjwSgQvg3D_n6l_Cr0ev6hEoJGS0xffrFo,9
 examples/ex_modesolver_dch.py,sha256=ha38QB7rLklEnTNfF_C0b8u7gTGKIk_T3FB0TMib5eM,7314
 examples/ex_modesolver_dch_anis.py,sha256=Ye4nV5FXVxjT-FtJ3CyjzjXh9pmx9A0mbv-CkZxIN3Y,8184
 examples/ex_transfer_matrix.py,sha256=JyC_MPrrfpNItYmMQjm5RbMWXe7CSd96RplJrntdOaI,1789
-examples/ex_transfer_matrix_2.py,sha256=i1YMmrOSWDK0YS9aGF2thFD4_suNZsRJvs7Ei62sHAI,1058
+examples/ex_transfer_matrix_2.py,sha256=anMoXcGgpioJ5k0AvHHFEynT32etWFgmEpLy5SL2nNI,1060
 examples/ex_transfer_matrix_2.py.png,sha256=-cgjAE1t_6UPJyOZbAagaaBs-odr59A1RYldSpMOo0M,34886
 examples/ex_transfer_matrix_3.py,sha256=J8GePd3b45TmGJWL_Df7GFg-4FN8846WS9j7l9TmvRs,1501
 examples/lc_data.dat,sha256=MrT57K7PZV0YT2GPU9LjO6WlC-xCd6n841P57tQW5_s,4151
@@ -37,8 +37,9 @@ tests/__init__.py,sha256=XNMyfmlHhqih2xHEklXlmQ8GVUAdiiWrkT3trIOMpRQ,29
 tests/devices_test.py,sha256=UbmJgHp7kNVQyBYwxgaAierUVMvC7Pq5Jv7BKdFQPSw,890
 tests/materials_test.py,sha256=-Z8ZmqwgSCg2AJwF_4j-RH8Ct7AOOWhV67lyMm5dcO8,1846
 tests/modesolvers_test.py,sha256=v_nRDbKlda4w7A5mbZZl5fKYa2GlgLzHZaKDJZzGyrM,984
+tests/transfer_matrix_test.py,sha256=hp9idGz0G9BcriJYVxtJJokROqliSyl8RR4Zuxjm8Tw,5330
 tests/utils_test.py,sha256=QnG4O_FHrX6tXH1MuocFXxptOuOtoU-dR-crCtADzQw,721
-electromagneticpython-2.2.3.dist-info/METADATA,sha256=XB6uQFtMcIOL-56FDLYMqR1_i_Cne79NZP4UApAC8os,2351
-electromagneticpython-2.2.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-electromagneticpython-2.2.3.dist-info/top_level.txt,sha256=CosMJsXjoaa3iZmCrZf7E0eorTFxpEFfrtfUx1YWIHA,28
-electromagneticpython-2.2.3.dist-info/RECORD,,
+electromagneticpython-2.2.4.dist-info/METADATA,sha256=bHDIDEcgf6o6NK-aSI3g1pBTf02A9VXpuicoHsF9zvU,2351
+electromagneticpython-2.2.4.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+electromagneticpython-2.2.4.dist-info/top_level.txt,sha256=CosMJsXjoaa3iZmCrZf7E0eorTFxpEFfrtfUx1YWIHA,28
+electromagneticpython-2.2.4.dist-info/RECORD,,

{electromagneticpython-2.2.3.dist-info → electromagneticpython-2.2.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.2)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

examples/ex_transfer_matrix_2.py

@@ -40,5 +40,5 @@ plt.xlabel("wavelength /m")
 plt.ylabel("Power /dB")
 plt.grid()
 plt.xlim(wls.min(), wls.max())
-plt.savefig(__file__ + ".png")
+# plt.savefig(__file__ + ".png")
 plt.show()

tests/transfer_matrix_test.py

@@ -0,0 +1,134 @@
+from unittest import TestCase
+
+import numpy as np
+from numpy.testing import assert_allclose
+
+import EMpy
+
+
+def _make_iso_multilayer(n_list, d_list):
+    layers = EMpy.utils.Multilayer()
+    for n, d in zip(n_list, d_list):
+        mat = EMpy.materials.IsotropicMaterial(
+            "mat", n0=EMpy.materials.RefractiveIndex(n0_const=n)
+        )
+        layers.append(EMpy.utils.Layer(mat, d))
+    return layers
+
+
+def _make_aniso_multilayer(n_list, d_list):
+    layers = EMpy.utils.Multilayer()
+    for n, d in zip(n_list, d_list):
+        eps = EMpy.materials.EpsilonTensor(
+            epsilon_tensor_const=(n**2) * EMpy.constants.eps0 * np.eye(3)
+        )
+        mat = EMpy.materials.AnisotropicMaterial("mat", epsilon_tensor=eps)
+        layers.append(EMpy.utils.Layer(mat, d))
+    return layers
+
+
+class TransferMatrixTest(TestCase):
+
+    def test_fresnel_brewster(self):
+        n1, n2 = 1.0, 1.5
+        theta_b = np.arctan2(n2, n1)
+        layers = _make_iso_multilayer([n1, n2], [np.inf, np.inf])
+        sol = EMpy.transfer_matrix.IsotropicTransferMatrix(layers, theta_b).solve(
+            [1.55e-6]
+        )
+        assert_allclose(sol.Rp, [0.0], atol=1e-15)
+        assert_allclose(sol.Tp, [1.0], atol=1e-15)
+        assert_allclose(sol.Rs + sol.Ts, [1.0], atol=1e-15)
+
+    def test_total_internal_reflection(self):
+        layers = _make_iso_multilayer([1.5, 1.0], [np.inf, np.inf])
+        theta_inc = EMpy.utils.deg2rad(60.0)
+        sol = EMpy.transfer_matrix.IsotropicTransferMatrix(layers, theta_inc).solve(
+            [1.55e-6]
+        )
+        assert_allclose(sol.Rs, [1.0], atol=1e-15)
+        assert_allclose(sol.Ts, [0.0], atol=1e-15)
+        assert_allclose(sol.Rp, [1.0], atol=1e-15)
+        assert_allclose(sol.Tp, [0.0], atol=1e-15)
+
+    def test_frustrated_total_internal_reflection(self):
+        layers = _make_iso_multilayer([1.5, 1.0, 1.5], [np.inf, 0.2e-6, np.inf])
+        theta_inc = EMpy.utils.deg2rad(60.0)
+        sol = EMpy.transfer_matrix.IsotropicTransferMatrix(layers, theta_inc).solve(
+            [1.55e-6]
+        )
+        self.assertTrue((0.0 < sol.Ts[0] < 1.0) and (0.0 < sol.Tp[0] < 1.0))
+        assert_allclose(sol.Rs + sol.Ts, [1.0], atol=1e-15)
+        assert_allclose(sol.Rp + sol.Tp, [1.0], atol=1e-15)
+
+    def test_absorbing_exit_medium(self):
+        wls = [1.55e-6]
+        theta_inc = EMpy.utils.deg2rad(40.0)
+        n_list = [1.0, 1.5 - 0.5j]
+        d_list = [np.inf, np.inf]
+
+        iso_layers = _make_iso_multilayer(n_list, d_list)
+        aniso_layers = _make_aniso_multilayer(n_list, d_list)
+
+        sol_iso = EMpy.transfer_matrix.IsotropicTransferMatrix(
+            iso_layers, theta_inc
+        ).solve(wls)
+        sol_aniso = EMpy.transfer_matrix.AnisotropicTransferMatrix(
+            aniso_layers, theta_inc, 0.0
+        ).solve(wls)
+
+        # Single interface from lossless medium: net flux across z=0 is conserved
+        assert_allclose(sol_iso.Rs + sol_iso.Ts, [1.0], atol=1e-15)
+        assert_allclose(sol_iso.Rp + sol_iso.Tp, [1.0], atol=1e-15)
+
+        assert_allclose(sol_iso.Rs, sol_aniso.R[0, 0, :], rtol=1e-6)
+        assert_allclose(sol_iso.Ts, sol_aniso.T[0, 0, :], rtol=1e-6)
+        assert_allclose(sol_iso.Rp, sol_aniso.R[1, 1, :], rtol=1e-6)
+        assert_allclose(sol_iso.Tp, sol_aniso.T[1, 1, :], rtol=1e-6)
+
+    def test_absorbing_slab(self):
+        wls = [1.55e-6]
+        theta_inc = EMpy.utils.deg2rad(20.0)
+        n_list = [1.0, 2.0 - 0.1j, 1.0]
+        d_list = [np.inf, 0.5e-6, np.inf]
+
+        iso_layers = _make_iso_multilayer(n_list, d_list)
+        aniso_layers = _make_aniso_multilayer(n_list, d_list)
+
+        sol_iso = EMpy.transfer_matrix.IsotropicTransferMatrix(
+            iso_layers, theta_inc
+        ).solve(wls)
+        sol_aniso = EMpy.transfer_matrix.AnisotropicTransferMatrix(
+            aniso_layers, theta_inc, 0.0
+        ).solve(wls)
+
+        self.assertLess(sol_iso.Rs[0] + sol_iso.Ts[0], 1.0)
+        self.assertLess(sol_iso.Rp[0] + sol_iso.Tp[0], 1.0)
+        assert_allclose(sol_iso.Rs, sol_aniso.R[0, 0, :], rtol=1e-6)
+        assert_allclose(sol_iso.Ts, sol_aniso.T[0, 0, :], rtol=1e-6)
+        assert_allclose(sol_iso.Rp, sol_aniso.R[1, 1, :], rtol=1e-6)
+        assert_allclose(sol_iso.Tp, sol_aniso.T[1, 1, :], rtol=1e-6)
+
+    def test_iso_vs_aniso_non_unit_incident_index(self):
+        wls = np.linspace(1.4e-6, 1.7e-6, 5)
+        n_list = [1.5, 2.1, 1.0]
+        d_list = [np.inf, 0.3e-6, np.inf]
+        theta_inc = EMpy.utils.deg2rad(30.0)
+        theta_vac = np.arcsin(n_list[0] * np.sin(theta_inc))
+
+        iso_layers = _make_iso_multilayer(n_list, d_list)
+        aniso_layers = _make_aniso_multilayer(n_list, d_list)
+
+        sol_iso = EMpy.transfer_matrix.IsotropicTransferMatrix(
+            iso_layers, theta_inc
+        ).solve(wls)
+        sol_aniso = EMpy.transfer_matrix.AnisotropicTransferMatrix(
+            aniso_layers, theta_vac, 0.0
+        ).solve(wls)
+
+        assert_allclose(sol_iso.Rs + sol_iso.Ts, 1.0, atol=1e-14)
+        assert_allclose(sol_iso.Rp + sol_iso.Tp, 1.0, atol=1e-14)
+        assert_allclose(sol_iso.Rs, sol_aniso.R[0, 0, :], rtol=1e-6)
+        assert_allclose(sol_iso.Ts, sol_aniso.T[0, 0, :], rtol=1e-6)
+        assert_allclose(sol_iso.Rp, sol_aniso.R[1, 1, :], rtol=1e-6)
+        assert_allclose(sol_iso.Tp, sol_aniso.T[1, 1, :], rtol=1e-6)