Skip to content

Commit 64ee3f1

Browse files
committed
Add example to docs
1 parent c6cb963 commit 64ee3f1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

tidy3d/components/tcad/generation_recombination.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,16 @@ class HurkxDirectBandToBandTunneling(Tidy3dBaseModel):
242242
243243
where :math:`A`, :math:`B`, :math:`E_0`, and :math:`\\sigma` are material-dependent parameters.
244244
245+
Example
246+
-------
247+
>>> import tidy3d as td
248+
>>> default_Si = td.HurkxDirectBandToBandTunneling(
249+
... A=1e19,
250+
... B=1.9e6,
251+
... E_0=1,
252+
... sigma=2.5
253+
... )
254+
245255
References
246256
----------
247257
.. [1] Palankovski, Vassil, and Rüdiger Quay. Analysis and simulation of heterostructure devices. Springer Science & Business Media, 2004.

0 commit comments

Comments
 (0)