Skip to content

Commit feb5883

Browse files
committed
docs(changelog): Document custom coordinate system example
Adds entry for the new 17_custom_coordinate_system.cpp example in the [Unreleased] section, documenting polar and spherical coordinate system implementations with ADL-based extension pattern.
1 parent 6f28092 commit feb5883

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ SPDX-License-Identifier: AGPL-3.0-or-later
99

1010
### Added
1111

12+
- **Examples**: Custom coordinate system example in `examples/17_custom_coordinate_system.cpp`
13+
demonstrating OpenPFC's extensibility via ADL (Argument-Dependent Lookup). Implements
14+
complete polar (2D: r, θ) and spherical (3D: r, θ, φ) coordinate systems with coordinate
15+
transformations (`polar_to_coords()`, `polar_to_indices()`, `spherical_to_coords()`,
16+
`spherical_to_indices()`). Includes comprehensive Doxygen documentation (615 lines),
17+
round-trip transformation verification, and 4-step recipe showing users how to add
18+
custom coordinate systems without modifying OpenPFC source code. Embodies "Laboratory,
19+
Not Fortress" philosophy - users can extend with cylindrical, spherical, or custom
20+
geometries through tag-based dispatch and free functions. Example compiles cleanly
21+
with zero warnings and demonstrates working coordinate conversions with correct output.
1222
- **Documentation**: Comprehensive API documentation for top 10 most-used public
1323
APIs with detailed @example blocks and usage patterns. Enhanced documentation
1424
covers World (domain creation and coordinate transforms), Model (physics

0 commit comments

Comments
 (0)