⚠️ Issue license warning for RF simulations

Co-authored-by: Dario Quintero <[email protected]>

Author: 2 people

docs/api/microwave/index.rst

@@ -1,6 +1,11 @@
 Microwave |:satellite:|
 =======================
 
+.. warning::
+
+    RF simulations are subject to new license requirements in the future. These components are within the RF scope.
+
+
 .. toctree::
     :hidden:
 

docs/api/plugins/microwave.rst

@@ -3,6 +3,11 @@
 Microwave
 ----------------------------
 
+.. warning::
+
+    RF simulations are subject to new license requirements in the future. These components are within the RF scope.
+
+
 .. autosummary::
    :toctree: ../_autosummary/
    :template: module.rst

docs/api/plugins/smatrix.rst

@@ -10,9 +10,21 @@ Scattering Matrix Calculator
    tidy3d.plugins.smatrix.ComponentModeler
    tidy3d.plugins.smatrix.Port
    tidy3d.plugins.smatrix.ModalPortDataArray
+
+
+.. warning::
+
+    RF simulations are subject to new license requirements in the future. 
+    The components below are within the RF scope. 
+
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
    tidy3d.plugins.smatrix.TerminalComponentModeler
    tidy3d.plugins.smatrix.PortDataArray
    tidy3d.plugins.smatrix.TerminalPortDataArray
    tidy3d.plugins.smatrix.LumpedPort
    tidy3d.plugins.smatrix.CoaxialLumpedPort
-   tidy3d.plugins.smatrix.WavePort
+   tidy3d.plugins.smatrix.WavePort

tidy3d/components/data/monitor_data.py

@@ -3469,9 +3469,9 @@ class DirectivityData(FieldProjectionAngleData):
     >>> values = (1+1j) * np.random.random((len(r), len(theta), len(phi), len(f)))
     >>> flux_data = FluxDataArray(np.random.random(len(f)), coords=coords_flux)
     >>> scalar_field = FieldProjectionAngleDataArray(values, coords=coords)
-    >>> monitor = DirectivityMonitor(center=(1,2,3), size=(2,2,2), freqs=f, name='n2f_monitor', phi=phi, theta=theta)
+    >>> monitor = DirectivityMonitor(center=(1,2,3), size=(2,2,2), freqs=f, name='n2f_monitor', phi=phi, theta=theta) # doctest: +SKIP
     >>> data = DirectivityData(monitor=monitor, flux=flux_data, Er=scalar_field, Etheta=scalar_field, Ephi=scalar_field,
-    ...     Hr=scalar_field, Htheta=scalar_field, Hphi=scalar_field, projection_surfaces=monitor.projection_surfaces)
+    ...     Hr=scalar_field, Htheta=scalar_field, Hphi=scalar_field, projection_surfaces=monitor.projection_surfaces) # doctest: +SKIP
     """
 
     monitor: DirectivityMonitor = pd.Field(

tidy3d/components/eme/simulation.py

@@ -122,7 +122,7 @@ class EMESimulation(AbstractYeeGridSimulation):
     >>> from tidy3d import Box, Medium, Structure, C_0, inf
     >>> from tidy3d import EMEModeSpec, EMEUniformGrid, GridSpec
     >>> from tidy3d import EMEFieldMonitor
-    >>> lambda0 = 1
+    >>> lambda0 = 1550e-9
     >>> freq0 = C_0 / lambda0
     >>> sim_size = 3*lambda0, 3*lambda0, 3*lambda0
     >>> waveguide_size = (lambda0/2, lambda0, inf)

tidy3d/components/lumped_element.py

@@ -9,6 +9,8 @@
 import numpy as np
 import pydantic.v1 as pd
 
+from tidy3d.log import log
+
 from ..components.grid.grid import Grid
 from ..components.medium import (
     PEC2D,
@@ -110,6 +112,14 @@ def to_structures(self, grid: Grid = None) -> list[Structure]:
         which are ready to be added to the :class:`.Simulation`"""
         return [self.to_structure(grid)]
 
+    @pd.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        log.warning(
+            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are have instantiated at least one RF-specific component.",
+            log_once=True,
+        )
+        return values
+
 
 class RectangularLumpedElement(LumpedElement, Box):
     """Class representing a rectangular element with zero thickness. A :class:`RectangularLumpedElement`
@@ -543,6 +553,14 @@ def complex_permittivity(a: tuple[float, ...], b: tuple[float, ...], freqs: np.n
         sigma = NetworkConversions.complex_conductivity(a, b, freqs)
         return 1j * sigma / (2 * np.pi * freqs * EPSILON_0)
 
+    @pd.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        log.warning(
+            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are have instantiated at least one RF-specific component.",
+            log_once=True,
+        )
+        return values
+
 
 class RLCNetwork(Tidy3dBaseModel):
     """Class for representing a simple network consisting of a resistor, capacitor, and inductor.
@@ -564,7 +582,7 @@ class RLCNetwork(Tidy3dBaseModel):
     >>> RL_series = RLCNetwork(resistance=75,
     ...                        inductance=1e-9,
     ...                        network_topology="series"
-    ...             )
+    ...                       ) # doctest: +SKIP
 
     """
 
@@ -794,6 +812,14 @@ def _validate_single_element(cls, val, values):
             raise ValueError("At least one element must be defined in the 'RLCNetwork'.")
         return val
 
+    @pd.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        log.warning(
+            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are have instantiated at least one RF-specific component.",
+            log_once=True,
+        )
+        return values
+
 
 class AdmittanceNetwork(Tidy3dBaseModel):
     """Class for representing a network consisting of an arbitrary number of resistors,
@@ -839,7 +865,7 @@ class AdmittanceNetwork(Tidy3dBaseModel):
     >>> b = (R, 0)
     >>> RC_parallel = AdmittanceNetwork(a=a,
     ...                                 b=b
-    ...               )
+    ...               ) # doctest: +SKIP
 
     """
 
@@ -871,6 +897,14 @@ def _as_admittance_function(self) -> tuple[tuple[float, ...], tuple[float, ...]]
         """
         return (self.a, self.b)
 
+    @pd.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        log.warning(
+            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are have instantiated at least one RF-specific component.",
+            log_once=True,
+        )
+        return values
+
 
 class LinearLumpedElement(RectangularLumpedElement):
     """Lumped element representing a network consisting of resistors, capacitors, and inductors.
@@ -893,14 +927,15 @@ class LinearLumpedElement(RectangularLumpedElement):
     >>> RL_series = RLCNetwork(resistance=75,
     ...                        inductance=1e-9,
     ...                        network_topology="series"
-    ...             )
+    ...             ) # doctest: +SKIP
     >>> linear_element = LinearLumpedElement(
     ...                         center=[0, 0, 0],
     ...                         size=[2, 0, 3],
     ...                         voltage_axis=0,
     ...                         network=RL_series,
     ...                         name="LumpedRL"
-    ...                   )
+    ...                   ) # doctest: +SKIP
+
 
     See Also
     --------

tidy3d/components/microwave/data/monitor_data.py

@@ -10,6 +10,7 @@
 from tidy3d.components.data.data_array import FieldProjectionAngleDataArray, FreqDataArray
 from tidy3d.components.data.monitor_data import DirectivityData
 from tidy3d.components.types import PolarizationBasis
+from tidy3d.log import log
 
 
 class AntennaMetricsData(DirectivityData):
@@ -36,8 +37,8 @@ class AntennaMetricsData(DirectivityData):
     ...     name="rad_monitor",
     ...     phi=phi,
     ...     theta=theta
-    ... )
-    >>> power_data = FreqDataArray(np.random.random(len(f)), coords=coords_flux)
+    ... ) # doctest: +SKIP
+    >>> power_data = FreqDataArray(np.random.random(len(f)), coords=coords_flux) # doctest: +SKIP
     >>> data = AntennaMetricsData(
     ...     monitor=monitor,
     ...     projection_surfaces=monitor.projection_surfaces,
@@ -50,7 +51,7 @@ class AntennaMetricsData(DirectivityData):
     ...     Hphi=scalar_field,
     ...     power_incident=power_data,
     ...     power_reflected=power_data
-    ... )
+    ... ) # doctest: +SKIP
 
     Notes
     -----
@@ -194,3 +195,11 @@ def realized_gain(self) -> FieldProjectionAngleDataArray:
         """The realized gain figure of merit for antennas. Realized gain is dimensionless."""
         partial_G = self.partial_realized_gain()
         return partial_G.Gtheta + partial_G.Gphi
+
+    @pd.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        log.warning(
+            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are have instantiated at least one RF-specific component.",
+            log_once=True,
+        )
+        return values

tidy3d/components/mode/simulation.py

@@ -83,7 +83,7 @@ class ModeSimulation(AbstractYeeGridSimulation):
     Example
     -------
     >>> from tidy3d import C_0, ModeSpec, BoundarySpec, Boundary
-    >>> lambda0 = 1
+    >>> lambda0 = 1550e-9
     >>> freq0 = C_0 / lambda0
     >>> freqs = [freq0]
     >>> sim_size = lambda0, lambda0, 0

tidy3d/components/monitor.py

@@ -1206,6 +1206,14 @@ def storage_size(self, num_cells: int, tmesh: ArrayFloat1D) -> int:
             self.freqs
         ) * 6 + BYTES_REAL * len(self.freqs)
 
+    @pydantic.root_validator(pre=False)
+    def _warn_rf_license(cls, values):
+        log.warning(
+            "ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are have instantiated at least one RF-specific component.",
+            log_once=True,
+        )
+        return values
+
 
 class FieldProjectionCartesianMonitor(AbstractFieldProjectionMonitor):
     """:class:`Monitor` that samples electromagnetic near fields in the frequency domain

tidy3d/components/simulation.py

@@ -15,6 +15,7 @@
 except ImportError:
     pass
 
+
 import pydantic.v1 as pydantic
 import xarray as xr
 
@@ -174,6 +175,9 @@
 # additional (safety) time step reduction factor for fixed angle simulations
 FIXED_ANGLE_DT_SAFETY_FACTOR = 0.9
 
+# RF frequency warning
+RF_FREQ_WARNING = 1e12
+
 
 def validate_boundaries_for_zero_dims():
     """Error if absorbing boundaries, bloch boundaries, unmatching pec/pmc, or symmetry is used along a zero dimension."""
@@ -3596,6 +3600,41 @@ def _post_init_validators(self) -> None:
         self._validate_custom_source_time()
         self._validate_mode_object_bends()
         self._warn_mode_object_pml()
+        self._warn_rf_license()
+
+    def _warn_rf_license(self):
+        """
+        Warn about new licensing requirements for RF simulations. This function details all the conditions in which a
+        simulation is categorised as RF simulation at the backend.
+        """
+        # RF component messages
+        rf_component_breakdown_msg = ""
+
+        # 1) lossy metal
+        for mat in self.scene.mediums:
+            if isinstance(mat, LossyMetalMedium):
+                rf_component_breakdown_msg += "\n - Contains a 'LossyMetalMedium'."
+                break
+
+        # 2) lumped elements
+        if len(self.lumped_elements) > 0:
+            rf_component_breakdown_msg += "\n - Contains a 'LumpedElement'."
+
+        # 3) source frequency is in RF range
+        if (self.frequency_range[0] < RF_FREQ_WARNING) & (self.frequency_range[0] != 0):
+            rf_component_breakdown_msg += "\n - Contains sources defined for RF wavelengths."
+
+        # 4) monitor frequency is in RF range
+        for monitor in self.monitors:
+            if isinstance(monitor, FreqMonitor) and monitor.frequency_range[0] < RF_FREQ_WARNING:
+                rf_component_breakdown_msg += "\n - Contains monitors defined for RF wavelengths."
+                break
+
+        # issue warning
+        if rf_component_breakdown_msg != "":
+            msg = " ℹ️ ⚠️ RF simulations are subject to new license requirements in the future. You are using RF-specific components in this simulation."
+            msg += rf_component_breakdown_msg
+            log.warning(msg, log_once=True)
 
     def _warn_mode_object_pml(self) -> None:
         """Warn if any mode objects have large pml."""