Base Models

These are some classes that are used to organize the tidy3d components, but aren’t to be used directly in the code. Documented here mainly for reference of inherited components.

tidy3d.Geometry	Abstract base class, defines where something exists in space.
tidy3d.components.base.Tidy3dBaseModel	Base pydantic model that all Tidy3d components inherit from.
tidy3d.components.boundary.AbsorberSpec	Specifies the generic absorber properties along a single dimension.
tidy3d.components.data.data_array.DataArray	Subclass of xr.DataArray that requires _dims to match the keys of the coords.
tidy3d.components.data.dataset.FieldDataset	Dataset storing a collection of the scalar components of E and H fields in the freq.
tidy3d.components.data.dataset.FieldTimeDataset	Dataset storing a collection of the scalar components of E and H fields in the time domain
tidy3d.components.data.dataset.ModeSolverDataset	Dataset storing scalar components of E and H fields as a function of freq.
tidy3d.components.data.monitor_data.ElectromagneticFieldData	Collection of electromagnetic fields.
tidy3d.components.data.monitor_data.MonitorData	Abstract base class of objects that store data pertaining to a single monitor.
tidy3d.components.data.sim_data.SimulationData	Stores data from a collection of Monitor objects in a Simulation.
tidy3d.components.geometry.base.Centered	Geometry with a well defined center.
tidy3d.components.geometry.base.Circular	Geometry with circular characteristics (specified by a radius).
tidy3d.components.geometry.base.Planar	Geometry with one axis that is slab-like with thickness height.
tidy3d.components.geometry.base.SimplePlaneIntersection	A geometry where intersections with an axis aligned plane may be computed efficiently.
tidy3d.components.grid.grid_spec.GridSpec1d	Abstract base class, defines 1D grid generation specifications.
tidy3d.components.lumped_element.LumpedElement	Base class describing the interface all lumped elements obey.
tidy3d.components.medium.CustomDispersiveMedium	A spatially varying dispersive medium.
tidy3d.components.medium.DispersiveMedium	A Medium with dispersion: field propagation characteristics depend on frequency.
tidy3d.components.monitor.FreqMonitor	Monitor that records data in the frequency-domain.
tidy3d.components.monitor.Monitor	Abstract base class for monitors.
tidy3d.components.monitor.PlanarMonitor	Monitor that has a planar geometry.
tidy3d.components.monitor.TimeMonitor	Monitor that records data in the time-domain.
tidy3d.components.source.AngledFieldSource	A FieldSource defined with an angled direction of propagation.
tidy3d.components.source.BroadbandSource	A source with frequency dependent field distributions.
tidy3d.components.source.CurrentSource	Source implements a current distribution directly.
tidy3d.components.source.DirectionalSource	A Field source that propagates in a given direction.
tidy3d.components.source.FieldSource	A Source defined by the desired E and/or H fields.
tidy3d.components.source.PlanarSource	A source defined on a 2D plane.
tidy3d.components.source.Pulse	A source time that ramps up with some fwidth and oscillates at freq0.
tidy3d.components.source.ReverseInterpolatedSource	Abstract source that allows reverse-interpolation along zero-sized dimensions.
tidy3d.components.source.Source	Abstract base class for all sources.
tidy3d.components.source.SourceTime	Base class describing the time dependence of a source.
tidy3d.components.source.VolumeSource	A source defined in a 3D Box.