tidy3d.plugins.adjoint.JaxSimulationData

class JaxSimulationData

Bases: SimulationData, JaxObject

A SimulationData registered with jax.

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 (JaxSimulation) – The jax-compatible simulation corresponding to the data.

• data (Tuple[Annotated[Union[tidy3d.components.data.monitor_data.FieldData, tidy3d.components.data.monitor_data.FieldTimeData, tidy3d.components.data.monitor_data.PermittivityData, tidy3d.components.data.monitor_data.ModeSolverData, tidy3d.components.data.monitor_data.ModeData, tidy3d.components.data.monitor_data.FluxData, tidy3d.components.data.monitor_data.FluxTimeData, tidy3d.components.data.monitor_data.AuxFieldTimeData, tidy3d.components.data.monitor_data.FieldProjectionKSpaceData, tidy3d.components.data.monitor_data.FieldProjectionCartesianData, tidy3d.components.data.monitor_data.FieldProjectionAngleData, tidy3d.components.data.monitor_data.DiffractionData, tidy3d.components.data.monitor_data.DirectivityData], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})], ...]) – 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.

• diverged (bool = False) – A boolean flag denoting whether the simulation run diverged.

• output_data (Tuple[Union[JaxModeData, JaxDiffractionData, JaxFieldData], ...] = ()) – Tuple of Jax-compatible data associated with output monitors.

• grad_data (Tuple[FieldData, ...] = ()) – Tuple of monitor data storing fields associated with the input structures.

• grad_eps_data (Tuple[PermittivityData, ...] = ()) – Tuple of monitor data storing epsilon associated with the input structures.

• task_id (Optional[str] = None) – Optional field storing the task_id for the original JaxSimulation.

Attributes

grad_data_symmetry	self.grad_data but with symmetry_expanded_copy applied.
grad_eps_data_symmetry	self.grad_eps_data but with symmetry_expanded_copy applied.
monitor_data	Dictionary of .output_data monitor .name to the corresponding data.
output_monitor_data	Dictionary of .output_data monitor .name to the corresponding data.
log	Custom logger to avoid the complexities of the logging module
attrs

Methods

from_sim_data(sim_data, jax_info[, task_id])	Construct a JaxSimulationData instance from a SimulationData.
get_poynting_vector(field_monitor_name)	return xarray.Dataset of the Poynting vector at Yee cell centers.
make_adjoint_simulation(fwidth, run_time)	Make an adjoint simulation out of the data provided (generally, the vjp sim data).
normalize_adjoint_fields()	Make copy of jax_sim_data with grad_data (fields) normalized by adjoint sources.
split_data(mnt_data, jax_info)	Split list of monitor data into data, output_data, grad_data, and grad_eps_data.
split_fwd_sim_data(sim_data, jax_info)	Split a SimulationData into two parts, containing user and gradient data.

Inherited Common Usage

output_data

grad_data

grad_eps_data

simulation

task_id

get_poynting_vector(field_monitor_name)

return xarray.Dataset of the Poynting vector at Yee cell centers.

Calculated values represent the instantaneous Poynting vector for time-domain fields and the complex vector for frequency-domain: S = 1/2 E × conj(H).

Only the available components are returned, e.g., if the indicated monitor doesn’t include field component “Ex”, then “Sy” and “Sz” will not be calculated.

Parameters:

field_monitor_name (str) – Name of field monitor used in the original Simulation.

Returns:

DataArray containing the Poynting vector calculated based on the field components colocated at the center locations of the Yee grid.

Return type:

xarray.DataArray

property grad_data_symmetry

self.grad_data but with symmetry_expanded_copy applied.

property grad_eps_data_symmetry

self.grad_eps_data but with symmetry_expanded_copy applied.

property output_monitor_data

Dictionary of .output_data monitor .name to the corresponding data.

property monitor_data

Dictionary of .output_data monitor .name to the corresponding data.

static split_data(mnt_data, jax_info)

Split list of monitor data into data, output_data, grad_data, and grad_eps_data.

classmethod from_sim_data(sim_data, jax_info, task_id=None)

Construct a JaxSimulationData instance from a SimulationData.

classmethod split_fwd_sim_data(sim_data, jax_info)

Split a SimulationData into two parts, containing user and gradient data.

make_adjoint_simulation(fwidth, run_time)

Make an adjoint simulation out of the data provided (generally, the vjp sim data).

normalize_adjoint_fields()

Make copy of jax_sim_data with grad_data (fields) normalized by adjoint sources.

__hash__()

Hash method.