Fix #2059 - change Fan Efficiency field to Fan Total Efficiency

openstudiocore/resources/model/OpenStudio.idd

@@ -19299,7 +19299,7 @@ OS:Fan:ConstantVolume,
        \type object-list
        \required-field
        \object-list ScheduleNames
-  N1, \field Fan Efficiency
+  N1, \field Fan Total Efficiency
        \type real
        \minimum> 0
        \maximum 1
@@ -19356,7 +19356,7 @@ OS:Fan:VariableVolume,
        \type object-list
        \required-field
        \object-list ScheduleNames
-  N1, \field Fan Efficiency
+  N1, \field Fan Total Efficiency
        \type real
        \minimum> 0
        \maximum 1
@@ -19441,7 +19441,7 @@ OS:Fan:OnOff,
        \type object-list
        \required-field
        \object-list ScheduleNames
-  N1, \field Fan Efficiency
+  N1, \field Fan Total Efficiency
        \type real
        \minimum> 0
        \maximum 1
@@ -19503,7 +19503,7 @@ OS:Fan:ZoneExhaust,
        \note If this field is blank, the system is always available.
        \type object-list
        \object-list ScheduleNames
-  N1, \field Fan Efficiency
+  N1, \field Fan Total Efficiency
        \type real
        \minimum> 0.0
        \maximum 1.0
@@ -30656,7 +30656,7 @@ OS:PlantComponent:UserDefined,
       \min-fields 6
   A1, \field Handle
       \type handle
-      \required-field    
+      \required-field
   A2, \field Name
       \required-field
       \type alpha
@@ -30666,7 +30666,7 @@ OS:PlantComponent:UserDefined,
       \object-list ErlProgramCallingManagerNames
   A4, \field Main Model Program Name
       \type object-list
-      \object-list ErlProgramNames    
+      \object-list ErlProgramNames
   A5, \field Plant Inlet Node Name
       \type object-list
       \object-list ConnectionNames
@@ -30694,13 +30694,13 @@ OS:PlantComponent:UserDefined,
       \object-list ErlProgramCallingManagerNames
   A10, \field Plant Initialization Program Name
       \type object-list
-      \object-list ErlProgramNames      
+      \object-list ErlProgramNames
   A11, \field Plant Simulation Program Calling Manager Name
       \type object-list
       \object-list ErlProgramCallingManagerNames
   A12, \field Plant Simulation Program Name
       \type object-list
-      \object-list ErlProgramNames      
+      \object-list ErlProgramNames
   A13, \field Design Volume Flow Rate Actuator
        \type object-list
        \object-list ErlActuatorNames
@@ -30724,9 +30724,9 @@ OS:PlantComponent:UserDefined,
        \object-list ErlActuatorNames
   A20, \field Mass Flow Rate Actuator
        \type object-list
-       \object-list ErlActuatorNames       
+       \object-list ErlActuatorNames
   A21; \field Ambient Zone Name
        \type object-list
        \object-list ThermalZoneNames
        \note Used for modeling device losses to surrounding zone
-      
+

openstudiocore/src/model/FanConstantVolume.cpp

@@ -152,14 +152,14 @@ namespace detail {
   }
 
 
-  double FanConstantVolume_Impl::fanEfficiency() const
+  double FanConstantVolume_Impl::fanTotalEfficiency() const
   {
-    return this->getDouble(OS_Fan_ConstantVolumeFields::FanEfficiency,true).get();
+    return this->getDouble(OS_Fan_ConstantVolumeFields::FanTotalEfficiency,true).get();
   }
 
-  bool FanConstantVolume_Impl::setFanEfficiency(double val)
+  bool FanConstantVolume_Impl::setFanTotalEfficiency(double val)
   {
-    return this->setDouble(OS_Fan_ConstantVolumeFields::FanEfficiency,val);
+    return this->setDouble(OS_Fan_ConstantVolumeFields::FanTotalEfficiency,val);
   }
 
   double FanConstantVolume_Impl::pressureRise() const
@@ -546,14 +546,24 @@ bool FanConstantVolume::setAvailabilitySchedule(Schedule& s)
   return getImpl<detail::FanConstantVolume_Impl>()->setAvailabilitySchedule(s);
 }
 
+double FanConstantVolume::fanTotalEfficiency() const
+{
+  return getImpl<detail::FanConstantVolume_Impl>()->fanTotalEfficiency();
+}
+
+bool FanConstantVolume::setFanTotalEfficiency(double val)
+{
+  return getImpl<detail::FanConstantVolume_Impl>()->setFanTotalEfficiency(val);
+}
+
 double FanConstantVolume::fanEfficiency() const
 {
-  return getImpl<detail::FanConstantVolume_Impl>()->fanEfficiency();
+  return getImpl<detail::FanConstantVolume_Impl>()->fanTotalEfficiency();
 }
 
 bool FanConstantVolume::setFanEfficiency(double val)
 {
-  return getImpl<detail::FanConstantVolume_Impl>()->setFanEfficiency(val);
+  return getImpl<detail::FanConstantVolume_Impl>()->setFanTotalEfficiency(val);
 }
 
 double FanConstantVolume::pressureRise() const

openstudiocore/src/model/FanConstantVolume.hpp

@@ -69,7 +69,10 @@ class MODEL_API FanConstantVolume : public StraightComponent {
 
   Schedule availabilitySchedule() const;
 
-  /** Returns the value of the FanEfficiency field. **/
+  /** Returns the value of the Fan Total Efficiency field **/
+  double fanTotalEfficiency() const;
+
+  /** Returns the value of the Fan Total Efficiency field. Deprecated, forwards to fanTotalEfficiency **/
   double fanEfficiency() const;
 
   /** Returns the value of the PressureRise field. **/
@@ -90,7 +93,10 @@ class MODEL_API FanConstantVolume : public StraightComponent {
 
   bool setAvailabilitySchedule(Schedule& s);
 
-  /** Sets the value of the FanEfficiency field. **/
+  /** Sets the value of the Fan Total Efficiency field. **/
+  bool setFanTotalEfficiency(double value);
+
+  /** Sets the value of the Fan Total Efficiency field. Deprecated, forwards to setFanTotalEfficiency. **/
   bool setFanEfficiency(double value);
 
   /** Sets the value of the PressureRise field. **/

openstudiocore/src/model/FanConstantVolume_Impl.hpp

@@ -93,11 +93,11 @@ namespace detail {
     Schedule availabilitySchedule() const;
     bool setAvailabilitySchedule(Schedule& s);
 
-    // Get FanEfficiency
-    double fanEfficiency() const;
+    // Get FanTotalEfficiency
+    double fanTotalEfficiency() const;
 
-    // Set fanEfficiency
-    bool setFanEfficiency(double val);
+    // Set fanTotalEfficiency
+    bool setFanTotalEfficiency(double val);
 
     // Get PressureRise
     double pressureRise() const;

openstudiocore/src/model/FanOnOff.cpp

@@ -175,16 +175,16 @@ namespace detail {
     return result;
   }
 
-  double FanOnOff_Impl::fanEfficiency() const
+  double FanOnOff_Impl::fanTotalEfficiency() const
   {
-    boost::optional<double> value = getDouble(OS_Fan_OnOffFields::FanEfficiency,true);
+    boost::optional<double> value = getDouble(OS_Fan_OnOffFields::FanTotalEfficiency,true);
     OS_ASSERT(value);
     return value.get();
   }
 
-  bool FanOnOff_Impl::isFanEfficiencyDefaulted() const
+  bool FanOnOff_Impl::isFanTotalEfficiencyDefaulted() const
   {
-    return isEmpty(OS_Fan_OnOffFields::FanEfficiency);
+    return isEmpty(OS_Fan_OnOffFields::FanTotalEfficiency);
   }
 
   double FanOnOff_Impl::pressureRise() const
@@ -239,15 +239,15 @@ namespace detail {
     return isEmpty(OS_Fan_OnOffFields::EndUseSubcategory);
   }
 
-  bool FanOnOff_Impl::setFanEfficiency(double fanEfficiency)
+  bool FanOnOff_Impl::setFanTotalEfficiency(double fanTotalEfficiency)
   {
-    bool result = setDouble(OS_Fan_OnOffFields::FanEfficiency, fanEfficiency);
+    bool result = setDouble(OS_Fan_OnOffFields::FanTotalEfficiency, fanTotalEfficiency);
     return result;
   }
 
-  void FanOnOff_Impl::resetFanEfficiency()
+  void FanOnOff_Impl::resetFanTotalEfficiency()
   {
-    bool result = setString(OS_Fan_OnOffFields::FanEfficiency, "");
+    bool result = setString(OS_Fan_OnOffFields::FanTotalEfficiency, "");
     OS_ASSERT(result);
   }
 
@@ -567,7 +567,7 @@ FanOnOff::FanOnOff(const Model& model)
     auto availabilitySchedule = model.alwaysOnDiscreteSchedule();
     setAvailabilitySchedule(availabilitySchedule);
 
-    bool ok = setFanEfficiency(0.6);
+    bool ok = setFanTotalEfficiency(0.6);
     OS_ASSERT(ok);
     setPressureRise(300);
     autosizeMaximumFlowRate();
@@ -601,7 +601,7 @@ FanOnOff::FanOnOff(const Model& model, Schedule& availabilitySchedule)
 
     setAvailabilitySchedule(availabilitySchedule);
 
-    bool ok = setFanEfficiency(0.6);
+    bool ok = setFanTotalEfficiency(0.6);
     OS_ASSERT(ok);
     setPressureRise(300);
     autosizeMaximumFlowRate();
@@ -640,7 +640,7 @@ FanOnOff::FanOnOff(const Model& model,
 
     setAvailabilitySchedule(availabilitySchedule);
 
-    bool ok = setFanEfficiency(0.6);
+    bool ok = setFanTotalEfficiency(0.6);
     OS_ASSERT(ok);
     setPressureRise(300);
     autosizeMaximumFlowRate();
@@ -675,24 +675,44 @@ bool FanOnOff::setAvailabilitySchedule(Schedule& schedule)
 
 // Field Fan Efficiency
 
+double FanOnOff::fanTotalEfficiency() const
+{
+  return getImpl<detail::FanOnOff_Impl>()->fanTotalEfficiency();
+}
+
+bool FanOnOff::isFanTotalEfficiencyDefaulted() const
+{
+  return getImpl<detail::FanOnOff_Impl>()->isFanTotalEfficiencyDefaulted();
+}
+
+bool FanOnOff::setFanTotalEfficiency(double fanTotalEfficiency)
+{
+  return getImpl<detail::FanOnOff_Impl>()->setFanTotalEfficiency(fanTotalEfficiency);
+}
+
+void FanOnOff::resetFanTotalEfficiency()
+{
+  getImpl<detail::FanOnOff_Impl>()->resetFanTotalEfficiency();
+}
+
 double FanOnOff::fanEfficiency() const
 {
-  return getImpl<detail::FanOnOff_Impl>()->fanEfficiency();
+  return getImpl<detail::FanOnOff_Impl>()->fanTotalEfficiency();
 }
 
 bool FanOnOff::isFanEfficiencyDefaulted() const
 {
-  return getImpl<detail::FanOnOff_Impl>()->isFanEfficiencyDefaulted();
+  return getImpl<detail::FanOnOff_Impl>()->isFanTotalEfficiencyDefaulted();
 }
 
-bool FanOnOff::setFanEfficiency(double fanEfficiency)
+bool FanOnOff::setFanEfficiency(double fanTotalEfficiency)
 {
-  return getImpl<detail::FanOnOff_Impl>()->setFanEfficiency(fanEfficiency);
+  return getImpl<detail::FanOnOff_Impl>()->setFanTotalEfficiency(fanTotalEfficiency);
 }
 
 void FanOnOff::resetFanEfficiency()
 {
-  getImpl<detail::FanOnOff_Impl>()->resetFanEfficiency();
+  getImpl<detail::FanOnOff_Impl>()->resetFanTotalEfficiency();
 }
 
 // Field Pressure Rise

openstudiocore/src/model/FanOnOff.hpp

@@ -75,8 +75,11 @@ class MODEL_API FanOnOff : public StraightComponent {
 
   Schedule availabilitySchedule() const;
 
-  double fanEfficiency() const;
+  double fanTotalEfficiency() const;
+  bool isFanTotalEfficiencyDefaulted() const;
 
+  /** Deprecrated in favor of fanTotalEfficiency **/
+  double fanEfficiency() const;
   bool isFanEfficiencyDefaulted() const;
 
   double pressureRise() const;
@@ -100,8 +103,11 @@ class MODEL_API FanOnOff : public StraightComponent {
 
   bool setAvailabilitySchedule(Schedule& schedule);
 
-  bool setFanEfficiency(double fanEfficiency);
 
+  bool setFanTotalEfficiency(double fanTotalEfficiency);
+  void resetFanTotalEfficiency();
+
+  bool setFanEfficiency(double fanTotalEfficiency);
   void resetFanEfficiency();
 
   bool setPressureRise(double pressureRise);

openstudiocore/src/model/FanOnOff_Impl.hpp

@@ -97,13 +97,13 @@ namespace detail {
 
     // Field Fan Efficiency
 
-    double fanEfficiency() const;
+    double fanTotalEfficiency() const;
 
-    bool isFanEfficiencyDefaulted() const;
+    bool isFanTotalEfficiencyDefaulted() const;
 
-    bool setFanEfficiency(double fanEfficiency);
+    bool setFanTotalEfficiency(double fanTotalEfficiency);
 
-    void resetFanEfficiency();
+    void resetFanTotalEfficiency();
 
     // Field Pressure Rise
 
@@ -196,4 +196,4 @@ namespace detail {
 } // model
 } // openstudio
 
-#endif // MODEL_FANONOFF_IMPL_HPP
+#endif // MODEL_FANONOFF_IMPL_HPP