paramrf 0.37.1__tar.gz → 0.37.2__tar.gz

{paramrf-0.37.1/paramrf.egg-info → paramrf-0.37.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: paramrf
-Version: 0.37.1
+Version: 0.37.2
 Summary: Parametric radio frequency modeling
 Author-email: Gary Allen <gvcallen@gmail.com>
 Project-URL: homepage, https://github.com/gvcallen/paramrf

{paramrf-0.37.1 → paramrf-0.37.2/paramrf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: paramrf
-Version: 0.37.1
+Version: 0.37.2
 Summary: Parametric radio frequency modeling
 Author-email: Gary Allen <gvcallen@gmail.com>
 Project-URL: homepage, https://github.com/gvcallen/paramrf

{paramrf-0.37.1 → paramrf-0.37.2}/pmrf/models/__init__.py

@@ -207,6 +207,7 @@ from pmrf.models.composite.transformed import (
 from pmrf.models.composite.nodal import (
     FloatingTwoPort as FloatingTwoPort,
     Shunt as Shunt,
+    Series as Series,
     GroundLifted as GroundLifted,
     GroundExposed as GroundExposed,
     CoupledOnePorts as CoupledOnePorts,

{paramrf-0.37.1 → paramrf-0.37.2}/pmrf/models/composite/nodal.py

@@ -203,6 +203,52 @@ class Shunt(Model):
         return renormalize_s(S_shunt, z0_eval, z0, 'power', 'power')
     
 
+class Series(Model):
+    r"""Connect a 1-port impedance in series along a 2-port line.
+
+    **Mathematical Formulation**
+
+    At a common reference impedance of 50 ohms, the wrapped 1-port's
+    reflection coefficient $\Gamma$ gives
+
+    $$S_{11} = S_{22} = \frac{1 + \Gamma}{3 - \Gamma}, \qquad
+    S_{21} = S_{12} = \frac{2(1 - \Gamma)}{3 - \Gamma}.$$
+
+    The resulting two-port is then renormalized to the requested reference
+    impedance. This form also covers ideal shorts and opens without converting
+    the wrapped reflection coefficient to an impedance.
+
+    Parameters
+    ----------
+    series : Model
+        The 1-port model to insert in series.
+
+    References
+    ----------
+    D. M. Pozar, *Microwave Engineering*, 4th ed., Wiley, 2012, sec. 4.4.
+    """
+    #: The 1-port model to insert in series.
+    series: Model
+
+    def __post_init__(self):
+        if self.series.nports != 1:
+            raise ValueError(
+                f"Series requires a 1-port model. Received a {self.series.nports}-port model."
+            )
+
+    def s(self, freq: Frequency, z0: ArrayLike = 50.0) -> jnp.ndarray:
+        z0_eval = 50.0
+        gamma = self.series.s(freq, z0=z0_eval)[:, 0, 0]
+        denom = 3.0 - gamma
+        s11 = (1.0 + gamma) / denom
+        s21 = 2.0 * (1.0 - gamma) / denom
+        s_series = jnp.array([
+            [s11, s21],
+            [s21, s11],
+        ]).transpose(2, 0, 1)
+        return renormalize_s(s_series, z0_eval, z0, 'power', 'power')
+
+
 class CoupledOnePorts(Model):
     r"""
     (experimental) Wraps N 1-port models (e.g. inductors) and couples them via a given K-matrix.

{paramrf-0.37.1 → paramrf-0.37.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "paramrf"
-version = "0.37.1"
+version = "0.37.2"
 description = "Parametric radio frequency modeling"
 readme = "README.rst"
 authors = [

{paramrf-0.37.1 → paramrf-0.37.2}/tests/test_models/test_nodal.py

@@ -3,6 +3,7 @@ import pytest
 import numpy as np
 import jax.numpy as jnp
 import equinox as eqx
+from skrf.media import DefinedGammaZ0
 
 from pmrf.frequency import Frequency
 from pmrf.parameters import Unconstrained
@@ -10,7 +11,8 @@ from pmrf.rf import s2y
 
 from pmrf.models import (
     Model, Cascade, Circuit, FloatingLine, FloatingTwoPort, GroundLifted,
-    GroundExposed, Shunt, PhaseLine, Port, RLGCLine, Resistor, Short, Open,
+    GroundExposed, Shunt, Series, PhaseLine, Port, RLGCLine, Resistor, Short, Open,
+    Load,
     Inductor
 )
 from pmrf.models.composite.nodal import CoupledOnePorts, CoupledTwoPorts
@@ -282,6 +284,44 @@ def test_shunt_invalid_port_count():
     with pytest.raises(ValueError, match="Shunt requires a 1-port model"):
         Shunt(shunt=res_model)
 
+# ---------------------------------------------------------
+# Series Tests
+# ---------------------------------------------------------
+
+@pytest.mark.parametrize("inner, reflection, transmission", [
+    (Short(), 0.0, 1.0),
+    (Open(), 1.0, 0.0),
+])
+def test_series_ideal_limits(inner, reflection, transmission, basic_freq):
+    s = Series(series=inner).s(basic_freq)
+
+    assert s.shape == (basic_freq.npoints, 2, 2)
+    assert jnp.all(jnp.isfinite(s))
+    np.testing.assert_allclose(s[:, 0, 0], reflection, atol=1e-12)
+    np.testing.assert_allclose(s[:, 1, 1], reflection, atol=1e-12)
+    np.testing.assert_allclose(s[:, 0, 1], transmission, atol=1e-12)
+    np.testing.assert_allclose(s[:, 1, 0], transmission, atol=1e-12)
+
+
+@pytest.mark.parametrize("resistance", [25.0, 50.0, 200.0])
+@pytest.mark.parametrize("z0", [50.0, 75.0, np.array([45.0, 75.0])])
+def test_series_resistance_matches_skrf(resistance, z0, basic_freq):
+    gamma = (resistance - 50.0) / (resistance + 50.0)
+    actual = Series(series=Load(gamma=gamma, z0=50.0)).s(basic_freq, z0=z0)
+
+    # A series element has a singular two-port Z matrix. Construct directly at
+    # the target z0: scikit-rf's S -> Z -> S renormalization perturbs that
+    # singularity and introduces errors of order 1e-8.
+    media = DefinedGammaZ0(basic_freq.to_skrf(), z0=50.0)
+    reference = media.resistor(resistance, z0=z0)
+
+    np.testing.assert_allclose(actual, reference.s, rtol=1e-12, atol=1e-12)
+
+
+def test_series_invalid_port_count():
+    with pytest.raises(ValueError, match="Series requires a 1-port model"):
+        Series(series=Resistor(R=50.0))
+
 # ---------------------------------------------------------
 # CoupledOnePorts Tests
 # ---------------------------------------------------------