Addresses #4647, wrap the E+ Table:Lookup, Table:IndependentVariableList, and Table:IndependentVariable objects

[joseph-robertson]

Pull request overview

• Fixes Wrap the E+ Table:Lookup, Table:IndependentVariableList, and Table:IndependentVariable objects. #4647
• Deprecate TableMultiVariableLookup
  • Throw warning from ctor
  • Throw error from FT
  • Replace old with new in ForwardTranslator.cpp, and then throw error in old FT
  • Support External File?
  • Create VT from old to new (note: this is not required if the previous item is addressed)
• Model
  • Source files
  • Tests
• FT
  • Source files
  • Tests
• RT?
  • Source files
  • Tests

Possible implementation:

• Table:Lookup (Curve?)
• Table:IndependentVariableList (Use ModelObjectList?)
• Table:IndependentVariable (ParentObject?)

much like the E+ IDD:

  Table:IndependentVariable,
    HPACCoolCapFFF_IndependentVariable1,  !- Name
    Cubic,                   !- Interpolation Method
    Constant,                !- Extrapolation Method
    0.5,                     !- Minimum Value
    1.5,                     !- Maximum Value
    ,                        !- Normalization Reference Value
    Dimensionless,           !- Unit Type
    ,                        !- External File Name
    ,                        !- External File Column Number
    ,                        !- External File Starting Row Number
    0.0,                     !- Value 1
    1.0,                     !- Value 2
    1.5;                     !- <none>

  Table:IndependentVariableList,
    HPACCoolCapFFF_IndependentVariableList,  !- Name
    HPACCoolCapFFF_IndependentVariable1;  !- Independent Variable 1 Name

  Table:Lookup,
    HPACCoolCapFFF,          !- Name
    HPACCoolCapFFF_IndependentVariableList,  !- Independent Variable List Name
    ,                        !- Normalization Method
    ,                        !- Normalization Divisor
    0.8,                     !- Minimum Output
    1.5,                     !- Maximum Output
    Dimensionless,           !- Output Unit Type
    ,                        !- External File Name
    ,                        !- External File Column Number
    ,                        !- External File Starting Row Number
    0.8,                     !- Output Value 1
    1.0,                     !- Output Value 2
    1.1;                     !- <none>

Pull Request Author

• Model API Changes / Additions
• Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
• Model API methods are tested (in src/model/test)
• EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
• If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
• If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
• Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
• All new and existing tests passes
• If methods have been deprecated, update rest of code to use the new methods

Labels:

• If change to an IDD file, add the label IDDChange
• If breaking existing API, add the label APIChange
• If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• Code Style, strip trailing whitespace, etc.
• All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
• Labeling is ok
• 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

[joseph-robertson]

@jmarrec Would you be able to do a cursory review of the general approach here? i.e., creating classes of TableLookup and TableIndependentVariable and then using ModelObjectLists to store the list of independent variables, etc?

[jmarrec]

@joseph-robertson, some thoughts:

Possible implementation:

* `Table:Lookup` (Curve?)

• Yeah, this one is a Curve (< ResourceObject < ParentObject < ModelObject)

* `Table:IndependentVariableList` (Use `ModelObjectList`?)

• ModelObjectList would work yes. But its behavior relating to clone/remove might be annoying (I believe it'll clone the underlying objects, regardless of whether they are ResourceObjects or not, so you might have to work around that... make sure to write extensive tests for that)

* `Table:IndependentVariable` (ParentObject?)

• I would say ResourceObject actually. It could technically be shared by several TableLookup objects.
  • Eg: you have a CSV file (or you use the extensible fields instead of using an external file, doesn't matter conceptually) where the first column is the temperature (independent variable), and the second and third columns are the EIRFT and CAPFT values (dependent variables/output), then you would have two TableLookUp using the same Table:IndependentVariable object.

[jmarrec]

• I think we should enforce ascending order here (?)

[joseph-robertson]

@jmarrec Is this still a TODO?

[jmarrec]

@joseph-robertson I added a ReverseTranslator. I opened a PR to NREL/OpenStudio-resources#173 which caught a few bugs and I added an explicit test for sharing two TableIndependentVariables on two TableLookups.

[ci-commercialbuildings]

CI Results for a8f312b:

• Ubuntu 18.04:

  • OpenStudio-3.4.1-alpha+a8f312bd3c-Ubuntu-18.04.deb
  • OpenStudio-3.4.1-alpha+a8f312bd3c-Ubuntu-18.04.tar.gz

• Ubuntu 20.04:

  • OpenStudio-3.4.1-alpha+a8f312bd3c-Ubuntu-20.04.deb
  • OpenStudio-3.4.1-alpha+a8f312bd3c-Ubuntu-20.04.tar.gz
  • perf_all.csv
  • perf_comparison.png
  • perf_means.csv

• Darwin:

  • OpenStudio-3.4.1-alpha+a8f312bd3c-Darwin-x86_64.dmg
  • OpenStudio-3.4.1-alpha+a8f312bd3c-Darwin-x86_64.tar.gz

• Windows:

• Code Coverage: