summaryrefslogtreecommitdiff
path: root/openEMS/python/doc/ports.rst
diff options
context:
space:
mode:
authorRuben Undheim <ruben.undheim@gmail.com>2019-02-10 08:20:54 +0000
committerRuben Undheim <ruben.undheim@gmail.com>2019-02-10 08:20:54 +0000
commitffda26309128be5d112df61a03e4827e47ecfac8 (patch)
tree7552a0f13b6873dbf98c41b84cb81bac0f220ca7 /openEMS/python/doc/ports.rst
parent086965becc2a02254e3441a1d97b61ccab2d66ea (diff)
Import GIT HEAD of openEMS sub-project (with Python interface)
Diffstat (limited to 'openEMS/python/doc/ports.rst')
-rw-r--r--openEMS/python/doc/ports.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/openEMS/python/doc/ports.rst b/openEMS/python/doc/ports.rst
new file mode 100644
index 0000000..79971e6
--- /dev/null
+++ b/openEMS/python/doc/ports.rst
@@ -0,0 +1,37 @@
+.. _ports:
+
+Ports
+-----
+
+.. automodule:: openEMS.ports
+
+ Port (Base Class)
+ -----------------
+ .. autoclass:: Port
+ :members:
+ :show-inheritance:
+
+ Lumped Port
+ -----------
+ .. autoclass:: LumpedPort
+ :members:
+ :show-inheritance:
+
+ MSL Port
+ --------
+ .. autoclass:: MSLPort
+ :members:
+ :show-inheritance:
+
+ Waveguide Port
+ --------------
+ .. autoclass:: WaveguidePort
+ :members:
+ :show-inheritance:
+
+ Rect Waveguide Port
+ -------------------
+ .. autoclass:: RectWGPort
+ :members:
+ :show-inheritance:
+