Index

`flex_rf.tidy3d`

ABCBoundary

One-way wave equation absorbing boundary conditions. See, for example, John B. Schneider, Understanding the Finite-Difference Time-Domain Method, Chapter 6.

Absorber

Specifies an adiabatic absorber along a single dimension.

AbsorberParams

Specifies parameters common to Absorbers and PMLs.

AbstractComponentModeler

Tool for modeling devices and computing port parameters.

AdmittanceNetwork

Class for representing a network consisting of an arbitrary number of resistors, capacitors, and inductors. The network is represented in the Laplace domain as an admittance function. Provides additional functionality for representing the network as an equivalent medium.

AnisotropicMedium

Diagonally anisotropic medium.

AntennaMetricsData

Data representing the main parameters and figures of merit for antennas.

ApodizationSpec

Stores specifications for the apodizaton of frequency-domain monitors.

AutoGrid

Specification for non-uniform grid along a given dimension.

AutoImpedanceSpec

Specification for fully automatic transmission line impedance computation.

AxisAlignedCurrentIntegral

Class for computing conduction current via Ampère’s circuital law on an axis-aligned loop.

AxisAlignedCurrentIntegralSpec

Class for specifying the computation of conduction current via Ampère’s circuital law on an axis-aligned loop.

AxisAlignedPathIntegral

Class for defining the simplest type of path integral, which is aligned with Cartesian axes.

AxisAlignedVoltageIntegral

Class for computing the voltage between two points defined by an axis-aligned line.

AxisAlignedVoltageIntegralSpec

Class for specifying the voltage calculation between two points defined by an axis-aligned line.

BasebandCustomSourceTime

Custom baseband source time profile from a user-provided time-domain dataset.

BasebandGaussianPulse

Unmodulated Gaussian pulse source time profile.

BasebandRectangularPulse

Smoothed rectangular pulse source time profile.

BasebandStep

Step function source time profile using an error function (erf).

BlackmanHarrisWindow

Standard Blackman-Harris window for tapering or spectral shaping.

BlackmanWindow

Standard Blackman window for tapering or spectral shaping.

BlochBoundary

Specifies a Bloch boundary condition along a single dimension.

Boundary

Boundary conditions at the minus and plus extents along a dimension.

BoundarySpec

Specifies boundary conditions on each side of the domain and along each dimension.

Box

Rectangular prism. Also base class for Simulation, Monitor, and Source.

BroadbandPulse

A source time injecting significant energy in the entire custom frequency range.

C_0

Speed of light in vacuum [um/s]

ChebWindow

Standard Chebyshev window for tapering with configurable sidelobe attenuation.

CircuitImpedanceModel

Circuit model storing R/L/C components and port nodes; fits admittance on demand.

ClipOperation

Class representing the result of a set operation between geometries.

CoaxialLumpedPort

Class representing a single coaxial lumped port.

CoaxialLumpedResistor

Class representing a coaxial lumped resistor. Lumped resistors are appended to the list of structures in the simulation as Medium2D with the appropriate conductivity given their size and geometry.

ComponentModelerDataType

ComponentModelerType

CompositeCurrentIntegral

Current integral comprising one or more disjoint paths

CompositeCurrentIntegralSpec

Specification for a composite current integral.

config

Tidy3D configuration system public API.

ContourPathAveraging

Apply a contour-path subpixel averaging method to dielectric boundaries.

Coords

Holds data about a set of x,y,z positions on a grid.

CornerFinderSpec

Specification for corner detection on a 2D plane.

CurrentIntegralTypes

Custom2DCurrentIntegral

Class for computing conduction current via Ampère’s circuital law on a custom path. To compute the current flowing in the positive axis direction, the vertices should be ordered in a counterclockwise direction.

Custom2DCurrentIntegralSpec

Class for specifying the computation of conduction current via Ampère’s circuital law on a custom path. To compute the current flowing in the positive axis direction, the vertices should be ordered in a counterclockwise direction.

Custom2DPathIntegral

Class for defining a custom path integral defined as a curve on an axis-aligned plane.

Custom2DVoltageIntegral

Class for computing the voltage between two points defined by a custom path. Computed voltage is $V=V_b-V_a$ , where position b is the final vertex in the supplied path.

Custom2DVoltageIntegralSpec

Class for specifying the computation of voltage between two points defined by a custom path. Computed voltage is $V=V_b-V_a$ , where position b is the final vertex in the supplied path.

CustomAnisotropicMedium

Diagonally anisotropic medium with spatially varying permittivity in each component.

CustomGrid

Custom 1D grid supplied as a list of grid cell sizes centered on the simulation center.

CustomGridBoundaries

Custom 1D grid supplied as a list of grid cell boundary coordinates.

CustomImpedanceSpec

Specification for custom transmission line voltages and currents in mode solvers.

CustomMedium

Medium with user-supplied permittivity distribution.

CustomPoleResidue

A spatially varying dispersive medium described by the pole-residue pair model.

CustomSourceTime

Custom source time dependence consisting of a real or complex envelope modulated at a central frequency, as shown below.

Cylinder

Cylindrical geometry with optional sidewall angle along axis direction. When sidewall_angle is nonzero, the shape is a conical frustum or a cone.

DiffractionData

Data for a DiffractionMonitor: complex components of diffracted far fields.

DiffractionMonitor

Monitor that uses a 2D Fourier transform to compute the diffraction amplitudes and efficiency for allowed diffraction orders.

DirectivityData

Data associated with a DirectivityMonitor.

DirectivityMonitor

Monitor that records the radiation characteristics of antennas in the frequency domain at specified observation angles.

DirectivityMonitorSpec

Specification for automatically generating a DirectivityMonitor.

EPSILON_0

Vacuum permittivity [F/um]

ETA_0

Vacuum impedance in Ohms

FastDispersionFitter

Tool for fitting refractive index data to get a dispersive medium described by PoleResidue model.

FieldData

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

FieldGrid

Holds the grid data for a single field.

FieldMonitor

Monitor that records electromagnetic fields in the frequency domain.

FieldTimeData

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

FieldTimeMonitor

Monitor that records electromagnetic fields in the time domain.

FluxData

Data associated with a FluxMonitor: flux data in the frequency-domain.

FluxMonitor

Monitor that records power flux in the frequency domain.

FluxTimeData

Data associated with a FluxTimeMonitor: flux data in the time-domain.

FluxTimeMonitor

Monitor that records power flux in the time domain.

FreqRange

Convenience class for handling frequency/wavelength conversion; it simplifies specification of frequency ranges and sample points for sources and monitors.

FrequencyUtils

Utilities for classifying frequencies/wavelengths and generating samples for standard optical bands.

FullyAnisotropicMedium

Fully anisotropic medium including all 9 components of the permittivity and conductivity tensors.

GaussianPulse

Source time dependence that describes a Gaussian pulse.

Geometry

Abstract base class, defines where something exists in space.

GeometryArray

A geometry representing an array of copies of a base geometry, with optional offsets and/or linear transformations applied to each copy.

GeometryGroup

A collection of Geometry objects that can be called as a single geometry object.

Grid

Contains all information about the spatial positions of the FDTD grid.

GridRefinement

Specification for local mesh refinement that defines the grid step size and the number of grid cells in the refinement region.

GridSpec

Collective grid specification for all three dimensions.

HammerstadSurfaceRoughness

Modified Hammerstad surface roughness model. It’s a popular model that works well under 5 GHz for surface roughness below 2 micrometer RMS.

HammingWindow

Standard Hamming window for tapering or spectral shaping.

HannWindow

Hann window with configurable sidelobe suppression and sidelobe count.

HeuristicPECStaircasing

Apply a variant of staircasing scheme to PEC boundaries: the electric field grid is set to PEC if the field is substantially parallel to the interface.

HuraySurfaceRoughness

Huray surface roughness model.

ImpedanceCalculator

Tool for computing the characteristic impedance of a transmission line.

inf

Representation of infinity used within tidy3d.

InternalAbsorber

Internally placed plane with one-way wave equation boundary conditions for absorption of electromagnetic waves. Note that internal absorbers are automatically wrapped in a PEC frame with a backing PEC plate on the non-absorbing side.

KaiserWindow

Class for Kaiser window.

LayerRefinementSpec

Specification for automatic mesh refinement and snapping in layered structures. Structure corners on the cross section perpendicular to layer thickness direction can be automatically identified. Subsequently, mesh is snapped and refined around the corners. Mesh can also be refined and snapped around the bounds along the layer thickness direction.

LinearLumpedElement

Lumped element representing a network consisting of resistors, capacitors, and inductors.

LobeMeasurer

Tool for detecting and analyzing lobes in antenna radiation patterns, along with their characteristics such as direction and beamwidth.

log

Logging Configuration for Tidy3d.

LossyMetalMedium

Lossy metal that can be modeled with a surface impedance boundary condition (SIBC).

LowFrequencySmoothingSpec

Specifies the low frequency smoothing parameters for the simulation. This specification affects only results recorded in mode monitors. Specifically, the mode decomposition data for frequencies for which the total simulation time in units of the corresponding period (T = 1/f) is less than the specified minimum sampling time will be overridden by extrapolation from the data in the trusted frequency range. The trusted frequency range is defined in terms of minimum and maximum sampling times (the total simulation time divided by the corresponding period).

LumpedCircuitComponent

Single R, L, or C branch between two nodes.

LumpedPort

Class representing a single rectangular lumped port.

LumpedResistor

Class representing a rectangular lumped resistor. Lumped resistors are appended to the list of structures in the simulation as Medium2D with the appropriate conductivity given their size and voltage axis.

material_library

Medium

Dispersionless medium. Mediums define the optical properties of the materials within the simulation.

Medium2D

2D diagonally anisotropic medium.

MeshOverrideStructure

Defines an object that is only used in the process of generating the mesh.

MicrowaveModeData

Data associated with a ModeMonitor for microwave and RF applications: modal amplitudes, propagation indices, mode profiles, and transmission line data.

MicrowaveModeMonitor

Monitor that records amplitudes from modal decomposition of fields on plane.

MicrowaveModeSolverData

Data associated with a ModeSolverMonitor for microwave and RF applications: scalar components of E and H fields plus characteristic impedance data.

MicrowaveModeSolverMonitor

Monitor that stores the mode field profiles returned by the mode solver in the monitor plane.

MicrowaveModeSpec

Specification for transmission line modes and microwave waveguides.

MicrowaveSMatrixData

Stores the computed S-matrix and reference impedances for the terminal ports.

MicrowaveTerminalSource

Injects current source to excite a specific terminal mode.

ModeABCBoundary

One-way wave equation absorbing boundary conditions for absorbing a waveguide mode.

ModeData

Data associated with a ModeMonitor: modal amplitudes, propagation indices and mode profiles.

ModeInterpSpec

Specification for mode frequency interpolation.

ModelerLowFrequencySmoothingSpec

Specifies the low frequency smoothing parameters for the terminal component simulation. This specification affects only results at wave ports. Specifically, the mode decomposition data for frequencies for which the total simulation time in units of the corresponding period (T = 1/f) is less than the specified minimum sampling time will be overridden by extrapolation from the data in the trusted frequency range. The trusted frequency range is defined in terms of minimum and maximum sampling times (the total simulation time divided by the corresponding period).

models

Imports for transmission line models.

ModeMonitor

Monitor that records amplitudes from modal decomposition of fields on plane.

ModeSolver

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

ModeSolverData

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

ModeSolverMonitor

Monitor that stores the mode field profiles returned by the mode solver in the monitor plane.

ModeSortSpec

Specification for filtering and sorting modes within each frequency.

ModeSpec

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

MU_0

Vacuum permeability [H/um]

path_integrals_from_lumped_element

Helper to create a AxisAlignedVoltageIntegral and AxisAlignedCurrentIntegral from a supplied LinearLumpedElement. Takes into account any snapping the lumped element undergoes using the supplied Grid.

PEC

PECBoundary

Perfect electric conductor boundary condition class.

PECConformal

Apply a subpixel averaging method known as conformal mesh scheme to PEC boundaries.

PECFrame

PEC source frame.

PECMedium

Perfect electrical conductor class.

Periodic

Periodic boundary condition class.

PermittivityData

Data for a PermittivityMonitor: diagonal components of the permittivity tensor.

PermittivityMonitor

Monitor that records the diagonal components of the complex-valued relative permittivity tensor in the frequency domain. The recorded data has the same shape as a FieldMonitor of the same geometry: the permittivity values are saved at the Yee grid locations, and can be interpolated to any point inside the monitor.

PlaneWave

Uniform current distribution on an infinite extent plane. One element of size must be zero.

PMCBoundary

Perfect magnetic conductor boundary condition class.

PMCMedium

Perfect magnetic conductor class.

PML

Specifies a standard PML along a single dimension.

PMLParams

Specifies full set of parameters needed for complex, frequency-shifted PML.

PointDipole

Uniform current source with a zero size. The source corresponds to an infinitesimal antenna with a fixed current density, and is slightly different from a related definition that is used in some contexts, namely an oscillating electric or magnetic dipole. The two are related through a factor of omega ** 2 in the power normalization, where omega is the angular frequency of the oscillation. This is discussed further in our source normalization FAQ page.

PolarizedAveraging

Apply a polarized subpixel averaging method to dielectric boundaries, which is a phenomenological approximation of ContourPathAveraging.

PoleResidue

A dispersive medium described by the pole-residue pair model.

PolySlab

Polygon extruded with optional sidewall angle along axis direction.

PortDataArray

Array of values over dimensions of frequency and port name.

QuasiUniformGrid

Similar to UniformGrid that generates uniform 1D grid, but grid positions are locally fine tuned to be snaped to snapping points and the edges of structure bounding boxes. Internally, it is using the same meshing method as AutoGrid, but it ignores material information in favor for a user-defined grid size.

RadialTaper

Class for Radial Taper.

RectangularAntennaArrayCalculator

This class provides methods to calculate the array factor and far-field radiation patterns for rectangular phased antenna arrays. It handles arrays with arbitrary size, spacing, phase shifts, and amplitude tapering in x, y, and z directions.

RectangularLumpedElement

Class representing a rectangular planar element with zero thickness along its normal axis. A RectangularLumpedElement is appended to the list of structures in the simulation as a Medium2D with the appropriate material properties given their size, voltage axis, and the network they represent.

RectangularTaper

Class for rectangular taper.

rf_material_library

RLCNetwork

Class for representing a simple network consisting of a resistor, capacitor, and inductor. Provides additional functionality for representing the network as an equivalent medium.

RotationAroundAxis

Rotation of vectors and tensors around a given vector.

RunTimeSpec

Defines specification for how long to run a simulation when added to Simulation.run_time.

Scene

Contains generic information about the geometry and medium properties common to all types of simulations.

set_logging_file

Set a file to write log to, independently from the stdout and stderr output chosen using set_logging_level.

set_logging_level

Raise a warning here instead of setting the logging level.

Simulation

Custom implementation of Maxwell’s equations which represents the physical model to be solved using the FDTD method.

SimulationData

Stores data from a collection of Monitor objects in a Simulation.

SourceTime

Base class describing the time dependence of a source.

SpatialDataArray

Spatial distribution.

Sphere

Spherical geometry.

StablePML

Specifies a ‘stable’ PML along a single dimension. This PML deals handles possibly divergent simulations better, but at the expense of more layers.

Staircasing

Apply staircasing scheme to material assignment of Yee grids on structure boundaries.

Structure

Defines a physical object that interacts with the electromagnetic fields. A Structure is a combination of a material property (AbstractMedium) and a Geometry.

SubpixelSpec

Defines specification for subpixel averaging schemes when added to Simulation.subpixel.

SurfaceFieldData

Data associated with a SurfaceFieldMonitor: E and H fields on a surface.

SurfaceFieldMonitor

Monitor that records electromagnetic fields in the frequency domain on PEC and lossy metal surfaces.

SurfaceFieldTimeData

SurfaceFieldTimeMonitor

Monitor that records electromagnetic fields in the time domain on PEC and lossy metal surfaces.

SurfaceImpedance

Apply 1st order (Leontovich) surface impedance boundary condition to structure made of LossyMetalMedium.

SurfaceImpedanceFitterParam

Advanced parameters for fitting surface impedance of a LossyMetalMedium. Internally, the quantity to be fitted is surface impedance divided by -1j * \omega.

TaylorWindow

Taylor window with configurable sidelobe suppression and sidelobe count.

TerminalComponentModeler

Tool for modeling two-terminal multiport devices and computing port parameters with lumped and wave ports.

TerminalComponentModelerData

Data associated with a TerminalComponentModeler simulation run.

TerminalPortDataArray

Port parameter matrix elements for terminal-based ports.

TerminalWavePort

Class representing a single terminal-driven wave port.

Transformed

Class representing a transformed geometry.

TriangleMesh

Custom surface geometry given by a triangle mesh, as in the STL file format.

UniformCurrentSource

Source in a rectangular volume with uniform time dependence.

UniformGrid

Uniform 1D grid. The most standard way to define a simulation is to use a constant grid size in each of the three directions.

VisualizationSpec

Defines specification for visualization when used with plotting functions.

VoltageIntegralTypes

VolumetricAveraging

Apply volumetric averaging scheme to material properties of Yee grids on structure boundaries. The material property is averaged in the volume surrounding the Yee grid.

WavePort

Class representing a single modal-driven wave port.

YeeGrid

Holds the yee grid coordinates for each of the E and H positions.