pyidf.water_systems module¶

Data objects in group “Water Systems”

class pyidf.water_systems.WaterUseConnections¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterUse:Connections 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.

add_extensible(water_use_equipment_1_name=None)¶

Add values for extensible fields

Parameters:	water_use_equipment_1_name (str) – value for IDD Field Water Use Equipment 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

cold_water_supply_temperature_schedule_name¶

field Cold Water Supply Temperature Schedule Name

Defaults to water temperatures calculated by Site:WaterMainsTemperature object

Parameters:	value (str) – value for IDD Field Cold Water Supply Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cold_water_supply_temperature_schedule_name or None if not set
Return type:	str

drain_water_heat_exchanger_destination¶

field Drain Water Heat Exchanger Destination

Default value: Plant

Parameters:	value (str) – value for IDD Field Drain Water Heat Exchanger Destination
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drain_water_heat_exchanger_destination or None if not set
Return type:	str

drain_water_heat_exchanger_type¶

field Drain Water Heat Exchanger Type

Default value: None

Parameters:	value (str) – value for IDD Field Drain Water Heat Exchanger Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drain_water_heat_exchanger_type or None if not set
Return type:	str

drain_water_heat_exchanger_ufactor_times_area¶

field Drain Water Heat Exchanger U-Factor Times Area

Units: W/K

Parameters:	value (float) – value for IDD Field Drain Water Heat Exchanger U-Factor Times Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of drain_water_heat_exchanger_ufactor_times_area or None if not set
Return type:	float

extensibles¶: Get list of all extensibles

hot_water_supply_temperature_schedule_name¶

field Hot Water Supply Temperature Schedule Name

Defaults to cold water supply temperature

Parameters:	value (str) – value for IDD Field Hot Water Supply Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of hot_water_supply_temperature_schedule_name or None if not set
Return type:	str

inlet_node_name¶

field Inlet Node Name

Parameters:	value (str) – value for IDD Field Inlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of inlet_node_name or None if not set
Return type:	str

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

outlet_node_name¶

field Outlet Node Name

Parameters:	value (str) – value for IDD Field Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outlet_node_name or None if not set
Return type:	str

reclamation_water_storage_tank_name¶

field Reclamation Water Storage Tank Name

Parameters:	value (str) – value for IDD Field Reclamation Water Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of reclamation_water_storage_tank_name or None if not set
Return type:	str

supply_water_storage_tank_name¶

field Supply Water Storage Tank Name

If blank, or tank is empty, defaults to fresh water from the mains

Parameters:	value (str) – value for IDD Field Supply Water Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_water_storage_tank_name or None if not set
Return type:	str

class pyidf.water_systems.WaterUseEquipment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterUse:Equipment 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.

cold_water_supply_temperature_schedule_name¶

field Cold Water Supply Temperature Schedule Name

Defaults to water temperatures calculated by Site:WaterMainsTemperature object

Parameters:	value (str) – value for IDD Field Cold Water Supply Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cold_water_supply_temperature_schedule_name or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

Parameters:	value (str) – value for IDD Field End-Use Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of enduse_subcategory or None if not set
Return type:	str

flow_rate_fraction_schedule_name¶

field Flow Rate Fraction Schedule Name

Defaults to 1.0 at all times

Parameters:	value (str) – value for IDD Field Flow Rate Fraction Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of flow_rate_fraction_schedule_name or None if not set
Return type:	str

hot_water_supply_temperature_schedule_name¶

field Hot Water Supply Temperature Schedule Name

Defaults to cold water supply temperature

Parameters:	value (str) – value for IDD Field Hot Water Supply Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of hot_water_supply_temperature_schedule_name or None if not set
Return type:	str

latent_fraction_schedule_name¶

field Latent Fraction Schedule Name

Defaults to 0.0 at all times

Parameters:	value (str) – value for IDD Field Latent Fraction Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of latent_fraction_schedule_name or None if not set
Return type:	str

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

peak_flow_rate¶

field Peak Flow Rate

Units: m3/s

Parameters:	value (float) – value for IDD Field Peak Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of peak_flow_rate or None if not set
Return type:	float

sensible_fraction_schedule_name¶

field Sensible Fraction Schedule Name

Defaults to 0.0 at all times

Parameters:	value (str) – value for IDD Field Sensible Fraction Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of sensible_fraction_schedule_name or None if not set
Return type:	str

target_temperature_schedule_name¶

field Target Temperature Schedule Name

Defaults to hot water supply temperature

Parameters:	value (str) – value for IDD Field Target Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of target_temperature_schedule_name or None if not set
Return type:	str

zone_name¶

field Zone Name

Parameters:	value (str) – value for IDD Field Zone Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of zone_name or None if not set
Return type:	str

class pyidf.water_systems.WaterUseRainCollector¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterUse:RainCollector Used for harvesting rainwater falling on building surfaces. The rainwater is sent to a WaterUse:Storage object. In order to use this object it is necessary to also include a Site:Precipitation object to describe the rates of rainfall.

add_extensible(collection_surface_1_name=None)¶

Add values for extensible fields

Parameters:	collection_surface_1_name (str) – value for IDD Field Collection Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

collection_loss_factor¶

field Collection Loss Factor

this is the portion of rain
that is lost in the process of collecting it
the rain collected is one minus this factor

Parameters:	value (float) – value for IDD Field Collection Loss Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of collection_loss_factor or None if not set
Return type:	float

collection_loss_factor_schedule_name¶

field Collection Loss Factor Schedule Name

Parameters:	value (str) – value for IDD Field Collection Loss Factor Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of collection_loss_factor_schedule_name or None if not set
Return type:	str

extensibles¶: Get list of all extensibles

loss_factor_mode¶

field Loss Factor Mode

Parameters:	value (str) – value for IDD Field Loss Factor Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of loss_factor_mode or None if not set
Return type:	str

maximum_collection_rate¶

field Maximum Collection Rate

Defaults to unlimited flow.

Units: m3/s

Parameters:	value (float) – value for IDD Field Maximum Collection Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_collection_rate or None if not set
Return type:	float

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

storage_tank_name¶

field Storage Tank Name

Parameters:	value (str) – value for IDD Field Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of storage_tank_name or None if not set
Return type:	str

class pyidf.water_systems.WaterUseStorage¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterUse:Storage 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.

ambient_temperature_indicator¶

field Ambient Temperature Indicator

Parameters:	value (str) – value for IDD Field Ambient Temperature Indicator
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ambient_temperature_indicator or None if not set
Return type:	str

ambient_temperature_schedule_name¶

field Ambient Temperature Schedule Name

Parameters:	value (str) – value for IDD Field Ambient Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ambient_temperature_schedule_name or None if not set
Return type:	str

backup_mains_capacity¶

field Backup Mains Capacity

Lower range of secondary target storage level
used to keep tanks at a minimum level using
mains water if well can’t keep up
Units: m3

Parameters:	value (float) – value for IDD Field Backup Mains Capacity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of backup_mains_capacity or None if not set
Return type:	float

design_in_flow_rate¶

field Design In Flow Rate

Defaults to unlimited flow.

Units: m3/s

Parameters:	value (float) – value for IDD Field Design In Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_in_flow_rate or None if not set
Return type:	float

design_out_flow_rate¶

field Design Out Flow Rate

Defaults to unlimited flow.

Units: m3/s

Parameters:	value (float) – value for IDD Field Design Out Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_out_flow_rate or None if not set
Return type:	float

float_valve_off_capacity¶

field Float Valve Off Capacity

Upper range of target storage level e.g. float valve kicks off

Units: m3

Parameters:	value (float) – value for IDD Field Float Valve Off Capacity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of float_valve_off_capacity or None if not set
Return type:	float

float_valve_on_capacity¶

field Float Valve On Capacity

Lower range of target storage level e.g. float valve kicks on

Units: m3

Parameters:	value (float) – value for IDD Field Float Valve On Capacity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of float_valve_on_capacity or None if not set
Return type:	float

initial_volume¶

field Initial Volume

Units: m3

Parameters:	value (float) – value for IDD Field Initial Volume
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_volume or None if not set
Return type:	float

maximum_capacity¶

field Maximum Capacity

Defaults to unlimited capacity.

Units: m3

Parameters:	value (float) – value for IDD Field Maximum Capacity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_capacity or None if not set
Return type:	float

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

other_tank_name¶

field Other Tank Name

Parameters:	value (str) – value for IDD Field Other Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of other_tank_name or None if not set
Return type:	str

overflow_destination¶

field Overflow Destination

If blank, overflow is discarded

Parameters:	value (str) – value for IDD Field Overflow Destination
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of overflow_destination or None if not set
Return type:	str

tank_outside_surface_material_name¶

field Tank Outside Surface Material Name

Parameters:	value (str) – value for IDD Field Tank Outside Surface Material Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of tank_outside_surface_material_name or None if not set
Return type:	str

tank_surface_area¶

field Tank Surface Area

Units: m2

Parameters:	value (float) – value for IDD Field Tank Surface Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of tank_surface_area or None if not set
Return type:	float

tank_u_value¶

field Tank U Value

Units: W/m2-K

Parameters:	value (float) – value for IDD Field Tank U Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of tank_u_value or None if not set
Return type:	float

type_of_supply_controlled_by_float_valve¶

field Type of Supply Controlled by Float Valve

Parameters:	value (str) – value for IDD Field Type of Supply Controlled by Float Valve
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of type_of_supply_controlled_by_float_valve or None if not set
Return type:	str

water_quality_subcategory¶

field Water Quality Subcategory

Parameters:	value (str) – value for IDD Field Water Quality Subcategory
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_quality_subcategory or None if not set
Return type:	str

water_temperature_schedule_name¶

field Water Temperature Schedule Name

Parameters:	value (str) – value for IDD Field Water Temperature Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_temperature_schedule_name or None if not set
Return type:	str

water_thermal_mode¶

field Water Thermal Mode

Parameters:	value (str) – value for IDD Field Water Thermal Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_thermal_mode or None if not set
Return type:	str

zone_name¶

field Zone Name

Parameters:	value (str) – value for IDD Field Zone Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of zone_name or None if not set
Return type:	str

class pyidf.water_systems.WaterUseWell¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterUse:Well 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.

name¶

field Name

Parameters:	value (str) – value for IDD Field Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name or None if not set
Return type:	str

nominal_well_storage_volume¶

field Nominal Well Storage Volume

Units: m3

Parameters:	value (float) – value for IDD Field Nominal Well Storage Volume
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of nominal_well_storage_volume or None if not set
Return type:	float

pump_depth¶

field Pump Depth

Units: m

Parameters:	value (float) – value for IDD Field Pump Depth
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pump_depth or None if not set
Return type:	float

pump_efficiency¶

field Pump Efficiency

Parameters:	value (float) – value for IDD Field Pump Efficiency
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pump_efficiency or None if not set
Return type:	float

pump_rated_flow_rate¶

field Pump Rated Flow Rate

Units: m3/s

Parameters:	value (float) – value for IDD Field Pump Rated Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pump_rated_flow_rate or None if not set
Return type:	float

pump_rated_head¶

field Pump Rated Head

Units: Pa

Parameters:	value (float) – value for IDD Field Pump Rated Head
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pump_rated_head or None if not set
Return type:	float

pump_rated_power_consumption¶

field Pump Rated Power Consumption

Units: W

Parameters:	value (float) – value for IDD Field Pump Rated Power Consumption
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pump_rated_power_consumption or None if not set
Return type:	float

storage_tank_name¶

field Storage Tank Name

Parameters:	value (str) – value for IDD Field Storage Tank Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of storage_tank_name or None if not set
Return type:	str

water_table_depth¶

field Water Table Depth

Units: m

Parameters:	value (float) – value for IDD Field Water Table Depth
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_table_depth or None if not set
Return type:	float

water_table_depth_mode¶

field Water Table Depth Mode

Parameters:	value (str) – value for IDD Field Water Table Depth Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_table_depth_mode or None if not set
Return type:	str

water_table_depth_schedule_name¶

field Water Table Depth Schedule Name

Parameters:	value (str) – value for IDD Field Water Table Depth Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of water_table_depth_schedule_name or None if not set
Return type:	str

well_recovery_rate¶

field Well Recovery Rate

Units: m3/s

Parameters:	value (float) – value for IDD Field Well Recovery Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of well_recovery_rate or None if not set
Return type:	float

pyidf.water_systems module¶

Related Topics

This Page