Mode 🎯#

Mode Source#

tidy3d.ModeSource

Injects current source to excite modal profile on finite extent plane.

tidy3d.ModeSpec

Stores specifications for the mode solver to find an electromagnetic mode.

tidy3d.PECFrame

PEC source frame.

The ModeSource class represents a propagating mode in a given structure cross section.

Behind the scenes, the desired mode is initially obtained by running the mode solver on the ModeSource plane. The ModeSpec class provides the settings for the mode solver. Once the desired mode is found, it is injected into the 3D simulation along the plane normal. The user does not need to invoke the mode solver explicitly; it is performed automatically whenever a ModeSource or ModeMonitor is included in a Tidy3D simulation.

# custom mode specification tells the mode solver to search for
# two modes around effective index = 1.5
my_mode_spec = ModeSpec(num_modes=2, target_neff=1.5)

# custom mode source injects the first mode along the +x direction
my_mode_source = ModeSource(
    size=(0,10,10),
    source_time=my_source_time,
    direction='+',
    mode_spec=my_mode_spec,
    mode_index=0,
)

See also

For more detailed explanation and examples, please see the following learning center resources:

For a short introduction to the use of mode sources, see the following FDTD101 lecture:

Mode Simulation#

tidy3d.ModeSimulation

Simulation class for solving electromagnetic eigenmodes in a 2D plane with translational invariance in the third dimension.

Mode Specifications#

tidy3d.ModeSpec

Stores specifications for the mode solver to find an electromagnetic mode.

tidy3d.ModeSortSpec

Specification for filtering and sorting modes within each frequency.

tidy3d.ModeInterpSpec

Specification for mode frequency interpolation.

Sampling Specifications#

tidy3d.UniformSampling

Uniform frequency sampling specification.

tidy3d.ChebSampling

Chebyshev node frequency sampling specification.

tidy3d.CustomSampling

Custom frequency sampling specification.

Output Data#

Simulation Data#

tidy3d.ModeSimulationData

Data associated with a mode solver simulation.

Monitor Data#

tidy3d.plugins.mode.ModeSolverData

Data associated with a ModeSolverMonitor: scalar components of E and H fields.

Datasets#

tidy3d.ModeSolverDataset

Dataset storing scalar components of E and H fields as a function of freq.

Deprecated#

Deprecated since version ``tidy3d.plugins.mode.ModeSolver``: will be deprecated in a future version. Please use tidy3d.ModeSimulation instead starting from version 2.11.0.

tidy3d.plugins.mode.ModeSolver

Interface for solving electromagnetic eigenmodes in a 2D plane with translational invariance in the third dimension.

tidy3d.plugins.mode.ModeSolverData

Data associated with a ModeSolverMonitor: scalar components of E and H fields.