Added EME solver

flexcompute · Apr 5, 2024 · b8b26b2 · b8b26b2
1 parent cd7bb00
commit b8b26b2
Show file tree

Hide file tree

Showing 34 changed files with 7,149 additions and 3,229 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 2D heat simulations are now fully supported. 
 - `tidy3d.plugins.adjoint.web.run_local` used in place of `run` will skip validators that restrict the size or number of `input_structures`.
 
+### Added
+- EME solver through `EMESimulation` class.
+
 ### Fixed
 - Better error message when trying to transform a geometry with infinite bounds.
 

diff --git a/docs/api/abstract_base.rst b/docs/api/abstract_base.rst
@@ -14,4 +14,4 @@ Base classes that represent abstractions of the core elements of a Simulation.
    tidy3d.components.base_sim.monitor.AbstractMonitor
    tidy3d.components.base_sim.source.AbstractSource
    tidy3d.components.source.Source
-   tidy3d.components.monitor.Monitor
+   tidy3d.components.monitor.Monitor
diff --git a/docs/api/abstract_models.rst b/docs/api/abstract_models.rst
@@ -12,6 +12,7 @@ These are some classes that are used to organize the tidy3d components, but aren
 
    tidy3d.components.base.Tidy3dBaseModel
    tidy3d.components.base_sim.simulation.AbstractSimulation
+   tidy3d.components.simulation.AbstractYeeGridSimulation
    tidy3d.components.boundary.AbsorberSpec
    tidy3d.Geometry
    tidy3d.components.geometry.base.Centered
@@ -42,6 +43,8 @@ These are some classes that are used to organize the tidy3d components, but aren
    tidy3d.components.monitor.AbstractFieldProjectionMonitor
    tidy3d.components.lumped_element.LumpedElement
    tidy3d.components.grid.grid_spec.GridSpec1d
+   tidy3d.components.base_sim.data.sim_data.SimulationData
+   tidy3d.components.data.sim_data.AbstractYeeGridSimulationData
    tidy3d.components.data.sim_data.SimulationData
    tidy3d.components.data.data_array.DataArray
    tidy3d.components.data.monitor_data.MonitorData
@@ -51,4 +54,4 @@ These are some classes that are used to organize the tidy3d components, but aren
    tidy3d.components.data.dataset.AbstractFieldDataset
    tidy3d.components.data.dataset.FieldDataset
    tidy3d.components.data.dataset.FieldTimeDataset
-   tidy3d.components.data.dataset.ModeSolverDataset
+   tidy3d.components.data.dataset.ModeSolverDataset
diff --git a/docs/api/eme/grid.rst b/docs/api/eme/grid.rst
@@ -0,0 +1,14 @@
+.. currentmodule:: tidy3d
+
+Grid Specification
+--------------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.EMEUniformGrid
+   tidy3d.EMECompositeGrid
+   tidy3d.EMEExplicitGrid
+   tidy3d.EMEGrid
+   tidy3d.EMEModeSpec
diff --git a/docs/api/eme/index.rst b/docs/api/eme/index.rst
@@ -0,0 +1,18 @@
+EME
+=============
+
+.. toctree::
+    :hidden:
+
+    simulation
+    grid
+    monitor
+    sweep
+    output_data
+
+
+.. include:: /api/eme/simulation.rst
+.. include:: /api/eme/grid.rst
+.. include:: /api/eme/monitor.rst
+.. include:: /api/eme/sweep.rst
+.. include:: /api/eme/output_data.rst
diff --git a/docs/api/eme/monitor.rst b/docs/api/eme/monitor.rst
@@ -0,0 +1,13 @@
+.. currentmodule:: tidy3d
+
+Monitors
+----------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.EMECoefficientMonitor
+   tidy3d.EMEModeSolverMonitor
+   tidy3d.EMEFieldMonitor
+   tidy3d.EMEMonitor
diff --git a/docs/api/eme/output_data.rst b/docs/api/eme/output_data.rst
@@ -0,0 +1,25 @@
+.. currentmodule:: tidy3d
+
+Output Data
+-------------
+
+Monitor Data
+^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.EMECoefficientData
+   tidy3d.EMEModeSolverData
+   tidy3d.EMEFieldData
+
+
+Simulation Data
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.EMESimulationData
diff --git a/docs/api/eme/simulation.rst b/docs/api/eme/simulation.rst
@@ -0,0 +1,10 @@
+.. currentmodule:: tidy3d
+
+Simulation
+-----------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.EMESimulation
diff --git a/docs/api/eme/sweep.rst b/docs/api/eme/sweep.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: tidy3d
+
+Propagation Sweeps
+--------------------
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.EMELengthSweep
+   tidy3d.EMEModeSweep
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -22,6 +22,7 @@ API |:computer:|
     submit_simulations
     heat/index
     charge/index
+    eme/index
     plugins/index
     constants
     abstract_base
@@ -43,7 +44,8 @@ API |:computer:|
 .. include:: /api/submit_simulations.rst
 .. include:: /api/heat/index.rst
 .. include:: /api/charge/index.rst
+.. include:: /api/eme/index.rst
 .. include:: /api/plugins/index.rst
 .. include:: /api/constants.rst
 .. include:: /api/abstract_base.rst
-.. include:: /api/abstract_models.rst
+.. include:: /api/abstract_models.rst
diff --git a/docs/notebooks b/docs/notebooks