tidy3d.HeatSimulationData#

class HeatSimulationData[source]#

Bases: HeatChargeSimulationData

DEPRECATED: Wrapper for Heat Simulation data.

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().

  • simulation (HeatSimulation) – Original HeatSimulation associated with the data.

  • data (Tuple[Union[TemperatureData, SteadyPotentialData, SteadyFreeCarrierData, SteadyCapacitanceData], ...]) – List of MonitorData instances associated with the monitors of the original Simulation.

  • log (Optional[str] = None) – A string containing the log information from the simulation run.

  • device_characteristics (Optional[DeviceCharacteristics] = None) – Data characterizing the device. Current characteristics include: ‘steady_dc_hole_capacitance’, ‘steady_dc_electron_capacitance’, and ‘steady_dc_current_voltage’

Warning

:class`HeatSimulationData` is DEPRECATED. Consider using HeatChargeSimulationData instead.

Attributes

log

Custom logger to avoid the complexities of the logging module

attrs

Methods

issue_warning_deprecated(values)

Issue warning for 'HeatSimulations'.

Inherited Common Usage

simulation#
classmethod issue_warning_deprecated(values)[source]#

Issue warning for ‘HeatSimulations’.

__hash__()#

Hash method.