Skip to content

Commit

Permalink
Docstring fix to flux monitors; changelog and schema for 1.6.3
Browse files Browse the repository at this point in the history
  • Loading branch information
momchil-flex committed Sep 12, 2022
1 parent 7fd319f commit eb9b533
Show file tree
Hide file tree
Showing 4 changed files with 769 additions and 823 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

## [1.6.3] - 2022-9-13

### Added
- Type field for `DataArray` subclasses written to `hdf5`.

### Fixed
- Docstring for `FluxMonitor` and `FluxTimeMonitor`.

### Removed
- Explicit error message about `grid_size` deprecation.

## [1.6.2] - 2022-9-6

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

[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v1.6.1...develop
[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v1.6.3...develop
[1.6.3]: https://github.com/flexcompute/tidy3d/compare/v1.6.2...v1.6.3
[1.6.2]: https://github.com/flexcompute/tidy3d/compare/v1.6.1...v1.6.2
[1.6.1]: https://github.com/flexcompute/tidy3d/compare/v1.6.0...v1.6.1
[1.6.0]: https://github.com/flexcompute/tidy3d/compare/v1.5.0...v1.6.0
Expand Down
12 changes: 4 additions & 8 deletions tidy3d/components/monitor.py
Original file line number Diff line number Diff line change
Expand Up @@ -374,10 +374,8 @@ class FluxMonitor(AbstractFluxMonitor, FreqMonitor):
""":class:`Monitor` that records power flux in the frequency domain.
If the monitor geometry is a 2D box, the total flux through this plane is returned, with a
positive sign corresponding to power flow in the positive direction along the axis normal to
the plane. If the geometry is a 3D box, the returned array has a ``surface`` coordinate, and
stores the flux through each of the six surfaces of the box. The sign convention in that case
is such that positive sign corresponds to power flowing outside of the box, such that
summing over the ``surface`` dimension results in the total out-going power.
the plane. If the geometry is a 3D box, the total power coming out of the box is returned by
integrating the flux over all box surfaces (excpet the ones defined in ``exclude_surfaces``).
Example
-------
Expand Down Expand Up @@ -406,10 +404,8 @@ class FluxTimeMonitor(AbstractFluxMonitor, TimeMonitor):
""":class:`Monitor` that records power flux in the time domain.
If the monitor geometry is a 2D box, the total flux through this plane is returned, with a
positive sign corresponding to power flow in the positive direction along the axis normal to
the plane. If the geometry is a 3D box, the returned array has a ``surface`` coordinate, and
stores the flux through each of the six surfaces of the box. The sign convention in that case
is such that positive sign corresponds to power flowing outside of the box, such that
summing over the ``surface`` dimension results in the total out-going power.
the plane. If the geometry is a 3D box, the total power coming out of the box is returned by
integrating the flux over all box surfaces (excpet the ones defined in ``exclude_surfaces``).
Example
-------
Expand Down
Loading

0 comments on commit eb9b533

Please sign in to comment.