Skip to content

Commit c789d91

Browse files
yaugenst-flexdaquinteroflex
yaugenst-flex
authored and
daquinteroflex
committed
⚡ CHARGE API & MultiPhysicsMedium 
1 parent 405aef2 commit c789d91

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+9536
-4315
lines changed

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [2.8.0rc1]
89
## [Unreleased]
910

1011
### Added
1112
- `VisualizationSpec` that allows `Medium` instances to specify color and transparency plotting attributes that override default ones.
13+
- Added :zap: CHARGE Solver API, `SPICE` & `MultiPhysicsMedium` functionality.
1214

1315
### Changed
1416
- `ModeMonitor` and `ModeSolverMonitor` now use the default `td.ModeSpec()` with `num_modes=1` when `mode_spec` is not provided.

‎docs/api/charge/boundary_conditions.rst

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
.. currentmodule:: tidy3d
2+
3+
Boundary Conditions
4+
-----------------------------
5+
6+
Specifications
7+
^^^^^^^^^^^^^^
8+
9+
.. autosummary::
10+
:toctree: ../_autosummary/
11+
:template: module.rst
12+
13+
tidy3d.HeatBoundarySpec
14+
tidy3d.HeatChargeBoundarySpec
15+
16+
17+
Types
18+
^^^^^^^^^^^^^^^^^
19+
20+
.. autosummary::
21+
:toctree: ../_autosummary/
22+
:template: module.rst
23+
24+
tidy3d.VoltageBC
25+
tidy3d.CurrentBC
26+
tidy3d.InsulatingBC
27+
28+
Placement
29+
^^^^^^^^^^^^^^^^^
30+
31+
.. autosummary::
32+
:toctree: ../_autosummary/
33+
:template: module.rst
34+
35+
tidy3d.StructureStructureInterface
36+
tidy3d.StructureBoundary
37+
tidy3d.MediumMediumInterface
38+
tidy3d.StructureSimulationBoundary
39+
tidy3d.SimulationBoundary

‎docs/api/heat_charge/discretization.rst ‎docs/api/charge/discretization.rst

File renamed without changes.

‎docs/api/charge/index.rst

+13-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,19 @@ CHARGE |:zap:|
44
.. toctree::
55
:hidden:
66

7+
simulation
78
mediums
9+
boundary_conditions
10+
source
11+
discretization
12+
monitor
13+
output_data
814

915

10-
.. include:: /api/charge/mediums.rst
16+
.. include:: /api/charge/simulation.rst
17+
.. include:: /api/charge/mediums.rst
18+
.. include:: /api/charge/boundary_conditions.rst
19+
.. include:: /api/charge/source.rst
20+
.. include:: /api/charge/discretization.rst
21+
.. include:: /api/charge/monitor.rst
22+
.. include:: /api/charge/output_data.rst

‎docs/api/charge/mediums.rst

+54
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,57 @@ Charge Perturbation Specification
99

1010
tidy3d.LinearChargePerturbation
1111
tidy3d.CustomChargePerturbation
12+
13+
14+
Charge Specification
15+
-------------------------------
16+
17+
.. autosummary::
18+
:toctree: ../_autosummary/
19+
:template: module.rst
20+
21+
tidy3d.ChargeConductorMedium
22+
tidy3d.ChargeInsulatorMedium
23+
tidy3d.SemiconductorMedium
24+
25+
Mobility
26+
^^^^^^^^^^^^^^
27+
28+
.. autosummary::
29+
:toctree: ../_autosummary/
30+
:template: module.rst
31+
32+
tidy3d.CaugheyThomasMobility
33+
34+
35+
Generation Recombination
36+
^^^^^^^^^^^^^^^^^^^^^^^^
37+
38+
.. autosummary::
39+
:toctree: ../_autosummary/
40+
:template: module.rst
41+
42+
tidy3d.AugerRecombination
43+
tidy3d.RadiativeRecombination
44+
tidy3d.ShockleyReedHallRecombination
45+
46+
47+
Doping
48+
^^^^^^
49+
50+
.. autosummary::
51+
:toctree: ../_autosummary/
52+
:template: module.rst
53+
54+
tidy3d.ConstantDoping
55+
tidy3d.GaussianDoping
56+
57+
58+
Bandgap
59+
^^^^^^^^
60+
61+
.. autosummary::
62+
:toctree: ../_autosummary/
63+
:template: module.rst
64+
65+
tidy3d.SlotboomBandGapNarrowing

‎docs/api/charge/monitor.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. currentmodule:: tidy3d
2+
3+
Monitors
4+
----------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.SteadyVoltageMonitor
11+
tidy3d.SteadyPotentialMonitor
12+
tidy3d.SteadyFreeCarrierMonitor
13+
tidy3d.SteadyCapacitanceMonitor

‎docs/api/charge/output_data.rst

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.. currentmodule:: tidy3d
2+
3+
Output Data
4+
-------------
5+
6+
7+
Simulation Data
8+
^^^^^^^^^^^^^^^^^^^^
9+
10+
.. autosummary::
11+
:toctree: ../_autosummary/
12+
:template: module.rst
13+
14+
tidy3d.HeatChargeSimulationData
15+
16+
17+
Monitor Data
18+
^^^^^^^^^^^^
19+
20+
.. autosummary::
21+
:toctree: ../_autosummary/
22+
:template: module.rst
23+
24+
tidy3d.SteadyVoltageData
25+
tidy3d.SteadyPotentialData
26+
tidy3d.SteadyFreeCarrierData
27+
tidy3d.SteadyCapacitanceData
28+
29+
30+
Unstructured Data Classes
31+
^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. autosummary::
34+
:toctree: ../_autosummary/
35+
:template: module.rst
36+
37+
tidy3d.TriangularGridDataset
38+
tidy3d.TetrahedralGridDataset
39+
40+
41+
Individual Datasets
42+
^^^^^^^^^^^^^^^^^^^
43+
44+
.. autosummary::
45+
:toctree: ../_autosummary/
46+
:template: module.rst
47+
48+
tidy3d.PointDataArray
49+
tidy3d.CellDataArray
50+
tidy3d.IndexedDataArray

‎docs/api/heat_charge/simulation.rst ‎docs/api/charge/simulation.rst

File renamed without changes.

‎docs/api/charge/source.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: tidy3d
2+
3+
Thermal Sources
4+
-----------------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.HeatFromElectricSource

‎docs/api/heat_charge/boundary_conditions.rst ‎docs/api/heat/boundary_conditions.rst

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. currentmodule:: tidy3d
22

3-
Thermal/Charge Boundary Conditions
3+
Boundary Conditions
44
-----------------------------
55

66
Specifications
@@ -24,9 +24,6 @@ Types
2424
tidy3d.TemperatureBC
2525
tidy3d.ConvectionBC
2626
tidy3d.HeatFluxBC
27-
tidy3d.VoltageBC
28-
tidy3d.CurrentBC,
29-
tidy3d.InsulatingBC
3027

3128

3229
Placement

‎docs/api/heat/discretization.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. currentmodule:: tidy3d
2+
3+
Grid Specification
4+
--------------------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.UniformUnstructuredGrid
11+
tidy3d.DistanceUnstructuredGrid

‎docs/api/heat/index.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
HEAT |:fire:|
2+
=============
3+
4+
.. toctree::
5+
:hidden:
6+
7+
simulation
8+
mediums
9+
boundary_conditions
10+
source
11+
discretization
12+
monitor
13+
output_data
14+
15+
16+
.. include:: /api/heat/simulation.rst
17+
.. include:: /api/heat/mediums.rst
18+
.. include:: /api/heat/boundary_conditions.rst
19+
.. include:: /api/heat/source.rst
20+
.. include:: /api/heat/discretization.rst
21+
.. include:: /api/heat/monitor.rst
22+
.. include:: /api/heat/output_data.rst

‎docs/api/heat_charge/mediums.rst ‎docs/api/heat/mediums.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. currentmodule:: tidy3d
22

3-
Material Thermal/Charge Specification
3+
Material Thermal
44
-------------------------------
55

66
.. autosummary::
@@ -9,8 +9,6 @@ Material Thermal/Charge Specification
99

1010
tidy3d.FluidSpec
1111
tidy3d.SolidSpec
12-
tidy3d.ConductorSpec
13-
tidy3d.InsulatorSpec
1412

1513

1614
Thermal Perturbation Specification

‎docs/api/heat_charge/monitor.rst ‎docs/api/heat/monitor.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,4 @@ Monitors
77
:toctree: ../_autosummary/
88
:template: module.rst
99

10-
tidy3d.TemperatureMonitor
11-
tidy3d.VoltageMonitor
10+
tidy3d.TemperatureMonitor

‎docs/api/heat_charge/output_data.rst ‎docs/api/heat/output_data.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Output Data
44
-------------
55

66

7-
Heat/Charge Simulation Data
7+
Simulation Data
88
^^^^^^^^^^^^^^^^^^^^
99

1010
.. autosummary::
@@ -23,7 +23,6 @@ Monitor Data
2323
:template: module.rst
2424

2525
tidy3d.TemperatureData
26-
tidy3d.VoltageData
2726

2827

2928
Unstructured Data Classes

‎docs/api/heat/simulation.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. currentmodule:: tidy3d
2+
3+
Simulation
4+
-----------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.HeatSimulation
11+
tidy3d.HeatChargeSimulation

‎docs/api/heat_charge/source.rst ‎docs/api/heat/source.rst

File renamed without changes.

‎docs/api/heat_charge/index.rst

-22
This file was deleted.

‎docs/api/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ API |:computer:|
2727
charge/index
2828
eme/index
2929
plugins/index
30+
spice
3031
constants
3132
abstract_base
3233
abstract_models
@@ -53,4 +54,4 @@ API |:computer:|
5354
.. include:: /api/plugins/index.rst
5455
.. include:: /api/constants.rst
5556
.. include:: /api/abstract_base.rst
56-
.. include:: /api/abstract_models.rst
57+
.. include:: /api/abstract_models.rst

‎docs/api/mediums.rst

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
.. currentmodule:: tidy3d
33

4-
Mediums
5-
=======
4+
EM Mediums
5+
==========
66

77
Non-Dispersive Medium
88
---------------------
@@ -137,3 +137,16 @@ Abstract Classes
137137

138138
tidy3d.components.medium.AbstractPerturbationMedium
139139
tidy3d.components.medium.NonlinearModel
140+
141+
142+
Multi-Physics Medium
143+
====================
144+
145+
146+
.. autosummary::
147+
:toctree: _autosummary/
148+
149+
tidy3d.components.material.multi_physics.MultiPhysicsMedium
150+
151+
152+

0 commit comments

Comments
 (0)