tidy3d.SteadyFreeCarrierData#

class SteadyFreeCarrierData[source]#

Bases: HeatChargeMonitorData

Stores free-carrier concentration in charge simulations.

Parameters:

attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().
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 (Union[TriangularGridDataset, TetrahedralGridDataset] = None) – Contains the computed electrons concentration $n$.
holes (Union[TriangularGridDataset, TetrahedralGridDataset] = None) – 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.
`symmetry_expanded_copy`	Return copy of self with symmetry applied.
`attrs`

Methods

`check_correct_data_type`(values)	Issue error if incorrect data type is used
`field_name`([val])	Gets the name of the fields to be plot.
`warn_no_data`(values)	Warn if no data provided.

Inherited Common Usage

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

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

property symmetry_expanded_copy#: Return copy of self with symmetry applied.

tidy3d.SteadyFreeCarrierData