tidy3d.SteadyChargeResidualData#
- class SteadyChargeResidualData[source]#
Bases:
HeatChargeMonitorDataStores per-node residual snapshots from a Charge simulation.
- Parameters:
monitor (
SteadyChargeResidualMonitor) – Per-node residual monitor 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.
residual_potential (Union[
TriangularGridDataset,TetrahedralGridDataset]) – [units = dimensionless]. Signed residual of the Poisson equation \(R_\psi\).residual_electrons (Union[
TriangularGridDataset,TetrahedralGridDataset]) – [units = dimensionless]. Signed residual of the electron continuity (carrier conservation) equation \(R_n\).residual_holes (Union[
TriangularGridDataset,TetrahedralGridDataset]) – [units = dimensionless]. Signed residual of the hole continuity (carrier conservation) equation \(R_p\).residual_temperature (Optional[Union[
TriangularGridDataset,TetrahedralGridDataset]] = None) – [units = dimensionless]. Signed residual of the heat equation \(R_T\). Present only when the thermal solver is active.
Notes
residual_potential,residual_electrons,residual_holes(andresidual_temperaturewhen the thermal solver is active) are the per-node signed residual components of each governing equation. They are dimensionless and on the same scale as the simulation’s convergence tolerance, so the nodes with the largest magnitude (approaching or exceeding that tolerance) are where the solution least satisfies the equations (the least-converged regions).Attributes
Maps the field components to their associated data.
symmetrysymmetry_center- monitor#
- residual_potential#
- residual_electrons#
- residual_holes#
- residual_temperature#
- property field_components#
Maps the field components to their associated data.