Update documentation and code comments in PowerElectronics module
Open
@alexander-novo is already working on this.
Since May 27, 2026.
documentation
enhancement
- Dominant language
- C++
- Stars
- 27
- Forks
- 11
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 23
Description
Summary
Review documentation and comments in the code in PowerElectronics module and make corrections and updates where necessary.
Rationale
The code is nontrivial and providing better documentation would help with its maintenance and adding new features in the future.
Description
A few specific issues to address:
- Update the documentation for
evaluateInternalResidualto referencef_int_inModel/PowerElectronics/CircuitComponent.hpp. - Use the more verbose name
componentinstead ofcompfor the component objects inModel/PowerElectronics/SystemModelPowerElectronics.hpp. - Further document the current structure of
f_. The residual vectorf_seems to be still allocated tosize_ = n_intern_ + n_extern_, but only the external part (firstn_extern_values) gets updated at the component level.
Additional information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.