User Defined HVAC and Plant Component Models¶

5 object types from idfpy.models.user_defined · EnergyPlus 26.2

Object	Summary
AirTerminal:SingleDuct:UserDefined	Defines a generic single duct air terminal unit for custom modeling using Energy Management System or …
Coil:UserDefined	Defines a generic air system component for custom modeling using Energy Management System or External …
PlantComponent:UserDefined	Defines a generic plant component for custom modeling using Energy Management System or External Interface
PlantEquipmentOperation:UserDefined	Defines a generic plant operation scheme for custom supervisory control using Energy Management System or …
ZoneHVAC:ForcedAir:UserDefined	Defines a generic zone air unit for custom modeling using Energy Management System or External Interface

AirTerminal:SingleDuct:UserDefined¶

from idfpy.models import AirTerminalSingleDuctUserDefined

Defines a generic single duct air terminal unit for custom modeling using Energy Management System or External Interface

Field	Type	Details
`name` Name required	string	This is the name of the air terminal
`overall_model_simulation_program_calling_manager_name` Overall Model Simulation Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`model_setup_and_sizing_program_calling_manager_name` Model Setup and Sizing Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`primary_air_inlet_node_name` Primary Air Inlet Node Name required	string	Air inlet node for the unit must be a zone splitter outlet.
`primary_air_outlet_node_name` Primary Air Outlet Node Name required	string	Air outlet node for the unit must be a zone air inlet node.
`secondary_air_inlet_node_name` Secondary Air Inlet Node Name	string	Inlet air used for heat rejection or air source
`secondary_air_outlet_node_name` Secondary Air Outlet Node Name	string	Outlet air used for heat rejection or air source
`number_of_plant_loop_connections` Number of Plant Loop Connections required	integer	Range: ≥ 0, ≤ 2
`plant_connection_1_inlet_node_name` Plant Connection 1 Inlet Node Name required	string
`plant_connection_1_outlet_node_name` Plant Connection 1 Outlet Node Name required	string
`plant_connection_2_inlet_node_name` Plant Connection 2 Inlet Node Name	string
`plant_connection_2_outlet_node_name` Plant Connection 2 Outlet Node Name	string
`supply_inlet_water_storage_tank_name` Supply Inlet Water Storage Tank Name	reference	Water use storage tank for alternate source of water consumed by device Names a WaterUse:Storage
`collection_outlet_water_storage_tank_name` Collection Outlet Water Storage Tank Name	reference	Water use storage tank for collection of condensate by device Names a WaterUse:Storage
`ambient_zone_name` Ambient Zone Name	reference	Used for modeling device losses to surrounding zone Names a Zone

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, ZoneHVAC:AirDistributionUnit

Coil:UserDefined¶

from idfpy.models import CoilUserDefined

Defines a generic air system component for custom modeling using Energy Management System or External Interface

Field	Type	Details
`name` Name required	string	This is the name of the coil
`overall_model_simulation_program_calling_manager_name` Overall Model Simulation Program Calling Manager Name	reference	This is the name of a program to run that defines the user-defined functionality for this component. This can match the name of an EnergyManagementSystem:Program or PythonPlugin:Instance object as defined in the input file. For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`model_setup_and_sizing_program_calling_manager_name` Model Setup and Sizing Program Calling Manager Name required	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`number_of_air_connections` Number of Air Connections required	integer	Range: ≥ 1, ≤ 2
`air_connection_1_inlet_node_name` Air Connection 1 Inlet Node Name required	string	Inlet air for primary air stream
`air_connection_1_outlet_node_name` Air Connection 1 Outlet Node Name required	string	Outlet air for primary air stream
`air_connection_2_inlet_node_name` Air Connection 2 Inlet Node Name	string	Inlet air for secondary air stream
`air_connection_2_outlet_node_name` Air Connection 2 Outlet Node Name	string	Outlet air for secondary air stream
`plant_connection_is_used` Plant Connection is Used	choice	One of `No`, `Yes`
`plant_connection_inlet_node_name` Plant Connection Inlet Node Name	string
`plant_connection_outlet_node_name` Plant Connection Outlet Node Name	string
`supply_inlet_water_storage_tank_name` Supply Inlet Water Storage Tank Name	reference	Water use storage tank for alternate source of water consumed by device Names a WaterUse:Storage
`collection_outlet_water_storage_tank_name` Collection Outlet Water Storage Tank Name	reference	Water use storage tank for collection of condensate by device Names a WaterUse:Storage
`ambient_zone_name` Ambient Zone Name	reference	Used for modeling device losses to surrounding zone Names a Zone

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirLoopHVAC:UnitarySystem, Branch

PlantComponent:UserDefined¶

from idfpy.models import PlantComponentUserDefined

Defines a generic plant component for custom modeling using Energy Management System or External Interface

Field	Type	Details
`name` Name required	string	This is the name of the plant component
`main_model_program_calling_manager_name` Main Model Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`number_of_plant_loop_connections` Number of Plant Loop Connections required	integer	Range: ≥ 1, ≤ 4
`plant_connection_1_inlet_node_name` Plant Connection 1 Inlet Node Name required	string
`plant_connection_1_outlet_node_name` Plant Connection 1 Outlet Node Name required	string
`plant_connection_1_loading_mode` Plant Connection 1 Loading Mode required	choice	One of `DemandsLoad`, `MeetsLoadWithNominalCapacity`, `MeetsLoadWithNominalCapacityHiOutLimit`, `MeetsLoadWithNominalCapacityLowOutLimit`, `MeetsLoadWithPassiveCapacity`
`plant_connection_1_loop_flow_request_mode` Plant Connection 1 Loop Flow Request Mode required	choice	One of `NeedsFlowAndTurnsLoopOn`, `NeedsFlowIfLoopOn`, `ReceivesWhateverFlowAvailable`
`plant_connection_1_initialization_program_calling_manager_name` Plant Connection 1 Initialization Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_1_simulation_program_calling_manager_name` Plant Connection 1 Simulation Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_2_inlet_node_name` Plant Connection 2 Inlet Node Name	string
`plant_connection_2_outlet_node_name` Plant Connection 2 Outlet Node Name	string
`plant_connection_2_loading_mode` Plant Connection 2 Loading Mode	choice	One of `DemandsLoad`, `MeetLoadWithNominalCapacity`, `MeetLoadWithNominalCapacityHiOutLimit`, `MeetLoadWithNominalCapacityLowOutLimit`, `MeetLoadWithPassiveCapacity`
`plant_connection_2_loop_flow_request_mode` Plant Connection 2 Loop Flow Request Mode	choice	One of `NeedsFlowAndTurnsLoopOn`, `NeedsFlowIfLoopOn`, `ReceivesWhateverFlowAvailable`
`plant_connection_2_initialization_program_calling_manager_name` Plant Connection 2 Initialization Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_2_simulation_program_calling_manager_name` Plant Connection 2 Simulation Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_3_inlet_node_name` Plant Connection 3 Inlet Node Name	string
`plant_connection_3_outlet_node_name` Plant Connection 3 Outlet Node Name	string
`plant_connection_3_loading_mode` Plant Connection 3 Loading Mode	choice	One of `DemandsLoad`, `MeetLoadWithNominalCapacity`, `MeetLoadWithNominalCapacityHiOutLimit`, `MeetLoadWithNominalCapacityLowOutLimit`, `MeetLoadWithPassiveCapacity`
`plant_connection_3_loop_flow_request_mode` Plant Connection 3 Loop Flow Request Mode	choice	One of `NeedsFlowAndTurnsLoopOn`, `NeedsFlowIfLoopOn`, `ReceivesWhateverFlowAvailable`
`plant_connection_3_initialization_program_calling_manager_name` Plant Connection 3 Initialization Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_3_simulation_program_calling_manager_name` Plant Connection 3 Simulation Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_4_inlet_node_name` Plant Connection 4 Inlet Node Name	string
`plant_connection_4_outlet_node_name` Plant Connection 4 Outlet Node Name	string
`plant_connection_4_loading_mode` Plant Connection 4 Loading Mode	choice	One of `DemandsLoad`, `MeetLoadWithNominalCapacity`, `MeetLoadWithNominalCapacityHiOutLimit`, `MeetLoadWithNominalCapacityLowOutLimit`, `MeetLoadWithPassiveCapacity`
`plant_connection_4_loop_flow_request_mode` Plant Connection 4 Loop Flow Request Mode	choice	One of `NeedsFlowAndTurnsLoopOn`, `NeedsFlowIfLoopOn`, `ReceivesWhateverFlowAvailable`
`plant_connection_4_initialization_program_calling_manager_name` Plant Connection 4 Initialization Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`plant_connection_4_simulation_program_calling_manager_name` Plant Connection 4 Simulation Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`air_connection_inlet_node_name` Air Connection Inlet Node Name	string	Inlet air used for heat rejection or air source
`air_connection_outlet_node_name` Air Connection Outlet Node Name	string	Outlet air used for heat rejection or air source
`supply_inlet_water_storage_tank_name` Supply Inlet Water Storage Tank Name	reference	Water use storage tank for alternate source of water consumed by device Names a WaterUse:Storage
`collection_outlet_water_storage_tank_name` Collection Outlet Water Storage Tank Name	reference	Water use storage tank for collection of condensate by device Names a WaterUse:Storage
`ambient_zone_name` Ambient Zone Name	reference	Used for modeling device losses to surrounding zone Names a Zone

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList

PlantEquipmentOperation:UserDefined¶

from idfpy.models import PlantEquipmentOperationUserDefined

Defines a generic plant operation scheme for custom supervisory control using Energy Management System or External Interface to dispatch loads

Field	Type	Details
`name` Name required	string	This is the name of the plant operation scheme
`main_model_program_calling_manager_name` Main Model Program Calling Manager Name required	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`initialization_program_calling_manager_name` Initialization Program Calling Manager Name	reference	Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`equipment_1_object_type` Equipment 1 Object Type	string
`equipment_1_name` Equipment 1 Name	string
`equipment_2_object_type` Equipment 2 Object Type	string
`equipment_2_name` Equipment 2 Name	string
`equipment_3_object_type` Equipment 3 Object Type	string
`equipment_3_name` Equipment 3 Name	string
`equipment_4_object_type` Equipment 4 Object Type	string
`equipment_4_name` Equipment 4 Name	string
`equipment_5_object_type` Equipment 5 Object Type	string
`equipment_5_name` Equipment 5 Name	string
`equipment_6_object_type` Equipment 6 Object Type	string
`equipment_6_name` Equipment 6 Name	string
`equipment_7_object_type` Equipment 7 Object Type	string
`equipment_7_name` Equipment 7 Name	string
`equipment_8_object_type` Equipment 8 Object Type	string
`equipment_8_name` Equipment 8 Name	string
`equipment_9_object_type` Equipment 9 Object Type	string
`equipment_9_name` Equipment 9 Name	string
`equipment_10_object_type` Equipment 10 Object Type	string
`equipment_10_name` Equipment 10 Name	string

ZoneHVAC:ForcedAir:UserDefined¶

from idfpy.models import ZoneHVACForcedAirUserDefined

Defines a generic zone air unit for custom modeling using Energy Management System or External Interface

Field	Type	Details
`name` Name required	string	This is the name of the zone unit
`overall_model_simulation_program_calling_manager_name` Overall Model Simulation Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`model_setup_and_sizing_program_calling_manager_name` Model Setup and Sizing Program Calling Manager Name	reference	For use with the API (Library, Callback) workflow, this field should be the same string that the user provides when registering a callback function using the API. In this workflow, the callback name is not entered elsewhere in the IDF, so the object-list will not include this user-specified function identifier. This will cause a warning when editing this field in IDF-Editor. Names a EnergyManagementSystem:ProgramCallingManager, PythonPlugin:Instance
`primary_air_inlet_node_name` Primary Air Inlet Node Name required	string	Air inlet node for the unit must be a zone air exhaust Node.
`primary_air_outlet_node_name` Primary Air Outlet Node Name required	string	Air outlet node for the unit must be a zone air inlet node.
`secondary_air_inlet_node_name` Secondary Air Inlet Node Name	string	Inlet air used for heat rejection or air source
`secondary_air_outlet_node_name` Secondary Air Outlet Node Name	string	Outlet air used for heat rejection or air source
`number_of_plant_loop_connections` Number of Plant Loop Connections required	integer	Range: ≥ 0, ≤ 3
`plant_connection_1_inlet_node_name` Plant Connection 1 Inlet Node Name	string
`plant_connection_1_outlet_node_name` Plant Connection 1 Outlet Node Name	string
`plant_connection_2_inlet_node_name` Plant Connection 2 Inlet Node Name	string
`plant_connection_2_outlet_node_name` Plant Connection 2 Outlet Node Name	string
`plant_connection_3_inlet_node_name` Plant Connection 3 Inlet Node Name	string
`plant_connection_3_outlet_node_name` Plant Connection 3 Outlet Node Name	string
`supply_inlet_water_storage_tank_name` Supply Inlet Water Storage Tank Name	reference	Water use storage tank for alternate source of water consumed by device Names a WaterUse:Storage
`collection_outlet_water_storage_tank_name` Collection Outlet Water Storage Tank Name	reference	Water use storage tank for collection of condensate by device Names a WaterUse:Storage
`ambient_zone_name` Ambient Zone Name	reference	Used for modeling device losses to surrounding zone Names a Zone

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList