[lukelowry]

Description

Adds a MANIFEST to component data: the units, symbol and description of every parameter, port and monitor, declared in each model's *Data.hpp beside the enums it describes. ComponentLibrary lists the models that have one, so applications can query GridKit models without a priori information.

Closes #482.

@pelesh @superwhiskers

Proposed changes

• ComponentManifest holds the units, symbol and description of a component's parameters, buses, inputs, outputs and monitors.
• IEEET1 and GENROU declare a MANIFEST in their *Data.hpp. The build fails if any enum value is left undescribed.
• ComponentLibrary lists the models that have a manifest.
• Unit tests in ComponentManifestTests.

For example, the IEEET1 inputs:

for (const auto& input : Exciter::Ieeet1Data<double, size_t>::MANIFEST.inputs)
{
  std::cout << input.name() << ": " << input.description << '\n';
}

speed: Machine speed deviation
vref: Voltage-control reference
vs: Stabilizer input signal
vuel: Under-excitation limiter input
voel: Over-excitation limiter input

Checklist

• All tests pass.
• Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
• The new code follows GridKit™ style guidelines.
• There are unit tests for the new code.
• The new code is documented.
• The feature branch is rebased with respect to the target branch.
• The CHANGELOG.md has been updated to reflect the changes.

Further comments

• Only IEEET1 and GENROU have manifests here. The remaining models follow in a separate PR.
• The parser and SystemModel are unchanged. ComponentLibrary lists model types so the system composer can construct through it later.

[pelesh]

I think this needs more discussion. I am setting this to draft until we decide how to proceed. Having said that, this PR is very helpful and a good suggestion. More discussion in #482 is needed.

[superwhiskers]

based on my current read of this, i think that it duplicates too much from ComponentData. i'd prefer the two be merged rather than having two separate classes

[lukelowry]

@superwhiskers @pelesh Give this another look, it is much better.

This moves us toward simpler input format parser, SystemModel composition, and feasibly be used to construct a JSON schema, aswell.

[read-the-docs-community]

Documentation build overview

📚 GridKit | 🛠️ Build #35332810 | 📁 Comparing 374d12e against latest (c9a6497)

  🔍 Preview build  

36 files changed · + 9 added · ± 25 modified · - 2 deleted

+ Added

• api/reference/function_namespaceGridKit_1_1PhasorDynamics_1ae67743bf2111806e741f428f05555edb.html
• api/reference/function_namespaceGridKit_1_1Utilities_1a63d5b78668269312ec4703c2ece87875.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1ComponentLibrary.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1ComponentManifest.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1Exciter_1_1Ieeet1Data.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1GenrouData.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1MonitorEntry.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1ParameterEntry.html
• api/reference/structGridKit_1_1PhasorDynamics_1_1PortEntry.html

± Modified

• genindex.html
• development/CHANGELOG.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1_1Exciter_1a23a0c762268b7def7ff9fd909a2d067c.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1_1Exciter_1a3fc52a879defc26d42491b22372f8cc7.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1_1Exciter_1a93a1616b849fab010f5c8cd00c133c3a.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1_1Exciter_1ad739787389b0320464cfb840b20f2a3d.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1a686c912a320cc284b16912f69a53ae5e.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1a78a394bd46fad8af20bd2fac15e9acc7.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1a924661c4189d8f9efed251192368ca5e.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1aea72d6d2e227072d9e162ea27b15a1a1.html
• and 15 more...

- Deleted

• api/reference/typedef_namespaceGridKit_1_1PhasorDynamics_1_1Exciter_1a553b0643af0f9540072c9c10339d4f81.html
• api/reference/typedef_namespaceGridKit_1_1PhasorDynamics_1a21be7d50bebc5a9c91160e348d72cd85.html