More comments

Author: marc-flex

Diff for: CHANGELOG.md

@@ -16,8 +16,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added :zap: CHARGE Solver API, basic `SPICE` & `MultiPhysicsMedium` functionality. 
 - Added :zap: Charge Solver API, basic `SPICE` & `MultiPhysicsMedium` functionality. 
 - `MultiphysicsMedium` allows for the modularization definition of physical properties. So in addition to the usual optical properties, one can now add heat properties or electric properties. The advantage is that it is now possible to define a medium with some frequency-dependent permittivity in the optical regime and some constant permittivity in valid for electrostatic simulations.
+- `MultiPhysicsMedium` allows for the modularization definition of physical properties. So in addition to the usual optical properties, one can now add heat properties or charge properties. The advantage is that it is now possible to define a medium with some frequency-dependent permittivity in the optical regime and some constant permittivity in valid for electrostatic simulations.
 - Added :zap: Charge Solver API. It is now possible to solve the Drift-Diffusion (DD) equations for semiconductors. These simulations can be set up with the new class `HeatChargeSimulation` (which supersedes `HeatSimulation`) in a way similar to that of Heat simulations. The solver has currently limited capabilities (which will be expanded in future releases): steady only, isothermal, Boltzmann statistics (non-degenerate semiconductors only).
-- `SemiconductorMedium` has been added. This is used in combination with `MultiphysicsMedium` to define the mediums used in the Charge solver. It allows to specify mobility, bandgap narrowing, and generation/recombination models as well as doping. Doping can be defined as constant or through "doping boxes" or, more generally, via `SpatialDataArray` objects for full flexibility.
+- `SemiconductorMedium` has been added. This is used in combination with `MultiPhysicsMedium` to define the mediums used in the Charge solver. It allows to specify mobility, bandgap narrowing, and generation/recombination models as well as doping. Doping can be defined as constant or through "doping boxes" or, more generally, via `SpatialDataArray` objects for full flexibility.
 - Mobility models for `SemiconductorMedium`: `ConstantMobilityModel`, `CaugheyThomasMobility`
 - Bandgap narrowing models for `SemiconductorMedium`: `SlotboomBandGapNarrowing`
 - Generation-recombination models for `SemiconductorMedium`: `ShockleyReedHallRecombination`, `RadiativeRecombination`, `AugerRecombination`

Diff for: tidy3d/components/material/multi_physics.py

@@ -5,11 +5,9 @@
 from tidy3d.components.base import Tidy3dBaseModel
 from tidy3d.components.material.solver_types import (
     ChargeMediumType,
-    ElectricalMediumType,
     HeatMediumType,
     OpticalMediumType,
 )
-from tidy3d.exceptions import SetupError
 
 
 class MultiPhysicsMedium(Tidy3dBaseModel):
@@ -78,18 +76,18 @@ class MultiPhysicsMedium(Tidy3dBaseModel):
         None, title="Optical properties", description="Specifies optical properties."
     )
 
-    electrical: Optional[ElectricalMediumType] = pd.Field(
-        None,
-        title="Electrical properties",
-        description="Specifies electrical properties for RF simulations. This is currently not in use.",
-    )
+    # electrical: Optional[ElectricalMediumType] = pd.Field(
+    #     None,
+    #     title="Electrical properties",
+    #     description="Specifies electrical properties for RF simulations. This is currently not in use.",
+    # )
 
     heat: Optional[HeatMediumType] = pd.Field(
-        None, title="Heat properties", description="Specifies properties for Heat simulations"
+        None, title="Heat properties", description="Specifies properties for Heat simulations."
     )
 
     charge: Optional[ChargeMediumType] = pd.Field(
-        None, title="Charge properties", description="Specifies properties for Charge simulations"
+        None, title="Charge properties", description="Specifies properties for Charge simulations."
     )
 
     @property
@@ -100,13 +98,3 @@ def heat_spec(self):
             return self.optical.heat_spec
         else:
             return None
-
-    @pd.validator("electrical", always=True)
-    def check_electrical(cls, val):
-        """Make sure 'electrical' has not been set."""
-
-        if val is not None:
-            raise SetupError(
-                "'electrical' properties are not yet supported. Leave this parameter unset or set it to None"
-            )
-        return val

Diff for: tidy3d/components/scene.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Optional, Set, Tuple, Union
+from typing import Dict, List, Literal, Optional, Set, Tuple, Union
 
 import autograd.numpy as np
 
@@ -43,6 +43,7 @@
 from .material.multi_physics import MultiPhysicsMedium
 from .medium import (
     AbstractCustomMedium,
+    AbstractMedium,
     AbstractPerturbationMedium,
     Medium,
     Medium2D,
@@ -850,7 +851,7 @@ def plot_structures_property(
         hlim: Tuple[float, float] = None,
         vlim: Tuple[float, float] = None,
         grid: Grid = None,
-        property: str = "eps",
+        property: Literal["eps", "doping", "N_a", "N_d"] = "eps",
     ) -> Ax:
         """Plot each of scene's structures on a plane defined by one nonzero x,y,z coordinate.
         The permittivity is plotted in grayscale based on its value at the specified frequency.
@@ -882,7 +883,7 @@ def plot_structures_property(
             The x range if plotting on xy or xz planes, y range if plotting on yz plane.
         vlim : Tuple[float, float] = None
             The z range if plotting on xz or yz planes, y plane if plotting on xy plane.
-        property: str = "eps"
+        property: Literal["eps", "doping", "N_a", "N_d"] = "eps"
             Indicates the property to plot for the structures. Currently supported properties
             are ["eps", "doping", "N_a", "N_d"]
 
@@ -1236,7 +1237,7 @@ def _get_structure_eps_plot_params(
         """Constructs the plot parameters for a given medium in scene.plot_eps()."""
 
         plot_params = plot_params_structure.copy(update={"linewidth": 0})
-        if hasattr(medium, "viz_spec"):
+        if isinstance(medium, AbstractMedium):
             if medium.viz_spec is not None:
                 plot_params = plot_params.override_with_viz_spec(medium.viz_spec)
         if alpha is not None:

Diff for: tidy3d/components/tcad/data/monitor_data/abstract.py

@@ -46,10 +46,9 @@ class HeatChargeMonitorData(AbstractMonitorData, ABC):
         description="Symmetry center of the original simulation in x, y, and z.",
     )
 
-    @property
+    @abstractmethod
     def symmetry_expanded_copy(self) -> HeatChargeMonitorData:
         """Return copy of self with symmetry applied."""
-        return self.copy()
 
     @abstractmethod
     def field_name(self, val: str) -> str:

Diff for: tidy3d/components/tcad/data/monitor_data/charge.py

@@ -35,7 +35,7 @@ class SteadyPotentialData(HeatChargeMonitorData):
 
     monitor: SteadyPotentialMonitor = pd.Field(
         ...,
-        title="Voltage monitor",
+        title="Electric potential monitor",
         description="Electric potential monitor associated with a `charge` simulation.",
     )
 
@@ -228,3 +228,8 @@ def warn_no_data(cls, val, values):
     def field_name(self, val: str) -> str:
         """Gets the name of the fields to be plot."""
         return ""
+
+    @property
+    def symmetry_expanded_copy(self) -> SteadyCapacitanceData:
+        """Return copy of self with symmetry applied."""
+        return self

Diff for: tidy3d/components/tcad/data/sim_data.py

@@ -134,7 +134,7 @@ class HeatChargeSimulationData(AbstractSimulationData):
         None,
         title="Device characteristics",
         description="Data characterizing the device. Current characteristics include: "
-        "'iv_curve' for and I-V curve and 'cv_curve' for a capacitance curve.",
+        "'steady_dc_hole_capacitance', 'steady_dc_electron_capacitance', and 'steady_dc_current_voltage'",
     )
 
     @equal_aspect

Diff for: tidy3d/components/tcad/doping.py

@@ -11,6 +11,8 @@
 from tidy3d.components.types import Bound, Union
 from tidy3d.constants import MICROMETER
 
+from ...constants import PERCMCUBE
+
 
 class AbstractDopingBox(Box):
     """Derived class from Box which redefines size so that
@@ -74,6 +76,7 @@ class ConstantDoping(AbstractDopingBox):
         default=0,
         title="Doping concentration density.",
         description="Doping concentration density in #/cm^3.",
+        units=PERCMCUBE,
     )
 
 

Diff for: tidy3d/components/tcad/simulation/heat_charge.py

@@ -216,7 +216,7 @@ class HeatChargeSimulation(AbstractSimulation):
     ...     placement=td.MediumMediumInterface(mediums=[air.name, Si_p.name]),
     ... )
     >>> charge_sim = td.HeatChargeSimulation(
-    ...     structures=[]n_side, p_side,
+    ...     structures=[n_side, p_side],
     ...     medium=td.Medium(heat_spec=td.FluidSpec(), name="air"),
     ...     monitors=[td.SteadyFreeCarrierMonitor(
     ...         center=(0, 0, 0), size=(td.inf, td.inf, 0), name="charge_mnt", unstructured=True