Skip to content

docs(gallery): cover the open-domain wave operators and modal analyses - #48

Merged
Shizheng-Wen merged 1 commit into
mainfrom
docs/wave-operators-docs
Jul 22, 2026
Merged

docs(gallery): cover the open-domain wave operators and modal analyses#48
Shizheng-Wen merged 1 commit into
mainfrom
docs/wave-operators-docs

Conversation

@Shizheng-Wen

Copy link
Copy Markdown
Collaborator

Docs follow-up to #39: two new gallery chapters (Open-Domain Wave: port-driven Helmholtz resonator + PML-framed optical microdisk; Modal Analysis: waveguide modes + cantilever vibration) with freshly generated figures, API reference entries for the new surface (FacetBilinearAssembler, AnisotropicLaplace/ScaledMass, robin_operator/port_source, functional.pml), guide/README/ROADMAP sync, example-README links updated for the namespace move, and 67 zh_CN entries translated. Both builds clean; ZH adds zero warnings over EN.

Documentation for PR #39's API surface and examples:

- New gallery chapter open_domain_wave.rst - the port-driven Helmholtz
  resonator (357 Hz fundamental, 12x cavity gain) and the PML-framed
  optical microdisk (whispering-gallery mode), with freshly generated
  figures and the four-line robin_operator / port_source recipe.
- New gallery chapter modal_analysis.rst - rectangular-waveguide modes
  (Marcatili agreement ~1e-4) and cantilever-cylinder vibration
  (Euler-Bernoulli +3%), both generalized-eigenproblem workflows.
- API reference: FacetBilinearAssembler + AnisotropicLaplace /
  ScaledMass builtins (assemble), robin_operator / port_source
  (operator), functional.pml section.
- forms builtin table + boundary_conditions: Robin/port conditions are
  now first-class, the 'not built in' bullet retires.
- README example/architecture rows; ROADMAP item 3 marks the PML half
  shipped (metamaterial TopOpt remains, with an autograd-through-
  boundary-ops prerequisite noted); example READMEs' source links
  follow the operator/functional namespace move; a handful of
  docstring cross-reference fixes surfaced by the API build.
- zh_CN catalogs synced: 67 new entries translated and reviewed.

Both builds clean; ZH adds zero warnings over the EN baseline.

Signed-off-by: Shizheng-Wen <wenshizheng0710@gmail.com>
@Shizheng-Wen
Shizheng-Wen deleted the docs/wave-operators-docs branch July 22, 2026 15:32
@Shizheng-Wen
Shizheng-Wen restored the docs/wave-operators-docs branch July 22, 2026 15:33
@Shizheng-Wen Shizheng-Wen reopened this Jul 22, 2026
@Shizheng-Wen
Shizheng-Wen merged commit 8d6941d into main Jul 22, 2026
4 of 7 checks passed
@Shizheng-Wen
Shizheng-Wen deleted the docs/wave-operators-docs branch July 22, 2026 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant