Skip to content

Commit 49b316f

Browse files
update to .rf on api references
1 parent 2f9b728 commit 49b316f

File tree

5 files changed

+29
-29
lines changed

5 files changed

+29
-29
lines changed

docs/api/microwave/component_modeler.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ TerminalComponentModeler
77
:toctree: ../_autosummary/
88
:template: module.rst
99

10-
tidy3d.plugins.smatrix.TerminalComponentModeler
11-
tidy3d.plugins.smatrix.TerminalComponentModelerData
12-
tidy3d.plugins.smatrix.MicrowaveSMatrixData
13-
tidy3d.plugins.smatrix.TerminalPortDataArray
14-
tidy3d.plugins.smatrix.PortDataArray
10+
tidy3d.rf.TerminalComponentModeler
11+
tidy3d.rf.TerminalComponentModelerData
12+
tidy3d.rf.MicrowaveSMatrixData
13+
tidy3d.rf.TerminalPortDataArray
14+
tidy3d.rf.PortDataArray
1515

1616
The :class:`.TerminalComponentModeler` is the core simulation object for 3D RF/microwave simulations in Tidy3D. Its primary function is to simulate the system over ``N`` number of ports and ``M`` number of frequency points, with the end result being a ``MxNxN`` S-parameter matrix.
1717

docs/api/microwave/material.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ RF Materials Models
1010
tidy3d.PECMedium
1111
tidy3d.PMCMedium
1212
tidy3d.LossyMetalMedium
13-
tidy3d.SurfaceImpedanceFitterParam
14-
tidy3d.HammerstadSurfaceRoughness
15-
tidy3d.HuraySurfaceRoughness
13+
tidy3d.rf.SurfaceImpedanceFitterParam
14+
tidy3d.rf.HammerstadSurfaceRoughness
15+
tidy3d.rf.HuraySurfaceRoughness
1616

1717
The :class:`.PECMedium` and :class:`.LossyMetalMedium` classes can be used to model metallic materials.
1818

docs/api/microwave/ports/lumped.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Lumped Port & Elements
77
:toctree: ../_autosummary/
88
:template: module.rst
99

10-
tidy3d.plugins.smatrix.LumpedPort
11-
tidy3d.plugins.smatrix.CoaxialLumpedPort
10+
tidy3d.rf.LumpedPort
11+
tidy3d.rf.CoaxialLumpedPort
1212

1313
The :class:`LumpedPort` feature represents a planar, uniform current excitation with a fixed impedance termination.
1414

@@ -52,11 +52,11 @@ The ``CoaxialLumpedPort`` represents an analytical coaxial field source.
5252
:toctree: ../_autosummary/
5353
:template: module.rst
5454

55-
tidy3d.LumpedResistor
56-
tidy3d.CoaxialLumpedResistor
57-
tidy3d.LinearLumpedElement
58-
tidy3d.RLCNetwork
59-
tidy3d.AdmittanceNetwork
55+
tidy3d.rf.LumpedResistor
56+
tidy3d.rf.CoaxialLumpedResistor
57+
tidy3d.rf.LinearLumpedElement
58+
tidy3d.rf.RLCNetwork
59+
tidy3d.rf.AdmittanceNetwork
6060

6161
For a simple resistive lumped element, use ``LumpedResistor``.
6262

docs/api/microwave/ports/wave.rst

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

10-
tidy3d.plugins.smatrix.WavePort
11-
tidy3d.ModeSpec
10+
tidy3d.rf.WavePort
11+
tidy3d.rf.MicrowaveModeSpec
1212

1313
The :class:`.WavePort` represents a modal source port. The port mode is first calculated in the 2D mode solver, then injected into the 3D simulation. The :class:`.WavePort` is also automatically terminated with a modal absorbing boundary :class:`.ModeABCBoundary` that perfectly absorbs the outgoing mode. Any non-matching modes are subject to PEC reflection.
1414

@@ -46,13 +46,13 @@ If it is desired to only solve for the 2D port mode, one can use the ``to_mode_s
4646
:toctree: ../_autosummary/
4747
:template: module.rst
4848

49-
tidy3d.plugins.microwave.AxisAlignedVoltageIntegral
50-
tidy3d.plugins.microwave.AxisAlignedCurrentIntegral
51-
tidy3d.plugins.microwave.Custom2DVoltageIntegral
52-
tidy3d.plugins.microwave.Custom2DCurrentIntegral
53-
tidy3d.plugins.microwave.AxisAlignedPathIntegral
54-
tidy3d.plugins.microwave.Custom2DPathIntegral
55-
tidy3d.plugins.microwave.ImpedanceCalculator
49+
tidy3d.rf.AxisAlignedVoltageIntegral
50+
tidy3d.rf.AxisAlignedCurrentIntegral
51+
tidy3d.rf.Custom2DVoltageIntegral
52+
tidy3d.rf.Custom2DCurrentIntegral
53+
tidy3d.rf.AxisAlignedPathIntegral
54+
tidy3d.rf.Custom2DPathIntegral
55+
tidy3d.rf.ImpedanceCalculator
5656

5757
The classes above are used to define the voltage/current integration paths for impedance calculation.
5858

docs/api/microwave/radiation_scattering.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Radiation & Scattering
77
:toctree: ../_autosummary/
88
:template: module.rst
99

10-
tidy3d.DirectivityMonitor
11-
tidy3d.plugins.smatrix.DirectivityMonitorSpec
12-
tidy3d.plugins.microwave.RectangularAntennaArrayCalculator
13-
tidy3d.plugins.microwave.LobeMeasurer
14-
tidy3d.AntennaMetricsData
10+
tidy3d.rf.DirectivityMonitor
11+
tidy3d.rf.DirectivityMonitorSpec
12+
tidy3d.rf.RectangularAntennaArrayCalculator
13+
tidy3d.rf.LobeMeasurer
14+
tidy3d.rf.AntennaMetricsData
1515

1616
When modeling antennas or scattering problems, it is vital to analyze the radiated far-field. For such applications, the :class:`.DirectivityMonitor` should be used.
1717

0 commit comments

Comments
 (0)