Add plant worker function to get current equipment capacity

[rraustad]

Pull request overview

• Fixes Allow water plant to access equipment operating capacity for plant dispatch management #10803
• For plant equipment that varies capacity based on operating conditions (e.g., outdoor temperature, entering water temperature, etc.) a worker function that returns current capacity will allow the plant manager to more accurately meet the plant load.

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

• Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
• Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
• Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
• Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
• If any diffs are expected, author must demonstrate they are justified using plots and descriptions
• If changes fix a defect, the fix should be demonstrated in plots and descriptions
• If any defect files are updated to a more recent version, upload new versions here or on DevSupport
• If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
• If structural output changes, add to output rules file and add OutputChange label
• If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• If branch is behind develop, merge develop and build locally to check for side effects of the merge
• If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
• If feature, test running new feature, try creative ways to break it
• CI status: all green or justified
• Check that performance is not impacted (CI Linux results include performance check)
• Run Unit Test(s) locally
• Check any new function arguments for performance impacts
• Verify IDF naming conventions and styles, memos and notes and defaults
• If new idf included, locally check the err file and other outputs

[rraustad]

With the new worker function the cooling tower can now meet the load.

[rraustad]

Walk thru

[rraustad]

Tower calculations for current maximum capacity

[rraustad]

This function will call the virtual function in PlantComponent.hh if a model does not have the override function (if that equipment's maximum capacity does not change this function is not needed) or will call the override function in the equipment model. If this function does not exist in an equipment model the virtual function will return 0 and MaxLoad will be used just as it is now. Otherwise the equipment model will return the current max capacity and that value will be used instead.

[rraustad]

Virtual function returns 0 if equipment model does not have an override function.

[rraustad]

CppCheck suggestion

[rraustad]

Down at line 3763 is code that will cap MyLoad if the component design capacity cannot meet the load. Calling this function provides a more accurate full load capacity for use in plant manager calculations.

    // Check bounds on MyLoad
    if (std::abs(this_component.MyLoad) > CompMaxLoad) {
        this_component.MyLoad = sign(CompMaxLoad, this_component.MyLoad);
    }

[nrel-bot-2]

@rraustad it has been 16 days since this pull request was last updated.

[nrel-bot-2c]

@rraustad it has been 7 days since this pull request was last updated.