⚡ CHARGE API & MultiPhysicsMedium integration

flexcompute · Jan 15, 2025 · fb3e409 · fb3e409
1 parent 405aef2
commit fb3e409
Show file tree

Hide file tree

Showing 96 changed files with 9,537 additions and 4,315 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,10 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.8.0rc1]
 ## [Unreleased]
 
 ### Added
 - `VisualizationSpec` that allows `Medium` instances to specify color and transparency plotting attributes that override default ones.
+- Added :zap: CHARGE Solver API, basic `SPICE` & `MultiPhysicsMedium` functionality. 
 
 ### Changed
 - `ModeMonitor` and `ModeSolverMonitor` now use the default `td.ModeSpec()` with `num_modes=1` when `mode_spec` is not provided.

diff --git a/docs/api/charge/boundary_conditions.rst b/docs/api/charge/boundary_conditions.rst
@@ -0,0 +1,39 @@
+.. currentmodule:: tidy3d
+
+Boundary Conditions
+-----------------------------
+
+Specifications
+^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.HeatBoundarySpec
+   tidy3d.HeatChargeBoundarySpec
+
+
+Types
+^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.VoltageBC
+   tidy3d.CurrentBC
+   tidy3d.InsulatingBC
+
+Placement
+^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.StructureStructureInterface
+   tidy3d.StructureBoundary
+   tidy3d.MediumMediumInterface
+   tidy3d.StructureSimulationBoundary
+   tidy3d.SimulationBoundary
diff --git a/docs/api/heat_charge/discretization.rst → docs/api/charge/discretization.rst b/docs/api/heat_charge/discretization.rst → docs/api/charge/discretization.rst
diff --git a/docs/api/charge/index.rst b/docs/api/charge/index.rst
@@ -4,7 +4,19 @@ CHARGE |:zap:|
 .. toctree::
     :hidden:
 
+    simulation
     mediums
+    boundary_conditions
+    source
+    discretization
+    monitor
+    output_data
 
 
-.. include:: /api/charge/mediums.rst
+.. include:: /api/charge/simulation.rst
+.. include:: /api/charge/mediums.rst
+.. include:: /api/charge/boundary_conditions.rst
+.. include:: /api/charge/source.rst
+.. include:: /api/charge/discretization.rst
+.. include:: /api/charge/monitor.rst
+.. include:: /api/charge/output_data.rst
diff --git a/docs/api/charge/mediums.rst b/docs/api/charge/mediums.rst
@@ -9,3 +9,57 @@ Charge Perturbation Specification
 
    tidy3d.LinearChargePerturbation
    tidy3d.CustomChargePerturbation
+
+
+Charge Specification
+-------------------------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ChargeConductorMedium
+   tidy3d.ChargeInsulatorMedium
+   tidy3d.SemiconductorMedium
+
+Mobility
+^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.CaugheyThomasMobility
+
+
+Generation Recombination
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.AugerRecombination
+   tidy3d.RadiativeRecombination
+   tidy3d.ShockleyReedHallRecombination
+
+
+Doping
+^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ConstantDoping
+   tidy3d.GaussianDoping
+
+
+Bandgap
+^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.SlotboomBandGapNarrowing
diff --git a/docs/api/charge/monitor.rst b/docs/api/charge/monitor.rst
@@ -0,0 +1,13 @@
+.. currentmodule:: tidy3d
+
+Monitors
+----------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.SteadyVoltageMonitor
+   tidy3d.SteadyPotentialMonitor
+   tidy3d.SteadyFreeCarrierMonitor
+   tidy3d.SteadyCapacitanceMonitor
diff --git a/docs/api/charge/output_data.rst b/docs/api/charge/output_data.rst
@@ -0,0 +1,50 @@
+.. currentmodule:: tidy3d
+
+Output Data
+-------------
+
+
+Simulation Data
+^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.HeatChargeSimulationData
+
+
+Monitor Data
+^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.SteadyVoltageData
+   tidy3d.SteadyPotentialData
+   tidy3d.SteadyFreeCarrierData
+   tidy3d.SteadyCapacitanceData
+
+
+Unstructured Data Classes
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.TriangularGridDataset
+   tidy3d.TetrahedralGridDataset
+
+
+Individual Datasets
+^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.PointDataArray
+   tidy3d.CellDataArray
+   tidy3d.IndexedDataArray
diff --git a/docs/api/heat_charge/simulation.rst → docs/api/charge/simulation.rst b/docs/api/heat_charge/simulation.rst → docs/api/charge/simulation.rst
diff --git a/docs/api/charge/source.rst b/docs/api/charge/source.rst
@@ -0,0 +1,10 @@
+.. currentmodule:: tidy3d
+
+Thermal Sources
+-----------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.HeatFromElectricSource
diff --git a/docs/api/heat_charge/boundary_conditions.rst → docs/api/heat/boundary_conditions.rst b/docs/api/heat_charge/boundary_conditions.rst → docs/api/heat/boundary_conditions.rst
@@ -1,6 +1,6 @@
 .. currentmodule:: tidy3d
 
-Thermal/Charge Boundary Conditions
+Boundary Conditions
 -----------------------------
 
 Specifications
@@ -24,9 +24,6 @@ Types
    tidy3d.TemperatureBC
    tidy3d.ConvectionBC
    tidy3d.HeatFluxBC
-   tidy3d.VoltageBC
-   tidy3d.CurrentBC,
-   tidy3d.InsulatingBC
 
 
 Placement

diff --git a/docs/api/heat/discretization.rst b/docs/api/heat/discretization.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: tidy3d
+
+Grid Specification
+--------------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.UniformUnstructuredGrid
+   tidy3d.DistanceUnstructuredGrid
diff --git a/docs/api/heat/index.rst b/docs/api/heat/index.rst
@@ -0,0 +1,22 @@
+HEAT |:fire:|
+=============
+
+.. toctree::
+    :hidden:
+
+    simulation
+    mediums
+    boundary_conditions
+    source
+    discretization
+    monitor
+    output_data
+
+
+.. include:: /api/heat/simulation.rst
+.. include:: /api/heat/mediums.rst
+.. include:: /api/heat/boundary_conditions.rst
+.. include:: /api/heat/source.rst
+.. include:: /api/heat/discretization.rst
+.. include:: /api/heat/monitor.rst
+.. include:: /api/heat/output_data.rst
diff --git a/docs/api/heat_charge/mediums.rst → docs/api/heat/mediums.rst b/docs/api/heat_charge/mediums.rst → docs/api/heat/mediums.rst
@@ -1,6 +1,6 @@
 .. currentmodule:: tidy3d
 
-Material Thermal/Charge Specification
+Material Thermal
 -------------------------------
 
 .. autosummary::
@@ -9,8 +9,6 @@ Material Thermal/Charge Specification
 
    tidy3d.FluidSpec
    tidy3d.SolidSpec
-   tidy3d.ConductorSpec
-   tidy3d.InsulatorSpec
 
 
 Thermal Perturbation Specification

diff --git a/docs/api/heat_charge/monitor.rst → docs/api/heat/monitor.rst b/docs/api/heat_charge/monitor.rst → docs/api/heat/monitor.rst
@@ -7,5 +7,4 @@ Monitors
    :toctree: ../_autosummary/
    :template: module.rst
 
-   tidy3d.TemperatureMonitor
-   tidy3d.VoltageMonitor
+   tidy3d.TemperatureMonitor
diff --git a/docs/api/heat_charge/output_data.rst → docs/api/heat/output_data.rst b/docs/api/heat_charge/output_data.rst → docs/api/heat/output_data.rst
@@ -4,7 +4,7 @@ Output Data
 -------------
 
 
-Heat/Charge Simulation Data
+Simulation Data
 ^^^^^^^^^^^^^^^^^^^^
 
 .. autosummary::
@@ -23,7 +23,6 @@ Monitor Data
    :template: module.rst
 
    tidy3d.TemperatureData
-   tidy3d.VoltageData
 
 
 Unstructured Data Classes

diff --git a/docs/api/heat/simulation.rst b/docs/api/heat/simulation.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: tidy3d
+
+Simulation
+-----------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.HeatSimulation
+   tidy3d.HeatChargeSimulation
diff --git a/docs/api/heat_charge/source.rst → docs/api/heat/source.rst b/docs/api/heat_charge/source.rst → docs/api/heat/source.rst
diff --git a/docs/api/heat_charge/index.rst b/docs/api/heat_charge/index.rst
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -27,6 +27,7 @@ API |:computer:|
     charge/index
     eme/index
     plugins/index
+    spice
     constants
     abstract_base
     abstract_models
@@ -53,4 +54,4 @@ API |:computer:|
 .. include:: /api/plugins/index.rst
 .. include:: /api/constants.rst
 .. include:: /api/abstract_base.rst
-.. include:: /api/abstract_models.rst
+.. include:: /api/abstract_models.rst
diff --git a/docs/api/mediums.rst b/docs/api/mediums.rst
@@ -1,8 +1,8 @@
 
 .. currentmodule:: tidy3d
 
-Mediums
-=======
+EM Mediums
+==========
 
 Non-Dispersive Medium
 ---------------------
@@ -137,3 +137,16 @@ Abstract Classes
 
    tidy3d.components.medium.AbstractPerturbationMedium
    tidy3d.components.medium.NonlinearModel
+
+
+Multi-Physics Medium
+====================
+
+
+.. autosummary::
+   :toctree: _autosummary/
+
+   tidy3d.components.material.multi_physics.MultiPhysicsMedium
+
+
+