pyidf.node module¶

Data objects in group “Node”

class pyidf.node.Branch¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Branch List components on the branch in simulation and connection order Note: this should NOT include splitters or mixers which define endpoints of branches

add_extensible(component_1_object_type=None, component_1_name=None, component_1_inlet_node_name=None, component_1_outlet_node_name=None, component_1_branch_control_type=None)¶

Add values for extensible fields

Parameters:

component_1_object_type (str) – value for IDD Field Component 1 Object Type if value is None it will not be checked against the specification and is assumed to be a missing value
component_1_name (str) – value for IDD Field Component 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
component_1_inlet_node_name (str) – value for IDD Field Component 1 Inlet Node Name if value is None it will not be checked against the specification and is assumed to be a missing value
component_1_outlet_node_name (str) – value for IDD Field Component 1 Outlet Node Name if value is None it will not be checked against the specification and is assumed to be a missing value
component_1_branch_control_type (str) – value for IDD Field Component 1 Branch Control Type if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles¶: Get list of all extensibles

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

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

pressure_drop_curve_name¶

field Pressure Drop Curve Name

Optional field to include this branch in plant pressure drop calculations
This field is only relevant for branches in PlantLoops and CondenserLoops
Air loops do not account for pressure drop using this field
Valid curve types are: Curve:Functional:PressureDrop or
one of Curve:{Linear,Quadratic,Cubic,Exponent}’)

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

class pyidf.node.BranchList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object BranchList Branches MUST be listed in Flow order: Inlet branch, then parallel branches, then Outlet branch. Branches are simulated in the order listed. Branch names cannot be duplicated within a single branch list.

add_extensible(branch_1_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

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

class pyidf.node.ConnectorList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ConnectorList only two connectors allowed per loop if two entered, one must be Connector:Splitter and one must be Connector:Mixer

connector_1_name¶

field Connector 1 Name

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

connector_1_object_type¶

field Connector 1 Object Type

Parameters:	value (str) – value for IDD Field Connector 1 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of connector_1_object_type or None if not set
Return type:	str

connector_2_name¶

field Connector 2 Name

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

connector_2_object_type¶

field Connector 2 Object Type

Parameters:	value (str) – value for IDD Field Connector 2 Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of connector_2_object_type 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

class pyidf.node.ConnectorMixer¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Connector:Mixer Mix N inlet air/water streams into one. Branch names cannot be duplicated within a single mixer list.

add_extensible(inlet_branch_1_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

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_branch_name¶

field Outlet Branch Name

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

class pyidf.node.ConnectorSplitter¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Connector:Splitter Split one air/water stream into N outlet streams. Branch names cannot be duplicated within a single Splitter list.

add_extensible(outlet_branch_1_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

inlet_branch_name¶

field Inlet Branch Name

Parameters:	value (str) – value for IDD Field Inlet Branch Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of inlet_branch_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

class pyidf.node.Duct¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Duct Passes inlet node state variables to outlet node state variables

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

class pyidf.node.NodeList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object NodeList This object is used in places where lists of nodes may be needed, e.g. ZoneHVAC:EquipmentConnections field Zone Air Inlet Node or NodeList Name

add_extensible(node_1_name=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

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

class pyidf.node.OutdoorAirNode¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutdoorAir:Node This object sets the temperature and humidity conditions for an outdoor air node. It allows the height above ground to be specified. This object may be used more than once. The same node name may not appear in both an OutdoorAir:Node object and an OutdoorAir:NodeList object.

height_above_ground¶

field Height Above Ground

A value less than zero indicates that the height will be ignored and the weather file conditions will be used.
Units: m
Default value: -1.0

Parameters:	value (float) – value for IDD Field Height Above Ground
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of height_above_ground 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

class pyidf.node.OutdoorAirNodeList¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object OutdoorAir:NodeList This object sets the temperature and humidity conditions for an outdoor air node using the weather data values. to vary outdoor air node conditions with height above ground use OutdoorAir:Node instead of this object. This object may be used more than once. The same node name may not appear in both an OutdoorAir:Node object and an OutdoorAir:NodeList object.

add_extensible(node_or_nodelist_name_1=None)¶

Add values for extensible fields

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

extensibles¶: Get list of all extensibles

class pyidf.node.PipeAdiabatic¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pipe:Adiabatic Passes Inlet Node state variables to Outlet Node state variables

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

class pyidf.node.PipeAdiabaticSteam¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pipe:Adiabatic:Steam Passes Inlet Node state variables to Outlet Node state variables

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

class pyidf.node.PipeIndoor¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pipe:Indoor Pipe model with transport delay and heat transfer to the environment.

ambient_air_velocity_schedule_name¶

field Ambient Air Velocity Schedule Name

Parameters:	value (str) – value for IDD Field Ambient Air Velocity Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ambient_air_velocity_schedule_name 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

ambient_temperature_zone_name¶

field Ambient Temperature Zone Name

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

construction_name¶

field Construction Name

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

environment_type¶

field Environment Type

Default value: Zone

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

fluid_inlet_node_name¶

field Fluid Inlet Node Name

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

fluid_outlet_node_name¶

field Fluid Outlet Node Name

Parameters:	value (str) – value for IDD Field Fluid Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fluid_outlet_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

pipe_inside_diameter¶

field Pipe Inside Diameter

Units: m

IP-Units: in

Parameters:	value (float) – value for IDD Field Pipe Inside Diameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_inside_diameter or None if not set
Return type:	float

pipe_length¶

field Pipe Length

Units: m

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

class pyidf.node.PipeOutdoor¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pipe:Outdoor Pipe model with transport delay and heat transfer to the environment.

ambient_temperature_outdoor_air_node_name¶

field Ambient Temperature Outdoor Air Node Name

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

construction_name¶

field Construction Name

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

fluid_inlet_node_name¶

field Fluid Inlet Node Name

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

fluid_outlet_node_name¶

field Fluid Outlet Node Name

Parameters:	value (str) – value for IDD Field Fluid Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fluid_outlet_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

pipe_inside_diameter¶

field Pipe Inside Diameter

Units: m

IP-Units: in

Parameters:	value (float) – value for IDD Field Pipe Inside Diameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_inside_diameter or None if not set
Return type:	float

pipe_length¶

field Pipe Length

Units: m

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

class pyidf.node.PipeUnderground¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pipe:Underground Buried Pipe model: For pipes buried at a depth less than one meter, this is an alternative object to: HeatExchanger:Surface

construction_name¶

field Construction Name

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

fluid_inlet_node_name¶

field Fluid Inlet Node Name

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

fluid_outlet_node_name¶

field Fluid Outlet Node Name

Parameters:	value (str) – value for IDD Field Fluid Outlet Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fluid_outlet_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

pipe_inside_diameter¶

field Pipe Inside Diameter

pipe thickness is defined in the Construction object
Units: m
IP-Units: in

Parameters:	value (float) – value for IDD Field Pipe Inside Diameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_inside_diameter or None if not set
Return type:	float

pipe_length¶

field Pipe Length

Units: m

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

soil_material_name¶

field Soil Material Name

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

sun_exposure¶

field Sun Exposure

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

undisturbed_ground_temperature_model_name¶

field Undisturbed Ground Temperature Model Name

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

undisturbed_ground_temperature_model_type¶

field Undisturbed Ground Temperature Model Type

Parameters:	value (str) – value for IDD Field Undisturbed Ground Temperature Model Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of undisturbed_ground_temperature_model_type or None if not set
Return type:	str

class pyidf.node.PipingSystemUndergroundDomain¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PipingSystem:Underground:Domain The ground domain object for underground piping system simulation.

add_extensible(pipe_circuit_1=None)¶

Add values for extensible fields

Parameters:	pipe_circuit_1 (str) – value for IDD Field Pipe Circuit 1 if value is None it will not be checked against the specification and is assumed to be a missing value

convergence_criterion_for_the_outer_cartesian_domain_iteration_loop¶

field Convergence Criterion for the Outer Cartesian Domain Iteration Loop

Units: deltaC
Default value: 0.001
value >= 1e-06
value <= 0.5

Parameters:	value (float) – value for IDD Field Convergence Criterion for the Outer Cartesian Domain Iteration Loop
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of convergence_criterion_for_the_outer_cartesian_domain_iteration_loop or None if not set
Return type:	float

depth_of_basement_wall_in_ground_domain¶

field Depth of Basement Wall In Ground Domain

Required only if Domain Has Basement Interaction

Units: m

Parameters:	value (float) – value for IDD Field Depth of Basement Wall In Ground Domain
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of depth_of_basement_wall_in_ground_domain or None if not set
Return type:	float

evapotranspiration_ground_cover_parameter¶

field Evapotranspiration Ground Cover Parameter

This specifies the ground cover effects during evapotranspiration
calculations.  The value roughly represents the following cases:
= 0   : concrete or other solid, non-permeable ground surface material
= 0.5 : short grass, much like a manicured lawn
= 1   : standard reference state (12 cm grass)
= 1.5 : wild growth
Default value: 0.4
value <= 1.5

Parameters:	value (float) – value for IDD Field Evapotranspiration Ground Cover Parameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of evapotranspiration_ground_cover_parameter or None if not set
Return type:	float

extensibles¶: Get list of all extensibles

maximum_iterations_in_the_outer_cartesian_domain_iteration_loop¶

field Maximum Iterations in the Outer Cartesian Domain Iteration Loop

Default value: 500
value >= 3
value <= 10000

Parameters:	value (int) – value for IDD Field Maximum Iterations in the Outer Cartesian Domain Iteration Loop
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_iterations_in_the_outer_cartesian_domain_iteration_loop or None if not set
Return type:	int

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

name_of_basement_floor_boundary_condition_model¶

field Name of Basement Floor Boundary Condition Model

Required only if Domain Has Basement Interaction

Parameters:	value (str) – value for IDD Field Name of Basement Floor Boundary Condition Model
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name_of_basement_floor_boundary_condition_model or None if not set
Return type:	str

name_of_basement_wall_boundary_condition_model¶

field Name of Basement Wall Boundary Condition Model

Required only if Domain Has Basement Interaction

Parameters:	value (str) – value for IDD Field Name of Basement Wall Boundary Condition Model
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of name_of_basement_wall_boundary_condition_model or None if not set
Return type:	str

number_of_pipe_circuits_entered_for_this_domain¶

field Number of Pipe Circuits Entered for this Domain

value >= 1

Parameters:	value (int) – value for IDD Field Number of Pipe Circuits Entered for this Domain
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_pipe_circuits_entered_for_this_domain or None if not set
Return type:	int

shift_pipe_x_coordinates_by_basement_width¶

field Shift Pipe X Coordinates By Basement Width

Required only if Domain Has Basement Interaction

Parameters:	value (str) – value for IDD Field Shift Pipe X Coordinates By Basement Width
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of shift_pipe_x_coordinates_by_basement_width or None if not set
Return type:	str

soil_density¶

field Soil Density

Units: kg/m3

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

soil_moisture_content_volume_fraction¶

field Soil Moisture Content Volume Fraction

Units: percent
Default value: 30.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Soil Moisture Content Volume Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of soil_moisture_content_volume_fraction or None if not set
Return type:	float

soil_moisture_content_volume_fraction_at_saturation¶

field Soil Moisture Content Volume Fraction at Saturation

Units: percent
Default value: 50.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Soil Moisture Content Volume Fraction at Saturation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of soil_moisture_content_volume_fraction_at_saturation or None if not set
Return type:	float

soil_specific_heat¶

field Soil Specific Heat

This is a dry soil property, which is adjusted for freezing effects
by the simulation algorithm.
Units: J/kg-K

Parameters:	value (float) – value for IDD Field Soil Specific Heat
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of soil_specific_heat or None if not set
Return type:	float

soil_thermal_conductivity¶

field Soil Thermal Conductivity

Units: W/m-K

Parameters:	value (float) – value for IDD Field Soil Thermal Conductivity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of soil_thermal_conductivity or None if not set
Return type:	float

this_domain_includes_basement_surface_interaction¶

field This Domain Includes Basement Surface Interaction

if Yes, then the following basement inputs are used
if No, then the following basement inputs are ignored
Default value: No

Parameters:	value (str) – value for IDD Field This Domain Includes Basement Surface Interaction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of this_domain_includes_basement_surface_interaction or None if not set
Return type:	str

undisturbed_ground_temperature_model_name¶

field Undisturbed Ground Temperature Model Name

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

undisturbed_ground_temperature_model_type¶

field Undisturbed Ground Temperature Model Type

Parameters:	value (str) – value for IDD Field Undisturbed Ground Temperature Model Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of undisturbed_ground_temperature_model_type or None if not set
Return type:	str

width_of_basement_floor_in_ground_domain¶

field Width of Basement Floor in Ground Domain

Required only if Domain Has Basement Interaction

Units: m

Parameters:	value (float) – value for IDD Field Width of Basement Floor in Ground Domain
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of width_of_basement_floor_in_ground_domain or None if not set
Return type:	float

xdirection_geometric_coefficient¶

field X-Direction Geometric Coefficient

optional
Only used if mesh type is symmetric geometric
Default value: 1.3
value >= 1.0
value <= 2.0

Parameters:	value (float) – value for IDD Field X-Direction Geometric Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of xdirection_geometric_coefficient or None if not set
Return type:	float

xdirection_mesh_density_parameter¶

field X-Direction Mesh Density Parameter

If mesh type is symmetric geometric, this should be an even number.

Default value: 4

Parameters:	value (int) – value for IDD Field X-Direction Mesh Density Parameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of xdirection_mesh_density_parameter or None if not set
Return type:	int

xdirection_mesh_type¶

field X-Direction Mesh Type

Parameters:	value (str) – value for IDD Field X-Direction Mesh Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of xdirection_mesh_type or None if not set
Return type:	str

xmax¶

field Xmax

Domain extent in the local ‘X’ direction

Units: m

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

ydirection_geometric_coefficient¶

field Y-Direction Geometric Coefficient

optional
Only used if mesh type is symmetric geometric
Default value: 1.3
value >= 1.0
value <= 2.0

Parameters:	value (float) – value for IDD Field Y-Direction Geometric Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ydirection_geometric_coefficient or None if not set
Return type:	float

ydirection_mesh_density_parameter¶

field Y-Direction Mesh Density Parameter

If mesh type is symmetric geometric, this should be an even number.

Default value: 4

Parameters:	value (int) – value for IDD Field Y-Direction Mesh Density Parameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ydirection_mesh_density_parameter or None if not set
Return type:	int

ydirection_mesh_type¶

field Y-Direction Mesh Type

Parameters:	value (str) – value for IDD Field Y-Direction Mesh Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ydirection_mesh_type or None if not set
Return type:	str

ymax¶

field Ymax

Domain extent in the local ‘Y’ direction

Units: m

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

zdirection_geometric_coefficient¶

field Z-Direction Geometric Coefficient

optional
Only used if mesh type is symmetric geometric
Default value: 1.3
value >= 1.0
value <= 2.0

Parameters:	value (float) – value for IDD Field Z-Direction Geometric Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of zdirection_geometric_coefficient or None if not set
Return type:	float

zdirection_mesh_density_parameter¶

field Z-Direction Mesh Density Parameter

If mesh type is symmetric geometric, this should be an even number.

Default value: 4

Parameters:	value (int) – value for IDD Field Z-Direction Mesh Density Parameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of zdirection_mesh_density_parameter or None if not set
Return type:	int

zdirection_mesh_type¶

field Z-Direction Mesh Type

Parameters:	value (str) – value for IDD Field Z-Direction Mesh Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of zdirection_mesh_type or None if not set
Return type:	str

zmax¶

field Zmax

Domain extent in the local ‘Y’ direction

Units: m

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

class pyidf.node.PipingSystemUndergroundPipeCircuit¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PipingSystem:Underground:PipeCircuit The pipe circuit object in an underground piping system. This object is simulated within an underground piping domain object and connected on a branch on a plant loop.

add_extensible(pipe_segment_1=None)¶

Add values for extensible fields

Parameters:	pipe_segment_1 (str) – value for IDD Field Pipe Segment 1 if value is None it will not be checked against the specification and is assumed to be a missing value

circuit_inlet_node¶

field Circuit Inlet Node

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

circuit_outlet_node¶

field Circuit Outlet Node

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

convergence_criterion_for_the_inner_radial_iteration_loop¶

field Convergence Criterion for the Inner Radial Iteration Loop

Units: deltaC
Default value: 0.001
value >= 1e-06
value <= 0.5

Parameters:	value (float) – value for IDD Field Convergence Criterion for the Inner Radial Iteration Loop
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of convergence_criterion_for_the_inner_radial_iteration_loop or None if not set
Return type:	float

design_flow_rate¶

field Design Flow Rate

Units: m3/s

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

extensibles¶: Get list of all extensibles

maximum_iterations_in_the_inner_radial_iteration_loop¶

field Maximum Iterations in the Inner Radial Iteration Loop

Default value: 500
value >= 3
value <= 10000

Parameters:	value (int) – value for IDD Field Maximum Iterations in the Inner Radial Iteration Loop
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_iterations_in_the_inner_radial_iteration_loop or None if not set
Return type:	int

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

number_of_pipe_segments_entered_for_this_pipe_circuit¶

field Number of Pipe Segments Entered for this Pipe Circuit

value >= 1

Parameters:	value (int) – value for IDD Field Number of Pipe Segments Entered for this Pipe Circuit
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_pipe_segments_entered_for_this_pipe_circuit or None if not set
Return type:	int

number_of_soil_nodes_in_the_inner_radial_near_pipe_mesh_region¶

field Number of Soil Nodes in the Inner Radial Near Pipe Mesh Region

Default value: 3
value >= 1
value <= 15

Parameters:	value (int) – value for IDD Field Number of Soil Nodes in the Inner Radial Near Pipe Mesh Region
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of number_of_soil_nodes_in_the_inner_radial_near_pipe_mesh_region or None if not set
Return type:	int

pipe_density¶

field Pipe Density

Units: kg/m3

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

pipe_inner_diameter¶

field Pipe Inner Diameter

Units: m

Parameters:	value (float) – value for IDD Field Pipe Inner Diameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_inner_diameter or None if not set
Return type:	float

pipe_outer_diameter¶

field Pipe Outer Diameter

Units: m

Parameters:	value (float) – value for IDD Field Pipe Outer Diameter
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_outer_diameter or None if not set
Return type:	float

pipe_specific_heat¶

field Pipe Specific Heat

Units: J/kg-K

Parameters:	value (float) – value for IDD Field Pipe Specific Heat
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_specific_heat or None if not set
Return type:	float

pipe_thermal_conductivity¶

field Pipe Thermal Conductivity

Units: W/m-K

Parameters:	value (float) – value for IDD Field Pipe Thermal Conductivity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_thermal_conductivity or None if not set
Return type:	float

radial_thickness_of_inner_radial_near_pipe_mesh_region¶

field Radial Thickness of Inner Radial Near Pipe Mesh Region

Required because it must be selected by user instead of being

inferred from circuit/domain object inputs.

Parameters:	value (float) – value for IDD Field Radial Thickness of Inner Radial Near Pipe Mesh Region
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of radial_thickness_of_inner_radial_near_pipe_mesh_region or None if not set
Return type:	float

class pyidf.node.PipingSystemUndergroundPipeSegment¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object PipingSystem:Underground:PipeSegment The pipe segment to be used in an underground piping system This object represents a single pipe leg positioned axially in the local z-direction, at a given x, y location in the domain

flow_direction¶

field Flow Direction

This segment will be simulated such that the flow is in the
selected direction.  This can allow for detailed analysis
of circuiting effects in a single domain.

Parameters:	value (str) – value for IDD Field Flow Direction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of flow_direction 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

x_position¶

field X Position

This segment will be centered at this distance from the x=0
domain surface or the basement wall surface, based on whether
a basement exists in this domain and the selection of the
shift input field found in the domain object.
Units: m

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

y_position¶

field Y Position

This segment will be centered at this distance away from the
ground surface; thus this value represents the burial depth
of this pipe segment.
Units: m

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

pyidf.node module¶

Related Topics

This Page