tidy3d.SteadyFreeCarrierData

tidy3d.SteadyFreeCarrierData#

class SteadyFreeCarrierData[source]#

Bases: HeatChargeMonitorData

Stores free-carrier concentration in charge simulations.

Parameters:

monitor (SteadyFreeCarrierMonitor) – Free carrier data associated with a Charge simulation.
symmetry (tuple[Literal[0, 1], Literal[0, 1], Literal[0, 1]] = (0, 0, 0)) – Symmetry of the original simulation in x, y, and z.
symmetry_center (tuple[float, float, float] = (0, 0, 0)) – Symmetry center of the original simulation in x, y, and z.
electrons (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = 1/cm^3]. Contains the computed electrons concentration \(n\).
holes (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = 1/cm^3]. Contains the computed holes concentration \(p\).

Notes

This data contains the carrier concentrations: the amount of electrons and holes per unit volume as defined in the monitor.

Attributes

`field_components`	Maps the field components to their associated data.
`monitor`
`electrons`
`holes`
`symmetry`
`symmetry_center`

Methods

Issue error if incorrect data type is used

property field_components#: Maps the field components to their associated data.

check_correct_data_type()[source]#: Issue error if incorrect data type is used