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

resources/model/OpenStudio.idd

@@ -21052,6 +21052,119 @@ OS:Table:MultiVariableLookup,
        \type real
        \begin-extensible
 
+OS:Table:IndependentVariable,
+       \memo An independent variable representing a single dimension of a Table:Lookup
+       \memo object.
+       \extensible:1
+  A1,  \field Handle
+       \type handle
+       \required-field
+  A2,  \field Name
+       \required-field
+       \reference IndependentVariableName
+       \type alpha
+  A3,  \field Interpolation Method
+       \type choice
+       \key Linear
+       \key Cubic
+       \required-field
+  A4,  \field Extrapolation Method
+       \type choice
+       \key Constant
+       \key Linear
+       \required-field
+  N1,  \field Minimum Value
+       \type real
+       \unitsBasedOnField A5
+  N2,  \field Maximum Value
+       \type real
+       \unitsBasedOnField A5
+  N3,  \field Normalization Reference Value
+       \type real
+       \unitsBasedOnField A5
+  A5,  \field Unit Type
+       \type choice
+       \key Dimensionless
+       \key Temperature
+       \key VolumetricFlow
+       \key MassFlow
+       \key Power
+       \key Distance
+       \key Angle
+       \required-field
+  A6,  \field External File Name
+       \type object-list
+       \object-list ExternalFileNames
+  N4,  \field External File Column Number
+       \type integer
+       \minimum 1
+  N5,  \field External File Starting Row Number
+       \type integer
+       \minimum 1
+  N6;  \field Value
+       \type real
+       \begin-extensible
+
+OS:Table:Lookup,
+       \memo Lookup tables are used in place of curves and can represent any number
+       \memo of independent variables (defined as Table:IndependentVariable objects
+       \memo in a Table:IndependentVariableList). Output values are interpolated
+       \memo within the bounds defined by each independent variable and extrapolated
+       \memo beyond the bounds according to the interpolation/extrapolation methods
+       \memo defined by each independent variable.
+       \extensible:1
+  A1,  \field Handle
+       \type handle
+       \required-field
+  A2,  \field Name
+       \required-field
+       \reference UnivariateFunctions
+       \reference BivariateFunctions
+       \reference TrivariateFunctions
+       \reference QuadvariateFunctions
+       \reference QuintvariateFunctions
+       \reference MultivariateFunctions
+       \reference AllCurves
+       \type alpha
+  A3,  \field Independent Variable List Name
+       \required-field
+       \type object-list
+       \object-list ModelObjectLists
+  A4,  \field Normalization Method
+       \type choice
+       \key None
+       \key DivisorOnly
+       \key AutomaticWithDivisor
+       \required-field
+  N1,  \field Normalization Divisor
+       \type real
+       \required-field
+  N2,  \field Minimum Output
+       \type real
+       \unitsBasedOnField A5
+  N3,  \field Maximum Output
+       \type real
+       \unitsBasedOnField A5
+  A5,  \field Output Unit Type
+       \type choice
+       \key Dimensionless
+       \key Capacity
+       \key Power
+       \required-field
+  A6,  \field External File Name
+       \type object-list
+       \object-list ExternalFileNames
+  N4,  \field External File Column Number
+       \type integer
+       \minimum 1
+  N5,  \field External File Starting Row Number
+       \type integer
+       \minimum 1
+  N6;  \field Output Value
+       \type real
+       \unitsBasedOnField A5
+       \begin-extensible
+
 OS:DesignSpecification:OutdoorAir,
        \memo This object is used to describe general outdoor air requirements which
        \memo are referenced by other objects.

src/energyplus/CMakeLists.txt

@@ -390,6 +390,8 @@ set(${target_name}_src
   ForwardTranslator/ForwardTranslateSurfacePropertySurroundingSurfaces.cpp
   ForwardTranslator/ForwardTranslateSwimmingPoolIndoor.cpp
   ForwardTranslator/ForwardTranslateTableMultiVariableLookup.cpp
+  ForwardTranslator/ForwardTranslateTableLookup.cpp
+  ForwardTranslator/ForwardTranslateTableIndependentVariable.cpp
   ForwardTranslator/ForwardTranslateTemperingValve.cpp
   ForwardTranslator/ForwardTranslateThermalStorageIceDetailed.cpp
   ForwardTranslator/ForwardTranslateThermalStorageChilledWaterStratified.cpp
@@ -587,6 +589,8 @@ set(${target_name}_src
   ReverseTranslator/ReverseTranslateSurfacePropertyLocalEnvironment.cpp
   ReverseTranslator/ReverseTranslateSurfacePropertySurroundingSurfaces.cpp
   ReverseTranslator/ReverseTranslateSwimmingPoolIndoor.cpp
+  ReverseTranslator/ReverseTranslateTableLookup.cpp
+  ReverseTranslator/ReverseTranslateTableIndependentVariable.cpp
   ReverseTranslator/ReverseTranslateThermostatSetpointDualSetpoint.cpp
   ReverseTranslator/ReverseTranslateTimestep.cpp
   ReverseTranslator/ReverseTranslateVersion.cpp
@@ -759,6 +763,7 @@ set(${target_name}_test_src
   Test/SurfacePropertySurroundingSurfaces_GTest.cpp
   Test/SwimmingPoolIndoor_GTest.cpp
   Test/TableMultiVariableLookup_GTest.cpp
+  Test/TableLookup_GTest.cpp
   Test/ThermalStorageChilledWaterStratified_GTest.cpp
   Test/ThermalZone_GTest.cpp
   Test/ThermostatSetpointDualSetpoint_GTest.cpp

src/energyplus/ForwardTranslator.cpp

@@ -100,6 +100,8 @@
 
 #include "../utilities/idd/IddEnums.hpp"
 
+#include "../utilities/core/Deprecated.hpp"
+
 #include <algorithm>
 #include <sstream>
 #include <thread>
@@ -2880,11 +2882,35 @@ namespace energyplus {
         retVal = translateSwimmingPoolIndoor(obj);
         break;
       }
+
+#if defined(_MSC_VER)
+#  pragma warning(push)
+#  pragma warning(disable : 4996)
+#elif (defined(__GNUC__))
+#  pragma GCC diagnostic push
+#  pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
       case openstudio::IddObjectType::OS_Table_MultiVariableLookup: {
         model::TableMultiVariableLookup table = modelObject.cast<TableMultiVariableLookup>();
         retVal = translateTableMultiVariableLookup(table);
         break;
       }
+#if defined(_MSC_VER)
+#  pragma warning(pop)
+#elif (defined(__GNUC__))
+#  pragma GCC diagnostic pop
+#endif
+
+      case openstudio::IddObjectType::OS_Table_Lookup: {
+        auto table = modelObject.cast<TableLookup>();
+        retVal = translateTableLookup(table);
+        break;
+      }
+      case openstudio::IddObjectType::OS_Table_IndependentVariable: {
+        auto tableIndependentVariable = modelObject.cast<TableIndependentVariable>();
+        retVal = translateTableIndependentVariable(tableIndependentVariable);
+        break;
+      }
       case openstudio::IddObjectType::OS_TemperingValve: {
         auto mo = modelObject.cast<TemperingValve>();
         retVal = translateTemperingValve(mo);
@@ -3414,6 +3440,7 @@ namespace energyplus {
     result.push_back(IddObjectType::OS_Curve_Sigmoid);
     result.push_back(IddObjectType::OS_Curve_Triquadratic);
     result.push_back(IddObjectType::OS_Table_MultiVariableLookup);
+    result.push_back(IddObjectType::OS_Table_Lookup);
     result.push_back(IddObjectType::OS_DistrictCooling);
     result.push_back(IddObjectType::OS_DistrictHeating);
     result.push_back(IddObjectType::OS_EvaporativeCooler_Direct_ResearchSpecial);

src/energyplus/ForwardTranslator.hpp

@@ -39,6 +39,8 @@
 #include "../utilities/core/StringStreamLogSink.hpp"
 #include "../utilities/time/Time.hpp"
 
+#include "../utilities/core/Deprecated.hpp"
+
 #include <iostream>
 
 namespace openstudio {
@@ -448,6 +450,8 @@ namespace model {
   class SurfacePropertySurroundingSurfaces;
   class SwimmingPoolIndoor;
   class TableMultiVariableLookup;
+  class TableLookup;
+  class TableIndependentVariable;
   class TemperingValve;
   class ThermalZone;
   class ThermalStorageIceDetailed;
@@ -1427,7 +1431,11 @@ namespace energyplus {
 
     boost::optional<IdfObject> translateSwimmingPoolIndoor(model::SwimmingPoolIndoor& modelObject);
 
-    boost::optional<IdfObject> translateTableMultiVariableLookup(model::TableMultiVariableLookup& modelObject);
+    OS_DEPRECATED boost::optional<IdfObject> translateTableMultiVariableLookup(model::TableMultiVariableLookup& modelObject);
+
+    boost::optional<IdfObject> translateTableLookup(model::TableLookup& modelObject);
+
+    boost::optional<IdfObject> translateTableIndependentVariable(model::TableIndependentVariable& modelObject);
 
     boost::optional<IdfObject> translateTemperingValve(model::TemperingValve& modelObject);
 

src/energyplus/ForwardTranslator/ForwardTranslateTableIndependentVariable.cpp

@@ -0,0 +1,93 @@
+/***********************************************************************************************************************
+*  OpenStudio(R), Copyright (c) 2008-2022, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+*
+*  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+*  following conditions are met:
+*
+*  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+*  disclaimer.
+*
+*  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+*  disclaimer in the documentation and/or other materials provided with the distribution.
+*
+*  (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products
+*  derived from this software without specific prior written permission from the respective party.
+*
+*  (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative works
+*  may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without specific prior
+*  written permission from Alliance for Sustainable Energy, LLC.
+*
+*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+*  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
+*  STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+*  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+*  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+*  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+*  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+***********************************************************************************************************************/
+
+#include "../ForwardTranslator.hpp"
+#include "../../model/Model.hpp"
+
+#include "../../model/TableIndependentVariable.hpp"
+
+#include "../../utilities/idf/IdfExtensibleGroup.hpp"
+
+#include <utilities/idd/Table_IndependentVariable_FieldEnums.hxx>
+// #include "../../utilities/idd/IddEnums.hpp"
+#include <utilities/idd/IddEnums.hxx>
+
+using namespace openstudio::model;
+
+namespace openstudio {
+
+namespace energyplus {
+
+  boost::optional<IdfObject> ForwardTranslator::translateTableIndependentVariable(model::TableIndependentVariable& modelObject) {
+    boost::optional<IdfObject> result;
+
+    // Instantiate an IdfObject of the class to store the values
+    IdfObject idfObject = createRegisterAndNameIdfObject(openstudio::IddObjectType::Table_IndependentVariable, modelObject);
+
+    // Interpolation Method: String
+    idfObject.setString(Table_IndependentVariableFields::InterpolationMethod, modelObject.interpolationMethod());
+
+    // Extrapolation Method: String
+    idfObject.setString(Table_IndependentVariableFields::ExtrapolationMethod, modelObject.extrapolationMethod());
+
+    // Minimum Value: boost::optional<double>
+    if (boost::optional<double> minimumValue_ = modelObject.minimumValue()) {
+      idfObject.setDouble(Table_IndependentVariableFields::MinimumValue, minimumValue_.get());
+    }
+
+    // Maximum Value: boost::optional<double>
+    if (boost::optional<double> maximumValue_ = modelObject.maximumValue()) {
+      idfObject.setDouble(Table_IndependentVariableFields::MaximumValue, maximumValue_.get());
+    }
+
+    // Normalization Reference Value: boost::optional<double>
+    if (boost::optional<double> normalizationReferenceValue_ = modelObject.normalizationReferenceValue()) {
+      idfObject.setDouble(Table_IndependentVariableFields::NormalizationReferenceValue, normalizationReferenceValue_.get());
+    }
+
+    // Unit Type: String
+    idfObject.setString(Table_IndependentVariableFields::UnitType, modelObject.unitType());
+
+    // Value
+    for (const double& value : modelObject.values()) {
+      IdfExtensibleGroup eg = idfObject.pushExtensibleGroup();
+      eg.setDouble(Table_IndependentVariableExtensibleFields::Value, value);
+    }
+
+    // External File Name: boost::optional<std::string>
+
+    // External File Column Number: boost::optional<int>
+
+    // External File Starting Row Number: boost::optional<int>
+
+    return idfObject;
+  }  // End of translate function
+
+}  // end namespace energyplus
+}  // end namespace openstudio