ORNL / ORNL/GridKit

Update documentation and code comments in PowerElectronics module

Open
#416 0 comments 0 reactions 1 assignee View on GitHub

@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 evaluateInternalResidual to reference f_int_ in Model/PowerElectronics/CircuitComponent.hpp.
  • Use the more verbose name component instead of comp for the component objects in Model/PowerElectronics/SystemModelPowerElectronics.hpp.
  • Further document the current structure of f_. The residual vector f_ seems to be still allocated to size_ = n_intern_ + n_extern_, but only the external part (first n_extern_ values) gets updated at the component level.
Additional information

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.