Base Classes

These are some of the classes that are used to organize Tidy3D components, but aren’t to be used directly by the user. They are documented here mainly for user reference of inherited components.

Geometry	Abstract base class, defines where something exists in space.
Tidy3dBaseModel	Base pydantic model that all Tidy3d components inherit from.
components.geometry.base.Centered	Geometry with a well defined center.
components.geometry.base.Circular	Geometry with circular characteristics (specified by a radius).
components.geometry.base.Planar	Geometry with one axis that is slab-like with thickness height.
components.geometry.base.SimplePlaneIntersection	A geometry where intersections with an axis aligned plane may be computed efficiently.
components.geometry.polyslab.ComplexPolySlabBase	Interface for dividing a complex polyslab where self-intersecting polygon can occur during extrusion.
components.structure.AbstractStructure	A basic structure object.
components.medium.AbstractMedium	A medium within which electromagnetic waves propagate.
components.medium.AbstractCustomMedium	A spatially varying medium.
components.medium.DispersiveMedium	A Medium with dispersion: field propagation characteristics depend on frequency.
components.medium.CustomDispersiveMedium	A spatially varying dispersive medium.
components.medium.AnisotropicMediumFromMedium2D	The same as AnisotropicMedium, but converted from Medium2D.
components.source.time.SourceTime	Base class describing the time dependence of a source.
components.source.time.Pulse	A source time that ramps up with some fwidth and oscillates at freq0.
components.source.base.Source	Abstract base class for all sources.
components.source.field.FieldSource	A Source defined by the desired E and/or H fields.
components.source.field.PlanarSource	A source defined on a 2D plane.
components.source.field.VolumeSource	A source defined in a 3D Box.
components.source.field.DirectionalSource	A Field source that propagates in a given direction.
components.source.field.BroadbandSource	A source with frequency dependent field distributions.
components.source.field.AngledFieldSource	A FieldSource defined with an angled direction of propagation.
components.source.current.CurrentSource	Source implements a current distribution directly.
components.source.current.ReverseInterpolatedSource	Abstract source that allows reverse-interpolation along zero-sized dimensions.
Monitor	Abstract base class for monitors.
components.tcad.monitors.abstract.HeatChargeMonitor	Abstract base class for heat-charge monitors.
components.monitor.FreqMonitor	Monitor that records data in the frequency-domain.
components.monitor.TimeMonitor	Monitor that records data in the time-domain.
components.monitor.AbstractFieldMonitor	Monitor that records electromagnetic field data as a function of x,y,z.
components.monitor.AbstractFluxMonitor	Monitor that records flux during the solver run.
components.monitor.PlanarMonitor	Monitor that has a planar geometry.
components.monitor.SurfaceIntegrationMonitor	Abstract class for monitors that perform surface integrals during the solver run, as in flux and near to far transformations.
components.monitor.AbstractFieldProjectionMonitor	Monitor that samples electromagnetic near fields in the frequency domain and projects them to a given set of observation points.
components.lumped_element.LumpedElement	Base class describing the interface all lumped elements obey.
components.lumped_element.RectangularLumpedElement	Class representing a rectangular planar element with zero thickness along its normal axis.
components.grid.grid_spec.GridSpec1d	Abstract base class, defines 1D grid generation specifications.
components.data.sim_data.AbstractYeeGridSimulationData	Data from an AbstractYeeGridSimulation involving electromagnetic fields on a Yee grid.
components.data.sim_data.SimulationData	Stores data from a collection of Monitor objects in a Simulation.
components.boundary.AbsorberSpec	Specifies the generic absorber properties along a single dimension.
components.tcad.boundary.abstract.HeatChargeBC	Abstract heat-charge boundary conditions.
components.subpixel_spec.AbstractSubpixelAveragingMethod	Base class defining how to handle material assignment on structure interfaces.
components.data.data_array.DataArray	Subclass of xr.DataArray that requires _dims to match the keys of the coords.
components.data.dataset.FieldDataset	Dataset storing a collection of the scalar components of E and H fields in the freq.
components.data.dataset.FieldTimeDataset	Dataset storing a collection of the scalar components of E and H fields in the time domain
components.data.dataset.ModeSolverDataset	Dataset storing scalar components of E and H fields as a function of freq.
components.data.monitor_data.ElectromagneticFieldData	Collection of electromagnetic fields.
components.data.monitor_data.MonitorData	Abstract base class of objects that store data pertaining to a single monitor.
components.spice.analysis.ac.AbstractSSACAnalysis	Abstract base class for Small-Signal AC (SSAC) analysis parameters.
components.bc_placement.AbstractBCPlacement	Abstract placement for boundary conditions.
components.boundary.AbstractABCBoundary	One-way wave equation absorbing boundary conditions abstract base class.
components.grid.grid_spec.AbstractAutoGrid	Specification for non-uniform or quasi-uniform grid along a given dimension.
components.material.tcad.charge.AbstractChargeMedium	Abstract class for Charge specifications Currently, permittivity is treated as a constant.
components.material.tcad.heat.AbstractHeatMedium	Abstract heat material specification.
components.medium.AbstractSurfaceRoughness	Abstract class for modeling surface roughness of lossy metal.
components.mode_spec.AbstractModeSpec	Abstract base for mode specification data.
components.base_sim.monitor.AbstractMonitor	Abstract base class for steady-state monitors.
components.monitor.AbstractGaussianOverlapMonitor	Monitor that records amplitudes from decomposition onto a Gaussian-like beam.
components.monitor.AbstractMediumPropertyMonitor	Monitor that records material properties in the frequency domain.
components.monitor.AbstractModeMonitor	Monitor that records mode-related data.
components.microwave.monitor.MicrowaveModeMonitorBase	Base class for microwave mode monitors that use MicrowaveModeSpec.
components.microwave.path_integrals.specs.base.AbstractAxesRH	Represents an axis-aligned right-handed coordinate system with one axis preferred.
components.source.field.AbstractAngularSpec	Abstract base for defining angular variability specifications for plane waves.
components.tcad.data.sim_data.AbstractHeatChargeSimulationData	Abstract class for HeatChargeSimulation results, or VolumeMesher results.
components.tcad.doping.AbstractDopingBox	Derived class from Box to deal with dopings
plugins.autograd.invdes.filters.AbstractFilter	An abstract class for creating and applying convolution filters.
plugins.invdes.base.InvdesBaseModel	Base class for invdes components, in case we need it.
plugins.invdes.design.AbstractInverseDesign	Container for an inverse design problem.
plugins.microwave.array_factor.AbstractAntennaArrayCalculator	Abstract base for phased array calculators.
plugins.smatrix.ports.base_lumped.AbstractLumpedPort	Class representing a single lumped port.
plugins.smatrix.ports.base_terminal.AbstractTerminalPort	Class representing a single terminal-based port.