Skip to content

Commit

Permalink
ELECTROSTATIC: HeatSimulation included in HeatChargeSimulation
Browse files Browse the repository at this point in the history
Added test for HeatChargeSimulation
Added functionality to compute heat source from conduction simulation
  • Loading branch information
marc-flex committed Jun 21, 2024
1 parent e625d65 commit 91381b5
Show file tree
Hide file tree
Showing 31 changed files with 2,001 additions and 428 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [2.7.0] - 2024-06-17

### Added
- `HeatSimulation` is now under the more generic class `HeatChargeSimulation`. This new class sallows for imulations of both HEAT and electric CONDUCTION types. One-way coupling between these is possible in which the CONDUCTION simulation is used to compute Joule heating which is subsequently used as a source in the HEAT simulation.
- EME solver through `EMESimulation` class.
- 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`.
Expand Down
22 changes: 0 additions & 22 deletions docs/api/heat/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. currentmodule:: tidy3d

Thermal Boundary Conditions
Thermal/Charge Boundary Conditions
-----------------------------

Specifications
Expand All @@ -11,6 +11,7 @@ Specifications
:template: module.rst

tidy3d.HeatBoundarySpec
tidy3d.HeatChargeBoundarySpec


Types
Expand All @@ -23,6 +24,9 @@ Types
tidy3d.TemperatureBC
tidy3d.ConvectionBC
tidy3d.HeatFluxBC
tidy3d.VoltageBC
tidy3d.CurrentBC,
tidy3d.InsulatingBC


Placement
Expand Down
File renamed without changes.
22 changes: 22 additions & 0 deletions docs/api/heat_charge/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
HEAT |:fire:|
=============

.. toctree::
:hidden:

simulation
mediums
boundary_conditions
source
discretization
monitor
output_data


.. include:: /api/heat_charge/simulation.rst
.. include:: /api/heat_charge/mediums.rst
.. include:: /api/heat_charge/boundary_conditions.rst
.. include:: /api/heat_charge/source.rst
.. include:: /api/heat_charge/discretization.rst
.. include:: /api/heat_charge/monitor.rst
.. include:: /api/heat_charge/output_data.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. currentmodule:: tidy3d

Material Thermal Specification
Material Thermal/Charge Specification
-------------------------------

.. autosummary::
Expand All @@ -9,6 +9,8 @@ Material Thermal Specification

tidy3d.FluidSpec
tidy3d.SolidSpec
tidy3d.ConductorSpec
tidy3d.InsulatorSpec


Thermal Perturbation Specification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ Monitors
:toctree: ../_autosummary/
:template: module.rst

tidy3d.TemperatureMonitor
tidy3d.TemperatureMonitor
tidy3d.VoltageMonitor
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ Output Data
-------------


Heat Simulation Data
Heat/Charge Simulation Data
^^^^^^^^^^^^^^^^^^^^

.. autosummary::
:toctree: ../_autosummary/
:template: module.rst

tidy3d.HeatSimulationData
tidy3d.HeatChargeSimulationData


Monitor Data
Expand All @@ -22,6 +23,7 @@ Monitor Data
:template: module.rst

tidy3d.TemperatureData
tidy3d.VoltageData


Unstructured Data Classes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Simulation
:template: module.rst

tidy3d.HeatSimulation
tidy3d.HeatChargeSimulation
4 changes: 3 additions & 1 deletion docs/api/heat/source.rst → docs/api/heat_charge/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ Thermal Sources
:toctree: ../_autosummary/
:template: module.rst

tidy3d.UniformHeatSource
tidy3d.UniformHeatSource
tidy3d.HeatSource
tidy3d.HeatFromElectricSource
2 changes: 1 addition & 1 deletion tests/test_components/test_heat.py
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ def test_heat_sim_bounds(shift_amount, log_level, log_capture):
def place_box(center_offset):
shifted_center = tuple(c + s for (c, s) in zip(center_offset, CENTER_SHIFT))

_ = td.HeatSimulation(
_ = td.HeatChargeSimulation(
size=(1.5, 1.5, 1.5),
center=CENTER_SHIFT,
medium=td.Medium(heat_spec=td.SolidSpec(conductivity=1, capacity=1)),
Expand Down
Loading

0 comments on commit 91381b5

Please sign in to comment.