Skip to content

Commit ac0835f

Browse files
marc-flexdaquinteroflex
authored andcommitted
docs: Missing charge dataclasses
1 parent 43c7183 commit ac0835f

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

docs/api/charge/monitor.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Monitors
77
:toctree: ../_autosummary/
88
:template: module.rst
99

10-
tidy3d.SteadyVoltageMonitor
1110
tidy3d.SteadyPotentialMonitor
1211
tidy3d.SteadyFreeCarrierMonitor
13-
tidy3d.SteadyCapacitanceMonitor
12+
tidy3d.SteadyCapacitanceMonitor
13+
tidy3d.SteadyCurrentDensityMonitor
14+
tidy3d.SteadyElectricFieldMonitor
15+
tidy3d.SteadyEnergyBandMonitor

docs/api/charge/output_data.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ Monitor Data
2121
:toctree: ../_autosummary/
2222
:template: module.rst
2323

24-
tidy3d.SteadyVoltageData
2524
tidy3d.SteadyPotentialData
2625
tidy3d.SteadyFreeCarrierData
26+
tidy3d.SteadyEnergyBandData
2727
tidy3d.SteadyCapacitanceData
28+
tidy3d.SteadyElectricFieldData
29+
tidy3d.SteadyCurrentDensityData
2830

tidy3d/components/tcad/generation_recombination.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,11 @@ class ShockleyReedHallRecombination(Tidy3dBaseModel):
173173
class DistributedGeneration(Tidy3dBaseModel):
174174
"""Class that allows to add a distributed generation model.
175175
176+
Notes
177+
-----
178+
The generation rate will be interpolated to the simulation mesh during the setup phase.
179+
In places where the generation rate is not defined, it will be filled with zeros.
180+
176181
Example
177182
-------
178183
>>> import tidy3d as td

0 commit comments

Comments
 (0)