Skip to content

Commit eb9b533

Browse files
committed
Docstring fix to flux monitors; changelog and schema for 1.6.3
1 parent 7fd319f commit eb9b533

File tree

4 files changed

+769
-823
lines changed

4 files changed

+769
-823
lines changed

CHANGELOG.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
### Added
99

10+
## [1.6.3] - 2022-9-13
11+
12+
### Added
13+
- Type field for `DataArray` subclasses written to `hdf5`.
14+
15+
### Fixed
16+
- Docstring for `FluxMonitor` and `FluxTimeMonitor`.
17+
18+
### Removed
19+
- Explicit error message about `grid_size` deprecation.
20+
1021
## [1.6.2] - 2022-9-6
1122

1223
### Added
@@ -404,7 +415,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
404415
- Job and Batch classes for better simulation handling (eventually to fully replace webapi functions).
405416
- A large number of small improvements and bug fixes.
406417

407-
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v1.6.1...develop
418+
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v1.6.3...develop
419+
[1.6.3]: https://github.com/flexcompute/tidy3d/compare/v1.6.2...v1.6.3
408420
[1.6.2]: https://github.com/flexcompute/tidy3d/compare/v1.6.1...v1.6.2
409421
[1.6.1]: https://github.com/flexcompute/tidy3d/compare/v1.6.0...v1.6.1
410422
[1.6.0]: https://github.com/flexcompute/tidy3d/compare/v1.5.0...v1.6.0

tidy3d/components/monitor.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -374,10 +374,8 @@ class FluxMonitor(AbstractFluxMonitor, FreqMonitor):
374374
""":class:`Monitor` that records power flux in the frequency domain.
375375
If the monitor geometry is a 2D box, the total flux through this plane is returned, with a
376376
positive sign corresponding to power flow in the positive direction along the axis normal to
377-
the plane. If the geometry is a 3D box, the returned array has a ``surface`` coordinate, and
378-
stores the flux through each of the six surfaces of the box. The sign convention in that case
379-
is such that positive sign corresponds to power flowing outside of the box, such that
380-
summing over the ``surface`` dimension results in the total out-going power.
377+
the plane. If the geometry is a 3D box, the total power coming out of the box is returned by
378+
integrating the flux over all box surfaces (excpet the ones defined in ``exclude_surfaces``).
381379
382380
Example
383381
-------
@@ -406,10 +404,8 @@ class FluxTimeMonitor(AbstractFluxMonitor, TimeMonitor):
406404
""":class:`Monitor` that records power flux in the time domain.
407405
If the monitor geometry is a 2D box, the total flux through this plane is returned, with a
408406
positive sign corresponding to power flow in the positive direction along the axis normal to
409-
the plane. If the geometry is a 3D box, the returned array has a ``surface`` coordinate, and
410-
stores the flux through each of the six surfaces of the box. The sign convention in that case
411-
is such that positive sign corresponds to power flowing outside of the box, such that
412-
summing over the ``surface`` dimension results in the total out-going power.
407+
the plane. If the geometry is a 3D box, the total power coming out of the box is returned by
408+
integrating the flux over all box surfaces (excpet the ones defined in ``exclude_surfaces``).
413409
414410
Example
415411
-------

0 commit comments

Comments
 (0)