Charge ⚡

Contents

Charge ⚡#

Simulation#

`tidy3d.HeatSimulation`	Contains all information about heat simulation.
`tidy3d.HeatChargeSimulation`	Defines thermoelectric simulations.

Charge Mediums#

`tidy3d.ChargeConductorMedium`	Conductor medium for conduction simulations.
`tidy3d.ChargeInsulatorMedium`	Insulating medium.
`tidy3d.SemiconductorMedium`	This class is used to define semiconductors.

Mobility#

tidy3d.CaugheyThomasMobility

The Caughey-Thomas temperature-dependent carrier mobility model.

Generation Recombination#

`tidy3d.AugerRecombination`	Parameters for the Auger recombination model.
`tidy3d.RadiativeRecombination`	Defines the parameters for the radiative recombination model.
`tidy3d.ShockleyReedHallRecombination`	Defines the parameters for the Shockley-Reed-Hall (SRH) recombination model.

Doping#

`tidy3d.ConstantDoping`	Sets constant doping $N$ in the specified box with a :parameter`size` and :parameter:`concentration`.
`tidy3d.GaussianDoping`	Sets a gaussian doping in the specified box.

Bandgap#

tidy3d.SlotboomBandGapNarrowing

Parameters for the Slotboom model for band-gap narrowing.

Charge Carrier Properties#

`tidy3d.LinearChargePerturbation`	Specifies parameter's perturbation due to free carrier effects as a linear function of electron and hole densities:
`tidy3d.CustomChargePerturbation`	Specifies parameter's perturbation due to free carrier effects as a custom function of electron and hole densities defined as a two-dimensional array of perturbation values at sample electron and hole density points.

Boundary Conditions#

Specifications#

`tidy3d.HeatBoundarySpec`	Heat BC specification.
`tidy3d.HeatChargeBoundarySpec`	Heat-Charge boundary conditions specification.

Types#

`tidy3d.VoltageBC`	Constant electric potential (voltage) $= V$ boundary condition.
`tidy3d.CurrentBC`	Current boundary conditions.
`tidy3d.InsulatingBC`	Insulation boundary condition.

Placement#

`tidy3d.StructureStructureInterface`	Placement of boundary conditions between two structures.
`tidy3d.StructureBoundary`	Placement of boundary conditions on the structure's boundary.
`tidy3d.MediumMediumInterface`	Placement of boundary conditions between two mediums.
`tidy3d.StructureSimulationBoundary`	Placement of boundary conditions on the simulation box boundary covered by the structure.
`tidy3d.SimulationBoundary`	Placement of boundary conditions on the simulation box boundary.

Thermal Sources#

tidy3d.HeatFromElectricSource

Volumetric heat source generated from an electric simulation.

Grid Specification#

`tidy3d.UniformUnstructuredGrid`	Uniform grid.
`tidy3d.DistanceUnstructuredGrid`	Adaptive grid based on distance to material interfaces.

Monitors#

`tidy3d.SteadyPotentialMonitor`	Electric potential ( $ψ$ ) monitor.
`tidy3d.SteadyFreeCarrierMonitor`	Free-carrier monitor for Charge simulations.
`tidy3d.SteadyCapacitanceMonitor`	Capacitance monitor associated with a charge simulation.

Output Data#

Simulation Data#

tidy3d.HeatChargeSimulationData

Stores results of a HeatChargeSimulation.

Monitor Data#

`tidy3d.SteadyPotentialData`	Stores electric potential $ψ$ from a charge simulation.
`tidy3d.SteadyFreeCarrierData`	Stores free-carrier concentration in charge simulations.
`tidy3d.SteadyCapacitanceData`	Class that stores capacitance data from a Charge simulation.

Unstructured Data Classes#

`tidy3d.TriangularGridDataset`	Dataset for storing triangular grid data.
`tidy3d.TetrahedralGridDataset`	Dataset for storing tetrahedral grid data.

Individual Datasets#

`tidy3d.PointDataArray`	A two-dimensional array that stores coordinates of a collection of points.
`tidy3d.CellDataArray`	A two-dimensional array that stores indices of points composing each cell in a collection of cells of the same type (for example: triangles, tetrahedra, etc).
`tidy3d.IndexedDataArray`	Stores a one-dimensional array enumerated by coordinate `index`.