Water Systems¶

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

Object	Summary
WaterUse:Connections	A subsystem that groups together multiple WaterUse:Equipment components.
WaterUse:Equipment	A generalized object for simulating all water end uses.
WaterUse:RainCollector	Used for harvesting rainwater falling on building surfaces.
WaterUse:Storage	A water storage tank.
WaterUse:Well	Simulates on-site water supply from a well.

WaterUse:Connections¶

from idfpy.models import WaterUseConnections extensible

A subsystem that groups together multiple WaterUse:Equipment components. As its name suggests, the object provides connections that are shared by these components, including: 1. Inlet node and outlet node connections to a plant loop 2. Connections to WaterUse:Storage objects to store and draw reclaimed water 3. Internal connections to simulate drainwater heat recovery.

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name	string
`outlet_node_name` Outlet Node Name	string
`supply_water_storage_tank_name` Supply Water Storage Tank Name	reference		If blank, or tank is empty, defaults to fresh water from the mains Names a WaterUse:Storage
`reclamation_water_storage_tank_name` Reclamation Water Storage Tank Name	reference		Names a WaterUse:Storage
`hot_water_supply_temperature_schedule_name` Hot Water Supply Temperature Schedule Name	reference		Defaults to cold water supply temperature Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cold_water_supply_temperature_schedule_name` Cold Water Supply Temperature Schedule Name	reference		Defaults to water temperatures calculated by Site:WaterMainsTemperature object Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`drain_water_heat_exchanger_type` Drain Water Heat Exchanger Type	choice	`None`	One of `CounterFlow`, `CrossFlow`, `Ideal`, `None`
`drain_water_heat_exchanger_destination` Drain Water Heat Exchanger Destination	choice	`Plant`	One of `Equipment`, `Plant`, `PlantAndEquipment`
`drain_water_heat_exchanger_u_factor_times_area` Drain Water Heat Exchanger U-Factor Times Area	number W/K		Range: ≥ 0
`connections`	list		Each item: `water_use_equipment_name`

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

WaterUse:Equipment¶

from idfpy.models import WaterUseEquipment

A generalized object for simulating all water end uses. Hot and cold water uses are included, as well as controlled mixing of hot and cold water at the tap. The WaterUse:Equipment object can be used stand-alone, or coupled into a plant loop using the WaterUse:Connections object (see below). The WaterUse:Connections object allows water uses to be linked to WaterUse:Storage objects to store and draw reclaimed water. The object can also simulate drainwater heat recovery.

Field	Type	Default	Details
`name` Name required	string
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`peak_flow_rate` Peak Flow Rate required	number m3/s		Range: ≥ 0
`flow_rate_fraction_schedule_name` Flow Rate Fraction Schedule Name	reference		Defaults to 1.0 at all times Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`target_temperature_schedule_name` Target Temperature Schedule Name	reference		Defaults to hot water supply temperature Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`hot_water_supply_temperature_schedule_name` Hot Water Supply Temperature Schedule Name	reference		Defaults to cold water supply temperature Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cold_water_supply_temperature_schedule_name` Cold Water Supply Temperature Schedule Name	reference		Defaults to water temperatures calculated by Site:WaterMainsTemperature object Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`zone_name` Zone Name	reference		Names a Zone
`sensible_fraction_schedule_name` Sensible Fraction Schedule Name	reference		Defaults to 0.0 at all times Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`latent_fraction_schedule_name` Latent Fraction Schedule Name	reference		Defaults to 0.0 at all times Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 1 object types

WaterUse:Connections

WaterUse:RainCollector¶

from idfpy.models import WaterUseRainCollector extensible

Used for harvesting rainwater falling on building surfaces. The rainwater is sent to a WaterUse:Storage object. In versions up till Version 9.6, it is necessary to also include a Site:Precipitation object to describe the rates of rainfall, in order to use this object. In later versions, if the Site:Precipitation is not present, precipitation depth in the weather input .epw will be used instead. When this is the case, please make sure the precipitation in the .epw is accurate.

Field	Type	Details
`name` Name required	string
`storage_tank_name` Storage Tank Name required	reference	Names a WaterUse:Storage
`loss_factor_mode` Loss Factor Mode	choice	One of `Constant`, `Scheduled`
`collection_loss_factor` Collection Loss Factor	number	this is the portion of rain that is lost in the process of collecting it the rain collected is one minus this factor
`collection_loss_factor_schedule_name` Collection Loss Factor Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_collection_rate` Maximum Collection Rate	number m3/s	Defaults to unlimited flow.
`surfaces`	list	Each item: `collection_surface_name`

WaterUse:Storage¶

from idfpy.models import WaterUseStorage

A water storage tank. If the building model is to include any on-site water collection, wells, or storing and reuse of graywater, then a WaterUse:Storage object is needed. Each WaterUse:Storage can serve as a central node and make connections to numerous sources of supply or numerous components with demand. If a maximum capacity is not specified, the tank is assumed to have unlimited capacity.

Field	Type	Details
`name` Name required	string
`water_quality_subcategory` Water Quality Subcategory	string
`maximum_capacity` Maximum Capacity	number m3	Defaults to unlimited capacity.
`initial_volume` Initial Volume	number m3
`design_in_flow_rate` Design In Flow Rate	number m3/s	Defaults to unlimited flow.
`design_out_flow_rate` Design Out Flow Rate	number m3/s	Defaults to unlimited flow.
`overflow_destination` Overflow Destination	reference	If blank, overflow is discarded Names a WaterUse:Storage
`type_of_supply_controlled_by_float_valve` Type of Supply Controlled by Float Valve	choice	One of `GroundwaterWell`, `Mains`, `None`, `OtherTank`
`float_valve_on_capacity` Float Valve On Capacity	number m3	Lower range of target storage level e.g. float valve kicks on
`float_valve_off_capacity` Float Valve Off Capacity	number m3	Upper range of target storage level e.g. float valve kicks off
`backup_mains_capacity` Backup Mains Capacity	number m3	Lower range of secondary target storage level used to keep tanks at a minimum level using mains water if well can't keep up
`other_tank_name` Other Tank Name	reference	Names a WaterUse:Storage
`water_thermal_mode` Water Thermal Mode	choice	One of `ScheduledTemperature`, `ThermalModel`
`water_temperature_schedule_name` Water Temperature Schedule Name required	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_indicator` Ambient Temperature Indicator	choice	One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`zone_name` Zone Name	reference	Names a Zone
`tank_surface_area` Tank Surface Area	number m2
`tank_u_value` Tank U Value	number W/m2-K
`tank_outside_surface_material_name` Tank Outside Surface Material Name	reference	Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more

Referenced by 37 object types

AirConditioner:VariableRefrigerantFlow, AirTerminal:SingleDuct:UserDefined, Coil:Cooling:DX, Coil:Cooling:DX:MultiSpeed, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:TwoSpeed, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableRefrigerantFlow, Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl, Coil:Cooling:DX:VariableSpeed, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:UserDefined, CoolingTower:SingleSpeed, CoolingTower:TwoSpeed, CoolingTower:VariableSpeed, CoolingTower:VariableSpeed:Merkel, EvaporativeCooler:Direct:CelDekPad, EvaporativeCooler:Direct:ResearchSpecial, EvaporativeCooler:Indirect:CelDekPad, EvaporativeCooler:Indirect:ResearchSpecial, EvaporativeCooler:Indirect:WetCoil, EvaporativeFluidCooler:SingleSpeed, EvaporativeFluidCooler:TwoSpeed, Humidifier:Steam:Electric, Humidifier:Steam:Gas, PlantComponent:UserDefined, Refrigeration:CompressorRack, Refrigeration:Condenser:EvaporativeCooled, WaterUse:Connections, WaterUse:RainCollector, WaterUse:Storage, WaterUse:Well, ZoneCoolTower:Shower, ZoneHVAC:Dehumidifier:DX, ZoneHVAC:ForcedAir:UserDefined

WaterUse:Well¶

from idfpy.models import WaterUseWell

Simulates on-site water supply from a well. Well water is pumped out of the ground into a WaterUse:Storage. The operation of the ground water well is controlled by the associated WaterUse:Storage which is assumed to be operated as a vented cistern with no pressure tank.

Field	Type	Details
`name` Name required	string
`storage_tank_name` Storage Tank Name required	reference	Names a WaterUse:Storage
`pump_depth` Pump Depth	number m
`pump_rated_flow_rate` Pump Rated Flow Rate	number m3/s
`pump_rated_head` Pump Rated Head	number Pa
`pump_rated_power_consumption` Pump Rated Power Consumption	number W
`pump_efficiency` Pump Efficiency	number
`well_recovery_rate` Well Recovery Rate	number m3/s
`nominal_well_storage_volume` Nominal Well Storage Volume	number m3
`water_table_depth_mode` Water Table Depth Mode	choice	One of `Constant`, `Scheduled`
`water_table_depth` Water Table Depth	number m
`water_table_depth_schedule_name` Water Table Depth Schedule Name	reference	Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules