Skip to content

Commit cc8fef1

Browse files
committed
Add VolumeMesher and VOLUME_MESH task type
ability to read unstructured data from legacy vtk format Adding a plot_mesh method for heat charge and mesher data Adding more tests and docstrings, and validate VolumeMeshMonitor at least 2D New unstructured mesh section in API docs
1 parent 00b0330 commit cc8fef1

File tree

27 files changed

+78146
-108
lines changed

27 files changed

+78146
-108
lines changed

docs/api/charge/discretization.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/api/charge/output_data.rst

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,3 @@ Monitor Data
2626
tidy3d.SteadyFreeCarrierData
2727
tidy3d.SteadyCapacitanceData
2828

29-
30-
Unstructured Data Classes
31-
^^^^^^^^^^^^^^^^^^^^^^^^^
32-
33-
.. autosummary::
34-
:toctree: ../_autosummary/
35-
:template: module.rst
36-
37-
tidy3d.TriangularGridDataset
38-
tidy3d.TetrahedralGridDataset
39-
40-
41-
Individual Datasets
42-
^^^^^^^^^^^^^^^^^^^
43-
44-
.. autosummary::
45-
:toctree: ../_autosummary/
46-
:template: module.rst
47-
48-
tidy3d.PointDataArray
49-
tidy3d.CellDataArray
50-
tidy3d.IndexedDataArray

docs/api/heat/output_data.rst

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,3 @@ Monitor Data
2323
:template: module.rst
2424

2525
tidy3d.TemperatureData
26-
27-
28-
Unstructured Data Classes
29-
^^^^^^^^^^^^^^^^^^^^^^^^^
30-
31-
.. autosummary::
32-
:toctree: ../_autosummary/
33-
:template: module.rst
34-
35-
tidy3d.TriangularGridDataset
36-
tidy3d.TetrahedralGridDataset
37-
38-
39-
Individual Datasets
40-
^^^^^^^^^^^^^^^^^^^
41-
42-
.. autosummary::
43-
:toctree: ../_autosummary/
44-
:template: module.rst
45-
46-
tidy3d.PointDataArray
47-
tidy3d.CellDataArray
48-
tidy3d.IndexedDataArray

docs/api/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ API |:computer:|
2424
scene
2525
logging
2626
submit_simulations
27+
mesh/index
2728
heat/index
2829
charge/index
2930
eme/index
@@ -52,6 +53,7 @@ API |:computer:|
5253
.. include:: /api/scene.rst
5354
.. include:: /api/logging.rst
5455
.. include:: /api/submit_simulations.rst
56+
.. include:: /api/mesh/index.rst
5557
.. include:: /api/heat/index.rst
5658
.. include:: /api/charge/index.rst
5759
.. include:: /api/eme/index.rst
File renamed without changes.

docs/api/mesh/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Unstructured mesh |:spider_web:|
2+
=================================
3+
4+
.. toctree::
5+
:hidden:
6+
7+
discretization
8+
mesher
9+
monitor
10+
output_data
11+
12+
.. include:: /api/mesh/discretization.rst
13+
.. include:: /api/mesh/mesher.rst
14+
.. include:: /api/mesh/monitor.rst
15+
.. include:: /api/mesh/output_data.rst

docs/api/mesh/mesher.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: tidy3d
2+
3+
Volume mesher
4+
--------------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.VolumeMesher

docs/api/mesh/monitor.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: tidy3d
2+
3+
Mesh monitors
4+
--------------
5+
6+
.. autosummary::
7+
:toctree: ../_autosummary/
8+
:template: module.rst
9+
10+
tidy3d.VolumeMeshMonitor

docs/api/mesh/output_data.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. currentmodule:: tidy3d
2+
3+
Output Data
4+
-------------
5+
6+
7+
Simulation Data
8+
^^^^^^^^^^^^^^^^^^^^
9+
10+
.. autosummary::
11+
:toctree: ../_autosummary/
12+
:template: module.rst
13+
14+
tidy3d.VolumeMesherData
15+
16+
17+
Monitor Data
18+
^^^^^^^^^^^^
19+
20+
.. autosummary::
21+
:toctree: ../_autosummary/
22+
:template: module.rst
23+
24+
tidy3d.VolumeMeshData
25+
26+
27+
Unstructured Data Classes
28+
^^^^^^^^^^^^^^^^^^^^^^^^^
29+
30+
.. autosummary::
31+
:toctree: ../_autosummary/
32+
:template: module.rst
33+
34+
tidy3d.TriangularGridDataset
35+
tidy3d.TetrahedralGridDataset
36+
37+
38+
Individual Datasets
39+
^^^^^^^^^^^^^^^^^^^
40+
41+
.. autosummary::
42+
:toctree: ../_autosummary/
43+
:template: module.rst
44+
45+
tidy3d.PointDataArray
46+
tidy3d.CellDataArray
47+
tidy3d.IndexedDataArray

0 commit comments

Comments
 (0)