pyidf.solar_collectors module

Data objects in group “Solar Collectors”

class pyidf.solar_collectors.SolarCollectorFlatPlatePhotovoltaicThermal

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollector:FlatPlate:PhotovoltaicThermal Models hybrid photovoltaic-thermal (PVT) solar collectors that convert incident solar energy into both electricity and useful thermal energy by heating air or water.

air_inlet_node_name

field Air Inlet Node Name

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

air_outlet_node_name

field Air Outlet Node Name

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

design_flow_rate

field Design Flow Rate

Units: m3/s

Parameters:value (float or “Autosize”) – 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 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

photovoltaic_name

field Photovoltaic Name

Enter the name of a Generator:Photovoltaic object.

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

photovoltaicthermal_model_performance_name

field Photovoltaic-Thermal Model Performance Name

Parameters:value (str) – value for IDD Field Photovoltaic-Thermal Model Performance Name Raises:ValueError – if value is not a valid value Returns:the value of photovoltaicthermal_model_performance_name or None if not set Return type:str

surface_name

field Surface Name

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

thermal_working_fluid_type

field Thermal Working Fluid Type

Parameters:value (str) – value for IDD Field Thermal Working Fluid Type Raises:ValueError – if value is not a valid value Returns:the value of thermal_working_fluid_type or None if not set Return type:str

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.solar_collectors.SolarCollectorFlatPlateWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollector:FlatPlate:Water Flat plate water solar collector (single glazed, unglazed, or evacuated tube). Thermal and optical properties are taken from the referenced SolarCollectorPerformance:FlatPlate object. Collector tilt, azimuth, and gross area are taken from the referenced building surface or shading surface. The collector surface participates normally in all shading calculations.

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

maximum_flow_rate

field Maximum Flow Rate

Units: m3/s

Parameters:value (float) – 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

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

solarcollectorperformance_name

field SolarCollectorPerformance Name

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

surface_name

field Surface Name

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

class pyidf.solar_collectors.SolarCollectorIntegralCollectorStorage

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollector:IntegralCollectorStorage Glazed solar collector with integral storage unit. Thermal and optical properties are taken from the referenced SolarCollectorPerformance:IntegralCollectorStorage object. Collector tilt, azimuth, and gross area are taken from the referenced building surface or shading surface. The collector surface participates normally in all shading calculations.

bottom_surface_boundary_conditions_type

field Bottom Surface Boundary Conditions Type

Default value: AmbientAir

Parameters:value (str) – value for IDD Field Bottom Surface Boundary Conditions Type Raises:ValueError – if value is not a valid value Returns:the value of bottom_surface_boundary_conditions_type or None if not set Return type:str

boundary_condition_model_name

field Boundary Condition Model Name

Enter the name of a SurfaceProperty:OtherSideConditionsModel

object. Specified only if the boundary condition type is

OtherSideConditionsModel, otherwise leave it blank

Parameters:value (str) – value for IDD Field Boundary Condition Model Name Raises:ValueError – if value is not a valid value Returns:the value of boundary_condition_model_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

integralcollectorstorageparameters_name

field IntegralCollectorStorageParameters Name

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

maximum_flow_rate

field Maximum Flow Rate

Units: m3/s

Parameters:value (float) – 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

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

surface_name

field Surface Name

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

class pyidf.solar_collectors.SolarCollectorPerformanceFlatPlate

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollectorPerformance:FlatPlate Thermal and optical performance parameters for a single flat plate solar collector module. These parameters are based on the testing methodologies described in ASHRAE Standards 93 and 96 which are used Solar Rating and Certification Corporation (SRCC) Directory of SRCC Certified Solar Collector Ratings. See EnergyPlus DataSets file SolarCollectors.idf.

coefficient_1_of_efficiency_equation

field Coefficient 1 of Efficiency Equation

Y-intercept term

Units: dimensionless

Parameters:value (float) – value for IDD Field Coefficient 1 of Efficiency Equation Raises:ValueError – if value is not a valid value Returns:the value of coefficient_1_of_efficiency_equation or None if not set Return type:float

coefficient_2_of_efficiency_equation

field Coefficient 2 of Efficiency Equation

1st Order term

Units: W/m2-K

Parameters:value (float) – value for IDD Field Coefficient 2 of Efficiency Equation Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_efficiency_equation or None if not set Return type:float

coefficient_2_of_incident_angle_modifier

field Coefficient 2 of Incident Angle Modifier

1st order term

Parameters:value (float) – value for IDD Field Coefficient 2 of Incident Angle Modifier Raises:ValueError – if value is not a valid value Returns:the value of coefficient_2_of_incident_angle_modifier or None if not set Return type:float

coefficient_3_of_efficiency_equation

field Coefficient 3 of Efficiency Equation

2nd order term

Units: W/m2-K2

Parameters:value (float) – value for IDD Field Coefficient 3 of Efficiency Equation Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_efficiency_equation or None if not set Return type:float

coefficient_3_of_incident_angle_modifier

field Coefficient 3 of Incident Angle Modifier

2nd order term

Parameters:value (float) – value for IDD Field Coefficient 3 of Incident Angle Modifier Raises:ValueError – if value is not a valid value Returns:the value of coefficient_3_of_incident_angle_modifier or None if not set Return type:float

gross_area

field Gross Area

Units: m2

Parameters:value (float) – value for IDD Field Gross Area Raises:ValueError – if value is not a valid value Returns:the value of gross_area 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

test_correlation_type

field Test Correlation Type

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

test_flow_rate

field Test Flow Rate

Units: m3/s

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

test_fluid

field Test Fluid

Default value: Water

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

class pyidf.solar_collectors.SolarCollectorPerformanceIntegralCollectorStorage

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollectorPerformance:IntegralCollectorStorage Thermal and optical performance parameters for a single glazed solar collector with integral storage unit.

absorptance_of_absorber_plate

field Absorptance of Absorber Plate

The absorber plate solar absorptance. Copper is assumed as

the default absorber plate.

Units: dimensionless

Default value: 0.96

value < 1.0

Parameters:value (float) – value for IDD Field Absorptance of Absorber Plate Raises:ValueError – if value is not a valid value Returns:the value of absorptance_of_absorber_plate or None if not set Return type:float

aspect_ratio

field Aspect Ratio

This value is ratio of the width (short side) to length

(long side of) of the collector. Used to calculate the

perimeter of the collector

Units: m

Default value: 0.8

value > 0.5

value < 1.0

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

bottom_heat_loss_conductance

field Bottom Heat Loss Conductance

Heat loss conductance of the collector bottom insulation

Units: W/m2-K

Default value: 0.4

Parameters:value (float) – value for IDD Field Bottom Heat Loss Conductance Raises:ValueError – if value is not a valid value Returns:the value of bottom_heat_loss_conductance or None if not set Return type:float

collector_side_height

field Collector Side Height

This value is used to estimate collector side area for the heat

loss calculation through the collector side

Units: m

Default value: 0.2

value < 0.3

Parameters:value (float) – value for IDD Field Collector Side Height Raises:ValueError – if value is not a valid value Returns:the value of collector_side_height or None if not set Return type:float

collector_water_volume

field Collector Water Volume

Units: m3

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

cover_spacing

field Cover Spacing

The gap between the transparent covers and between the inner cover

and the absorber plate

Units: m

Default value: 0.05

value <= 0.2

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

emissivity_of_absorber_plate

field Emissivity of Absorber Plate

Thermal emissivity of the absorber plate

Units: dimensionless

Default value: 0.3

value < 1.0

Parameters:value (float) – value for IDD Field Emissivity of Absorber Plate Raises:ValueError – if value is not a valid value Returns:the value of emissivity_of_absorber_plate or None if not set Return type:float

emissivity_of_inner_cover

field Emissivity of Inner Cover

Thermal emissivity of the inner cover material

Units: dimensionless

Default value: 0.88

value < 1.0

Parameters:value (float) – value for IDD Field Emissivity of Inner Cover Raises:ValueError – if value is not a valid value Returns:the value of emissivity_of_inner_cover or None if not set Return type:float

emissivity_of_outer_cover

field Emissivity of Outer Cover

Thermal emissivity of the outer cover, commonly glass is used as

the out collector cover material.

Units: dimensionless

Default value: 0.88

value < 1.0

Parameters:value (float) – value for IDD Field Emissivity of Outer Cover Raises:ValueError – if value is not a valid value Returns:the value of emissivity_of_outer_cover or None if not set Return type:float

extinction_coefficient_times_thickness_of_outer_cover

field Extinction Coefficient Times Thickness of Outer Cover

Clear glass has extinction coefficient of about 15 [1/m]

and with thickness of 3.0mm, the product of the extinction

coefficient and thickness becomes 0.045 (=15 * 0.003)

Units: dimensionless

Default value: 0.045

Parameters:value (float) – value for IDD Field Extinction Coefficient Times Thickness of Outer Cover Raises:ValueError – if value is not a valid value Returns:the value of extinction_coefficient_times_thickness_of_outer_cover or None if not set Return type:float

extinction_coefficient_times_thickness_of_the_inner_cover

field Extinction Coefficient Times Thickness of the inner Cover

Default inner cover is very thin sheet of Teflon with

extinction coefficient of approximately 40.0 and a thickness

0.2mm yields a default value of 0.008.

Units: dimensionless

Default value: 0.008

Parameters:value (float) – value for IDD Field Extinction Coefficient Times Thickness of the inner Cover Raises:ValueError – if value is not a valid value Returns:the value of extinction_coefficient_times_thickness_of_the_inner_cover or None if not set Return type:float

gross_area

field Gross Area

Units: m2

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

ics_collector_type

field ICS Collector Type

Currently only RectangularTank ICS collector type is available.

Parameters:value (str) – value for IDD Field ICS Collector Type Raises:ValueError – if value is not a valid value Returns:the value of ics_collector_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

number_of_covers

field Number of Covers

Number of transparent covers. Common practice is to use low-iron

glass as the outer cover and very thin transparent sheet such as

Teflon as the inner cover.

Default value: 2

value >= 1

value <= 2

Parameters:value (int) – value for IDD Field Number of Covers Raises:ValueError – if value is not a valid value Returns:the value of number_of_covers or None if not set Return type:int

refractive_index_of_inner_cover

field Refractive Index of Inner Cover

Typical material is very thin sheet of Teflon (PTFE). The default

value is refractive index of Teflon.

Units: dimensionless

Default value: 1.37

value >= 1.0

value <= 2.0

Parameters:value (float) – value for IDD Field Refractive Index of Inner Cover Raises:ValueError – if value is not a valid value Returns:the value of refractive_index_of_inner_cover or None if not set Return type:float

refractive_index_of_outer_cover

field Refractive Index of Outer Cover

Refractive index of outer cover. Typically low-iron glass is used

as the outer cover material, and used as the default outer cover

with a value of 1.526.

Units: dimensionless

Default value: 1.526

value >= 1.0

value <= 2.0

Parameters:value (float) – value for IDD Field Refractive Index of Outer Cover Raises:ValueError – if value is not a valid value Returns:the value of refractive_index_of_outer_cover or None if not set Return type:float

side_heat_loss_conductance

field Side Heat Loss Conductance

heat loss conductance of the collector side insulation

Units: W/m2-K

Default value: 0.6

Parameters:value (float) – value for IDD Field Side Heat Loss Conductance Raises:ValueError – if value is not a valid value Returns:the value of side_heat_loss_conductance or None if not set Return type:float

thermal_mass_of_absorber_plate

field Thermal Mass of Absorber Plate

Calculated from the specific heat, density and thickness

of the absorber plate.

Units: J/m2-K

Parameters:value (float) – value for IDD Field Thermal Mass of Absorber Plate Raises:ValueError – if value is not a valid value Returns:the value of thermal_mass_of_absorber_plate or None if not set Return type:float

class pyidf.solar_collectors.SolarCollectorPerformancePhotovoltaicThermalSimple

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollectorPerformance:PhotovoltaicThermal:Simple Thermal performance parameters for a hybrid photovoltaic-thermal (PVT) solar collector.

fraction_of_surface_area_with_active_thermal_collector

field Fraction of Surface Area with Active Thermal Collector

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Surface Area with Active Thermal Collector Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_surface_area_with_active_thermal_collector or None if not set Return type:float

front_surface_emittance

field Front Surface Emittance

Default value: 0.84

value < 1.0

Parameters:value (float) – value for IDD Field Front Surface Emittance Raises:ValueError – if value is not a valid value Returns:the value of front_surface_emittance 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

thermal_conversion_efficiency_input_mode_type

field Thermal Conversion Efficiency Input Mode Type

Parameters:value (str) – value for IDD Field Thermal Conversion Efficiency Input Mode Type Raises:ValueError – if value is not a valid value Returns:the value of thermal_conversion_efficiency_input_mode_type or None if not set Return type:str

thermal_conversion_efficiency_schedule_name

field Thermal Conversion Efficiency Schedule Name

Parameters:value (str) – value for IDD Field Thermal Conversion Efficiency Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of thermal_conversion_efficiency_schedule_name or None if not set Return type:str

value_for_thermal_conversion_efficiency_if_fixed

field Value for Thermal Conversion Efficiency if Fixed

Efficiency = (thermal power generated [W])/(incident solar[W])

value <= 1.0

Parameters:value (float) – value for IDD Field Value for Thermal Conversion Efficiency if Fixed Raises:ValueError – if value is not a valid value Returns:the value of value_for_thermal_conversion_efficiency_if_fixed or None if not set Return type:float

class pyidf.solar_collectors.SolarCollectorUnglazedTranspired

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollector:UnglazedTranspired Unglazed transpired solar collector (UTSC) used to condition outdoor air. This type of collector is generally used to heat air drawn through perforated absorbers and also recover heat conducted out through the underlying surface. This object represents a single collector attached to one or more building or shading surfaces and to one or more outdoor air systems.

add_extensible(surface_1_name=None)

Add values for extensible fields

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

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this collector. Schedule value > 0 means it is available.

If this field is blank, the collector is always available.

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

boundary_conditions_model_name

field Boundary Conditions Model Name

Enter the name of a SurfaceProperty:OtherSideConditionsModel object

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

collector_thickness

field Collector Thickness

Collector thickness is not required for Kutscher correlation

Collector thickness is required for Van Decker et al. correlation

Units: m

value >= 0.0005

value <= 0.007

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

diameter_of_perforations_in_collector

field Diameter of Perforations in Collector

Units: m

Parameters:value (float) – value for IDD Field Diameter of Perforations in Collector Raises:ValueError – if value is not a valid value Returns:the value of diameter_of_perforations_in_collector or None if not set Return type:float

discharge_coefficient_for_openings_with_respect_to_buoyancy_driven_flow

field Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow

Cd

Units: dimensionless

Default value: 0.65

value <= 1.5

Parameters:value (float) – value for IDD Field Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow Raises:ValueError – if value is not a valid value Returns:the value of discharge_coefficient_for_openings_with_respect_to_buoyancy_driven_flow or None if not set Return type:float

distance_between_perforations_in_collector

field Distance Between Perforations in Collector

Units: m

Parameters:value (float) – value for IDD Field Distance Between Perforations in Collector Raises:ValueError – if value is not a valid value Returns:the value of distance_between_perforations_in_collector or None if not set Return type:float

effective_cross_section_area_of_plenum_behind_collector

field Effective Cross Section Area of Plenum Behind Collector

if corrugated, use average depth

Units: m2

Parameters:value (float) – value for IDD Field Effective Cross Section Area of Plenum Behind Collector Raises:ValueError – if value is not a valid value Returns:the value of effective_cross_section_area_of_plenum_behind_collector or None if not set Return type:float

effective_gap_thickness_of_plenum_behind_collector

field Effective Gap Thickness of Plenum Behind Collector

if corrugated, use average depth

Units: m

Parameters:value (float) – value for IDD Field Effective Gap Thickness of Plenum Behind Collector Raises:ValueError – if value is not a valid value Returns:the value of effective_gap_thickness_of_plenum_behind_collector or None if not set Return type:float

effective_overall_height_of_collector

field Effective Overall Height of Collector

Parameters:value (float) – value for IDD Field Effective Overall Height of Collector Raises:ValueError – if value is not a valid value Returns:the value of effective_overall_height_of_collector or None if not set Return type:float

effectiveness_for_perforations_with_respect_to_wind

field Effectiveness for Perforations with Respect to Wind

Cv

Units: dimensionless

Default value: 0.25

value <= 1.5

Parameters:value (float) – value for IDD Field Effectiveness for Perforations with Respect to Wind Raises:ValueError – if value is not a valid value Returns:the value of effectiveness_for_perforations_with_respect_to_wind or None if not set Return type:float

extensibles

Get list of all extensibles

free_heating_setpoint_schedule_name

field Free Heating Setpoint Schedule Name

Parameters:value (str) – value for IDD Field Free Heating Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of free_heating_setpoint_schedule_name or None if not set Return type:str

heat_exchange_effectiveness_correlation

field Heat Exchange Effectiveness Correlation

Default value: Kutscher1994

Parameters:value (str) – value for IDD Field Heat Exchange Effectiveness Correlation Raises:ValueError – if value is not a valid value Returns:the value of heat_exchange_effectiveness_correlation or None if not set Return type:str

hole_layout_pattern_for_pitch

field Hole Layout Pattern for Pitch

Default value: Square

Parameters:value (str) – value for IDD Field Hole Layout Pattern for Pitch Raises:ValueError – if value is not a valid value Returns:the value of hole_layout_pattern_for_pitch or None if not set Return type:str

inlet_node_name

field Inlet Node Name

required field if no SolarCollector:UnglazedTranspired:Multisystem

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

required field if no SolarCollector:UnglazedTranspired:Multisystem

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

ratio_of_actual_collector_surface_area_to_projected_surface_area

field Ratio of Actual Collector Surface Area to Projected Surface Area

This parameter is used to help account for corrugations in the collector

Units: dimensionless

Default value: 1.0

value >= 1.0

value <= 2.0

Parameters:value (float) – value for IDD Field Ratio of Actual Collector Surface Area to Projected Surface Area Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_actual_collector_surface_area_to_projected_surface_area or None if not set Return type:float

roughness_of_collector

field Roughness of Collector

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

setpoint_node_name

field Setpoint Node Name

This node is where the mixed air setpoint is determined.

required field if no SolarCollector:UnglazedTranspired:Multisystem

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

solar_absorbtivity_of_collector_surface

field Solar Absorbtivity of Collector Surface

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Solar Absorbtivity of Collector Surface Raises:ValueError – if value is not a valid value Returns:the value of solar_absorbtivity_of_collector_surface or None if not set Return type:float

thermal_emissivity_of_collector_surface

field Thermal Emissivity of Collector Surface

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Thermal Emissivity of Collector Surface Raises:ValueError – if value is not a valid value Returns:the value of thermal_emissivity_of_collector_surface or None if not set Return type:float

zone_node_name

field Zone Node Name

This node is used to identify the affected zone

required field if no SolarCollector:UnglazedTranspired:Multisystem

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

class pyidf.solar_collectors.SolarCollectorUnglazedTranspiredMultisystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object SolarCollector:UnglazedTranspired:Multisystem quad-tuples of inlet, outlet, control, and zone nodes for multiple different outdoor air systems attached to same collector

add_extensible(outdoor_air_system_1_collector_inlet_node=None, outdoor_air_system_1_collector_outlet_node=None, outdoor_air_system_1_mixed_air_node=None, outdoor_air_system_1_zone_node=None)

Add values for extensible fields

Parameters:

• outdoor_air_system_1_collector_inlet_node (str) – value for IDD Field Outdoor Air System 1 Collector Inlet Node if value is None it will not be checked against the specification and is assumed to be a missing value
• outdoor_air_system_1_collector_outlet_node (str) – value for IDD Field Outdoor Air System 1 Collector Outlet Node if value is None it will not be checked against the specification and is assumed to be a missing value
• outdoor_air_system_1_mixed_air_node (str) – value for IDD Field Outdoor Air System 1 Mixed Air Node if value is None it will not be checked against the specification and is assumed to be a missing value
• outdoor_air_system_1_zone_node (str) – value for IDD Field Outdoor Air System 1 Zone Node 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

solar_collector_name

field Solar Collector Name

Enter the name of a SolarCollector:UnglazedTranspired object.

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