Revert to the old version

Author: damiano-flex

docs/api/spice.rst

@@ -10,21 +10,11 @@ Sources
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.ACVoltageSource
+   tidy3d.SSACVoltageSource
    tidy3d.DCVoltageSource
    tidy3d.GroundVoltageSource
    tidy3d.DCCurrentSource
 
-Signal
-----------------
-
-.. autosummary::
-   :toctree: _autosummary/
-   :template: module.rst
-
-   tidy3d.SinusoidalSignal
-
-
 Analysis
 ----------------
 
@@ -34,6 +24,7 @@ Analysis
 
    tidy3d.SteadyChargeDCAnalysis
    tidy3d.IsothermalSteadyChargeDCAnalysis
+   tidy3d.AbstractSSACAnalysis
    tidy3d.SSACAnalysis
    tidy3d.IsothermalSSACAnalysis
    tidy3d.ChargeToleranceSpec

tests/test_components/test_heat_charge.py

@@ -897,17 +897,13 @@ def test_heat_charge_bcs_validation(boundary_conditions):
     with pytest.raises(pd.ValidationError):
         td.VoltageBC(source=td.DCVoltageSource(voltage=np.array([td.inf, 0, 1])))
 
-    # Invalid ACVoltageSource: infinite voltage
+    # Invalid SSACVoltageSource: infinite voltage
     with pytest.raises(pd.ValidationError):
-        td.VoltageBC(
-            source=td.ACVoltageSource(
-                voltage=np.array([td.inf, 0, 1]), signal=td.SinusoidalSignal(amplitude=1e-2)
-            )
-        )
+        td.VoltageBC(source=td.SSACVoltageSource(voltage=np.array([td.inf, 0, 1]), amplitude=1e-2))
 
 
 def test_ssac_freqs_validation():
-    """Test validation that ssac_freqs requires ACVoltageSource."""
+    """Test validation that ssac_freqs requires SSACVoltageSource."""
     solid_box_1 = td.Box(center=(0, 0, 0), size=(2, 2, 2))
     solid_box_2 = td.Box(center=(1, 1, 1), size=(2, 2, 2))
     solid_box_3 = td.Box(center=(2, 2, 2), size=(2, 2, 2))
@@ -948,16 +944,16 @@ def test_ssac_freqs_validation():
         ssac_freqs=ssac_freqs_input,
     )
 
-    # Test that ssac_freqs with ACVoltageSource works
-    ac_source = td.ACVoltageSource(voltage=[0, 1, 2], signal=td.SinusoidalSignal(amplitude=1e-3))
+    # Test that ssac_freqs with SSACVoltageSource works
+    ssac_source = td.SSACVoltageSource(voltage=[0, 1, 2], amplitude=1e-3)
     sim = td.HeatChargeSimulation(
         size=(8, 8, 8),
         center=(0, 0, 0),
         structures=structures,
         boundary_spec=[
             td.HeatChargeBoundarySpec(
                 placement=td.StructureStructureInterface(structures=["anode", "silicon"]),
-                condition=td.VoltageBC(source=ac_source),
+                condition=td.VoltageBC(source=ssac_source),
             ),
             td.HeatChargeBoundarySpec(
                 placement=td.StructureStructureInterface(structures=["cathode", "silicon"]),
@@ -969,10 +965,10 @@ def test_ssac_freqs_validation():
         analysis_spec=isothermal_spec,
     )
 
-    # Test that ssac_freqs without ACVoltageSource raises error
+    # Test that ssac_freqs without SSACVoltageSource raises error
     with pytest.raises(
         pd.ValidationError,
-        match="If 'ssac_freqs' is provided and not empty, at least one 'ACVoltageSource' must be present in the boundary conditions.",
+        match="If 'ssac_freqs' is provided and not empty, at least one 'SSACVoltageSource' must be present in the boundary conditions.",
     ):
         sim.updated_copy(
             boundary_spec=[
@@ -1597,14 +1593,12 @@ def test_charge_simulation(
                 ]
             )
 
-        condition_ssac_n = td.VoltageBC(
-            source=td.ACVoltageSource(voltage=[0, 1], signal=td.SinusoidalSignal(amplitude=1e-3))
-        )
-        condition_ssac_p = td.VoltageBC(
-            source=td.ACVoltageSource(voltage=[0, 1], signal=td.SinusoidalSignal(amplitude=1e-3))
-        )
+        condition_ssac_n = td.VoltageBC(source=td.SSACVoltageSource(voltage=[0, 1], amplitude=1e-3))
+        condition_ssac_p = td.VoltageBC(source=td.SSACVoltageSource(voltage=[0, 1], amplitude=1e-3))
         # Two AC sources cannot be defined
-        with pytest.raises(pd.ValidationError, match="Only a single AC source can be supplied."):
+        with pytest.raises(
+            pd.ValidationError, match="Only a single 'SSACVoltageSource' source can be supplied."
+        ):
             analysis = td.IsothermalSSACAnalysis(ssac_freqs=[1e2, 1e3], temperature=300)
             sim.updated_copy(
                 boundary_spec=[
@@ -1615,7 +1609,9 @@ def test_charge_simulation(
             )
 
         # Test SSACAnalysis as well
-        with pytest.raises(pd.ValidationError, match="Only a single AC source can be supplied."):
+        with pytest.raises(
+            pd.ValidationError, match="Only a single 'SSACVoltageSource' source can be supplied."
+        ):
             analysis_ssac = td.SSACAnalysis(
                 ssac_freqs=[1e2, 1e3], tolerance_settings=charge_tolerance
             )

tidy3d/__init__.py

@@ -26,7 +26,7 @@
     IsothermalSteadyChargeDCAnalysis,
     SteadyChargeDCAnalysis,
 )
-from tidy3d.components.spice.sources.ac import ACVoltageSource, SinusoidalSignal
+from tidy3d.components.spice.sources.ac import SSACVoltageSource
 from tidy3d.components.spice.sources.dc import DCCurrentSource, DCVoltageSource, GroundVoltageSource
 from tidy3d.components.spice.sources.types import VoltageSourceType
 from tidy3d.components.tcad.analysis.heat_simulation_type import UnsteadyHeatAnalysis, UnsteadySpec
@@ -446,7 +446,6 @@ def set_logging_level(level: str) -> None:
     "PML",
     "TFSF",
     "ABCBoundary",
-    "ACVoltageSource",
     "Absorber",
     "AbsorberParams",
     "AbstractFieldProjectionData",
@@ -684,6 +683,7 @@ def set_logging_level(level: str) -> None:
     "RotationAroundAxis",
     "RunTimeSpec",
     "SSACAnalysis",
+    "SSACVoltageSource",
     "ScalarFieldDataArray",
     "ScalarFieldTimeDataArray",
     "ScalarModeFieldCylindricalDataArray",
@@ -697,7 +697,6 @@ def set_logging_level(level: str) -> None:
     "SimulationData",
     "SimulationDataMap",
     "SimulationMap",
-    "SinusoidalSignal",
     "SlotboomBandGapNarrowing",
     "SolidMedium",
     "SolidSpec",

tidy3d/components/spice/analysis/ac.py

@@ -1,7 +1,10 @@
 from __future__ import annotations
 
+from abc import ABC
+
 import pydantic.v1 as pd
 
+from tidy3d.components.base import Tidy3dBaseModel
 from tidy3d.components.spice.analysis.dc import (
     IsothermalSteadyChargeDCAnalysis,
     SteadyChargeDCAnalysis,
@@ -11,9 +14,18 @@
 from tidy3d.constants import inf as td_inf
 
 
-class SSACAnalysis(SteadyChargeDCAnalysis):
+class AbstractSSACAnalysis(Tidy3dBaseModel, ABC):
     """
-    Configures Small-Signal AC (SSAC) analysis parameters for charge simulation.
+    Abstract base class for Small-Signal AC (SSAC) analysis parameters.
+
+    Notes
+    -----
+    This class provides the common interface for SSAC analysis by adding the
+    ``ssac_freqs`` field to any DC analysis class.
+
+    Small-signal analysis is performed by linearizing the device equations
+    around a DC operating point. The analysis computes the small-signal response
+    at the specified frequencies.
 
     Examples
     --------
@@ -27,7 +39,7 @@ class SSACAnalysis(SteadyChargeDCAnalysis):
         ...,
         title="Small Signal AC Frequencies",
         description="List of frequencies for small signal AC analysis. "
-        "At least one :class:`.ACVoltageSource` must be present in the boundary conditions.",
+        "At least one :class:`.SSACVoltageSource` must be present in the boundary conditions.",
         units=HERTZ,
     )
 
@@ -44,7 +56,20 @@ def validate_ssac_freqs(cls, val):
         return val
 
 
-class IsothermalSSACAnalysis(IsothermalSteadyChargeDCAnalysis):
+class SSACAnalysis(SteadyChargeDCAnalysis, AbstractSSACAnalysis):
+    """
+    Configures Small-Signal AC (SSAC) analysis parameters for charge simulation.
+
+    Examples
+    --------
+    >>> import tidy3d as td
+    >>> freq_range = td.FreqRange.from_freq_interval(start_freq=1e3, stop_freq=1e6)
+    >>> sweep_freqs = freq_range.sweep_decade(num_points_per_decade=10)
+    >>> ssac_spec = td.SSACAnalysis(ssac_freqs=sweep_freqs)
+    """
+
+
+class IsothermalSSACAnalysis(IsothermalSteadyChargeDCAnalysis, AbstractSSACAnalysis):
     """
     Configures Isothermal Small-Signal AC (SSAC) analysis parameters for charge simulation.
 
@@ -59,23 +84,3 @@ class IsothermalSSACAnalysis(IsothermalSteadyChargeDCAnalysis):
     >>> sweep_freqs = freq_range.sweep_decade(num_points_per_decade=10)
     >>> ssac_spec = td.IsothermalSSACAnalysis(ssac_freqs=sweep_freqs)
     """
-
-    ssac_freqs: ArrayFloat1D = pd.Field(
-        ...,
-        title="Small Signal AC Frequencies",
-        description="List of frequencies for small signal AC analysis. "
-        "At least one :class:`.ACVoltageSource` must be present in the boundary conditions.",
-        units=HERTZ,
-    )
-
-    @pd.validator("ssac_freqs")
-    def validate_ssac_freqs(cls, val):
-        if len(val) == 0:
-            raise ValueError("'ssac_freqs' cannot be empty (size 0).")
-        else:
-            for freq in val:
-                if freq == td_inf:
-                    raise ValueError("'ssac_freqs' cannot contain infinite frequencies.")
-                elif freq < 0:
-                    raise ValueError("'ssac_freqs' cannot contain negative frequencies.")
-        return val

tidy3d/components/spice/analysis/dc.py

@@ -4,13 +4,10 @@
 
 from __future__ import annotations
 
-from typing import Optional
-
 import pydantic.v1 as pd
 
 from tidy3d.components.base import Tidy3dBaseModel
-from tidy3d.components.types import ArrayFloat1D
-from tidy3d.constants import HERTZ, KELVIN
+from tidy3d.constants import KELVIN
 
 
 class ChargeToleranceSpec(Tidy3dBaseModel):
@@ -81,14 +78,6 @@ class SteadyChargeDCAnalysis(Tidy3dBaseModel):
         "either the conduction or valence energy bands.",
     )
 
-    ssac_freqs: Optional[ArrayFloat1D] = pd.Field(
-        [],
-        title="Small Signal AC Frequencies",
-        description="List of frequencies for small signal AC analysis. If provided, "
-        "at least one 'ACVoltageSource' must be present in the boundary conditions.",
-        units=HERTZ,
-    )
-
 
 class IsothermalSteadyChargeDCAnalysis(SteadyChargeDCAnalysis):
     """

tidy3d/components/spice/sources/ac.py

@@ -1,91 +1,42 @@
 from __future__ import annotations
 
-from typing import Optional, Union
+from typing import Optional
 
 import pydantic.v1 as pd
 
 from tidy3d.components.base import Tidy3dBaseModel
 from tidy3d.components.types import ArrayFloat1D
-from tidy3d.constants import HERTZ, VOLT
+from tidy3d.constants import VOLT
 from tidy3d.constants import inf as td_inf
 
 
-class SinusoidalSignal(Tidy3dBaseModel):
+class SSACVoltageSource(Tidy3dBaseModel):
     """
-    Sinusoidal signal in the time domain.
+    Small-Signal AC (SSAC) voltage source.
 
     Notes
     -----
-    The parameter ``frequency`` is not employed in small-signal analysis (See :class:`.IsothermalSSACAnalysis`).
+    This source represents a small-signal AC excitation defined by a DC operating point
+    voltage and the amplitude of the small signal perturbation.
 
-    Examples
-    --------
-    >>> import tidy3d as td
-    >>> signal = td.SinusoidalSignal(amplitude=0.1)
-    >>> ac_source = td.ACVoltageSource(
-    ...     name="VIN",
-    ...     voltage=0.8, # DC bias voltage
-    ...     signal=signal
-    ... )
-    """
-
-    amplitude: pd.FiniteFloat = pd.Field(
-        default=1.0,
-        title="Signal Amplitude",
-        description="Amplitude of the sinusoidal signal",
-        units=VOLT,
-    )
-
-    frequency: Optional[pd.PositiveFloat] = pd.Field(
-        default=None,
-        title="Frequency",
-        description="When using SSAC analysis, the value is optional, and even if provided it is overwritten by the 'ssac_freqs' in the analysis specification.",
-        units=HERTZ,
-    )
-
-    @pd.validator("amplitude")
-    def validate_amplitude(cls, val):
-        if val == td_inf:
-            raise ValueError(f"Signal amplitude must be finite. Current amplitude={val}.")
-        return val
-
-    @pd.validator("frequency")
-    def validate_frequency(cls, val):
-        if val is not None and val == td_inf:
-            raise ValueError(f"Signal frequency must be finite. Current frequency={val}.")
-        return val
-
-
-ACSignalType = Union[SinusoidalSignal]
-
-
-class ACVoltageSource(Tidy3dBaseModel):
-    """
-    AC voltage source.
-
-    Notes
-    -----
-    This source represents an AC excitation defined by a list of bias voltages,
-    and a signal specification.
-
-    The bias ``voltage`` refers to the DC operating point above the simulation ground.
+    The ``voltage`` refers to the DC operating point above the simulation ground.
+    The ``amplitude`` defines the magnitude of the small-signal perturbation.
     Currently, full circuit simulation through electrical ports is not supported.
 
     Examples
     --------
     >>> import tidy3d as td
-    >>> voltages = [-0.5, 0, 1, 2, 3, 4]
-    >>> signal = td.SinusoidalSignal(amplitude=1e-3)
-    >>> voltage_source = td.ACVoltageSource(
-    ...     voltage=voltages,
-    ...     signal=signal,
+    >>> ssac_source = td.SSACVoltageSource(
+    ...     name="VIN",
+    ...     voltage=0.8,  # DC bias voltage
+    ...     amplitude=1e-3  # Small signal amplitude
     ... )
     """
 
     name: Optional[str] = pd.Field(
         None,
         title="Name",
-        description="Unique name for the AC voltage source.",
+        description="Unique name for the SSAC voltage source.",
         min_length=1,
     )
 
@@ -96,10 +47,11 @@ class ACVoltageSource(Tidy3dBaseModel):
         units=VOLT,
     )
 
-    signal: ACSignalType = pd.Field(
-        default=SinusoidalSignal(),
-        title="AC signal properties",
-        description="Currently employed only for small-signal analysis.",
+    amplitude: pd.FiniteFloat = pd.Field(
+        default=1.0,
+        title="Small Signal Amplitude",
+        description="Amplitude of the small-signal perturbation for SSAC analysis.",
+        units=VOLT,
     )
 
     @pd.validator("voltage")
@@ -108,3 +60,9 @@ def validate_voltage(cls, val):
             if v == td_inf:
                 raise ValueError(f"Voltages must be finite. Current voltage={val}.")
         return val
+
+    @pd.validator("amplitude")
+    def validate_amplitude(cls, val):
+        if val == td_inf:
+            raise ValueError(f"Signal amplitude must be finite. Current amplitude={val}.")
+        return val