Add Fan:SystemModel to OpenStudio

resources/model/OpenStudio.idd

@@ -20093,7 +20093,155 @@ OS:EvaporativeFluidCooler:TwoSpeed,
        \type object-list
        \object-list WaterStorageTankNames
 
+OS:Fan:SystemModel,
+       \memo Versatile simple fan that can be used in variable air volume, constant volume, on-off cycling, two-speed or multi-speed applications.
+       \memo Performance at different flow rates, or speed levels, is determined using separate performance curve or table
+       \memo or prescribed power fractions at discrete speed levels for two-speed or multi-speed fans.
+       \min-fields 15
+       \extensible:2
+  A1, \field Handle
+       \type handle
+       \required-field
+  A2 , \field Name
+       \required-field
+       \reference Fans
+       \reference FansCV
+       \reference FansCVandOnOff
+       \reference FansVAV
+       \reference FansCVandVAV
+       \reference FansCVandOnOffandVAV
+       \reference ConnectionObject
+  A3 , \field Availability Schedule Name
+       \note Availability schedule name for this fan. Schedule value > 0 means the fan is available.
+       \note If this field is blank, the fan is always available.
+       \type object-list
+       \required-field
+       \object-list ScheduleNames
+  A4 , \field Air Inlet Node Name
+       \type object-list
+       \object-list ConnectionNames
+  A5 , \field Air Outlet Node Name
+       \type object-list
+       \object-list ConnectionNames
+  N1 , \field Design Maximum Air Flow Rate
+       \required-field
+       \type real
+       \units m3/s
+       \minimum> 0.0
+       \autosizable
+  A6 , \field Speed Control Method
+       \type choice
+       \key Continuous
+       \key Discrete
+       \required-field
+  N2 , \field Electric Power Minimum Flow Rate Fraction
+       \type real
+       \required-field
+       \minimum 0.0
+       \maximum 1.0
+  N3 , \field Design Pressure Rise
+       \type real
+       \minimum> 0.0
+       \units Pa
+       \ip-units inH2O
+       \required-field
+  N4 , \field Motor Efficiency
+       \type real
+       \required-field
+       \minimum> 0.0
+       \maximum 1.0
+  N5 , \field Motor In Air Stream Fraction
+       \note 0.0 means fan motor outside of air stream, 1.0 means motor inside of air stream
+       \type real
+       \required-field
+       \minimum 0.0
+       \maximum 1.0
+  N6 , \field Design Electric Power Consumption
+       \type real
+       \units W
+       \autosizable
+       \required-field
+       \minimum> 0.0
+       \note Fan power consumption at maximum air flow rate.
+       \note If autosized the method used to scale power is chosen in the following field
+  A7 , \field Design Power Sizing Method
+       \type choice
+       \key PowerPerFlow
+       \key PowerPerFlowPerPressure
+       \key TotalEfficiencyAndPressure
+       \required-field
+  N7 , \field Electric Power Per Unit Flow Rate
+       \type real
+       \units W/(m3/s)
+       \ip-units W/(ft3/min)
+       \required-field
+       \minimum> 0.0
+  N8 , \field Electric Power Per Unit Flow Rate Per Unit Pressure
+       \type real
+       \units W/((m3/s)-Pa)
+       \ip-units W/((ft3/min)-inH2O)
+       \required-field
+       \minimum> 0.0
+  N9,  \field Fan Total Efficiency
+       \type real
+       \required-field
+       \minimum> 0.0
+       \maximum 1.0
+  A8 , \field Electric Power Function of Flow Fraction Curve Name
+       \note independent variable is normalized flow rate, current flow divided by Design Maximum Air Flow Rate.
+       \note dependent variable is modification factor multiplied by Design Power Consumption.
+       \note This field is required if Speed Control Method is set to Continuous or if the Number of Speeds is greater than 1 and Speed Electric Power Fraction fields are not used.
+       \type object-list
+       \object-list UniVariateCurves
+       \object-list UniVariateTables
+  N10, \field Night Ventilation Mode Pressure Rise
+       \note Total system fan pressure rise at the fan when in night mode using AvailabilityManager:NightVentilation
+       \type real
+       \units Pa
+       \ip-units inH2O
+       \minimum> 0.0
+  N11, \field Night Ventilation Mode Flow Fraction
+       \note Fraction of Design Maximum Air Flow Rate to use when in night mode using AvailabilityManager:NightVentilation
+       \type real
+       \minimum 0.0
+       \maximum 1.0
+  A9 , \field Motor Loss Zone Name
+       \note optional, if used fan motor heat losses that not added to air stream are transferred to zone as internal gains
+       \type object-list
+       \object-list ThermalZoneNames
+  N12, \field Motor Loss Radiative Fraction
+       \note optional. If zone identified in previous field then this determines
+       \note the split between convection and radiation for the fan motor's skin losses
+       \type real
+       \minimum 0.0
+       \maximum 1.0
+       \required-field
+  A10, \field End-Use Subcategory
+       \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
+       \type alpha
+       \retaincase
+       \default General
+  N13, \field Speed 1 Flow Fraction
+       \note number of different speed levels is inferred from the number of extensible groups you provide
+       \note This is meant to be used when Speed Control Method is set to Discrete
+       \note Speed need to be arranged in increasing order in remaining field sets.
+       \note If no extensible groups (speeds) are specified, and Speed Control Method is Discrete,
+       \note then constant fan speed is the design maximum.
+       \begin-extensible
+       \type real
+       \minimum 0.0
+       \maximum 1.0
+       \required-field
+  N14; \field Speed 1 Electric Power Fraction
+       \note if left blank then use Electric Power Function of Flow Fraction Curve
+       \type real
+       \minimum 0.0
+       \maximum 1.0
+
 OS:Fan:ConstantVolume,
+       \memo Constant volume fan that is intended to operate continuously based on a time schedule.
+       \memo This fan will not cycle on and off based on cooling/heating load or other control
+       \memo signals.
        \min-fields 10
   A1, \field Handle
        \type handle
@@ -20108,6 +20256,8 @@ OS:Fan:ConstantVolume,
        \reference FansCVandOnOffandVAV
        \reference ConnectionObject
   A3, \field Availability Schedule Name
+       \note Availability schedule name for this system. Schedule value > 0 means the system is available.
+       \note If this field is blank, the system is always available.
        \type object-list
        \required-field
        \object-list ScheduleNames
@@ -20146,11 +20296,14 @@ OS:Fan:ConstantVolume,
        \required-field
        \object-list ConnectionNames
   A6; \field End-Use Subcategory
+       \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
        \type alpha
        \retaincase
        \default General
 
 OS:Fan:VariableVolume,
+       \memo Variable air volume fan where the electric power input varies according to a
+       \memo performance curve as a function of flow fraction.
        \min-fields 18
   A1, \field Handle
        \type handle
@@ -20165,6 +20318,8 @@ OS:Fan:VariableVolume,
        \reference FansCVandOnOffandVAV
        \reference ConnectionObject
   A3, \field Availability Schedule Name
+       \note Availability schedule name for this system. Schedule value > 0 means the system is available.
+       \note If this field is blank, the system is always available.
        \type object-list
        \required-field
        \object-list ScheduleNames
@@ -20230,11 +20385,15 @@ OS:Fan:VariableVolume,
        \required-field
        \object-list ConnectionNames
   A6; \field End-Use Subcategory
+       \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
        \type alpha
        \retaincase
        \default General
 
 OS:Fan:OnOff,
+       \memo Constant volume fan that is intended to cycle on and off based on cooling/heating load
+       \memo or other control signals. This fan can also operate continuously like
+       \memo Fan:ConstantVolume.
        \min-fields 13
   A1, \field Handle
        \type handle
@@ -20250,6 +20409,8 @@ OS:Fan:OnOff,
        \reference FansCVandOnOffandVAV
        \reference ConnectionObject
   A3, \field Availability Schedule Name
+       \note Availability schedule name for this system. Schedule value > 0 means the system is available.
+       \note If this field is blank, the system is always available.
        \type object-list
        \required-field
        \object-list ScheduleNames
@@ -20295,6 +20456,7 @@ OS:Fan:OnOff,
        \type object-list
        \object-list QuadraticCubicCurves
   A8; \field End-Use Subcategory
+       \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
        \type alpha
        \retaincase
        \default General

src/energyplus/CMakeLists.txt

@@ -174,6 +174,7 @@ set(${target_name}_src
   ForwardTranslator/ForwardTranslateExternalInterfaceVariable.cpp
   ForwardTranslator/ForwardTranslateFanConstantVolume.cpp
   ForwardTranslator/ForwardTranslateFanOnOff.cpp
+  ForwardTranslator/ForwardTranslateFanSystemModel.cpp
   ForwardTranslator/ForwardTranslateFanVariableVolume.cpp
   ForwardTranslator/ForwardTranslateFanZoneExhaust.cpp
   ForwardTranslator/ForwardTranslateFFactorGroundFloorConstruction.cpp
@@ -455,6 +456,7 @@ set(${target_name}_src
   ReverseTranslator/ReverseTranslateExteriorFuelEquipment.cpp
   ReverseTranslator/ReverseTranslateExteriorWaterEquipment.cpp
   ReverseTranslator/ReverseTranslateFanConstantVolume.cpp
+  ReverseTranslator/ReverseTranslateFanSystemModel.cpp
   ReverseTranslator/ReverseTranslateFenestrationSurfaceDetailed.cpp
   ReverseTranslator/ReverseTranslateFoundationKiva.cpp
   ReverseTranslator/ReverseTranslateFoundationKivaSettings.cpp
@@ -587,6 +589,7 @@ set(${target_name}_test_src
   Test/ExternalInterfaceFT_GTest.cpp
   Test/FanConstantVolume_GTest.cpp
   Test/FanVariableVolume_GTest.cpp
+  Test/FanSystemModel_GTest.cpp
   Test/FuelCell_GTest.cpp
   Test/GasEquipment_GTest.cpp
   Test/GeneratorMicroTurbine_GTest.cpp
@@ -690,7 +693,7 @@ CREATE_SRC_GROUPS("${${target_name}_src}")
 if(BUILD_TESTING)
 
   CREATE_TEST_TARGETS(${target_name} "${${target_name}_test_src}" "${${target_name}_depends}")
-  
+
   add_dependencies(${target_name}_tests
     ResultsViewer_resources
     openstudio_energyplus_resources

src/energyplus/ForwardTranslator.cpp

@@ -1864,6 +1864,12 @@ boost::optional<IdfObject> ForwardTranslator::translateAndMapModelObject(ModelOb
       retVal = translateFanOnOff(fan);
       break;
     }
+  case openstudio::IddObjectType::OS_Fan_SystemModel :
+    {
+      model::FanSystemModel fan = modelObject.cast<FanSystemModel>();
+      retVal = translateFanSystemModel(fan);
+      break;
+    }
   case openstudio::IddObjectType::OS_Fan_VariableVolume :
     {
       model::FanVariableVolume fan = modelObject.cast<FanVariableVolume>();

src/energyplus/ForwardTranslator.hpp

@@ -225,6 +225,7 @@ class ExternalInterfaceSchedule;
 class ExternalInterfaceVariable;
 class FanConstantVolume;
 class FanOnOff;
+class FanSystemModel;
 class FanVariableVolume;
 class FanZoneExhaust;
 class FFactorGroundFloorConstruction;
@@ -893,6 +894,8 @@ class ENERGYPLUS_API ForwardTranslator {
 
   boost::optional<IdfObject> translateFanOnOff( model::FanOnOff & modelObject );
 
+  boost::optional<IdfObject> translateFanSystemModel( model::FanSystemModel & modelObject );
+
   boost::optional<IdfObject> translateFanVariableVolume( model::FanVariableVolume & modelObject );
 
   boost::optional<IdfObject> translateFanZoneExhaust( model::FanZoneExhaust & modelObject );

src/energyplus/ForwardTranslator/ForwardTranslateAirLoopHVACUnitaryHeatCoolVAVChangeoverBypass.cpp

@@ -54,6 +54,7 @@
 #include <utilities/idd/Fan_ConstantVolume_FieldEnums.hxx>
 #include <utilities/idd/Fan_OnOff_FieldEnums.hxx>
 #include <utilities/idd/Fan_VariableVolume_FieldEnums.hxx>
+#include <utilities/idd/Fan_SystemModel_FieldEnums.hxx>
 #include <utilities/idd/OutdoorAir_Mixer_FieldEnums.hxx>
 #include "../../utilities/idd/IddEnums.hpp"
 #include <utilities/idd/IddEnums.hxx>
@@ -298,6 +299,11 @@ boost::optional<IdfObject> ForwardTranslator::translateAirLoopHVACUnitaryHeatCoo
       _fan->setString(Fan_OnOffFields::AirInletNodeName,fanInletNodeName);
       _fan->setString(Fan_OnOffFields::AirOutletNodeName,fanOutletNodeName);
     }
+    else if( _fan->iddObject().type() == IddObjectType::Fan_SystemModel )
+    {
+      _fan->setString(Fan_SystemModelFields::AirInletNodeName,fanInletNodeName);
+      _fan->setString(Fan_SystemModelFields::AirOutletNodeName,fanOutletNodeName);
+    }
 
     fixSPMsForUnitarySystem(modelObject,fanInletNodeName,fanOutletNodeName);
 

src/energyplus/ForwardTranslator/ForwardTranslateAirLoopHVACUnitaryHeatPumpAirToAir.cpp

@@ -44,6 +44,7 @@
 #include <utilities/idd/AirLoopHVAC_UnitaryHeatPump_AirToAir_FieldEnums.hxx>
 #include <utilities/idd/Fan_ConstantVolume_FieldEnums.hxx>
 #include <utilities/idd/Fan_OnOff_FieldEnums.hxx>
+#include <utilities/idd/Fan_SystemModel_FieldEnums.hxx>
 #include <utilities/idd/Coil_Heating_DX_SingleSpeed_FieldEnums.hxx>
 #include <utilities/idd/Coil_Heating_Fuel_FieldEnums.hxx>
 #include <utilities/idd/Coil_Heating_Electric_FieldEnums.hxx>
@@ -284,6 +285,10 @@ boost::optional<IdfObject> ForwardTranslator::translateAirLoopHVACUnitaryHeatPum
     {
       _fan->setString(Fan_OnOffFields::AirInletNodeName,airInletNodeName.get());
     }
+    else if( _fan->iddObject().type() == IddObjectType::Fan_SystemModel )
+    {
+      _fan->setString(Fan_SystemModelFields::AirInletNodeName,airInletNodeName.get());
+    }
   }
 
   //if( airOutletNodeName && _heatingCoil )
@@ -306,6 +311,10 @@ boost::optional<IdfObject> ForwardTranslator::translateAirLoopHVACUnitaryHeatPum
     {
       _fan->setString(Fan_OnOffFields::AirOutletNodeName,nodeName);
     }
+    else if( _fan->iddObject().type() == IddObjectType::Fan_SystemModel )
+    {
+      _fan->setString(Fan_SystemModelFields::AirOutletNodeName,nodeName);
+    }
 
     _coolingCoil->setString(Coil_Cooling_DX_SingleSpeedFields::AirInletNodeName,nodeName);
   }

src/energyplus/ForwardTranslator/ForwardTranslateAirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed.cpp

@@ -42,6 +42,7 @@
 #include <utilities/idd/AirLoopHVAC_UnitaryHeatPump_AirToAir_MultiSpeed_FieldEnums.hxx>
 #include <utilities/idd/Fan_ConstantVolume_FieldEnums.hxx>
 #include <utilities/idd/Fan_OnOff_FieldEnums.hxx>
+#include <utilities/idd/Fan_SystemModel_FieldEnums.hxx>
 #include <utilities/idd/Coil_Heating_DX_SingleSpeed_FieldEnums.hxx>
 #include <utilities/idd/Coil_Heating_Fuel_FieldEnums.hxx>
 #include <utilities/idd/Coil_Heating_Gas_MultiStage_FieldEnums.hxx>
@@ -338,6 +339,9 @@ boost::optional<IdfObject> ForwardTranslator::translateAirLoopHVACUnitaryHeatPum
     } else if( _fan->iddObject().type() == IddObjectType::Fan_OnOff ) {
       _fan->setString(Fan_OnOffFields::AirInletNodeName,fanInletNodeName);
       _fan->setString(Fan_OnOffFields::AirOutletNodeName,fanOutletNodeName);
+    } else if( _fan->iddObject().type() == IddObjectType::Fan_SystemModel ) {
+      _fan->setString(Fan_SystemModelFields::AirInletNodeName,fanInletNodeName);
+      _fan->setString(Fan_SystemModelFields::AirOutletNodeName,fanOutletNodeName);
     }
   }
 

src/energyplus/ForwardTranslator/ForwardTranslateAirLoopHVACUnitarySystem.cpp

@@ -98,6 +98,7 @@
 #include <utilities/idd/Fan_ConstantVolume_FieldEnums.hxx>
 #include <utilities/idd/Fan_OnOff_FieldEnums.hxx>
 #include <utilities/idd/Fan_VariableVolume_FieldEnums.hxx>
+#include <utilities/idd/Fan_SystemModel_FieldEnums.hxx>
 #include <utilities/idd/SetpointManager_MixedAir_FieldEnums.hxx>
 #include <utilities/idd/UnitarySystemPerformance_Multispeed_FieldEnums.hxx>
 #include "../../utilities/idd/IddEnums.hpp"
@@ -679,6 +680,11 @@ boost::optional<IdfObject> ForwardTranslator::translateAirLoopHVACUnitarySystem(
       _fan->setString(Fan_OnOffFields::AirInletNodeName,inletNodeName);
       _fan->setString(Fan_OnOffFields::AirOutletNodeName,outletNodeName);
     }
+    else if( _fan->iddObject().type() == IddObjectType::Fan_SystemModel )
+    {
+      _fan->setString(Fan_SystemModelFields::AirInletNodeName,inletNodeName);
+      _fan->setString(Fan_SystemModelFields::AirOutletNodeName,outletNodeName);
+    }
 
     fixSPMsForUnitarySystem(modelObject,inletNodeName,outletNodeName);
   }