Node-Branch Management¶

17 object types from idfpy.models.node_branch · EnergyPlus 26.2

Object	Summary
Branch	List components on the branch in simulation and connection order Note: this should NOT include splitters or …
BranchList	Branches MUST be listed in Flow order: Inlet branch, then parallel branches, then Outlet branch.
Connector:Mixer	Mix N inlet air/water streams into one.
Connector:Splitter	Split one air/water stream into N outlet streams.
ConnectorList	only two connectors allowed per loop if two entered, one must be Connector:Splitter and one must be …
Duct	Passes inlet node state variables to outlet node state variables
NodeList	This object is used in places where lists of nodes may be needed, e.g.
OutdoorAir:Node	This object sets the temperature and humidity conditions for an outdoor air node.
OutdoorAir:NodeList	This object sets the temperature and humidity conditions for an outdoor air node using the weather data …
Pipe:Adiabatic	Passes Inlet Node state variables to Outlet Node state variables
Pipe:Adiabatic:Steam	Passes Inlet Node state variables to Outlet Node state variables
Pipe:Indoor	Pipe model with transport delay and heat transfer to the environment.
Pipe:Outdoor	Pipe model with transport delay and heat transfer to the environment.
Pipe:Underground	Buried Pipe model: For pipes buried at a depth less than one meter, this is an alternative object to: …
PipingSystem:Underground:Domain	The ground domain object for underground piping system simulation.
PipingSystem:Underground:PipeCircuit	The pipe circuit object in an underground piping system.
PipingSystem:Underground:PipeSegment	The pipe segment to be used in an underground piping system This object represents a single pipe leg …

Branch¶

from idfpy.models import Branch extensible

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

Field	Type	Details
`name` Name required	string
`pressure_drop_curve_name` Pressure Drop Curve Name	reference	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}') Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`components`	list	Each item: `component_object_type`, `component_name`, `component_inlet_node_name`, `component_outlet_node_name`

Referenced by 3 object types

BranchList, Connector:Mixer, Connector:Splitter

BranchList¶

from idfpy.models import BranchList extensible

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.

Field	Type	Default	Details
`name` Name required	string
`branches`	list		Each item: `branch_name`

Referenced by 3 object types

AirLoopHVAC, CondenserLoop, PlantLoop

Connector:Mixer¶

from idfpy.models import ConnectorMixer extensible

Mix N inlet air/water streams into one. Branch names cannot be duplicated within a single mixer list.

Field	Type	Details
`name` Name required	string
`outlet_branch_name` Outlet Branch Name required	reference	Names a Branch
`branches`	list	Each item: `inlet_branch_name`

Referenced by 1 object types

ConnectorList

Connector:Splitter¶

from idfpy.models import ConnectorSplitter extensible

Split one air/water stream into N outlet streams. Branch names cannot be duplicated within a single Splitter list.

Field	Type	Details
`name` Name required	string
`inlet_branch_name` Inlet Branch Name required	reference	Names a Branch
`branches`	list	Each item: `outlet_branch_name`

Referenced by 1 object types

ConnectorList

ConnectorList¶

from idfpy.models import ConnectorList

only two connectors allowed per loop if two entered, one must be Connector:Splitter and one must be Connector:Mixer

Field	Type	Details
`name` Name required	string
`connector_1_object_type` Connector 1 Object Type required	choice	One of `Connector:Mixer`, `Connector:Splitter`
`connector_1_name` Connector 1 Name required	reference	Names a Connector:Mixer, Connector:Splitter
`connector_2_object_type` Connector 2 Object Type	choice	One of `Connector:Mixer`, `Connector:Splitter`
`connector_2_name` Connector 2 Name	reference	Names a Connector:Mixer, Connector:Splitter

Referenced by 3 object types

AirLoopHVAC, CondenserLoop, PlantLoop

Duct¶

from idfpy.models import Duct

Passes inlet node state variables to outlet node state variables

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

NodeList¶

from idfpy.models import NodeList extensible

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

Field	Type	Default	Details
`name` Name required	string
`nodes`	list		Each item: `node_name`

OutdoorAir:Node¶

from idfpy.models import OutdoorAirNode

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. This object defines local outdoor air environmental conditions.

Field	Type	Default	Details
`name` Name required	string
`height_above_ground` Height Above Ground	number m	`-1.0`	A value less than zero indicates that the height will be ignored and the weather file conditions will be used.
`drybulb_temperature_schedule_name` Drybulb Temperature Schedule Name	reference		Schedule values are real numbers, -100.0 to 100.0, units C Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`wetbulb_temperature_schedule_name` Wetbulb Temperature Schedule Name	reference		Schedule values are real numbers, -100.0 to 100.0, units C Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`wind_speed_schedule_name` Wind Speed Schedule Name	reference		Schedule values are real numbers, 0.0 to 40.0, units m/s Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`wind_direction_schedule_name` Wind Direction Schedule Name	reference		Schedule values are real numbers, 0.0 to 360.0, units degree Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`wind_pressure_coefficient_curve_name` Wind Pressure Coefficient Curve Name	reference		The name of the AirflowNetwork:MultiZone:WindPressureCoefficientValues, curve, or table object specifying the wind pressure coefficient. Names a AirflowNetwork:MultiZone:WindPressureCoefficientValues, Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2 and 2 more
`symmetric_wind_pressure_coefficient_curve` Symmetric Wind Pressure Coefficient Curve	choice	`No`	Specify whether the pressure curve is symmetric or not. Specify Yes for curves that should be evaluated from 0 to 180 degrees Specify No for curves that should be evaluated from 0 to 360 degrees One of `No`, `Yes`
`wind_angle_type` Wind Angle Type	choice	`Absolute`	Specify whether the angle used to compute the wind pressure coefficient is absolute or relative Specify Relative to compute the angle between the wind direction and the surface azimuth Specify Absolute to use the wind direction angle directly One of `Absolute`, `Relative`

Referenced by 5 object types

AirflowNetwork:MultiZone:Surface, HeatPump:AirToWater:FuelFired:Cooling, HeatPump:AirToWater:FuelFired:Heating, SurfaceProperty:LocalEnvironment, ZoneProperty:LocalEnvironment

OutdoorAir:NodeList¶

from idfpy.models import OutdoorAirNodeList extensible

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.

Field	Type	Default	Details
`nodes`	list		Each item: `node_or_nodelist_name`

Pipe:Adiabatic¶

from idfpy.models import PipeAdiabatic

Passes Inlet Node state variables to Outlet Node state variables

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

Pipe:Adiabatic:Steam¶

from idfpy.models import PipeAdiabaticSteam

Passes Inlet Node state variables to Outlet Node state variables

Field	Type	Default	Details
`name` Name required	string
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

Pipe:Indoor¶

from idfpy.models import PipeIndoor

Pipe model with transport delay and heat transfer to the environment.

Field	Type	Default	Details
`name` Name required	string
`construction_name` Construction Name required	reference		Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`fluid_inlet_node_name` Fluid Inlet Node Name required	string
`fluid_outlet_node_name` Fluid Outlet Node Name required	string
`environment_type` Environment Type	choice	`Zone`	One of `Schedule`, `Zone`
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Names a 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
`ambient_air_velocity_schedule_name` Ambient Air Velocity 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
`pipe_inside_diameter` Pipe Inside Diameter	number m		Range: > 0
`pipe_length` Pipe Length	number m		Range: > 0

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

Pipe:Outdoor¶

from idfpy.models import PipeOutdoor

Pipe model with transport delay and heat transfer to the environment.

Field	Type	Details
`name` Name required	string
`construction_name` Construction Name required	reference	Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`fluid_inlet_node_name` Fluid Inlet Node Name required	string
`fluid_outlet_node_name` Fluid Outlet Node Name required	string
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string
`pipe_inside_diameter` Pipe Inside Diameter	number m	Range: > 0
`pipe_length` Pipe Length	number m	Range: > 0

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

Pipe:Underground¶

from idfpy.models import PipeUnderground

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

Field	Type	Details
`name` Name required	string
`construction_name` Construction Name required	reference	Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer
`fluid_inlet_node_name` Fluid Inlet Node Name required	string
`fluid_outlet_node_name` Fluid Outlet Node Name required	string
`sun_exposure` Sun Exposure required	choice	One of `NoSun`, `SunExposed`
`pipe_inside_diameter` Pipe Inside Diameter	number m	pipe thickness is defined in the Construction object Range: > 0
`pipe_length` Pipe Length	number m	Range: > 0
`soil_material_name` Soil Material Name required	string
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice	One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference	Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

PipingSystem:Underground:Domain¶

from idfpy.models import PipingSystemUndergroundDomain extensible

The ground domain object for underground piping system simulation.

Field	Type	Default	Details
`name` Name required	string
`xmax` Xmax required	number m		Domain extent in the local 'X' direction Range: > 0
`ymax` Ymax required	number m		Domain extent in the local 'Y' direction Range: > 0
`zmax` Zmax required	number m		Domain extent in the local 'Y' direction Range: > 0
`x_direction_mesh_density_parameter` X-Direction Mesh Density Parameter	integer	`4`	If mesh type is symmetric geometric, this should be an even number. Range: > 0
`x_direction_mesh_type` X-Direction Mesh Type required	choice		One of `SymmetricGeometric`, `Uniform`
`x_direction_geometric_coefficient` X-Direction Geometric Coefficient	number	`1.3`	optional Only used if mesh type is symmetric geometric Range: ≥ 1, ≤ 2
`y_direction_mesh_density_parameter` Y-Direction Mesh Density Parameter	integer	`4`	If mesh type is symmetric geometric, this should be an even number. Range: > 0
`y_direction_mesh_type` Y-Direction Mesh Type required	choice		One of `SymmetricGeometric`, `Uniform`
`y_direction_geometric_coefficient` Y-Direction Geometric Coefficient	number	`1.3`	optional Only used if mesh type is symmetric geometric Range: ≥ 1, ≤ 2
`z_direction_mesh_density_parameter` Z-Direction Mesh Density Parameter	integer	`4`	If mesh type is symmetric geometric, this should be an even number. Range: > 0
`z_direction_mesh_type` Z-Direction Mesh Type required	choice		One of `SymmetricGeometric`, `Uniform`
`z_direction_geometric_coefficient` Z-Direction Geometric Coefficient	number	`1.3`	optional Only used if mesh type is symmetric geometric Range: ≥ 1, ≤ 2
`soil_thermal_conductivity` Soil Thermal Conductivity required	number W/m-K		Range: > 0
`soil_density` Soil Density required	number kg/m3		Range: > 0
`soil_specific_heat` Soil Specific Heat required	number J/kg-K		This is a dry soil property, which is adjusted for freezing effects by the simulation algorithm. Range: > 0
`soil_moisture_content_volume_fraction` Soil Moisture Content Volume Fraction	number percent	`30.0`	Range: ≥ 0, ≤ 100
`soil_moisture_content_volume_fraction_at_saturation` Soil Moisture Content Volume Fraction at Saturation	number percent	`50.0`	Range: ≥ 0, ≤ 100
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice		One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference		Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing
`this_domain_includes_basement_surface_interaction` This Domain Includes Basement Surface Interaction	choice	`No`	if Yes, then the following basement inputs are used if No, then the following basement inputs are ignored One of `No`, `Yes`
`width_of_basement_floor_in_ground_domain` Width of Basement Floor in Ground Domain	number m		Required only if Domain Has Basement Interaction
`depth_of_basement_wall_in_ground_domain` Depth of Basement Wall In Ground Domain	number m		Required only if Domain Has Basement Interaction
`shift_pipe_x_coordinates_by_basement_width` Shift Pipe X Coordinates By Basement Width	choice		Required only if Domain Has Basement Interaction One of `No`, `Yes`
`name_of_basement_wall_boundary_condition_model` Name of Basement Wall Boundary Condition Model	reference		Required only if Domain Has Basement Interaction Names a SurfaceProperty:OtherSideConditionsModel
`name_of_basement_floor_boundary_condition_model` Name of Basement Floor Boundary Condition Model	reference		Required only if Domain Has Basement Interaction Names a SurfaceProperty:OtherSideConditionsModel
`convergence_criterion_for_the_outer_cartesian_domain_iteration_loop` Convergence Criterion for the Outer Cartesian Domain Iteration Loop	number deltaC	`0.001`	Range: ≥ 1e-06, ≤ 0.5
`maximum_iterations_in_the_outer_cartesian_domain_iteration_loop` Maximum Iterations in the Outer Cartesian Domain Iteration Loop	integer	`500`	Range: ≥ 3, ≤ 10000
`evapotranspiration_ground_cover_parameter` Evapotranspiration Ground Cover Parameter	number	`0.4`	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 Range: ≥ 0, ≤ 1.5
`number_of_pipe_circuits_entered_for_this_domain` Number of Pipe Circuits Entered for this Domain required	integer		Range: ≥ 1
`pipe_circuits`	list		Each item: `pipe_circuit`

PipingSystem:Underground:PipeCircuit¶

from idfpy.models import PipingSystemUndergroundPipeCircuit extensible

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.

Field	Type	Default	Details
`name` Name required	string
`pipe_thermal_conductivity` Pipe Thermal Conductivity required	number W/m-K		Range: > 0
`pipe_density` Pipe Density required	number kg/m3		Range: > 0
`pipe_specific_heat` Pipe Specific Heat required	number J/kg-K		Range: > 0
`pipe_inner_diameter` Pipe Inner Diameter required	number m		Range: > 0
`pipe_outer_diameter` Pipe Outer Diameter required	number m		Range: > 0
`design_flow_rate` Design Flow Rate required	number m3/s		Range: > 0
`circuit_inlet_node` Circuit Inlet Node required	string
`circuit_outlet_node` Circuit Outlet Node required	string
`convergence_criterion_for_the_inner_radial_iteration_loop` Convergence Criterion for the Inner Radial Iteration Loop	number deltaC	`0.001`	Range: ≥ 1e-06, ≤ 0.5
`maximum_iterations_in_the_inner_radial_iteration_loop` Maximum Iterations in the Inner Radial Iteration Loop	integer	`500`	Range: ≥ 3, ≤ 10000
`number_of_soil_nodes_in_the_inner_radial_near_pipe_mesh_region` Number of Soil Nodes in the Inner Radial Near Pipe Mesh Region	integer	`3`	Range: ≥ 1, ≤ 15
`radial_thickness_of_inner_radial_near_pipe_mesh_region` Radial Thickness of Inner Radial Near Pipe Mesh Region required	number		Required because it must be selected by user instead of being inferred from circuit/domain object inputs. Range: > 0
`number_of_pipe_segments_entered_for_this_pipe_circuit` Number of Pipe Segments Entered for this Pipe Circuit required	integer		Range: ≥ 1
`pipe_segments`	list		Each item: `pipe_segment`

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PipingSystem:Underground:Domain, PlantEquipmentList

PipingSystem:Underground:PipeSegment¶

from idfpy.models import PipingSystemUndergroundPipeSegment

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

Field	Type	Details
`name` Name required	string
`x_position` X Position required	number m	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. Range: > 0
`y_position` Y Position required	number m	This segment will be centered at this distance away from the ground surface; thus this value represents the burial depth of this pipe segment. Range: > 0
`flow_direction` Flow Direction required	choice	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. One of `DecreasingZ`, `IncreasingZ`

Referenced by 1 object types

PipingSystem:Underground:PipeCircuit