tidy3d.components.base_sim.data.sim_data.AbstractSimulationData

tidy3d.components.base_sim.data.sim_data.AbstractSimulationData#

class AbstractSimulationData[source]#

Bases: Tidy3dBaseModel, ABC

Stores data from a collection of AbstractMonitor objects in a AbstractSimulation.

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 (AbstractSimulation) – Original AbstractSimulation associated with the data.
data (Tuple[AbstractMonitorData, ...]) – List of AbstractMonitorData instances associated with the monitors of the original AbstractSimulation.
log (Optional[str] = None) – A string containing the log information from the simulation run.

Attributes

`monitor_data`	Dictionary mapping monitor name to its associated `AbstractMonitorData`.
`attrs`

Methods

`data_monitors_match_sim`(values)	Ensure each `AbstractMonitorData` in `.data` corresponds to a monitor in `.simulation`.
`get_monitor_by_name`(name)	Return monitor named 'name'.
`validate_no_ambiguity`(val, values)	Ensure all `AbstractMonitorData` entries in `.data` correspond to different monitors in `.simulation`.

Inherited Common Usage

__getitem__(monitor_name)[source]#: Get a AbstractMonitorData by name. Apply symmetry if applicable.

property monitor_data#: Dictionary mapping monitor name to its associated AbstractMonitorData.

classmethod data_monitors_match_sim(values)[source]#: Ensure each AbstractMonitorData in .data corresponds to a monitor in .simulation.

classmethod validate_no_ambiguity(val, values)[source]#: Ensure all AbstractMonitorData entries in .data correspond to different monitors in .simulation.