EnergyPlus epJSON Input Schema¶

The EnergyPlus input syntax is changing from IDD/IDF to epJSON. A schema is currently autogenerated from the IDD but will eventually become the fundamental input schema. The schema objects are described here.

840 objects in all.

Simulation Parameters¶

Version¶

Specifies the EnergyPlus version of the IDF file.

Fields
- version_identifier [string] (Current Version)

SimulationControl¶

Note that the following 3 fields are related to the Sizing:Zone, Sizing:System, and Sizing:Plant objects. Having these fields set to Yes but no corresponding Sizing object will not cause the sizing to be done. However, having any of these fields set to No, the corresponding Sizing object is ignored. Note also, if you want to do system sizing, you must also do zone sizing in the same run or an error will result.

Fields
- do_zone_sizing_calculation [string] (Default: No)
- do_system_sizing_calculation [string] (Default: No)
- do_plant_sizing_calculation [string] (Default: No)
- run_simulation_for_sizing_periods [string] (Default: Yes)
- run_simulation_for_weather_file_run_periods [string] (Default: Yes)
- do_hvac_sizing_simulation_for_sizing_periods [string] (Default: No)
- maximum_number_of_hvac_sizing_simulation_passes [integer] (Default: 1)

PerformancePrecisionTradeoffs¶

This object enables users to choose certain options that speed up EnergyPlus simulation, but may lead to small decreases in accuracy of results.

Fields
- use_coil_direct_solutions [string] (Default: No)
- zone_radiant_exchange_algorithm [string] (Default: ScriptF)
- override_mode [string] (Default: Normal)
- maxzonetempdiff [number] (Default: 0.3)
- maxalloweddeltemp [number] (Default: 0.002)
- use_representative_surfaces_for_calculations [string] (Default: No)

Building¶

Describes parameters that are used during the simulation of the building. There are necessary correlations between the entries for this object and some entries in the Site:WeatherStation and Site:HeightVariation objects, specifically the Terrain field.

Fields
- north_axis [number] (Default: 0.0)
- terrain [string] (Default: Suburbs)
- loads_convergence_tolerance_value [number] (Default: 0.04)
- temperature_convergence_tolerance_value [number] (Default: 0.4)
- solar_distribution [string] (Default: FullExterior)
- maximum_number_of_warmup_days [integer] (Default: 25)
- minimum_number_of_warmup_days [integer] (Default: 1)

ShadowCalculation¶

This object is used to control details of the solar, shading, and daylighting models

Fields
- shading_calculation_method [string] (Default: PolygonClipping)
- shading_calculation_update_frequency_method [string] (Default: Periodic)
- shading_calculation_update_frequency [integer] (Default: 20)
- maximum_figures_in_shadow_overlap_calculations [integer] (Default: 15000)
- polygon_clipping_algorithm [string] (Default: SutherlandHodgman)
- pixel_counting_resolution [integer] (Default: 512)
- sky_diffuse_modeling_algorithm [string] (Default: SimpleSkyDiffuseModeling)
- output_external_shading_calculation_results [string] (Default: No)
- disable_self_shading_within_shading_zone_groups [string] (Default: No)
- disable_self_shading_from_shading_zone_groups_to_other_zones [string] (Default: No)
- shading_zone_groups [Array of {shading_zone_group_zonelist_name}]

SurfaceConvectionAlgorithm:Inside¶

Default indoor surface heat transfer convection algorithm to be used for all zones

Fields
- algorithm [string] (Default: TARP)

SurfaceConvectionAlgorithm:Outside¶

Default outside surface heat transfer convection algorithm to be used for all zones

Fields
- algorithm [string] (Default: DOE-2)

HeatBalanceAlgorithm¶

Determines which Heat Balance Algorithm will be used ie. CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: ConductionFiniteDifferenceSimplified Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

Fields
- algorithm [string] (Default: ConductionTransferFunction)
- surface_temperature_upper_limit [number] (Default: 200.0)
- minimum_surface_convection_heat_transfer_coefficient_value [number] (Default: 0.1)
- maximum_surface_convection_heat_transfer_coefficient_value [number] (Default: 1000.0)

HeatBalanceSettings:ConductionFiniteDifference¶

Determines settings for the Conduction Finite Difference algorithm for surface heat transfer modeling.

Fields
- difference_scheme [string] (Default: FullyImplicitFirstOrder)
- space_discretization_constant [number] (Default: 3.0)
- relaxation_factor [number] (Default: 1.0)
- inside_face_surface_temperature_convergence_criteria [number] (Default: 0.002)

ZoneAirHeatBalanceAlgorithm¶

Controls the zone/space air heat balance.

Fields
- algorithm [string] (Default: ThirdOrderBackwardDifference)
- do_space_heat_balance_for_sizing [string] (Default: No)
- do_space_heat_balance_for_simulation [string] (Default: No)

ZoneAirContaminantBalance¶

Determines which contaminant concentration will be simulates.

Fields
- carbon_dioxide_concentration [string] (Default: No)
- outdoor_carbon_dioxide_schedule_name [string]
- generic_contaminant_concentration [string] (Default: No)
- outdoor_generic_contaminant_schedule_name [string]

ZoneAirMassFlowConservation¶

Enforces the zone air mass flow balance by either adjusting zone mixing object flow only, adjusting zone total return flow only, zone mixing and the zone total return flows, or adjusting the zone total return and zone mixing object flows. Zone infiltration flow air flow is increased or decreased depending user selection in the infiltration treatment method. If either of zone mixing or zone return flow adjusting methods or infiltration is active, then the zone air mass flow balance calculation will attempt to enforce conservation of mass for each zone. If flow balancing method is “None” and infiltration is “None”, then the zone air mass flow calculation defaults to assume self-balanced simple flow mixing and infiltration objects.

Fields
- adjust_zone_mixing_and_return_for_air_mass_flow_balance [string] (Default: None)
- infiltration_balancing_method [string] (Default: AddInfiltrationFlow)
- infiltration_balancing_zones [string] (Default: MixingSourceZonesOnly)

ZoneCapacitanceMultiplier:ResearchSpecial¶

Multiplier altering the relative capacitance of the air compared to an empty zone

Fields
- zone_or_zonelist_name [string]
- temperature_capacity_multiplier [number] (Default: 1.0)
- humidity_capacity_multiplier [number] (Default: 1.0)
- carbon_dioxide_capacity_multiplier [number] (Default: 1.0)
- generic_contaminant_capacity_multiplier [number] (Default: 1.0)

Timestep¶

Specifies the “basic” timestep for the simulation. The value entered here is also known as the Zone Timestep. This is used in the Zone Heat Balance Model calculation as the driving timestep for heat transfer and load calculations.

Fields
- number_of_timesteps_per_hour [integer] (Default: 6)

ConvergenceLimits¶

Specifies limits on HVAC system simulation timesteps and iterations. This item is an advanced feature that should be used only with caution.

Fields
- minimum_system_timestep [integer]
- maximum_hvac_iterations [integer] (Default: 20)
- minimum_plant_iterations [integer] (Default: 2)
- maximum_plant_iterations [integer] (Default: 8)

HVACSystemRootFindingAlgorithm¶

Specifies a HVAC system solver algorithm to find a root

Fields
- algorithm [string] (Default: RegulaFalsi)
- number_of_iterations_before_algorithm_switch [integer] (Default: 5)

Compliance Objects¶

Compliance:Building¶

Building level inputs related to compliance to building standards, building codes, and beyond energy code programs.

Fields
- building_rotation_for_appendix_g [number] (Default: 0.0)

Location and Climate¶

Site:Location¶

Specifies the building’s location. Only one location is allowed. Weather data file location, if it exists, will override this object.

Fields
- latitude [number] (Default: 0.0)
- longitude [number] (Default: 0.0)
- time_zone [number] (Default: 0.0)
- elevation [number] (Default: 0.0)

Site:VariableLocation¶

Captures the scheduling of a moving/reorienting building, or more likely a vessel

Fields
- building_location_latitude_schedule [string]
- building_location_longitude_schedule [string]
- building_location_orientation_schedule [string]

SizingPeriod:DesignDay¶

The design day object creates the parameters for the program to create the 24 hour weather profile that can be used for sizing as well as running to test the other simulation parameters. Parameters in this include a date (month and day), a day type (which uses the appropriate schedules for either sizing or simple tests), min/max temperatures, wind speeds, and solar radiation values.

Fields
- month [integer]
- day_of_month [integer]
- day_type [string]
- maximum_dry_bulb_temperature [number]
- daily_dry_bulb_temperature_range [number] (Default: 0.0)
- dry_bulb_temperature_range_modifier_type [string] (Default: DefaultMultipliers)
- dry_bulb_temperature_range_modifier_day_schedule_name [string]
- humidity_condition_type [string] (Default: WetBulb)
- wetbulb_or_dewpoint_at_maximum_dry_bulb [number]
- humidity_condition_day_schedule_name [string]
- humidity_ratio_at_maximum_dry_bulb [number]
- enthalpy_at_maximum_dry_bulb [number]
- daily_wet_bulb_temperature_range [number]
- barometric_pressure [number]
- wind_speed [number]
- wind_direction [number]
- rain_indicator [string] (Default: No)
- snow_indicator [string] (Default: No)
- daylight_saving_time_indicator [string] (Default: No)
- solar_model_indicator [string] (Default: ASHRAEClearSky)
- beam_solar_day_schedule_name [string]
- diffuse_solar_day_schedule_name [string]
- ashrae_clear_sky_optical_depth_for_beam_irradiance_taub_ [number] (Default: 0.0)
- ashrae_clear_sky_optical_depth_for_diffuse_irradiance_taud_ [number] (Default: 0.0)
- sky_clearness [number] (Default: 0.0)
- maximum_number_warmup_days [integer]
- begin_environment_reset_mode [string] (Default: FullResetAtBeginEnvironment)

SizingPeriod:WeatherFileDays¶

Use a weather file period for design sizing calculations.

Fields
- begin_month [integer]
- begin_day_of_month [integer]
- end_month [integer]
- end_day_of_month [integer]
- day_of_week_for_start_day [string] (Default: Monday)
- use_weather_file_daylight_saving_period [string] (Default: Yes)
- use_weather_file_rain_and_snow_indicators [string] (Default: Yes)

SizingPeriod:WeatherFileConditionType¶

Use a weather file period for design sizing calculations. EPW weather files are created with typical and extreme periods created heuristically from the weather file data. For more details on these periods, see AuxiliaryPrograms document.

Fields
- period_selection [string]
- day_of_week_for_start_day [string] (Default: Monday)
- use_weather_file_daylight_saving_period [string] (Default: Yes)
- use_weather_file_rain_and_snow_indicators [string] (Default: Yes)

RunPeriod¶

Specify a range of dates and other parameters for a simulation. Multiple run periods may be input, but they may not overlap.

Fields
- begin_month [integer]
- begin_day_of_month [integer]
- begin_year [number]
- end_month [integer]
- end_day_of_month [integer]
- end_year [number]
- day_of_week_for_start_day [string]
- use_weather_file_holidays_and_special_days [string] (Default: Yes)
- use_weather_file_daylight_saving_period [string] (Default: Yes)
- apply_weekend_holiday_rule [string] (Default: No)
- use_weather_file_rain_indicators [string] (Default: Yes)
- use_weather_file_snow_indicators [string] (Default: Yes)
- treat_weather_as_actual [string] (Default: No)
- first_hour_interpolation_starting_values [string] (Default: Hour24)

RunPeriodControl:SpecialDays¶

This object sets up holidays/special days to be used during weather file run periods. (These are not used with SizingPeriod:* objects.) Depending on the value in the run period, days on the weather file may also be used. However, the weather file specification will take precedence over any specification shown here. (No error message on duplicate days or overlapping days).

Fields
- start_date [string]
- duration [number] (Default: 1.0)
- special_day_type [string] (Default: Holiday)

RunPeriodControl:DaylightSavingTime¶

This object sets up the daylight saving time period for any RunPeriod. Ignores any daylight saving time period on the weather file and uses this definition. These are not used with SizingPeriod:DesignDay objects. Use with SizingPeriod:WeatherFileDays object can be controlled in that object.

Fields
- start_date [string]
- end_date [string]

WeatherProperty:SkyTemperature¶

This object is used to override internal sky temperature calculations.

Fields
- calculation_type [string] (Default: ClarkAllen)
- schedule_name [string]
- use_weather_file_horizontal_ir [string] (Default: Yes)

Site:WeatherStation¶

This object should only be used for non-standard weather data. Standard weather data such as TMY2, IWEC, and ASHRAE design day data are all measured at the default conditions and do not require this object.

Fields
- wind_sensor_height_above_ground [number] (Default: 10.0)
- wind_speed_profile_exponent [number] (Default: 0.14)
- wind_speed_profile_boundary_layer_thickness [number] (Default: 270.0)
- air_temperature_sensor_height_above_ground [number] (Default: 1.5)

Site:HeightVariation¶

This object is used if the user requires advanced control over height-dependent variations in wind speed and temperature. When this object is not present, the default model for temperature dependence on height is used, and the wind speed is modeled according to the Terrain field of the BUILDING object.

Fields
- wind_speed_profile_exponent [number] (Default: 0.22)
- wind_speed_profile_boundary_layer_thickness [number] (Default: 370.0)
- air_temperature_gradient_coefficient [number] (Default: 0.0065)

Site:GroundTemperature:BuildingSurface¶

These temperatures are specifically for those surfaces that have the outside environment of “Ground”. Documentation about what values these should be is located in the Auxiliary programs document (Ground Heat Transfer) as well as the InputOutput Reference. CAUTION - Do not use the “undisturbed” ground temperatures from the weather data. These values are too extreme for the soil under a conditioned building. For best results, use the Slab or Basement program to calculate custom monthly average ground temperatures (see Auxiliary Programs). For typical commercial buildings in the USA, a reasonable default value is 2C less than the average indoor space temperature.

Fields
- january_ground_temperature [number] (Default: 18.0)
- february_ground_temperature [number] (Default: 18.0)
- march_ground_temperature [number] (Default: 18.0)
- april_ground_temperature [number] (Default: 18.0)
- may_ground_temperature [number] (Default: 18.0)
- june_ground_temperature [number] (Default: 18.0)
- july_ground_temperature [number] (Default: 18.0)
- august_ground_temperature [number] (Default: 18.0)
- september_ground_temperature [number] (Default: 18.0)
- october_ground_temperature [number] (Default: 18.0)
- november_ground_temperature [number] (Default: 18.0)
- december_ground_temperature [number] (Default: 18.0)

Site:GroundTemperature:FCfactorMethod¶

These temperatures are specifically for underground walls and ground floors defined with the C-factor and F-factor methods, and should be close to the monthly average outdoor air temperature delayed by 3 months for the location.

Fields
- january_ground_temperature [number] (Default: 13.0)
- february_ground_temperature [number] (Default: 13.0)
- march_ground_temperature [number] (Default: 13.0)
- april_ground_temperature [number] (Default: 13.0)
- may_ground_temperature [number] (Default: 13.0)
- june_ground_temperature [number] (Default: 13.0)
- july_ground_temperature [number] (Default: 13.0)
- august_ground_temperature [number] (Default: 13.0)
- september_ground_temperature [number] (Default: 13.0)
- october_ground_temperature [number] (Default: 13.0)
- november_ground_temperature [number] (Default: 13.0)
- december_ground_temperature [number] (Default: 13.0)

Site:GroundTemperature:Shallow¶

These temperatures are specifically for the Surface Ground Heat Exchanger and should probably be close to the average outdoor air temperature for the location. They are not used in other models.

Fields
- january_surface_ground_temperature [number] (Default: 13.0)
- february_surface_ground_temperature [number] (Default: 13.0)
- march_surface_ground_temperature [number] (Default: 13.0)
- april_surface_ground_temperature [number] (Default: 13.0)
- may_surface_ground_temperature [number] (Default: 13.0)
- june_surface_ground_temperature [number] (Default: 13.0)
- july_surface_ground_temperature [number] (Default: 13.0)
- august_surface_ground_temperature [number] (Default: 13.0)
- september_surface_ground_temperature [number] (Default: 13.0)
- october_surface_ground_temperature [number] (Default: 13.0)
- november_surface_ground_temperature [number] (Default: 13.0)
- december_surface_ground_temperature [number] (Default: 13.0)

Site:GroundTemperature:Deep¶

These temperatures are specifically for the ground heat exchangers that would use “deep” (3-4 m depth) ground temperatures for their heat source. They are not used in other models.

Fields
- january_deep_ground_temperature [number] (Default: 16.0)
- february_deep_ground_temperature [number] (Default: 16.0)
- march_deep_ground_temperature [number] (Default: 16.0)
- april_deep_ground_temperature [number] (Default: 16.0)
- may_deep_ground_temperature [number] (Default: 16.0)
- june_deep_ground_temperature [number] (Default: 16.0)
- july_deep_ground_temperature [number] (Default: 16.0)
- august_deep_ground_temperature [number] (Default: 16.0)
- september_deep_ground_temperature [number] (Default: 16.0)
- october_deep_ground_temperature [number] (Default: 16.0)
- november_deep_ground_temperature [number] (Default: 16.0)
- december_deep_ground_temperature [number] (Default: 16.0)

Site:GroundTemperature:Undisturbed:FiniteDifference¶

Undisturbed ground temperature object using a detailed finite difference 1-D model

Fields
- soil_thermal_conductivity [number]
- soil_density [number]
- soil_specific_heat [number]
- soil_moisture_content_volume_fraction [number] (Default: 30.0)
- soil_moisture_content_volume_fraction_at_saturation [number] (Default: 50.0)
- evapotranspiration_ground_cover_parameter [number] (Default: 0.4)

Site:GroundTemperature:Undisturbed:KusudaAchenbach¶

Undisturbed ground temperature object using the Kusuda-Achenbach 1965 correlation.

Fields
- soil_thermal_conductivity [number]
- soil_density [number]
- soil_specific_heat [number]
- average_soil_surface_temperature [number]
- average_amplitude_of_surface_temperature [number]
- phase_shift_of_minimum_surface_temperature [number]

Site:GroundTemperature:Undisturbed:Xing¶

Undisturbed ground temperature object using the Xing 2014 2 harmonic parameter model.

Fields
- soil_thermal_conductivity [number]
- soil_density [number]
- soil_specific_heat [number]
- average_soil_surface_tempeature [number]
- soil_surface_temperature_amplitude_1 [number]
- soil_surface_temperature_amplitude_2 [number]
- phase_shift_of_temperature_amplitude_1 [number]
- phase_shift_of_temperature_amplitude_2 [number]

Site:GroundDomain:Slab¶

Ground-coupled slab model for on-grade and in-grade cases with or without insulation.

Fields
- ground_domain_depth [number] (Default: 10.0)
- aspect_ratio [number] (Default: 1.0)
- perimeter_offset [number] (Default: 5.0)
- soil_thermal_conductivity [number] (Default: 1.5)
- soil_density [number] (Default: 2800.0)
- soil_specific_heat [number] (Default: 850.0)
- soil_moisture_content_volume_fraction [number] (Default: 30.0)
- soil_moisture_content_volume_fraction_at_saturation [number] (Default: 50.0)
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]
- evapotranspiration_ground_cover_parameter [number] (Default: 0.4)
- slab_boundary_condition_model_name [string]
- slab_location [string]
- slab_material_name [string]
- horizontal_insulation [string] (Default: No)
- horizontal_insulation_material_name [string]
- horizontal_insulation_extents [string] (Default: Full)
- perimeter_insulation_width [number]
- vertical_insulation [string] (Default: No)
- vertical_insulation_material_name [string]
- vertical_insulation_depth [number]
- simulation_timestep [string] (Default: Hourly)
- geometric_mesh_coefficient [number] (Default: 1.6)
- mesh_density_parameter [integer] (Default: 6)

Site:GroundDomain:Basement¶

Ground-coupled basement model for simulating basements or other underground zones.

Fields
- ground_domain_depth [number] (Default: 10.0)
- aspect_ratio [number] (Default: 1.0)
- perimeter_offset [number] (Default: 5.0)
- soil_thermal_conductivity [number] (Default: 1.5)
- soil_density [number] (Default: 2800.0)
- soil_specific_heat [number] (Default: 850.0)
- soil_moisture_content_volume_fraction [number] (Default: 30.0)
- soil_moisture_content_volume_fraction_at_saturation [number] (Default: 50.0)
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]
- evapotranspiration_ground_cover_parameter [number] (Default: 0.4)
- basement_floor_boundary_condition_model_name [string]
- horizontal_insulation [string] (Default: No)
- horizontal_insulation_material_name [string]
- horizontal_insulation_extents [string] (Default: Full)
- perimeter_horizontal_insulation_width [number]
- basement_wall_depth [number]
- basement_wall_boundary_condition_model_name [string]
- vertical_insulation [string] (Default: No)
- basement_wall_vertical_insulation_material_name [string]
- vertical_insulation_depth [number]
- simulation_timestep [string] (Default: Hourly)
- mesh_density_parameter [integer] (Default: 4)

Site:GroundReflectance¶

Specifies the ground reflectance values used to calculate ground reflected solar. The ground reflectance can be further modified when snow is on the ground by Site:GroundReflectance:SnowModifier.

Fields
- january_ground_reflectance [number] (Default: 0.2)
- february_ground_reflectance [number] (Default: 0.2)
- march_ground_reflectance [number] (Default: 0.2)
- april_ground_reflectance [number] (Default: 0.2)
- may_ground_reflectance [number] (Default: 0.2)
- june_ground_reflectance [number] (Default: 0.2)
- july_ground_reflectance [number] (Default: 0.2)
- august_ground_reflectance [number] (Default: 0.2)
- september_ground_reflectance [number] (Default: 0.2)
- october_ground_reflectance [number] (Default: 0.2)
- november_ground_reflectance [number] (Default: 0.2)
- december_ground_reflectance [number] (Default: 0.2)

Site:GroundReflectance:SnowModifier¶

Specifies ground reflectance multipliers when snow resident on the ground. These multipliers are applied to the “normal” ground reflectances specified in Site:GroundReflectance.

Fields
- ground_reflected_solar_modifier [number] (Default: 1.0)
- daylighting_ground_reflected_solar_modifier [number] (Default: 1.0)

Site:WaterMainsTemperature¶

Used to calculate water mains temperatures delivered by underground water main pipes. Water mains temperatures are a function of outdoor climate conditions and vary with time of year.

Fields
- calculation_method [string] (Default: CorrelationFromWeatherFile)
- temperature_schedule_name [string]
- annual_average_outdoor_air_temperature [number]
- maximum_difference_in_monthly_average_outdoor_air_temperatures [number]

Site:Precipitation¶

Used to describe the amount of water precipitation at the building site. Precipitation includes both rain and the equivalent water content of snow.

Fields
- precipitation_model_type [string]
- design_level_for_total_annual_precipitation [number]
- precipitation_rates_schedule_name [string]
- average_total_annual_precipitation [number]

RoofIrrigation¶

Used to describe the amount of irrigation on the ecoroof surface over the course of the simulation runperiod.

Fields
- irrigation_model_type [string]
- irrigation_rate_schedule_name [string]
- irrigation_maximum_saturation_threshold [number] (Default: 40.0)

Site:SolarAndVisibleSpectrum¶

If this object is omitted, the default solar and visible spectrum data will be used.

Fields
- spectrum_data_method [string] (Default: Default)
- solar_spectrum_data_object_name [string]
- visible_spectrum_data_object_name [string]

Site:SpectrumData¶

Spectrum Data Type is followed by up to 107 sets of normal-incidence measured values of [wavelength, spectrum] for wavelengths covering the solar (0.25 to 2.5 microns) or visible spectrum (0.38 to 0.78 microns)

Fields
- spectrum_data_type [string]
- wavelength [number]
- spectrum [number]
- wavelength_1 [number]
- spectrum_2 [number]
- extensions [Array of {wavelength, spectrum}]

Schedules¶

ScheduleTypeLimits¶

ScheduleTypeLimits specifies the data types and limits for the values contained in schedules

Fields
- lower_limit_value [number]
- upper_limit_value [number]
- numeric_type [string]
- unit_type [string] (Default: Dimensionless)

Schedule:Day:Hourly¶

A Schedule:Day:Hourly contains 24 values for each hour of the day.

Fields
- schedule_type_limits_name [string]
- hour_1 [number] (Default: 0.0)
- hour_2 [number] (Default: 0.0)
- hour_3 [number] (Default: 0.0)
- hour_4 [number] (Default: 0.0)
- hour_5 [number] (Default: 0.0)
- hour_6 [number] (Default: 0.0)
- hour_7 [number] (Default: 0.0)
- hour_8 [number] (Default: 0.0)
- hour_9 [number] (Default: 0.0)
- hour_10 [number] (Default: 0.0)
- hour_11 [number] (Default: 0.0)
- hour_12 [number] (Default: 0.0)
- hour_13 [number] (Default: 0.0)
- hour_14 [number] (Default: 0.0)
- hour_15 [number] (Default: 0.0)
- hour_16 [number] (Default: 0.0)
- hour_17 [number] (Default: 0.0)
- hour_18 [number] (Default: 0.0)
- hour_19 [number] (Default: 0.0)
- hour_20 [number] (Default: 0.0)
- hour_21 [number] (Default: 0.0)
- hour_22 [number] (Default: 0.0)
- hour_23 [number] (Default: 0.0)
- hour_24 [number] (Default: 0.0)

Schedule:Day:Interval¶

A Schedule:Day:Interval contains a full day of values with specified end times for each value Currently, is set up to allow for 10 minute intervals for an entire day.

Fields
- schedule_type_limits_name [string]
- interpolate_to_timestep [string] (Default: No)
- data [Array of {time, value_until_time}]

Schedule:Day:List¶

Schedule:Day:List will allow the user to list 24 hours worth of values, which can be sub-hourly in nature.

Fields
- schedule_type_limits_name [string]
- interpolate_to_timestep [string] (Default: No)
- minutes_per_item [integer]
- extensions [Array of {value}]

Schedule:Week:Daily¶

A Schedule:Week:Daily contains 12 Schedule:Day:Hourly objects, one for each day type.

Fields
- sunday_schedule_day_name [string]
- monday_schedule_day_name [string]
- tuesday_schedule_day_name [string]
- wednesday_schedule_day_name [string]
- thursday_schedule_day_name [string]
- friday_schedule_day_name [string]
- saturday_schedule_day_name [string]
- holiday_schedule_day_name [string]
- summerdesignday_schedule_day_name [string]
- winterdesignday_schedule_day_name [string]
- customday1_schedule_day_name [string]
- customday2_schedule_day_name [string]

Schedule:Week:Compact¶

Compact definition for Schedule:Day:List

Fields
- data [Array of {daytype_list, schedule_day_name}]

Schedule:Year¶

A Schedule:Year contains from 1 to 52 week schedules

Fields
- schedule_type_limits_name [string]
- schedule_weeks [Array of {schedule_week_name, start_month, start_day, end_month, end_day}]

Schedule:Compact¶

Irregular object. Does not follow the usual definition for fields. Fields A3… are: Through: Date For: Applicable days (ref: Schedule:Week:Compact) Interpolate: Average/Linear/No (ref: Schedule:Day:Interval) – optional, if not used will be “No” Until: <Time> (ref: Schedule:Day:Interval) <numeric value> words “Through”,”For”,”Interpolate”,”Until” must be included.

Fields
- schedule_type_limits_name [string]
- data [Array of {field}]

Schedule:Constant¶

Constant hourly value for entire year.

Fields
- schedule_type_limits_name [string]
- hourly_value [number] (Default: 0.0)

Schedule:File:Shading¶

A Schedule:File:Shading points to a CSV file that has 8760-8784 hours of sunlit fraction data for all or some of the exterior surfaces.

Fields
- file_name [string]

Schedule:File¶

A Schedule:File points to a text computer file that has 8760-8784 hours of data.

Fields
- schedule_type_limits_name [string]
- file_name [string]
- column_number [integer]
- rows_to_skip_at_top [integer]
- number_of_hours_of_data [number] (Default: 8760.0)
- column_separator [string] (Default: Comma)
- interpolate_to_timestep [string] (Default: No)
- minutes_per_item [integer] (Default: 60)
- adjust_schedule_for_daylight_savings [string] (Default: Yes)

Surface Construction Elements¶

Material¶

Regular materials described with full set of thermal properties

Fields
- roughness [string]
- thickness [number]
- conductivity [number]
- density [number]
- specific_heat [number]
- thermal_absorptance [number] (Default: 0.9)
- solar_absorptance [number] (Default: 0.7)
- visible_absorptance [number] (Default: 0.7)

Material:NoMass¶

Regular materials properties described whose principal description is R (Thermal Resistance)

Fields
- roughness [string]
- thermal_resistance [number]
- thermal_absorptance [number] (Default: 0.9)
- solar_absorptance [number] (Default: 0.7)
- visible_absorptance [number] (Default: 0.7)

Material:InfraredTransparent¶

Special infrared transparent material. Similar to a Material:Nomass with low thermal resistance. High absorptance in both wavelengths. Area will be doubled internally to make internal radiant exchange accurate. Should be only material in single layer surface construction. All thermal properties are set internally. User needs only to supply name. Cannot be used with ConductionFiniteDifference solution algorithms

Fields

Material:AirGap¶

Air Space in Opaque Construction

Fields
- thermal_resistance [number]

Material:RoofVegetation¶

EcoRoof model, plant layer plus soil layer Implemented by Portland State University (Sailor et al., January, 2007) only one material must be referenced per simulation though the same EcoRoof material could be used in multiple constructions. New moisture redistribution scheme (2010) requires higher number of timesteps per hour (minimum 12 recommended).

Fields
- height_of_plants [number] (Default: 0.2)
- leaf_area_index [number] (Default: 1.0)
- leaf_reflectivity [number] (Default: 0.22)
- leaf_emissivity [number] (Default: 0.95)
- minimum_stomatal_resistance [number] (Default: 180.0)
- soil_layer_name [string] (Default: Green Roof Soil)
- roughness [string] (Default: MediumRough)
- thickness [number] (Default: 0.1)
- conductivity_of_dry_soil [number] (Default: 0.35)
- density_of_dry_soil [number] (Default: 1100.0)
- specific_heat_of_dry_soil [number] (Default: 1200.0)
- thermal_absorptance [number] (Default: 0.9)
- solar_absorptance [number] (Default: 0.7)
- visible_absorptance [number] (Default: 0.75)
- saturation_volumetric_moisture_content_of_the_soil_layer [number] (Default: 0.3)
- residual_volumetric_moisture_content_of_the_soil_layer [number] (Default: 0.01)
- initial_volumetric_moisture_content_of_the_soil_layer [number] (Default: 0.1)
- moisture_diffusion_calculation_method [string] (Default: Advanced)

WindowMaterial:SimpleGlazingSystem¶

Alternate method of describing windows This window material object is used to define an entire glazing system using simple performance parameters.

Fields
- u_factor [number]
- solar_heat_gain_coefficient [number]
- visible_transmittance [number]

WindowMaterial:Glazing¶

Glass material properties for Windows or Glass Doors Transmittance/Reflectance input method.

Fields
- optical_data_type [string]
- window_glass_spectral_data_set_name [string]
- thickness [number]
- solar_transmittance_at_normal_incidence [number]
- front_side_solar_reflectance_at_normal_incidence [number]
- back_side_solar_reflectance_at_normal_incidence [number]
- visible_transmittance_at_normal_incidence [number]
- front_side_visible_reflectance_at_normal_incidence [number]
- back_side_visible_reflectance_at_normal_incidence [number]
- infrared_transmittance_at_normal_incidence [number] (Default: 0.0)
- front_side_infrared_hemispherical_emissivity [number] (Default: 0.84)
- back_side_infrared_hemispherical_emissivity [number] (Default: 0.84)
- conductivity [number] (Default: 0.9)
- dirt_correction_factor_for_solar_and_visible_transmittance [number] (Default: 1.0)
- solar_diffusing [string] (Default: No)
- young_s_modulus [number] (Default: 72000000000.0)
- poisson_s_ratio [number] (Default: 0.22)
- window_glass_spectral_and_incident_angle_transmittance_data_set_table_name [string]
- window_glass_spectral_and_incident_angle_front_reflectance_data_set_table_name [string]
- window_glass_spectral_and_incident_angle_back_reflectance_data_set_table_name [string]

WindowMaterial:GlazingGroup:Thermochromic¶

thermochromic glass at different temperatures

Fields
- temperature_data [Array of {optical_data_temperature, window_material_glazing_name}]

WindowMaterial:Glazing:RefractionExtinctionMethod¶

Glass material properties for Windows or Glass Doors Index of Refraction/Extinction Coefficient input method Not to be used for coated glass

Fields
- thickness [number]
- solar_index_of_refraction [number]
- solar_extinction_coefficient [number]
- visible_index_of_refraction [number]
- visible_extinction_coefficient [number]
- infrared_transmittance_at_normal_incidence [number] (Default: 0.0)
- infrared_hemispherical_emissivity [number] (Default: 0.84)
- conductivity [number] (Default: 0.9)
- dirt_correction_factor_for_solar_and_visible_transmittance [number] (Default: 1.0)
- solar_diffusing [string] (Default: No)

WindowMaterial:Gas¶

Gas material properties that are used in Windows or Glass Doors

Fields
- gas_type [string]
- thickness [number]
- conductivity_coefficient_a [number]
- conductivity_coefficient_b [number]
- conductivity_coefficient_c [number]
- viscosity_coefficient_a [number]
- viscosity_coefficient_b [number]
- viscosity_coefficient_c [number]
- specific_heat_coefficient_a [number]
- specific_heat_coefficient_b [number]
- specific_heat_coefficient_c [number]
- molecular_weight [number]
- specific_heat_ratio [number]

WindowGap:SupportPillar¶

used to define pillar geometry for support pillars

Fields
- spacing [number] (Default: 0.04)
- radius [number] (Default: 0.0004)

WindowGap:DeflectionState¶

Used to enter data describing deflection state of the gap. It is referenced from WindowMaterial:Gap object only and it is used only when deflection model is set to MeasuredDeflection, otherwise it is ignored.

Fields
- deflected_thickness [number] (Default: 0.0)
- initial_temperature [number] (Default: 25.0)
- initial_pressure [number] (Default: 101325.0)

WindowMaterial:GasMixture¶

Gas mixtures that are used in Windows or Glass Doors

Fields
- thickness [number]
- number_of_gases_in_mixture [integer]
- gas_1_type [string]
- gas_1_fraction [number]
- gas_2_type [string]
- gas_2_fraction [number]
- gas_3_type [string]
- gas_3_fraction [number]
- gas_4_type [string]
- gas_4_fraction [number]

WindowMaterial:Gap¶

Used to define the gap between two layers in a complex fenestration system, where the Construction:ComplexFenestrationState object is used. It is referenced as a layer in the Construction:ComplexFenestrationState object. It cannot be referenced as a layer from the Construction object.

Fields
- thickness [number]
- gas_or_gas_mixture_ [string]
- pressure [number] (Default: 101325.0)
- deflection_state [string]
- support_pillar [string]

WindowMaterial:Shade¶

Specifies the properties of window shade materials. Reflectance and emissivity properties are assumed to be the same on both sides of the shade. Shades are considered to be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) independent of angle of incidence.

Fields
- solar_transmittance [number]
- solar_reflectance [number]
- visible_transmittance [number]
- visible_reflectance [number]
- infrared_hemispherical_emissivity [number]
- infrared_transmittance [number]
- thickness [number]
- conductivity [number]
- shade_to_glass_distance [number] (Default: 0.05)
- top_opening_multiplier [number] (Default: 0.5)
- bottom_opening_multiplier [number] (Default: 0.5)
- left_side_opening_multiplier [number] (Default: 0.5)
- right_side_opening_multiplier [number] (Default: 0.5)
- airflow_permeability [number] (Default: 0.0)

WindowMaterial:ComplexShade¶

Complex window shading layer thermal properties

Fields
- layer_type [string] (Default: OtherShadingType)
- thickness [number] (Default: 0.002)
- conductivity [number] (Default: 1.0)
- ir_transmittance [number] (Default: 0.0)
- front_emissivity [number] (Default: 0.84)
- back_emissivity [number] (Default: 0.84)
- top_opening_multiplier [number] (Default: 0.0)
- bottom_opening_multiplier [number] (Default: 0.0)
- left_side_opening_multiplier [number] (Default: 0.0)
- right_side_opening_multiplier [number] (Default: 0.0)
- front_opening_multiplier [number] (Default: 0.05)
- slat_width [number] (Default: 0.016)
- slat_spacing [number] (Default: 0.012)
- slat_thickness [number] (Default: 0.0006)
- slat_angle [number] (Default: 90.0)
- slat_conductivity [number] (Default: 160.0)
- slat_curve [number] (Default: 0.0)

WindowMaterial:Screen¶

Window screen physical properties. Can only be located on the exterior side of a window construction.

Fields
- reflected_beam_transmittance_accounting_method [string] (Default: ModelAsDiffuse)
- diffuse_solar_reflectance [number]
- diffuse_visible_reflectance [number]
- thermal_hemispherical_emissivity [number] (Default: 0.9)
- conductivity [number] (Default: 221.0)
- screen_material_spacing [number]
- screen_material_diameter [number]
- screen_to_glass_distance [number] (Default: 0.025)
- top_opening_multiplier [number] (Default: 0.0)
- bottom_opening_multiplier [number] (Default: 0.0)
- left_side_opening_multiplier [number] (Default: 0.0)
- right_side_opening_multiplier [number] (Default: 0.0)
- angle_of_resolution_for_screen_transmittance_output_map [unknown field type] (Default: 0.0)

WindowMaterial:Shade:EquivalentLayer¶

Specifies the properties of equivalent layer window shade material Shades are considered to be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) independent of angle of incidence. Shade represents roller blinds.

Fields
- shade_beam_beam_solar_transmittance [number] (Default: 0.0)
- front_side_shade_beam_diffuse_solar_transmittance [number]
- back_side_shade_beam_diffuse_solar_transmittance [number]
- front_side_shade_beam_diffuse_solar_reflectance [number]
- back_side_shade_beam_diffuse_solar_reflectance [number]
- shade_beam_beam_visible_transmittance_at_normal_incidence [number]
- shade_beam_diffuse_visible_transmittance_at_normal_incidence [number]
- shade_beam_diffuse_visible_reflectance_at_normal_incidence [number]
- shade_material_infrared_transmittance [number] (Default: 0.05)
- front_side_shade_material_infrared_emissivity [number] (Default: 0.91)
- back_side_shade_material_infrared_emissivity [number] (Default: 0.91)

WindowMaterial:Drape:EquivalentLayer¶

Specifies the properties of equivalent layer drape fabric materials. Shades are considered to be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) independent of angle of incidence. unpleated drape fabric is treated as thin and flat layer.

Fields
- drape_beam_beam_solar_transmittance_at_normal_incidence [number] (Default: 0.0)
- front_side_drape_beam_diffuse_solar_transmittance [number]
- back_side_drape_beam_diffuse_solar_transmittance [number]
- front_side_drape_beam_diffuse_solar_reflectance [number]
- back_side_drape_beam_diffuse_solar_reflectance [number]
- drape_beam_beam_visible_transmittance [number]
- drape_beam_diffuse_visible_transmittance [number]
- drape_beam_diffuse_visible_reflectance [number]
- drape_material_infrared_transmittance [number] (Default: 0.05)
- front_side_drape_material_infrared_emissivity [number] (Default: 0.87)
- back_side_drape_material_infrared_emissivity [number] (Default: 0.87)
- width_of_pleated_fabric [number] (Default: 0.0)
- length_of_pleated_fabric [number] (Default: 0.0)

WindowMaterial:Screen:EquivalentLayer¶

Equivalent layer window screen physical properties. Can only be located on the exterior side of a window construction.

Fields
- screen_beam_beam_solar_transmittance [unknown field type] (Default: Autocalculate)
- screen_beam_diffuse_solar_transmittance [number]
- screen_beam_diffuse_solar_reflectance [number]
- screen_beam_beam_visible_transmittance [number]
- screen_beam_diffuse_visible_transmittance [number]
- screen_beam_diffuse_visible_reflectance [number]
- screen_infrared_transmittance [number] (Default: 0.02)
- screen_infrared_emissivity [number] (Default: 0.93)
- screen_wire_spacing [number] (Default: 0.025)
- screen_wire_diameter [number] (Default: 0.005)

WindowMaterial:Glazing:EquivalentLayer¶

Glass material properties for Windows or Glass Doors Transmittance/Reflectance input method.

Fields
- optical_data_type [string] (Default: SpectralAverage)
- window_glass_spectral_data_set_name [string]
- front_side_beam_beam_solar_transmittance [number]
- back_side_beam_beam_solar_transmittance [number]
- front_side_beam_beam_solar_reflectance [number]
- back_side_beam_beam_solar_reflectance [number]
- front_side_beam_beam_visible_solar_transmittance [number]
- back_side_beam_beam_visible_solar_transmittance [number]
- front_side_beam_beam_visible_solar_reflectance [number]
- back_side_beam_beam_visible_solar_reflectance [number]
- front_side_beam_diffuse_solar_transmittance [number] (Default: 0.0)
- back_side_beam_diffuse_solar_transmittance [number] (Default: 0.0)
- front_side_beam_diffuse_solar_reflectance [number] (Default: 0.0)
- back_side_beam_diffuse_solar_reflectance [number] (Default: 0.0)
- front_side_beam_diffuse_visible_solar_transmittance [number] (Default: 0.0)
- back_side_beam_diffuse_visible_solar_transmittance [number] (Default: 0.0)
- front_side_beam_diffuse_visible_solar_reflectance [number] (Default: 0.0)
- back_side_beam_diffuse_visible_solar_reflectance [number] (Default: 0.0)
- diffuse_diffuse_solar_transmittance [unknown field type] (Default: Autocalculate)
- front_side_diffuse_diffuse_solar_reflectance [unknown field type] (Default: Autocalculate)
- back_side_diffuse_diffuse_solar_reflectance [unknown field type] (Default: Autocalculate)
- diffuse_diffuse_visible_solar_transmittance [unknown field type] (Default: Autocalculate)
- front_side_diffuse_diffuse_visible_solar_reflectance [unknown field type] (Default: Autocalculate)
- back_side_diffuse_diffuse_visible_solar_reflectance [unknown field type] (Default: Autocalculate)
- infrared_transmittance_applies_to_front_and_back_ [number] (Default: 0.0)
- front_side_infrared_emissivity [number] (Default: 0.84)
- back_side_infrared_emissivity [number] (Default: 0.84)
- thermal_resistance [number] (Default: 0.158)

WindowMaterial:Gap:EquivalentLayer¶

Gas material properties that are used in Windows Equivalent Layer References only WindowMaterial:Gas properties

Fields
- gas_type [string]
- thickness [number]
- gap_vent_type [string]
- conductivity_coefficient_a [number]
- conductivity_coefficient_b [number]
- conductivity_coefficient_c [number]
- viscosity_coefficient_a [number]
- viscosity_coefficient_b [number]
- viscosity_coefficient_c [number]
- specific_heat_coefficient_a [number]
- specific_heat_coefficient_b [number]
- specific_heat_coefficient_c [number]
- molecular_weight [number]
- specific_heat_ratio [number]

MaterialProperty:MoisturePenetrationDepth:Settings¶

Additional properties for moisture using EMPD procedure HeatBalanceAlgorithm choice=MoisturePenetrationDepthConductionTransferFunction only Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- water_vapor_diffusion_resistance_factor [number]
- moisture_equation_coefficient_a [number]
- moisture_equation_coefficient_b [number]
- moisture_equation_coefficient_c [number]
- moisture_equation_coefficient_d [number]
- surface_layer_penetration_depth [unknown field type] (Default: Autocalculate)
- deep_layer_penetration_depth [unknown field type] (Default: Autocalculate)
- coating_layer_thickness [number]
- coating_layer_water_vapor_diffusion_resistance_factor [number]

MaterialProperty:PhaseChange¶

Additional properties for temperature dependent thermal conductivity and enthalpy for Phase Change Materials (PCM) HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. Constructions with this should use the detailed CondFD process. Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- temperature_coefficient_for_thermal_conductivity [number] (Default: 0.0)
- temperature_1 [number]
- enthalpy_1 [number]
- temperature_2 [number]
- enthalpy_2 [number]
- temperature_3 [number]
- enthalpy_3 [number]
- temperature_4 [number]
- enthalpy_4 [number]
- temperature_5 [number]
- enthalpy_5 [number]
- temperature_6 [number]
- enthalpy_6 [number]
- temperature_7 [number]
- enthalpy_7 [number]
- temperature_8 [number]
- enthalpy_8 [number]
- temperature_9 [number]
- enthalpy_9 [number]
- temperature_10 [number]
- enthalpy_10 [number]
- temperature_11 [number]
- enthalpy_11 [number]
- temperature_12 [number]
- enthalpy_12 [number]
- temperature_13 [number]
- enthalpy_13 [number]
- temperature_14 [number]
- enthalpy_14 [number]
- temperature_15 [number]
- enthalpy_15 [number]
- temperature_16 [number]
- enthalpy_16 [number]

MaterialProperty:PhaseChangeHysteresis¶

Additional properties for temperature dependent thermal conductivity and enthalpy for Phase Change Materials (PCM) with separate melting and freezing curves. HeatBalanceAlgorithm = CondFD (ConductionFiniteDifference) solution algorithm only. Constructions with this should use the detailed CondFD process. Has no effect with other HeatBalanceAlgorithm solution algorithms.

Fields
- latent_heat_during_the_entire_phase_change_process [number]
- liquid_state_thermal_conductivity [number]
- liquid_state_density [number]
- liquid_state_specific_heat [number]
- high_temperature_difference_of_melting_curve [number]
- peak_melting_temperature [number]
- low_temperature_difference_of_melting_curve [number]
- solid_state_thermal_conductivity [number]
- solid_state_density [number]
- solid_state_specific_heat [number]
- high_temperature_difference_of_freezing_curve [number]
- peak_freezing_temperature [number]
- low_temperature_difference_of_freezing_curve [number]

MaterialProperty:VariableThermalConductivity¶

Additional properties for temperature dependent thermal conductivity using piecewise linear temperature-conductivity function. HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- temperature_1 [number]
- thermal_conductivity_1 [number]
- temperature_2 [number]
- thermal_conductivity_2 [number]
- temperature_3 [number]
- thermal_conductivity_3 [number]
- temperature_4 [number]
- thermal_conductivity_4 [number]
- temperature_5 [number]
- thermal_conductivity_5 [number]
- temperature_6 [number]
- thermal_conductivity_6 [number]
- temperature_7 [number]
- thermal_conductivity_7 [number]
- temperature_8 [number]
- thermal_conductivity_8 [number]
- temperature_9 [number]
- thermal_conductivity_9 [number]
- temperature_10 [number]
- thermal_conductivity_10 [number]

MaterialProperty:VariableAbsorptance¶

Fields
- reference_material_name [string]
- control_signal [string] (Default: SurfaceTemperature)
- thermal_absorptance_function_name [string]
- thermal_absorptance_schedule_name [string]
- solar_absorptance_function_name [string]
- solar_absorptance_schedule_name [string]

MaterialProperty:HeatAndMoistureTransfer:Settings¶

HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Additional material properties for surfaces. Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- material_name [string]
- porosity [number]
- initial_water_content_ratio [number] (Default: 0.2)

MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm¶

HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between moisture content and relative humidity fraction. Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- material_name [string]
- number_of_isotherm_coordinates [integer]
- relative_humidity_fraction_1 [number]
- moisture_content_1 [number]
- relative_humidity_fraction_2 [number]
- moisture_content_2 [number]
- relative_humidity_fraction_3 [number]
- moisture_content_3 [number]
- relative_humidity_fraction_4 [number]
- moisture_content_4 [number]
- relative_humidity_fraction_5 [number]
- moisture_content_5 [number]
- relative_humidity_fraction_6 [number]
- moisture_content_6 [number]
- relative_humidity_fraction_7 [number]
- moisture_content_7 [number]
- relative_humidity_fraction_8 [number]
- moisture_content_8 [number]
- relative_humidity_fraction_9 [number]
- moisture_content_9 [number]
- relative_humidity_fraction_10 [number]
- moisture_content_10 [number]
- relative_humidity_fraction_11 [number]
- moisture_content_11 [number]
- relative_humidity_fraction_12 [number]
- moisture_content_12 [number]
- relative_humidity_fraction_13 [number]
- moisture_content_13 [number]
- relative_humidity_fraction_14 [number]
- moisture_content_14 [number]
- relative_humidity_fraction_15 [number]
- moisture_content_15 [number]
- relative_humidity_fraction_16 [number]
- moisture_content_16 [number]
- relative_humidity_fraction_17 [number]
- moisture_content_17 [number]
- relative_humidity_fraction_18 [number]
- moisture_content_18 [number]
- relative_humidity_fraction_19 [number]
- moisture_content_19 [number]
- relative_humidity_fraction_20 [number]
- moisture_content_20 [number]
- relative_humidity_fraction_21 [number]
- moisture_content_21 [number]
- relative_humidity_fraction_22 [number]
- moisture_content_22 [number]
- relative_humidity_fraction_23 [number]
- moisture_content_23 [number]
- relative_humidity_fraction_24 [number]
- moisture_content_24 [number]
- relative_humidity_fraction_25 [number]
- moisture_content_25 [number]

MaterialProperty:HeatAndMoistureTransfer:Suction¶

HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between liquid suction transport coefficient and moisture content Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- material_name [string]
- number_of_suction_points [integer]
- moisture_content_1 [number]
- liquid_transport_coefficient_1 [number]
- moisture_content_2 [number]
- liquid_transport_coefficient_2 [number]
- moisture_content_3 [number]
- liquid_transport_coefficient_3 [number]
- moisture_content_4 [number]
- liquid_transport_coefficient_4 [number]
- moisture_content_5 [number]
- liquid_transport_coefficient_5 [number]
- moisture_content_6 [number]
- liquid_transport_coefficient_6 [number]
- moisture_content_7 [number]
- liquid_transport_coefficient_7 [number]
- moisture_content_8 [number]
- liquid_transport_coefficient_8 [number]
- moisture_content_9 [number]
- liquid_transport_coefficient_9 [number]
- moisture_content_10 [number]
- liquid_transport_coefficient_10 [number]
- moisture_content_11 [number]
- liquid_transport_coefficient_11 [number]
- moisture_content_12 [number]
- liquid_transport_coefficient_12 [number]
- moisture_content_13 [number]
- liquid_transport_coefficient_13 [number]
- moisture_content_14 [number]
- liquid_transport_coefficient_14 [number]
- moisture_content_15 [number]
- liquid_transport_coefficient_15 [number]
- moisture_content_16 [number]
- liquid_transport_coefficient_16 [number]
- moisture_content_17 [number]
- liquid_transport_coefficient_17 [number]
- moisture_content_18 [number]
- liquid_transport_coefficient_18 [number]
- moisture_content_19 [number]
- liquid_transport_coefficient_19 [number]
- moisture_content_20 [number]
- liquid_transport_coefficient_20 [number]
- moisture_content_21 [number]
- liquid_transport_coefficient_21 [number]
- moisture_content_22 [number]
- liquid_transport_coefficient_22 [number]
- moisture_content_23 [number]
- liquid_transport_coefficient_23 [number]
- moisture_content_24 [number]
- liquid_transport_coefficient_24 [number]
- moisture_content_25 [number]
- liquid_transport_coefficient_25 [number]

MaterialProperty:HeatAndMoistureTransfer:Redistribution¶

HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between liquid transport coefficient and moisture content Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- material_name [string]
- number_of_redistribution_points [integer]
- moisture_content_1 [number]
- liquid_transport_coefficient_1 [number]
- moisture_content_2 [number]
- liquid_transport_coefficient_2 [number]
- moisture_content_3 [number]
- liquid_transport_coefficient_3 [number]
- moisture_content_4 [number]
- liquid_transport_coefficient_4 [number]
- moisture_content_5 [number]
- liquid_transport_coefficient_5 [number]
- moisture_content_6 [number]
- liquid_transport_coefficient_6 [number]
- moisture_content_7 [number]
- liquid_transport_coefficient_7 [number]
- moisture_content_8 [number]
- liquid_transport_coefficient_8 [number]
- moisture_content_9 [number]
- liquid_transport_coefficient_9 [number]
- moisture_content_10 [number]
- liquid_transport_coefficient_10 [number]
- moisture_content_11 [number]
- liquid_transport_coefficient_11 [number]
- moisture_content_12 [number]
- liquid_transport_coefficient_12 [number]
- moisture_content_13 [number]
- liquid_transport_coefficient_13 [number]
- moisture_content_14 [number]
- liquid_transport_coefficient_14 [number]
- moisture_content_15 [number]
- liquid_transport_coefficient_15 [number]
- moisture_content_16 [number]
- liquid_transport_coefficient_16 [number]
- moisture_content_17 [number]
- liquid_transport_coefficient_17 [number]
- moisture_content_18 [number]
- liquid_transport_coefficient_18 [number]
- moisture_content_19 [number]
- liquid_transport_coefficient_19 [number]
- moisture_content_20 [number]
- liquid_transport_coefficient_20 [number]
- moisture_content_21 [number]
- liquid_transport_coefficient_21 [number]
- moisture_content_22 [number]
- liquid_transport_coefficient_22 [number]
- moisture_content_23 [number]
- liquid_transport_coefficient_23 [number]
- moisture_content_24 [number]
- liquid_transport_coefficient_24 [number]
- moisture_content_25 [number]
- liquid_transport_coefficient_25 [number]

MaterialProperty:HeatAndMoistureTransfer:Diffusion¶

HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between water vapor diffusion and relative humidity fraction Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- material_name [string]
- number_of_data_pairs [integer]
- relative_humidity_fraction_1 [number]
- water_vapor_diffusion_resistance_factor_1 [number]
- relative_humidity_fraction_2 [number]
- water_vapor_diffusion_resistance_factor_2 [number]
- relative_humidity_fraction_3 [number]
- water_vapor_diffusion_resistance_factor_3 [number]
- relative_humidity_fraction_4 [number]
- water_vapor_diffusion_resistance_factor_4 [number]
- relative_humidity_fraction_5 [number]
- water_vapor_diffusion_resistance_factor_5 [number]
- relative_humidity_fraction_6 [number]
- water_vapor_diffusion_resistance_factor_6 [number]
- relative_humidity_fraction_7 [number]
- water_vapor_diffusion_resistance_factor_7 [number]
- relative_humidity_fraction_8 [number]
- water_vapor_diffusion_resistance_factor_8 [number]
- relative_humidity_fraction_9 [number]
- water_vapor_diffusion_resistance_factor_9 [number]
- relative_humidity_fraction_10 [number]
- water_vapor_diffusion_resistance_factor_10 [number]
- relative_humidity_fraction_11 [number]
- water_vapor_diffusion_resistance_factor_11 [number]
- relative_humidity_fraction_12 [number]
- water_vapor_diffusion_resistance_factor_12 [number]
- relative_humidity_fraction_13 [number]
- water_vapor_diffusion_resistance_factor_13 [number]
- relative_humidity_fraction_14 [number]
- water_vapor_diffusion_resistance_factor_14 [number]
- relative_humidity_fraction_15 [number]
- water_vapor_diffusion_resistance_factor_15 [number]
- relative_humidity_fraction_16 [number]
- water_vapor_diffusion_resistance_factor_16 [number]
- relative_humidity_fraction_17 [number]
- water_vapor_diffusion_resistance_factor_17 [number]
- relative_humidity_fraction_18 [number]
- water_vapor_diffusion_resistance_factor_18 [number]
- relative_humidity_fraction_19 [number]
- water_vapor_diffusion_resistance_factor_19 [number]
- relative_humidity_fraction_20 [number]
- water_vapor_diffusion_resistance_factor_20 [number]
- relative_humidity_fraction_21 [number]
- water_vapor_diffusion_resistance_factor_21 [number]
- relative_humidity_fraction_22 [number]
- water_vapor_diffusion_resistance_factor_22 [number]
- relative_humidity_fraction_23 [number]
- water_vapor_diffusion_resistance_factor_23 [number]
- relative_humidity_fraction_24 [number]
- water_vapor_diffusion_resistance_factor_24 [number]
- relative_humidity_fraction_25 [number]
- water_vapor_diffusion_resistance_factor_25 [number]

MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity¶

HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between thermal conductivity and moisture content Has no effect with other HeatBalanceAlgorithm solution algorithms

Fields
- material_name [string]
- number_of_thermal_coordinates [integer]
- moisture_content_1 [number]
- thermal_conductivity_1 [number]
- moisture_content_2 [number]
- thermal_conductivity_2 [number]
- moisture_content_3 [number]
- thermal_conductivity_3 [number]
- moisture_content_4 [number]
- thermal_conductivity_4 [number]
- moisture_content_5 [number]
- thermal_conductivity_5 [number]
- moisture_content_6 [number]
- thermal_conductivity_6 [number]
- moisture_content_7 [number]
- thermal_conductivity_7 [number]
- moisture_content_8 [number]
- thermal_conductivity_8 [number]
- moisture_content_9 [number]
- thermal_conductivity_9 [number]
- moisture_content_10 [number]
- thermal_conductivity_10 [number]
- moisture_content_11 [number]
- thermal_conductivity_11 [number]
- moisture_content_12 [number]
- thermal_conductivity_12 [number]
- moisture_content_13 [number]
- thermal_conductivity_13 [number]
- moisture_content_14 [number]
- thermal_conductivity_14 [number]
- moisture_content_15 [number]
- thermal_conductivity_15 [number]
- moisture_content_16 [number]
- thermal_conductivity_16 [number]
- moisture_content_17 [number]
- thermal_conductivity_17 [number]
- moisture_content_18 [number]
- thermal_conductivity_18 [number]
- moisture_content_19 [number]
- thermal_conductivity_19 [number]
- moisture_content_20 [number]
- thermal_conductivity_20 [number]
- moisture_content_21 [number]
- thermal_conductivity_21 [number]
- moisture_content_22 [number]
- thermal_conductivity_22 [number]
- moisture_content_23 [number]
- thermal_conductivity_23 [number]
- moisture_content_24 [number]
- thermal_conductivity_24 [number]
- moisture_content_25 [number]
- thermal_conductivity_25 [number]

MaterialProperty:GlazingSpectralData¶

Name is followed by up to 800 sets of normal-incidence measured values of [wavelength, transmittance, front reflectance, back reflectance] for wavelengths covering the solar spectrum (from about 0.25 to 2.5 microns)

Fields
- wavelength_1 [number]
- transmittance_1 [number]
- front_reflectance_1 [number]
- back_reflectance_1 [number]
- wavelength_2 [number]
- transmittance_2 [number]
- front_reflectance_2 [number]
- back_reflectance_2 [number]
- wavelength_3 [number]
- transmittance_3 [number]
- front_reflectance_3 [number]
- back_reflectance_3 [number]
- wavelength_4 [number]
- transmittance_4 [number]
- front_reflectance_4 [number]
- back_reflectance_4 [number]
- extensions [Array of {wavelength, transmittance, front_reflectance, back_reflectance}]

Construction¶

Start with outside layer and work your way to the inside layer Up to 10 layers total, 8 for windows Enter the material name for each layer

Fields
- outside_layer [string]
- layer_2 [string]
- layer_3 [string]
- layer_4 [string]
- layer_5 [string]
- layer_6 [string]
- layer_7 [string]
- layer_8 [string]
- layer_9 [string]
- layer_10 [string]

Construction:CfactorUndergroundWall¶

Alternate method of describing underground wall constructions

Fields
- c_factor [number]
- height [number]

Construction:FfactorGroundFloor¶

Alternate method of describing slab-on-grade or underground floor constructions

Fields
- f_factor [number]
- area [number]
- perimeterexposed [number]

ConstructionProperty:InternalHeatSource¶

Internal heat source to be attached to a construction layer

Fields
- construction_name [string]
- thermal_source_present_after_layer_number [integer]
- temperature_calculation_requested_after_layer_number [integer]
- dimensions_for_the_ctf_calculation [integer]
- tube_spacing [number]
- two_dimensional_temperature_calculation_position [number] (Default: 0.0)

Construction:AirBoundary¶

Indicates an open boundary between two zones. It may be used for base surfaces and fenestration surfaces. The two adjacent zones are grouped together for solar, daylighting and radiant exchange. When this construction type is used, the Outside Boundary Condition of the surface (or the base surface of a fenestration surface) must be either Surface or Zone. A base surface with Construction:AirBoundary cannot hold any fenestration surfaces.

Fields
- air_exchange_method [string] (Default: None)
- simple_mixing_air_changes_per_hour [number] (Default: 0.5)
- simple_mixing_schedule_name [string]

WindowThermalModel:Params¶

object is used to select which thermal model should be used in tarcog simulations

Fields
- standard [string] (Default: ISO15099)
- thermal_model [string] (Default: ISO15099)
- sdscalar [number] (Default: 1.0)
- deflection_model [string] (Default: NoDeflection)
- vacuum_pressure_limit [number] (Default: 13.238)
- initial_temperature [number] (Default: 25.0)
- initial_pressure [number] (Default: 101325.0)

WindowsCalculationEngine¶

Describes which window model will be used in calculations. Built in windows model will use algorithms that are part of EnergyPlus, while ExternalWindowsModel will use Windows-CalcEngine library to perform optical and thermal performances of windows and doors.

Fields
- windows_engine [string] (Default: BuiltInWindowsModel)

Construction:ComplexFenestrationState¶

Describes one state for a complex glazing system These input objects are typically generated by using WINDOW software and export to IDF syntax

Fields
- basis_type [string] (Default: LBNLWINDOW)
- basis_symmetry_type [string] (Default: None)
- window_thermal_model [string]
- basis_matrix_name [string]
- solar_optical_complex_front_transmittance_matrix_name [string]
- solar_optical_complex_back_reflectance_matrix_name [string]
- visible_optical_complex_front_transmittance_matrix_name [string]
- visible_optical_complex_back_transmittance_matrix_name [string]
- outside_layer_name [string]
- outside_layer_directional_front_absoptance_matrix_name [string]
- outside_layer_directional_back_absoptance_matrix_name [string]
- gap_1_name [string]
- cfs_gap_1_directional_front_absoptance_matrix_name [string]
- cfs_gap_1_directional_back_absoptance_matrix_name [string]
- layer_2_name [string]
- layer_2_directional_front_absoptance_matrix_name [string]
- layer_2_directional_back_absoptance_matrix_name [string]
- gap_2_name [string]
- gap_2_directional_front_absoptance_matrix_name [string]
- gap_2_directional_back_absoptance_matrix_name [string]
- layer_3_name [string]
- layer_3_directional_front_absoptance_matrix_name [string]
- layer_3_directional_back_absoptance_matrix_name [string]
- gap_3_name [string]
- gap_3_directional_front_absoptance_matrix_name [string]
- gap_3_directional_back_absoptance_matrix_name [string]
- layer_4_name [string]
- layer_4_directional_front_absoptance_matrix_name [string]
- layer_4_directional_back_absoptance_matrix_name [string]
- gap_4_name [string]
- gap_4_directional_front_absoptance_matrix_name [string]
- gap_4_directional_back_absoptance_matrix_name [string]
- layer_5_name [string]
- layer_5_directional_front_absoptance_matrix_name [string]
- layer_5_directional_back_absoptance_matrix_name [string]

Construction:WindowEquivalentLayer¶

Start with outside layer and work your way to the inside Layer Up to 11 layers total. Up to six solid layers and up to five gaps. Enter the material name for each layer

Fields
- outside_layer [string]
- layer_2 [string]
- layer_3 [string]
- layer_4 [string]
- layer_5 [string]
- layer_6 [string]
- layer_7 [string]
- layer_8 [string]
- layer_9 [string]
- layer_10 [string]
- layer_11 [string]

Construction:WindowDataFile¶

Initiates search of the Window data file for a window called Name.

Fields
- file_name [string]

Thermal Zones and Surfaces¶

GlobalGeometryRules¶

Specifies the geometric rules used to describe the input of surface vertices and daylighting reference points.

Fields
- starting_vertex_position [string]
- vertex_entry_direction [string]
- coordinate_system [string]
- daylighting_reference_point_coordinate_system [string] (Default: Relative)
- rectangular_surface_coordinate_system [string] (Default: Relative)

GeometryTransform¶

Provides a simple method of altering the footprint geometry of a model. The intent is to provide a single parameter that can be used to reshape the building description contained in the rest of the input file.

Fields
- plane_of_transform [string] (Default: XY)
- current_aspect_ratio [number]
- new_aspect_ratio [number]

Space¶

Defines a space (room) in the building. All Spaces are part of a Zone. Every Zone contains one or more spaces. Space is an optional input. If a Zone has no Space(s) specified in input then a default Space named <Zone Name> will be created. If some surfaces in a Zone are assigned to a space and some are not, then a default Space named <Zone Name>-Remainder will be created. Input references to Space Names must have a matching Space object (default space names may not be referenced except in output variable keys).

Fields
- zone_name [string]
- ceiling_height [unknown field type] (Default: Autocalculate)
- volume [unknown field type] (Default: Autocalculate)
- floor_area [unknown field type] (Default: Autocalculate)
- space_type [string] (Default: General)
- tags [Array of {tag}]

SpaceList¶

Defines a list of Spaces which can be referenced as a group. The SpaceList name may be used elsewhere in the input to apply a parameter to all Spaces in the list. SpaceLists can be used effectively with the following objects: InternalMass, People, Lights, ElectricEquipment, GasEquipment, HotWaterEquipment, and others.

Fields
- spaces [Array of {space_name}]

Zone¶

Defines a thermal zone of the building. Every zone contains one or more Spaces. Space is an optional input. If a Zone has no Space(s) specified in input then a default Space named <Zone Name> will be created. If some surfaces in a Zone are assigned to a space and some are not, then a default Space named <Zone Name>-Remainder will be created. Input references to Space Names must have a matching Space object (default space names may not be referenced except in output variable keys).

Fields
- direction_of_relative_north [number] (Default: 0.0)
- x_origin [number] (Default: 0.0)
- y_origin [number] (Default: 0.0)
- z_origin [number] (Default: 0.0)
- type [integer] (Default: 1)
- multiplier [integer] (Default: 1)
- ceiling_height [unknown field type] (Default: Autocalculate)
- volume [unknown field type] (Default: Autocalculate)
- floor_area [unknown field type] (Default: Autocalculate)
- zone_inside_convection_algorithm [string]
- zone_outside_convection_algorithm [string]
- part_of_total_floor_area [string] (Default: Yes)

ZoneList¶

Defines a list of thermal zones which can be referenced as a group. The ZoneList name may be used elsewhere in the input to apply a parameter to all zones in the list. ZoneLists can be used effectively with the following objects: People, Lights, ElectricEquipment, GasEquipment, HotWaterEquipment, ZoneInfiltration:DesignFlowRate, ZoneVentilation:DesignFlowRate, Sizing:Zone, ZoneControl:Thermostat, and others.

Fields
- zones [Array of {zone_name}]

ZoneGroup¶

Adds a multiplier to a ZoneList. This can be used to reduce the amount of input necessary for simulating repetitive structures, such as the identical floors of a multi-story building.

Fields
- zone_list_name [string]
- zone_list_multiplier [integer] (Default: 1)

BuildingSurface:Detailed¶

Allows for detailed entry of building heat transfer surfaces. Does not include subsurfaces such as windows or doors.

Fields
- surface_type [string]
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition [string]
- outside_boundary_condition_object [string]
- sun_exposure [string] (Default: SunExposed)
- wind_exposure [string] (Default: WindExposed)
- view_factor_to_ground [unknown field type] (Default: Autocalculate)
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

Wall:Detailed¶

Allows for detailed entry of wall heat transfer surfaces.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition [string]
- outside_boundary_condition_object [string]
- sun_exposure [string] (Default: SunExposed)
- wind_exposure [string] (Default: WindExposed)
- view_factor_to_ground [unknown field type] (Default: Autocalculate)
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

RoofCeiling:Detailed¶

Allows for detailed entry of roof/ceiling heat transfer surfaces.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition [string]
- outside_boundary_condition_object [string]
- sun_exposure [string] (Default: SunExposed)
- wind_exposure [string] (Default: WindExposed)
- view_factor_to_ground [unknown field type] (Default: Autocalculate)
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

Floor:Detailed¶

Allows for detailed entry of floor heat transfer surfaces.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition [string]
- outside_boundary_condition_object [string]
- sun_exposure [string] (Default: SunExposed)
- wind_exposure [string] (Default: WindExposed)
- view_factor_to_ground [unknown field type] (Default: Autocalculate)
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

Wall:Exterior¶

Allows for simplified entry of exterior walls. View Factor to Ground is automatically calculated.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 90.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Wall:Adiabatic¶

Allows for simplified entry of interior walls.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 90.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Wall:Underground¶

Allows for simplified entry of underground walls.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 90.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Wall:Interzone¶

Allows for simplified entry of interzone walls (walls between zones).

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition_object [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 90.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Roof¶

Allows for simplified entry of roofs (exterior). View Factor to Ground is automatically calculated.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 0.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- width [number]

Ceiling:Adiabatic¶

Allows for simplified entry of interior ceilings.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 0.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- width [number]

Ceiling:Interzone¶

Allows for simplified entry of ceilings using adjacent zone (interzone) heat transfer - adjacent surface should be a floor

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition_object [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 0.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- width [number]

Floor:GroundContact¶

Allows for simplified entry of exterior floors with ground contact. View Factors to Ground is automatically calculated.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 180.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- width [number]

Floor:Adiabatic¶

Allows for simplified entry of exterior floors ignoring ground contact or interior floors. View Factor to Ground is automatically calculated.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 180.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- width [number]

Floor:Interzone¶

Allows for simplified entry of floors using adjacent zone (interzone) heat transfer - adjacent surface should be a ceiling.

Fields
- construction_name [string]
- zone_name [string]
- space_name [string]
- outside_boundary_condition_object [string]
- azimuth_angle [number]
- tilt_angle [number] (Default: 180.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- width [number]

FenestrationSurface:Detailed¶

Allows for detailed entry of subsurfaces (windows, doors, glass doors, tubular daylighting devices).

Fields
- surface_type [string]
- construction_name [string]
- building_surface_name [string]
- outside_boundary_condition_object [string]
- view_factor_to_ground [unknown field type] (Default: Autocalculate)
- frame_and_divider_name [string]
- multiplier [number] (Default: 1.0)
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertex_1_x_coordinate [number]
- vertex_1_y_coordinate [number]
- vertex_1_z_coordinate [number]
- vertex_2_x_coordinate [number]
- vertex_2_y_coordinate [number]
- vertex_2_z_coordinate [number]
- vertex_3_x_coordinate [number]
- vertex_3_y_coordinate [number]
- vertex_3_z_coordinate [number]
- vertex_4_x_coordinate [number]
- vertex_4_y_coordinate [number]
- vertex_4_z_coordinate [number]

Window¶

Allows for simplified entry of Windows.

Fields
- construction_name [string]
- building_surface_name [string]
- frame_and_divider_name [string]
- multiplier [number] (Default: 1.0)
- starting_x_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Door¶

Allows for simplified entry of opaque Doors.

Fields
- construction_name [string]
- building_surface_name [string]
- multiplier [number] (Default: 1.0)
- starting_x_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

GlazedDoor¶

Allows for simplified entry of glass Doors.

Fields
- construction_name [string]
- building_surface_name [string]
- frame_and_divider_name [string]
- multiplier [number] (Default: 1.0)
- starting_x_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Window:Interzone¶

Allows for simplified entry of interzone windows (adjacent to other zones).

Fields
- construction_name [string]
- building_surface_name [string]
- outside_boundary_condition_object [string]
- multiplier [number] (Default: 1.0)
- starting_x_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Door:Interzone¶

Allows for simplified entry of interzone (opaque interior) doors (adjacent to other zones).

Fields
- construction_name [string]
- building_surface_name [string]
- outside_boundary_condition_object [string]
- multiplier [number] (Default: 1.0)
- starting_x_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

GlazedDoor:Interzone¶

Allows for simplified entry of interzone (glass interior) doors (adjacent to other zones).

Fields
- construction_name [string]
- building_surface_name [string]
- outside_boundary_condition_object [string]
- multiplier [number] (Default: 1.0)
- starting_x_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

WindowShadingControl¶

Specifies the type, location, and controls for window shades, window blinds, and switchable glazing. Referencing the surface objects for exterior windows and glass doors (ref: FenestrationSurface:Detailed, Window, and GlazedDoor).

Fields
- zone_name [string]
- shading_control_sequence_number [integer] (Default: 1)
- shading_type [string]
- construction_with_shading_name [string]
- shading_control_type [string]
- schedule_name [string]
- setpoint [number]
- shading_control_is_scheduled [string] (Default: No)
- glare_control_is_active [string] (Default: No)
- shading_device_material_name [string]
- type_of_slat_angle_control_for_blinds [string] (Default: FixedSlatAngle)
- slat_angle_schedule_name [string]
- setpoint_2 [number]
- daylighting_control_object_name [string]
- multiple_surface_control_type [string] (Default: Sequential)
- fenestration_surfaces [Array of {fenestration_surface_name}]

WindowProperty:FrameAndDivider¶

Specifies the dimensions of a window frame, dividers, and inside reveal surfaces. Referenced by the surface objects for exterior windows and glass doors (ref: FenestrationSurface:Detailed, Window, and GlazedDoor).

Fields
- frame_width [number] (Default: 0.0)
- frame_outside_projection [number] (Default: 0.0)
- frame_inside_projection [number] (Default: 0.0)
- frame_conductance [number]
- ratio_of_frame_edge_glass_conductance_to_center_of_glass_conductance [number] (Default: 1.0)
- frame_solar_absorptance [number] (Default: 0.7)
- frame_visible_absorptance [number] (Default: 0.7)
- frame_thermal_hemispherical_emissivity [number] (Default: 0.9)
- divider_type [string] (Default: DividedLite)
- divider_width [number] (Default: 0.0)
- number_of_horizontal_dividers [number] (Default: 0.0)
- number_of_vertical_dividers [number] (Default: 0.0)
- divider_outside_projection [number] (Default: 0.0)
- divider_inside_projection [number] (Default: 0.0)
- divider_conductance [number] (Default: 0.0)
- ratio_of_divider_edge_glass_conductance_to_center_of_glass_conductance [number] (Default: 1.0)
- divider_solar_absorptance [number] (Default: 0.0)
- divider_visible_absorptance [number] (Default: 0.0)
- divider_thermal_hemispherical_emissivity [number] (Default: 0.9)
- outside_reveal_solar_absorptance [number] (Default: 0.0)
- inside_sill_depth [number] (Default: 0.0)
- inside_sill_solar_absorptance [number] (Default: 0.0)
- inside_reveal_depth [number] (Default: 0.0)
- inside_reveal_solar_absorptance [number] (Default: 0.0)
- nfrc_product_type_for_assembly_calculations [string] (Default: CurtainWall)

WindowProperty:AirflowControl¶

Used to control forced airflow through a gap between glass layers

Fields
- airflow_source [string] (Default: IndoorAir)
- airflow_destination [string] (Default: OutdoorAir)
- maximum_flow_rate [number] (Default: 0.0)
- airflow_control_type [string] (Default: AlwaysOnAtMaximumFlow)
- airflow_is_scheduled [string] (Default: No)
- airflow_multiplier_schedule_name [string]
- airflow_return_air_node_name [string]

WindowProperty:StormWindow¶

This is a movable exterior glass layer that is usually applied in the winter and removed in the summer.

Fields
- window_name [string]
- storm_glass_layer_name [string]
- distance_between_storm_glass_layer_and_adjacent_glass [number] (Default: 0.05)
- month_that_storm_glass_layer_is_put_on [integer]
- day_of_month_that_storm_glass_layer_is_put_on [integer]
- month_that_storm_glass_layer_is_taken_off [integer]
- day_of_month_that_storm_glass_layer_is_taken_off [integer]

InternalMass¶

Used to describe internal zone surface area that does not need to be part of geometric representation. This should be the total surface area exposed to the zone air. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList. Likewise for SpaceList.

Fields
- construction_name [string]
- zone_or_zonelist_name [string]
- space_or_spacelist_name [string]
- surface_area [number]

Shading:Site¶

used for shading elements such as trees these items are fixed in space and would not move with relative geometry

Fields
- azimuth_angle [number]
- tilt_angle [number] (Default: 90.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Shading:Building¶

used for shading elements such as trees, other buildings, parts of this building not being modeled these items are relative to the current building and would move with relative geometry

Fields
- azimuth_angle [number]
- tilt_angle [number] (Default: 90.0)
- starting_x_coordinate [number]
- starting_y_coordinate [number]
- starting_z_coordinate [number]
- length [number]
- height [number]

Shading:Site:Detailed¶

used for shading elements such as trees these items are fixed in space and would not move with relative geometry

Fields
- transmittance_schedule_name [string]
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

Shading:Building:Detailed¶

used for shading elements such as trees, other buildings, parts of this building not being modeled these items are relative to the current building and would move with relative geometry

Fields
- transmittance_schedule_name [string]
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

Shading:Overhang¶

Overhangs are usually flat shading surfaces that reference a window or door.

Fields
- window_or_door_name [string]
- height_above_window_or_door [number]
- tilt_angle_from_window_door [number] (Default: 90.0)
- left_extension_from_window_door_width [number]
- right_extension_from_window_door_width [number]
- depth [number]

Shading:Overhang:Projection¶

Overhangs are typically flat shading surfaces that reference a window or door.

Fields
- window_or_door_name [string]
- height_above_window_or_door [number]
- tilt_angle_from_window_door [number] (Default: 90.0)
- left_extension_from_window_door_width [number]
- right_extension_from_window_door_width [number]
- depth_as_fraction_of_window_door_height [number]

Shading:Fin¶

Fins are usually shading surfaces that are perpendicular to a window or door.

Fields
- window_or_door_name [string]
- left_extension_from_window_door [number]
- left_distance_above_top_of_window [number]
- left_distance_below_bottom_of_window [number]
- left_tilt_angle_from_window_door [number] (Default: 90.0)
- left_depth [number]
- right_extension_from_window_door [number]
- right_distance_above_top_of_window [number]
- right_distance_below_bottom_of_window [number]
- right_tilt_angle_from_window_door [number] (Default: 90.0)
- right_depth [number]

Shading:Fin:Projection¶

Fins are usually shading surfaces that are perpendicular to a window or door.

Fields
- window_or_door_name [string]
- left_extension_from_window_door [number]
- left_distance_above_top_of_window [number]
- left_distance_below_bottom_of_window [number]
- left_tilt_angle_from_window_door [number] (Default: 90.0)
- left_depth_as_fraction_of_window_door_width [number]
- right_extension_from_window_door [number]
- right_distance_above_top_of_window [number]
- right_distance_below_bottom_of_window [number]
- right_tilt_angle_from_window_door [number] (Default: 90.0)
- right_depth_as_fraction_of_window_door_width [number]

Shading:Zone:Detailed¶

used For fins, overhangs, elements that shade the building, are attached to the building but are not part of the heat transfer calculations

Fields
- base_surface_name [string]
- transmittance_schedule_name [string]
- number_of_vertices [unknown field type] (Default: Autocalculate)
- vertices [Array of {vertex_x_coordinate, vertex_y_coordinate, vertex_z_coordinate}]

ShadingProperty:Reflectance¶

If this object is not defined for a shading surface the default values listed in following fields will be used in the solar reflection calculation.

Fields
- shading_surface_name [string]
- diffuse_solar_reflectance_of_unglazed_part_of_shading_surface [number] (Default: 0.2)
- diffuse_visible_reflectance_of_unglazed_part_of_shading_surface [number] (Default: 0.2)
- fraction_of_shading_surface_that_is_glazed [number] (Default: 0.0)
- glazing_construction_name [string]

Advanced Construction, Surface, Zone Concepts¶

SurfaceProperty:HeatTransferAlgorithm¶

Determines which Heat Balance Algorithm will be used for a specific surface Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

Fields
- surface_name [string]
- algorithm [string] (Default: ConductionTransferFunction)

SurfaceProperty:HeatTransferAlgorithm:MultipleSurface¶

Determines which Heat Balance Algorithm will be used for a group of surface types Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

Fields
- surface_type [string]
- algorithm [string] (Default: ConductionTransferFunction)

SurfaceProperty:HeatTransferAlgorithm:SurfaceList¶

Determines which Heat Balance Algorithm will be used for a list of surfaces Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

Fields
- algorithm [string] (Default: ConductionTransferFunction)
- surface [Array of {surface_name}]

SurfaceProperty:HeatTransferAlgorithm:Construction¶

Determines which Heat Balance Algorithm will be used for surfaces that have a specific type of construction Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

Fields
- algorithm [string] (Default: ConductionTransferFunction)
- construction_name [string]

SurfaceProperty:HeatBalanceSourceTerm¶

Allows an additional heat source term to be added to the inside or outside surface boundary. A heat source can be added to either or both the inside and outside of the same surface.

Fields
- surface_name [string]
- inside_face_heat_source_term_schedule_name [string]
- outside_face_heat_source_term_schedule_name [string]

SurfaceControl:MovableInsulation¶

Exterior or Interior Insulation on opaque surfaces

Fields
- insulation_type [string]
- surface_name [string]
- material_name [string]
- schedule_name [string]

SurfaceProperty:OtherSideCoefficients¶

This object sets the other side conditions for a surface in a variety of ways.

Fields
- combined_convective_radiative_film_coefficient [number]
- constant_temperature [number] (Default: 0.0)
- constant_temperature_coefficient [number] (Default: 1.0)
- external_dry_bulb_temperature_coefficient [number] (Default: 0.0)
- ground_temperature_coefficient [number] (Default: 0.0)
- wind_speed_coefficient [number] (Default: 0.0)
- zone_air_temperature_coefficient [number] (Default: 0.0)
- constant_temperature_schedule_name [string]
- sinusoidal_variation_of_constant_temperature_coefficient [string] (Default: No)
- period_of_sinusoidal_variation [number] (Default: 24.0)
- previous_other_side_temperature_coefficient [number] (Default: 0.0)
- minimum_other_side_temperature_limit [number]
- maximum_other_side_temperature_limit [number]

SurfaceProperty:OtherSideConditionsModel¶

This object sets up modifying the other side conditions for a surface from other model results.

Fields
- type_of_modeling [string] (Default: GapConvectionRadiation)

SurfaceProperty:Underwater¶

This object sets up a convective water boundary condition for a surface The free stream temperature and velocity are scheduled. If the free stream velocity is zero, the surface will naturally convect with the surrounding water.

Fields
- distance_from_surface_centroid_to_leading_edge_of_boundary_layer [number]
- free_stream_water_temperature_schedule [string]
- free_stream_water_velocity_schedule [string]

Foundation:Kiva¶

Refined definition of the foundation surface construction used to inform two-dimensional heat transfer calculated using the Kiva ground heat transfer methodology.

Fields
- initial_indoor_air_temperature [number]
- interior_horizontal_insulation_material_name [string]
- interior_horizontal_insulation_depth [number] (Default: 0.0)
- interior_horizontal_insulation_width [number]
- interior_vertical_insulation_material_name [string]
- interior_vertical_insulation_depth [number]
- exterior_horizontal_insulation_material_name [string]
- exterior_horizontal_insulation_depth [number]
- exterior_horizontal_insulation_width [number] (Default: 0.0)
- exterior_vertical_insulation_material_name [string]
- exterior_vertical_insulation_depth [number]
- wall_height_above_grade [number] (Default: 0.2)
- wall_depth_below_slab [number] (Default: 0.0)
- footing_wall_construction_name [string]
- footing_material_name [string]
- footing_depth [number] (Default: 0.3)
- blocks [Array of {custom_block_material_name, custom_block_depth, custom_block_x_position, custom_block_z_position}]

Foundation:Kiva:Settings¶

Settings applied across all Kiva foundation calculations. Object is not required. If not defined, defaults will be applied.

Fields
- soil_conductivity [number] (Default: 1.73)
- soil_density [number] (Default: 1842.0)
- soil_specific_heat [number] (Default: 419.0)
- ground_solar_absorptivity [number] (Default: 0.9)
- ground_thermal_absorptivity [number] (Default: 0.9)
- ground_surface_roughness [number] (Default: 0.03)
- far_field_width [number] (Default: 40.0)
- deep_ground_boundary_condition [string] (Default: Autoselect)
- deep_ground_depth [unknown field type] (Default: Autocalculate)
- minimum_cell_dimension [number] (Default: 0.02)
- maximum_cell_growth_coefficient [number] (Default: 1.5)
- simulation_timestep [string] (Default: Hourly)

SurfaceProperty:ExposedFoundationPerimeter¶

Defines the perimeter of a foundation floor that is exposed to the exterior environment through the floor. User may either define the total exposed perimeter, fraction of perimeter exposed or individually define which segments of the floor surface perimeter are exposed.

Fields
- surface_name [string]
- exposed_perimeter_calculation_method [string]
- total_exposed_perimeter [number]
- exposed_perimeter_fraction [number] (Default: 1.0)
- surfaces [Array of {surface_segment_exposed}]

SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections¶

Options to change the individual convection model equations for dynamic selection when using AdaptiveConvectiongAlgorithm This object is only needed to make changes to the default model selections for any or all of the surface categories. This object is for the inside face, the side of the surface facing a thermal zone.

Fields
- simple_buoyancy_vertical_wall_equation_source [string] (Default: FohannoPolidoriVerticalWall)
- simple_buoyancy_vertical_wall_user_curve_name [string]
- simple_buoyancy_stable_horizontal_equation_source [string] (Default: AlamdariHammondStableHorizontal)
- simple_buoyancy_stable_horizontal_equation_user_curve_name [string]
- simple_buoyancy_unstable_horizontal_equation_source [string] (Default: AlamdariHammondUnstableHorizontal)
- simple_buoyancy_unstable_horizontal_equation_user_curve_name [string]
- simple_buoyancy_stable_tilted_equation_source [string] (Default: WaltonStableHorizontalOrTilt)
- simple_buoyancy_stable_tilted_equation_user_curve_name [string]
- simple_buoyancy_unstable_tilted_equation_source [string] (Default: WaltonUnstableHorizontalOrTilt)
- simple_buoyancy_unstable_tilted_equation_user_curve_name [string]
- simple_buoyancy_windows_equation_source [string] (Default: ISO15099Windows)
- simple_buoyancy_windows_equation_user_curve_name [string]
- floor_heat_ceiling_cool_vertical_wall_equation_source [string] (Default: KhalifaEq3WallAwayFromHeat)
- floor_heat_ceiling_cool_vertical_wall_equation_user_curve_name [string]
- floor_heat_ceiling_cool_stable_horizontal_equation_source [string] (Default: AlamdariHammondStableHorizontal)
- floor_heat_ceiling_cool_stable_horizontal_equation_user_curve_name [string]
- floor_heat_ceiling_cool_unstable_horizontal_equation_source [string] (Default: KhalifaEq4CeilingAwayFromHeat)
- floor_heat_ceiling_cool_unstable_horizontal_equation_user_curve_name [string]
- floor_heat_ceiling_cool_heated_floor_equation_source [string] (Default: AwbiHattonHeatedFloor)
- floor_heat_ceiling_cool_heated_floor_equation_user_curve_name [string]
- floor_heat_ceiling_cool_chilled_ceiling_equation_source [string] (Default: KaradagChilledCeiling)
- floor_heat_ceiling_cool_chilled_ceiling_equation_user_curve_name [string]
- floor_heat_ceiling_cool_stable_tilted_equation_source [string] (Default: WaltonStableHorizontalOrTilt)
- floor_heat_ceiling_cool_stable_tilted_equation_user_curve_name [string]
- floor_heat_ceiling_cool_unstable_tilted_equation_source [string] (Default: WaltonUnstableHorizontalOrTilt)
- floor_heat_ceiling_cool_unstable_tilted_equation_user_curve_name [string]
- floor_heat_ceiling_cool_window_equation_source [string] (Default: ISO15099Windows)
- floor_heat_ceiling_cool_window_equation_user_curve_name [string]
- wall_panel_heating_vertical_wall_equation_source [string] (Default: KhalifaEq6NonHeatedWalls)
- wall_panel_heating_vertical_wall_equation_user_curve_name [string]
- wall_panel_heating_heated_wall_equation_source [string] (Default: AwbiHattonHeatedWall)
- wall_panel_heating_heated_wall_equation_user_curve_name [string]
- wall_panel_heating_stable_horizontal_equation_source [string] (Default: AlamdariHammondStableHorizontal)
- wall_panel_heating_stable_horizontal_equation_user_curve_name [string]
- wall_panel_heating_unstable_horizontal_equation_source [string] (Default: KhalifaEq7Ceiling)
- wall_panel_heating_unstable_horizontal_equation_user_curve_name [string]
- wall_panel_heating_stable_tilted_equation_source [string] (Default: WaltonStableHorizontalOrTilt)
- wall_panel_heating_stable_tilted_equation_user_curve_name [string]
- wall_panel_heating_unstable_tilted_equation_source [string] (Default: WaltonUnstableHorizontalOrTilt)
- wall_panel_heating_unstable_tilted_equation_user_curve_name [string]
- wall_panel_heating_window_equation_source [string] (Default: ISO15099Windows)
- wall_panel_heating_window_equation_user_curve_name [string]
- convective_zone_heater_vertical_wall_equation_source [string] (Default: FohannoPolidoriVerticalWall)
- convective_zone_heater_vertical_wall_equation_user_curve_name [string]
- convective_zone_heater_vertical_walls_near_heater_equation_source [string] (Default: KhalifaEq5WallNearHeat)
- convective_zone_heater_vertical_walls_near_heater_equation_user_curve_name [string]
- convective_zone_heater_stable_horizontal_equation_source [string] (Default: AlamdariHammondStableHorizontal)
- convective_zone_heater_stable_horizontal_equation_user_curve_name [string]
- convective_zone_heater_unstable_horizontal_equation_source [string] (Default: KhalifaEq7Ceiling)
- convective_zone_heater_unstable_horizontal_equation_user_curve_name [string]
- convective_zone_heater_stable_tilted_equation_source [string] (Default: WaltonStableHorizontalOrTilt)
- convective_zone_heater_stable_tilted_equation_user_curve_name [string]
- convective_zone_heater_unstable_tilted_equation_source [string] (Default: WaltonUnstableHorizontalOrTilt)
- convective_zone_heater_unstable_tilted_equation_user_curve_name [string]
- convective_zone_heater_windows_equation_source [string] (Default: ISO15099Windows)
- convective_zone_heater_windows_equation_user_curve_name [string]
- central_air_diffuser_wall_equation_source [string] (Default: GoldsteinNovoselacCeilingDiffuserWalls)
- central_air_diffuser_wall_equation_user_curve_name [string]
- central_air_diffuser_ceiling_equation_source [string] (Default: FisherPedersenCeilingDiffuserCeiling)
- central_air_diffuser_ceiling_equation_user_curve_name [string]
- central_air_diffuser_floor_equation_source [string] (Default: GoldsteinNovoselacCeilingDiffuserFloor)
- central_air_diffuser_floor_equation_user_curve_name [string]
- central_air_diffuser_window_equation_source [string] (Default: GoldsteinNovoselacCeilingDiffuserWindow)
- central_air_diffuser_window_equation_user_curve_name [string]
- mechanical_zone_fan_circulation_vertical_wall_equation_source [string] (Default: KhalifaEq3WallAwayFromHeat)
- mechanical_zone_fan_circulation_vertical_wall_equation_user_curve_name [string]
- mechanical_zone_fan_circulation_stable_horizontal_equation_source [string] (Default: AlamdariHammondStableHorizontal)
- mechanical_zone_fan_circulation_stable_horizontal_equation_user_curve_name [string]
- mechanical_zone_fan_circulation_unstable_horizontal_equation_source [string] (Default: KhalifaEq4CeilingAwayFromHeat)
- mechanical_zone_fan_circulation_unstable_horizontal_equation_user_curve_name [string]
- mechanical_zone_fan_circulation_stable_tilted_equation_source [string] (Default: WaltonStableHorizontalOrTilt)
- mechanical_zone_fan_circulation_stable_tilted_equation_user_curve_name [string]
- mechanical_zone_fan_circulation_unstable_tilted_equation_source [string] (Default: WaltonUnstableHorizontalOrTilt)
- mechanical_zone_fan_circulation_unstable_tilted_equation_user_curve_name [string]
- mechanical_zone_fan_circulation_window_equation_source [string] (Default: ISO15099Windows)
- mechanical_zone_fan_circulation_window_equation_user_curve_name [string]
- mixed_regime_buoyancy_assisting_flow_on_walls_equation_source [string] (Default: BeausoleilMorrisonMixedAssistedWall)
- mixed_regime_buoyancy_assisting_flow_on_walls_equation_user_curve_name [string]
- mixed_regime_buoyancy_opposing_flow_on_walls_equation_source [string] (Default: BeausoleilMorrisonMixedOpposingWall)
- mixed_regime_buoyancy_opposing_flow_on_walls_equation_user_curve_name [string]
- mixed_regime_stable_floor_equation_source [string] (Default: BeausoleilMorrisonMixedStableFloor)
- mixed_regime_stable_floor_equation_user_curve_name [string]
- mixed_regime_unstable_floor_equation_source [string] (Default: BeausoleilMorrisonMixedUnstableFloor)
- mixed_regime_unstable_floor_equation_user_curve_name [string]
- mixed_regime_stable_ceiling_equation_source [string] (Default: BeausoleilMorrisonMixedStableCeiling)
- mixed_regime_stable_ceiling_equation_user_curve_name [string]
- mixed_regime_unstable_ceiling_equation_source [string] (Default: BeausoleilMorrisonMixedUnstableCeiling)
- mixed_regime_unstable_ceiling_equation_user_curve_name [string]
- mixed_regime_window_equation_source [string] (Default: GoldsteinNovoselacCeilingDiffuserWindow)
- mixed_regime_window_equation_user_curve_name [string]

SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections¶

Options to change the individual convection model equations for dynamic selection when using AdaptiveConvectiongAlgorithm This object is only needed to make changes to the default model selections for any or all of the surface categories. This object is for the outside face, the side of the surface facing away from the thermal zone.

Fields
- wind_convection_windward_vertical_wall_equation_source [string] (Default: TARPWindward)
- wind_convection_windward_equation_vertical_wall_user_curve_name [string]
- wind_convection_leeward_vertical_wall_equation_source [string] (Default: TARPLeeward)
- wind_convection_leeward_vertical_wall_equation_user_curve_name [string]
- wind_convection_horizontal_roof_equation_source [string] (Default: ClearRoof)
- wind_convection_horizontal_roof_user_curve_name [string]
- natural_convection_vertical_wall_equation_source [string] (Default: ASHRAEVerticalWall)
- natural_convection_vertical_wall_equation_user_curve_name [string]
- natural_convection_stable_horizontal_equation_source [string] (Default: WaltonStableHorizontalOrTilt)
- natural_convection_stable_horizontal_equation_user_curve_name [string]
- natural_convection_unstable_horizontal_equation_source [string] (Default: WaltonUnstableHorizontalOrTilt)
- natural_convection_unstable_horizontal_equation_user_curve_name [string]

SurfaceConvectionAlgorithm:Inside:UserCurve¶

Used to describe a custom model equation for surface convection heat transfer coefficient If more than one curve is referenced they are all used and added together.

Fields
- reference_temperature_for_convection_heat_transfer [string]
- hc_function_of_temperature_difference_curve_name [string]
- hc_function_of_temperature_difference_divided_by_height_curve_name [string]
- hc_function_of_air_change_rate_curve_name [string]
- hc_function_of_air_system_volume_flow_rate_divided_by_zone_perimeter_length_curve_name [string]

SurfaceConvectionAlgorithm:Outside:UserCurve¶

Used to describe a custom model equation for surface convection heat transfer coefficient If more than one curve is referenced they are all used and added together.

Fields
- wind_speed_type_for_curve [string] (Default: HeightAdjust)
- hf_function_of_wind_speed_curve_name [string]
- hn_function_of_temperature_difference_curve_name [string]
- hn_function_of_temperature_difference_divided_by_height_curve_name [string]

SurfaceProperty:ConvectionCoefficients¶

Allow user settable interior and/or exterior convection coefficients. Note that some other factors may limit the lower bounds for these values, such as for windows, the interior convection coefficient must be >.28, for trombe wall algorithm selection (zone), the interior convection coefficient must be >.1 for TARP interior convection, the lower limit is also .1 Minimum and maximum limits are set in HeatBalanceAlgorithm object. Defaults in HeatBalanceAlgorithm object are [.1,1000].

Fields
- surface_name [string]
- convection_coefficient_1_location [string]
- convection_coefficient_1_type [string]
- convection_coefficient_1 [number]
- convection_coefficient_1_schedule_name [string]
- convection_coefficient_1_user_curve_name [string]
- convection_coefficient_2_location [string]
- convection_coefficient_2_type [string]
- convection_coefficient_2 [number] (Default: 0.1)
- convection_coefficient_2_schedule_name [string]
- convection_coefficient_2_user_curve_name [string]

SurfaceProperty:ConvectionCoefficients:MultipleSurface¶

Fields
- surface_type [string]
- convection_coefficient_1_location [string]
- convection_coefficient_1_type [string]
- convection_coefficient_1 [number]
- convection_coefficient_1_schedule_name [string]
- convection_coefficient_1_user_curve_name [string]
- convection_coefficient_2_location [string]
- convection_coefficient_2_type [string]
- convection_coefficient_2 [number] (Default: 0.1)
- convection_coefficient_2_schedule_name [string]
- convection_coefficient_2_user_curve_name [string]

SurfaceProperties:VaporCoefficients¶

The interior and external vapor transfer coefficients. Normally these value are calculated using the heat convection coefficient values. Use this object to used fixed constant values. Units are kg/Pa.s.m2 This will only work with the CombinedHeatAndMoistureFiniteElement algorithm for surfaces. Other algorithms will ignore these coefficients

Fields
- surface_name [string]
- constant_external_vapor_transfer_coefficient [string] (Default: No)
- external_vapor_coefficient_value [number] (Default: 0.0)
- constant_internal_vapor_transfer_coefficient [string] (Default: No)
- internal_vapor_coefficient_value [number] (Default: 0.0)

SurfaceProperty:ExteriorNaturalVentedCavity¶

Used to describe the decoupled layer, or baffle, and the characteristics of the cavity and openings for naturally ventilated exterior surfaces. This object is also used in conjunction with the OtherSideConditionsModel.

Fields
- boundary_conditions_model_name [string]
- area_fraction_of_openings [number]
- thermal_emissivity_of_exterior_baffle_material [number]
- solar_absorbtivity_of_exterior_baffle [number]
- height_scale_for_buoyancy_driven_ventilation [number]
- effective_thickness_of_cavity_behind_exterior_baffle [number]
- ratio_of_actual_surface_area_to_projected_surface_area [number] (Default: 1.0)
- roughness_of_exterior_surface [string]
- effectiveness_for_perforations_with_respect_to_wind [number] (Default: 0.25)
- discharge_coefficient_for_openings_with_respect_to_buoyancy_driven_flow [number] (Default: 0.65)
- surface [Array of {surface_name}]

SurfaceProperty:SolarIncidentInside¶

Used to provide incident solar radiation on the inside of the surface. Reference surface-construction pair and if that pair is used in a simulation, then program will use value provided in schedule instead of calculating it.

Fields
- surface_name [string]
- construction_name [string]
- inside_surface_incident_sun_solar_radiation_schedule_name [string]

SurfaceProperty:IncidentSolarMultiplier¶

Fields
- surface_name [string]
- incident_solar_multiplier [number] (Default: 1.0)
- incident_solar_multiplier_schedule_name [string]

SurfaceProperty:LocalEnvironment¶

This object defines the local environment properties of an exterior surface. One or more environment properties have to be defined and linked to the exterior surface.

Fields
- exterior_surface_name [string]
- external_shading_fraction_schedule_name [string]
- surrounding_surfaces_object_name [string]
- outdoor_air_node_name [string]
- ground_surfaces_object_name [string]

ZoneProperty:LocalEnvironment¶

This object defines the local environment properties of a zone object. A corresponding outdoor air node should be defined and linked to the zone object.

Fields
- zone_name [string]
- outdoor_air_node_name [string]

SurfaceProperty:SurroundingSurfaces¶

This object defines a list of surrounding surfaces for an exterior surface.

Fields
- sky_view_factor [number] (Default: 0.5)
- sky_temperature_schedule_name [string]
- ground_view_factor [number] (Default: 0.5)
- ground_temperature_schedule_name [string]
- surfaces [Array of {surrounding_surface_name, surrounding_surface_view_factor, surrounding_surface_temperature_schedule_name}]

SurfaceProperty:GroundSurfaces¶

This object defines a list of ground surfaces for use with an exterior surface.

Fields
- ground_surfaces [Array of {ground_surface_name, ground_surface_view_factor, ground_surface_temperature_schedule_name, ground_surface_reflectance_schedule_name}]

ComplexFenestrationProperty:SolarAbsorbedLayers¶

Used to provide solar radiation absorbed in fenestration layers. References surface-construction pair and if that pair is used in a simulation, then program will use value provided in schedules instead of calculating it.

Fields
- fenestration_surface [string]
- construction_name [string]
- layer_1_solar_radiation_absorbed_schedule_name [string]
- layer_2_solar_radiation_absorbed_schedule_name [string]
- layer_3_solar_radiation_absorbed_schedule_name [string]
- layer_4_solar_radiation_absorbed_schedule_name [string]
- layer_5_solar_radiation_absorbed_schedule_name [string]

ZoneProperty:UserViewFactors:BySurfaceName¶

View factors for Surface to Surface in a zone. (Number of Surfaces)**2 are expected. Any omitted surface pairs will be assumed to have a view factor of zero.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- view_factors [Array of {from_surface, to_surface, view_factor}]

Detailed Ground Heat Transfer¶

GroundHeatTransfer:Control¶

Object determines if the Slab and Basement preprocessors are going to be executed.

Fields
- run_basement_preprocessor [string] (Default: No)
- run_slab_preprocessor [string] (Default: No)

GroundHeatTransfer:Slab:Materials¶

Object gives an overall description of the slab ground heat transfer model.

Fields
- nmat_number_of_materials [number]
- albedo_surface_albedo_no_snow [number] (Default: 0.16)
- albedo_surface_albedo_snow [number] (Default: 0.4)
- epslw_surface_emissivity_no_snow [number] (Default: 0.94)
- epslw_surface_emissivity_snow [number] (Default: 0.86)
- z0_surface_roughness_no_snow [number] (Default: 0.75)
- z0_surface_roughness_snow [number] (Default: 0.25)
- hin_indoor_hconv_downward_flow [number] (Default: 6.13)
- hin_indoor_hconv_upward [number] (Default: 9.26)

GroundHeatTransfer:Slab:MatlProps¶

This object contains the material properties for the materials used in the model. The fields are mostly self explanatory.

Fields
- rho_slab_material_density [number] (Default: 2300.0)
- rho_soil_density [number] (Default: 1200.0)
- cp_slab_cp [number] (Default: 650.0)
- cp_soil_cp [number] (Default: 1200.0)
- tcon_slab_k [number] (Default: 0.9)
- tcon_soil_k [number] (Default: 1.0)

GroundHeatTransfer:Slab:BoundConds¶

Supplies some of the boundary conditions used in the ground heat transfer calculations.

Fields
- evtr_is_surface_evapotranspiration_modeled [string]
- fixbc_is_the_lower_boundary_at_a_fixed_temperature [string]
- tdeepin [number]
- usrhflag_is_the_ground_surface_h_specified_by_the_user_ [string]
- userh_user_specified_ground_surface_heat_transfer_coefficient [number]

GroundHeatTransfer:Slab:BldgProps¶

Object provides information about the building and its operating conditions Monthly Average Temperature SetPoint fields specify the average indoor building set point temperatures for each month of the year. These fields are useful for simulating a building that is not temperature controlled for some of the year. In such a case, the average indoor set point temperatures can be obtained by first running the model in EnergyPlus with an insulated floor boundary condition, and then using the resulting monthly average zone temperatures in these fields.

Fields
- iyrs_number_of_years_to_iterate [number] (Default: 10.0)
- shape_slab_shape [number]
- hbldg_building_height [number]
- tin1_january_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin2_february_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin3_march_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin4_april_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin5_may_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin6_june_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin7_july_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin8_august_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin9_september_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin10_october_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin11_november_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tin12_december_indoor_average_temperature_setpoint [number] (Default: 22.0)
- tinamp_daily_indoor_sine_wave_variation_amplitude [number] (Default: 0.0)
- convtol_convergence_tolerance [number] (Default: 0.1)

GroundHeatTransfer:Slab:Insulation¶

This object supplies the information about insulation used around the slab. There are two possible configurations: under the slab or vertical insulation around the slab.

Fields
- rins_r_value_of_under_slab_insulation [number] (Default: 0.0)
- dins_width_of_strip_of_under_slab_insulation [number] (Default: 0.0)
- rvins_r_value_of_vertical_insulation [number] (Default: 0.0)
- zvins_depth_of_vertical_insulation [number] (Default: 0.0)
- ivins_flag_is_there_vertical_insulation [unknown field type] (Default: 0.0)

GroundHeatTransfer:Slab:EquivalentSlab¶

Using an equivalent slab allows non-rectangular shapes to be modeled accurately. Object uses the area - perimeter (area/perimeter) ratio to determine the size of an equivalent rectangular slab. EnergyPlus users normally use this option.

Fields
- apratio_the_area_to_perimeter_ratio_for_this_slab [number]
- slabdepth_thickness_of_slab_on_grade [number] (Default: 0.1)
- clearance_distance_from_edge_of_slab_to_domain_edge [number] (Default: 15.0)
- zclearance_distance_from_bottom_of_slab_to_domain_bottom [number] (Default: 15.0)

GroundHeatTransfer:Slab:AutoGrid¶

AutoGrid only necessary when EquivalentSlab option not chosen. Not normally needed by EnergyPlus users. This object permits user selection of rectangular slab dimensions. NO SLAB DIMENSIONS LESS THAN 6 m.

Fields
- slabx_x_dimension_of_the_building_slab [number]
- slaby_y_dimension_of_the_building_slab [number]
- slabdepth_thickness_of_slab_on_grade [number] (Default: 0.1)
- clearance_distance_from_edge_of_slab_to_domain_edge [number] (Default: 15.0)
- zclearance_distance_from_bottom_of_slab_to_domain_bottom [number] (Default: 15.0)

GroundHeatTransfer:Slab:ManualGrid¶

Manual Grid only necessary when using manual gridding (not recommended) Used only in special cases when previous two objects are not used. User must input complete gridding information.

Fields
- nx_number_of_cells_in_the_x_direction [number]
- ny_number_of_cells_in_the_y_direction [number]
- nz_number_of_cells_in_the_z_direction [number]
- ibox_x_direction_cell_indicator_of_slab_edge [number]
- jbox_y_direction_cell_indicator_of_slab_edge [number]

GroundHeatTransfer:Slab:XFACE¶

This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m

Fields

GroundHeatTransfer:Slab:YFACE¶

This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m,

Fields

GroundHeatTransfer:Slab:ZFACE¶

This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m

Fields

GroundHeatTransfer:Basement:SimParameters¶

Specifies certain parameters that control the Basement preprocessor ground heat transfer simulation.

Fields
- f_multiplier_for_the_adi_solution [number]
- iyrs_maximum_number_of_yearly_iterations_ [number] (Default: 15.0)

GroundHeatTransfer:Basement:MatlProps¶

Specifies the material properties for the Basement preprocessor ground heat transfer simulation. Only the Foundation Wall, Floor Slab, Soil, and Gravel properties are currently used.

Fields
- nmat_number_of_materials_in_this_domain [number]
- density_for_foundation_wall [number] (Default: 2243.0)
- density_for_floor_slab [number] (Default: 2243.0)
- density_for_ceiling [number] (Default: 311.0)
- density_for_soil [number] (Default: 1500.0)
- density_for_gravel [number] (Default: 2000.0)
- density_for_wood [number] (Default: 449.0)
- specific_heat_for_foundation_wall [number] (Default: 880.0)
- specific_heat_for_floor_slab [number] (Default: 880.0)
- specific_heat_for_ceiling [number] (Default: 1530.0)
- specific_heat_for_soil [number] (Default: 840.0)
- specific_heat_for_gravel [number] (Default: 720.0)
- specific_heat_for_wood [number] (Default: 1530.0)
- thermal_conductivity_for_foundation_wall [number] (Default: 1.4)
- thermal_conductivity_for_floor_slab [number] (Default: 1.4)
- thermal_conductivity_for_ceiling [number] (Default: 0.09)
- thermal_conductivity_for_soil [number] (Default: 1.1)
- thermal_conductivity_for_gravel [number] (Default: 1.9)
- thermal_conductivity_for_wood [number] (Default: 0.12)

GroundHeatTransfer:Basement:Insulation¶

Describes the insulation used on an exterior basement wall for the Basement preprocessor ground heat transfer simulation.

Fields
- rext_r_value_of_any_exterior_insulation [number]
- insfull_flag_is_the_wall_fully_insulated_ [string]

GroundHeatTransfer:Basement:SurfaceProps¶

Specifies the soil surface properties for the Basement preprocessor ground heat transfer simulation.

Fields
- albedo_surface_albedo_for_no_snow_conditions [number] (Default: 0.16)
- albedo_surface_albedo_for_snow_conditions [number] (Default: 0.4)
- epsln_surface_emissivity_no_snow [number] (Default: 0.94)
- epsln_surface_emissivity_with_snow [number] (Default: 0.86)
- veght_surface_roughness_no_snow_conditions [number] (Default: 6.0)
- veght_surface_roughness_snow_conditions [number] (Default: 0.25)
- pet_flag_potential_evapotranspiration_on_ [string] (Default: FALSE)

GroundHeatTransfer:Basement:BldgData¶

Specifies the surface and gravel thicknesses used for the Basement preprocessor ground heat transfer simulation.

Fields
- dwall_wall_thickness [number] (Default: 0.2)
- dslab_floor_slab_thickness [number] (Default: 0.1)
- dgravxy_width_of_gravel_pit_beside_basement_wall [number] (Default: 0.3)
- dgravzn_gravel_depth_extending_above_the_floor_slab [number] (Default: 0.2)
- dgravzp_gravel_depth_below_the_floor_slab [number] (Default: 0.1)

GroundHeatTransfer:Basement:Interior¶

Provides the information needed to simulate the inside boundary conditions for the Basement preprocessor ground heat transfer simulation.

Fields
- cond_flag_is_the_basement_conditioned_ [string] (Default: TRUE)
- hin_downward_convection_only_heat_transfer_coefficient [number] (Default: 0.92)
- hin_upward_convection_only_heat_transfer_coefficient [number] (Default: 4.04)
- hin_horizontal_convection_only_heat_transfer_coefficient [number] (Default: 3.08)
- hin_downward_combined_convection_and_radiation_heat_transfer_coefficient [number] (Default: 6.13)
- hin_upward_combined_convection_and_radiation_heat_transfer_coefficient [number] (Default: 9.26)
- hin_horizontal_combined_convection_and_radiation_heat_transfer_coefficient [number] (Default: 8.29)

GroundHeatTransfer:Basement:ComBldg¶

ComBldg contains the monthly average temperatures (C) and possibility of daily variation amplitude

Fields
- january_average_temperature [number] (Default: 22.0)
- february_average_temperature [number] (Default: 22.0)
- march_average_temperature [number] (Default: 22.0)
- april_average_temperature [number] (Default: 22.0)
- may_average_temperature [number] (Default: 22.0)
- june_average_temperature [number] (Default: 22.0)
- july_average_temperature [number] (Default: 22.0)
- august_average_temperature [number] (Default: 22.0)
- september_average_temperature [number] (Default: 22.0)
- october_average_temperature [number] (Default: 22.0)
- november_average_temperature [number] (Default: 22.0)
- december_average_temperature [number] (Default: 22.0)
- daily_variation_sine_wave_amplitude [number] (Default: 0.0)

GroundHeatTransfer:Basement:EquivSlab¶

Using an equivalent slab allows non-rectangular shapes to be modeled accurately. The simulation default should be EquivSizing=True

Fields
- apratio_the_area_to_perimeter_ratio_for_this_slab [number]
- equivsizing_flag [string]

GroundHeatTransfer:Basement:EquivAutoGrid¶

EquivAutoGrid necessary when EquivSizing=TRUE, TRUE is is the normal case.

Fields
- clearance_distance_from_outside_of_wall_to_edge_of_3_d_ground_domain [number] (Default: 15.0)
- slabdepth_thickness_of_the_floor_slab [number] (Default: 0.1)
- basedepth_depth_of_the_basement_wall_below_grade [number] (Default: 2.0)

GroundHeatTransfer:Basement:AutoGrid¶

AutoGrid only necessary when EquivSizing is false If the modeled building is not a rectangle or square, Equivalent sizing MUST be used to get accurate results

Fields
- clearance_distance_from_outside_of_wall_to_edge_ [number] (Default: 15.0)
- slabx_x_dimension_of_the_building_slab [number]
- slaby_y_dimension_of_the_building_slab [number]
- concagheight_height_of_the_foundation_wall_above_grade [number] (Default: 0.0)
- slabdepth_thickness_of_the_floor_slab [number] (Default: 0.1)
- basedepth_depth_of_the_basement_wall_below_grade [number] (Default: 2.0)

GroundHeatTransfer:Basement:ManualGrid¶

Manual Grid only necessary using manual gridding (not recommended)

Fields
- nx_number_of_cells_in_the_x_direction_20_ [number]
- ny_number_of_cells_in_the_y_direction_20_ [number]
- nzag_number_of_cells_in_the_z_direction_above_grade_4_always_ [number]
- nzbg_number_of_cells_in_z_direction_below_grade_10_35_ [number]
- ibase_x_direction_cell_indicator_of_slab_edge_5_20_ [number]
- jbase_y_direction_cell_indicator_of_slab_edge_5_20_ [number]
- kbase_z_direction_cell_indicator_of_the_top_of_the_floor_slab_5_20_ [number]

GroundHeatTransfer:Basement:XFACE¶

This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m

Fields

GroundHeatTransfer:Basement:YFACE¶

This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m

Fields

GroundHeatTransfer:Basement:ZFACE¶

This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m

Fields

Room Air Models¶

RoomAirModelType¶

Selects the type of room air model to be used in a given zone. If no RoomAirModelType object is specified then the default Mixing model (all zone air at the same temperature) will be used.

Fields
- zone_name [string]
- room_air_modeling_type [string] (Default: Mixing)
- air_temperature_coupling_strategy [string] (Default: Direct)

RoomAir:TemperaturePattern:UserDefined¶

Used to explicitly define temperature patterns that are to be applied to the mean air temperature within a thermal zone. Used with RoomAirModelType = UserDefined.

Fields
- zone_name [string]
- availability_schedule_name [string]
- pattern_control_schedule_name [string]

RoomAir:TemperaturePattern:ConstantGradient¶

Used to model room air with a fixed temperature gradient in the vertical direction. Used in combination with RoomAir:TemperaturePattern:UserDefined.

Fields
- room_air_temperature_pattern_constant_gradient_name [string]
- control_integer_for_pattern_control_schedule_name [integer]
- thermostat_offset [number]
- return_air_offset [number]
- exhaust_air_offset [number]
- temperature_gradient [number]

RoomAir:TemperaturePattern:TwoGradient¶

Used to model room air with two temperature gradients in the vertical direction. Used in combination with RoomAir:TemperaturePattern:UserDefined.

Fields
- room_air_temperature_pattern_two_gradient_name [string]
- control_integer_for_pattern_control_schedule_name [integer]
- thermostat_height [number]
- return_air_height [number]
- exhaust_air_height [number]
- temperature_gradient_lower_bound [number]
- temperature_gradient_upper_bound [number]
- gradient_interpolation_mode [string]
- upper_temperature_bound [number]
- lower_temperature_bound [number]
- upper_heat_rate_bound [number]
- lower_heat_rate_bound [number]

RoomAir:TemperaturePattern:NondimensionalHeight¶

Defines a distribution pattern for air temperatures relative to the current mean air temperature as a function of height. The height, referred to as Zeta, is nondimensional by normalizing with the zone ceiling height. Used in combination with RoomAir:TemperaturePattern:UserDefined.

Fields
- control_integer_for_pattern_control_schedule_name [integer]
- thermostat_offset [number]
- return_air_offset [number]
- exhaust_air_offset [number]
- pairs [Array of {pair_zeta_nondimensional_height, pair_delta_adjacent_air_temperature}]

RoomAir:TemperaturePattern:SurfaceMapping¶

Defines a distribution pattern for the air temperatures adjacent to individual surfaces. This allows controlling the adjacent air temperature on a surface-by-surface basis rather than by height. This allows modeling different adjacent air temperatures on the opposite sides of the zone. Used in combination with RoomAir:TemperaturePattern:UserDefined.

Fields
- control_integer_for_pattern_control_schedule_name [integer]
- thermostat_offset [number]
- return_air_offset [number]
- exhaust_air_offset [number]
- surface_deltas [Array of {surface_name_pair, delta_adjacent_air_temperature_pair}]

RoomAir:Node¶

Define an air node for some types of nodal room air models

Fields
- node_type [string]
- zone_name [string]
- height_of_nodal_control_volume_center [number]
- surface_1_name [string]
- surface_2_name [string]
- surface_3_name [string]
- surface_4_name [string]
- surface_5_name [string]
- surface_6_name [string]
- surface_7_name [string]
- surface_8_name [string]
- surface_9_name [string]
- surface_10_name [string]
- surface_11_name [string]
- surface_12_name [string]
- surface_13_name [string]
- surface_14_name [string]
- surface_15_name [string]
- surface_16_name [string]
- surface_17_name [string]
- surface_18_name [string]
- surface_19_name [string]
- surface_20_name [string]
- surface_21_name [string]

RoomAirSettings:OneNodeDisplacementVentilation¶

The Mundt model for displacement ventilation

Fields
- zone_name [string]
- fraction_of_convective_internal_loads_added_to_floor_air [number]
- fraction_of_infiltration_internal_loads_added_to_floor_air [number]

RoomAirSettings:ThreeNodeDisplacementVentilation¶

The UCSD model for Displacement Ventilation

Fields
- zone_name [string]
- gain_distribution_schedule_name [string]
- number_of_plumes_per_occupant [number] (Default: 1.0)
- thermostat_height [number] (Default: 1.1)
- comfort_height [number] (Default: 1.1)
- temperature_difference_threshold_for_reporting [number] (Default: 0.4)

RoomAirSettings:CrossVentilation¶

This UCSD Cross Ventilation Room Air Model provides a simple model for heat transfer and vertical temperature profile prediction in cross ventilated rooms. The model distinguishes two regions in the room, the main jet region and the recirculations, and predicts characteristic airflow velocities and average air temperatures. Used with RoomAirModelType = CrossVentilation.

Fields
- zone_name [string]
- gain_distribution_schedule_name [string]
- airflow_region_used_for_thermal_comfort_evaluation [string]

RoomAirSettings:UnderFloorAirDistributionInterior¶

This Room Air Model is applicable to interior spaces that are served by an underfloor air distribution system. The dominant sources of heat gain should be from people, equipment, and other localized sources located in the occupied part of the room. The model should be used with caution in zones which have large heat gains or losses through exterior walls or windows or which have considerable direct solar gain. Used with RoomAirModelType = UnderFloorAirDistributionInterior.

Fields
- zone_name [string]
- number_of_diffusers [unknown field type] (Default: Autocalculate)
- power_per_plume [unknown field type] (Default: Autocalculate)
- design_effective_area_of_diffuser [unknown field type] (Default: Autocalculate)
- diffuser_slot_angle_from_vertical [unknown field type] (Default: Autocalculate)
- thermostat_height [number] (Default: 1.2)
- comfort_height [number] (Default: 1.1)
- temperature_difference_threshold_for_reporting [number] (Default: 0.4)
- floor_diffuser_type [string] (Default: Swirl)
- transition_height [unknown field type] (Default: 1.7)
- coefficient_a [unknown field type] (Default: Autocalculate)
- coefficient_b [unknown field type] (Default: Autocalculate)
- coefficient_c [unknown field type] (Default: Autocalculate)
- coefficient_d [unknown field type] (Default: Autocalculate)
- coefficient_e [unknown field type] (Default: Autocalculate)

RoomAirSettings:UnderFloorAirDistributionExterior¶

Applicable to exterior spaces that are served by an underfloor air distribution system. The dominant sources of heat gain should be from people, equipment, and other localized sources located in the occupied part of the room, as well as convective gain coming from a warm window. Used with RoomAirModelType = CrossVentilation.

Fields
- zone_name [string]
- number_of_diffusers_per_zone [unknown field type] (Default: Autocalculate)
- power_per_plume [unknown field type] (Default: Autocalculate)
- design_effective_area_of_diffuser [unknown field type] (Default: Autocalculate)
- diffuser_slot_angle_from_vertical [unknown field type] (Default: Autocalculate)
- thermostat_height [number] (Default: 1.2)
- comfort_height [number] (Default: 1.1)
- temperature_difference_threshold_for_reporting [number] (Default: 0.4)
- floor_diffuser_type [string] (Default: Swirl)
- transition_height [unknown field type] (Default: 1.7)
- coefficient_a_in_formula_kc_a_gamma_b_c_d_gamma_e_gamma_2 [unknown field type] (Default: Autocalculate)
- coefficient_b_in_formula_kc_a_gamma_b_c_d_gamma_e_gamma_2 [unknown field type] (Default: Autocalculate)
- coefficient_c_in_formula_kc_a_gamma_b_c_d_gamma_e_gamma_2 [unknown field type] (Default: Autocalculate)
- coefficient_d_in_formula_kc_a_gamma_b_c_d_gamma_e_gamma_2 [unknown field type] (Default: Autocalculate)
- coefficient_e_in_formula_kc_a_gamma_b_c_d_gamma_e_gamma_2 [unknown field type] (Default: Autocalculate)

RoomAir:Node:AirflowNetwork¶

define an air node for some types of nodal air models

Fields
- zone_name [string]
- fraction_of_zone_air_volume [number]
- roomair_node_airflownetwork_adjacentsurfacelist_name [string]
- roomair_node_airflownetwork_internalgains_name [string]
- roomair_node_airflownetwork_hvacequipment_name [string]

RoomAir:Node:AirflowNetwork:AdjacentSurfaceList¶

Fields
- surfaces [Array of {surface_name}]

RoomAir:Node:AirflowNetwork:InternalGains¶

define the internal gains that are associated with one particular RoomAir:Node

Fields
- gains [Array of {internal_gain_object_type, internal_gain_object_name, fraction_of_gains_to_node}]

RoomAir:Node:AirflowNetwork:HVACEquipment¶

define the zone equipment associated with one particular RoomAir:Node

Fields
- equipment_fractions [Array of {zonehvac_or_air_terminal_equipment_object_type, zonehvac_or_air_terminal_equipment_object_name, fraction_of_output_or_supply_air_from_hvac_equipment, fraction_of_input_or_return_air_to_hvac_equipment}]

RoomAirSettings:AirflowNetwork¶

RoomAir modeling using Airflow pressure network solver

Fields
- zone_name [string]
- control_point_roomairflownetwork_node_name [string]
- nodes [Array of {roomairflownetwork_node_name}]

Internal Gains¶

People¶

Sets internal gains and contaminant rates for occupants in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- number_of_people_schedule_name [string]
- number_of_people_calculation_method [string] (Default: People)
- number_of_people [number]
- people_per_floor_area [number]
- floor_area_per_person [number]
- fraction_radiant [number] (Default: 0.3)
- sensible_heat_fraction [unknown field type] (Default: Autocalculate)
- activity_level_schedule_name [string]
- carbon_dioxide_generation_rate [number] (Default: 3.82e-08)
- enable_ashrae_55_comfort_warnings [string] (Default: No)
- mean_radiant_temperature_calculation_type [string] (Default: ZoneAveraged)
- surface_name_angle_factor_list_name [string]
- work_efficiency_schedule_name [string]
- clothing_insulation_calculation_method [string] (Default: ClothingInsulationSchedule)
- clothing_insulation_calculation_method_schedule_name [string]
- clothing_insulation_schedule_name [string]
- air_velocity_schedule_name [string]
- thermal_comfort_model_1_type [string]
- thermal_comfort_model_2_type [string]
- thermal_comfort_model_3_type [string]
- thermal_comfort_model_4_type [string]
- thermal_comfort_model_5_type [string]
- thermal_comfort_model_6_type [string]
- thermal_comfort_model_7_type [string]
- ankle_level_air_velocity_schedule_name [string]
- cold_stress_temperature_threshold [number] (Default: 15.56)
- heat_stress_temperature_threshold [number] (Default: 30.0)

ComfortViewFactorAngles¶

Used to specify radiant view factors for thermal comfort calculations. Note that the following angle factor fractions must sum up to 1.0 The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list.

Fields
- zone_name [string]
- surface_1_name [string]
- angle_factor_1 [number]
- surface_2_name [string]
- angle_factor_2 [number]
- surface_3_name [string]
- angle_factor_3 [number]
- surface_4_name [string]
- angle_factor_4 [number]
- surface_5_name [string]
- angle_factor_5 [number]
- surface_6_name [string]
- angle_factor_6 [number]
- surface_7_name [string]
- angle_factor_7 [number]
- surface_8_name [string]
- angle_factor_8 [number]
- surface_9_name [string]
- angle_factor_9 [number]
- surface_10_name [string]
- angle_factor_10 [number]
- surface_11_name [string]
- angle_factor_11 [number]
- surface_12_name [string]
- angle_factor_12 [number]
- surface_13_name [string]
- angle_factor_13 [number]
- surface_14_name [string]
- angle_factor_14 [number]
- surface_15_name [string]
- angle_factor_15 [number]
- surface_16_name [string]
- angle_factor_16 [number]
- surface_17_name [string]
- angle_factor_17 [number]
- surface_18_name [string]
- angle_factor_18 [number]
- surface_19_name [string]
- angle_factor_19 [number]
- surface_20_name [string]
- angle_factor_20 [number]
- surface_21_name [string]
- angle_factor_21 [number]
- surface_22_name [string]
- angle_factor_22 [number]
- surface_23_name [string]
- angle_factor_23 [number]
- surface_24_name [string]
- angle_factor_24 [number]
- surface_25_name [string]
- angle_factor_25 [number]
- surface_26_name [string]
- angle_factor_26 [number]
- surface_27_name [string]
- angle_factor_27 [number]
- surface_28_name [string]
- angle_factor_28 [number]
- surface_29_name [string]
- angle_factor_29 [number]
- surface_30_name [string]
- angle_factor_30 [number]
- surface_31_name [string]
- angle_factor_31 [number]
- surface_32_name [string]
- angle_factor_32 [number]
- surface_33_name [string]
- angle_factor_33 [number]
- surface_34_name [string]
- angle_factor_34 [number]
- surface_35_name [string]
- angle_factor_35 [number]
- surface_36_name [string]
- angle_factor_36 [number]
- surface_37_name [string]
- angle_factor_37 [number]
- surface_38_name [string]
- angle_factor_38 [number]
- surface_39_name [string]
- angle_factor_39 [number]
- surface_40_name [string]
- angle_factor_40 [number]
- surface_41_name [string]
- angle_factor_41 [number]
- surface_42_name [string]
- angle_factor_42 [number]
- surface_43_name [string]
- angle_factor_43 [number]
- surface_44_name [string]
- angle_factor_44 [number]
- surface_45_name [string]
- angle_factor_45 [number]
- surface_46_name [string]
- angle_factor_46 [number]
- surface_47_name [string]
- angle_factor_47 [number]
- surface_48_name [string]
- angle_factor_48 [number]
- surface_49_name [string]
- angle_factor_49 [number]
- surface_50_name [string]
- angle_factor_50 [number]
- surface_51_name [string]
- angle_factor_51 [number]
- surface_52_name [string]
- angle_factor_52 [number]
- surface_53_name [string]
- angle_factor_53 [number]
- surface_54_name [string]
- angle_factor_54 [number]
- surface_55_name [string]
- angle_factor_55 [number]
- surface_56_name [string]
- angle_factor_56 [number]
- surface_57_name [string]
- angle_factor_57 [number]
- surface_58_name [string]
- angle_factor_58 [number]
- surface_59_name [string]
- angle_factor_59 [number]
- surface_60_name [string]
- angle_factor_60 [number]
- surface_61_name [string]
- angle_factor_61 [number]
- surface_62_name [string]
- angle_factor_62 [number]
- surface_63_name [string]
- angle_factor_63 [number]
- surface_64_name [string]
- angle_factor_64 [number]
- surface_65_name [string]
- angle_factor_65 [number]
- surface_66_name [string]
- angle_factor_66 [number]
- surface_67_name [string]
- angle_factor_67 [number]
- surface_68_name [string]
- angle_factor_68 [number]
- surface_69_name [string]
- angle_factor_69 [number]
- surface_70_name [string]
- angle_factor_70 [number]
- surface_71_name [string]
- angle_factor_71 [number]
- surface_72_name [string]
- angle_factor_72 [number]
- surface_73_name [string]
- angle_factor_73 [number]
- surface_74_name [string]
- angle_factor_74 [number]
- surface_75_name [string]
- angle_factor_75 [number]
- surface_76_name [string]
- angle_factor_76 [number]
- surface_77_name [string]
- angle_factor_77 [number]
- surface_78_name [string]
- angle_factor_78 [number]
- surface_79_name [string]
- angle_factor_79 [number]
- surface_80_name [string]
- angle_factor_80 [number]
- surface_81_name [string]
- angle_factor_81 [number]
- surface_82_name [string]
- angle_factor_82 [number]
- surface_83_name [string]
- angle_factor_83 [number]
- surface_84_name [string]
- angle_factor_84 [number]
- surface_85_name [string]
- angle_factor_85 [number]
- surface_86_name [string]
- angle_factor_86 [number]
- surface_87_name [string]
- angle_factor_87 [number]
- surface_88_name [string]
- angle_factor_88 [number]
- surface_89_name [string]
- angle_factor_89 [number]
- surface_90_name [string]
- angle_factor_90 [number]
- surface_91_name [string]
- angle_factor_91 [number]
- surface_92_name [string]
- angle_factor_92 [number]
- surface_93_name [string]
- angle_factor_93 [number]
- surface_94_name [string]
- angle_factor_94 [number]
- surface_95_name [string]
- angle_factor_95 [number]
- surface_96_name [string]
- angle_factor_96 [number]
- surface_97_name [string]
- angle_factor_97 [number]
- surface_98_name [string]
- angle_factor_98 [number]
- surface_99_name [string]
- angle_factor_99 [number]
- surface_100_name [string]
- angle_factor_100 [number]

Lights¶

Sets internal gains for lights in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_level_calculation_method [string] (Default: LightingLevel)
- lighting_level [number]
- watts_per_zone_floor_area [number]
- watts_per_person [number]
- return_air_fraction [number] (Default: 0.0)
- fraction_radiant [number] (Default: 0.0)
- fraction_visible [number] (Default: 0.0)
- fraction_replaceable [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)
- return_air_fraction_calculated_from_plenum_temperature [string] (Default: No)
- return_air_fraction_function_of_plenum_temperature_coefficient_1 [number] (Default: 0.0)
- return_air_fraction_function_of_plenum_temperature_coefficient_2 [number] (Default: 0.0)
- return_air_heat_gain_node_name [string]
- exhaust_air_heat_gain_node_name [string]

ElectricEquipment¶

Sets internal gains for electric equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_level_calculation_method [string] (Default: EquipmentLevel)
- design_level [number]
- watts_per_zone_floor_area [number]
- watts_per_person [number]
- fraction_latent [number] (Default: 0.0)
- fraction_radiant [number] (Default: 0.0)
- fraction_lost [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

GasEquipment¶

Sets internal gains and contaminant rates for gas equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_level_calculation_method [string] (Default: EquipmentLevel)
- design_level [number]
- power_per_zone_floor_area [number]
- power_per_person [number]
- fraction_latent [number] (Default: 0.0)
- fraction_radiant [number] (Default: 0.0)
- fraction_lost [number] (Default: 0.0)
- carbon_dioxide_generation_rate [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

HotWaterEquipment¶

Sets internal gains for hot water equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_level_calculation_method [string] (Default: EquipmentLevel)
- design_level [number]
- power_per_zone_floor_area [number]
- power_per_person [number]
- fraction_latent [number] (Default: 0.0)
- fraction_radiant [number] (Default: 0.0)
- fraction_lost [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

SteamEquipment¶

Sets internal gains for steam equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_level_calculation_method [string] (Default: EquipmentLevel)
- design_level [number]
- power_per_zone_floor_area [number]
- power_per_person [number]
- fraction_latent [number] (Default: 0.0)
- fraction_radiant [number] (Default: 0.0)
- fraction_lost [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

OtherEquipment¶

Sets internal gains or losses for “other” equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- fuel_type [string] (Default: None)
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_level_calculation_method [string] (Default: EquipmentLevel)
- design_level [number]
- power_per_zone_floor_area [number]
- power_per_person [number]
- fraction_latent [number] (Default: 0.0)
- fraction_radiant [number] (Default: 0.0)
- fraction_lost [number] (Default: 0.0)
- carbon_dioxide_generation_rate [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

ElectricEquipment:ITE:AirCooled¶

This object describes air-cooled electric information technology equipment (ITE) which has variable power consumption as a function of loading and temperature. If a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_space_name [string]
- air_flow_calculation_method [string] (Default: FlowFromSystem)
- design_power_input_calculation_method [string] (Default: Watts/Unit)
- watts_per_unit [number]
- number_of_units [number] (Default: 1.0)
- watts_per_zone_floor_area [number]
- design_power_input_schedule_name [string]
- cpu_loading_schedule_name [string]
- cpu_power_input_function_of_loading_and_air_temperature_curve_name [string]
- design_fan_power_input_fraction [number] (Default: 0.0)
- design_fan_air_flow_rate_per_power_input [number]
- air_flow_function_of_loading_and_air_temperature_curve_name [string]
- fan_power_input_function_of_flow_curve_name [string]
- design_entering_air_temperature [number] (Default: 15.0)
- environmental_class [string] (Default: None)
- air_inlet_connection_type [string] (Default: AdjustedSupply)
- air_inlet_room_air_model_node_name [string]
- air_outlet_room_air_model_node_name [string]
- supply_air_node_name [string]
- design_recirculation_fraction [number] (Default: 0.0)
- recirculation_function_of_loading_and_supply_temperature_curve_name [string]
- design_electric_power_supply_efficiency [number] (Default: 1.0)
- electric_power_supply_efficiency_function_of_part_load_ratio_curve_name [string]
- fraction_of_electric_power_supply_losses_to_zone [number] (Default: 1.0)
- cpu_end_use_subcategory [string] (Default: ITE-CPU)
- fan_end_use_subcategory [string] (Default: ITE-Fans)
- electric_power_supply_end_use_subcategory [string] (Default: ITE-UPS)
- supply_temperature_difference [number]
- supply_temperature_difference_schedule [string]
- return_temperature_difference [number]
- return_temperature_difference_schedule [string]

ZoneBaseboard:OutdoorTemperatureControlled¶

Specifies outside temperature-controlled electric baseboard heating. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- capacity_at_low_temperature [number]
- low_temperature [number]
- capacity_at_high_temperature [number]
- high_temperature [number]
- fraction_radiant [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

SwimmingPool:Indoor¶

Specifies an indoor swimming pools linked to a floor surface. The pool is assumed to cover the entire floor to which it is linked.

Fields
- surface_name [string]
- average_depth [number]
- activity_factor_schedule_name [string]
- make_up_water_supply_schedule_name [string]
- cover_schedule_name [string]
- cover_evaporation_factor [number] (Default: 0.0)
- cover_convection_factor [number] (Default: 0.0)
- cover_short_wavelength_radiation_factor [number] (Default: 0.0)
- cover_long_wavelength_radiation_factor [number] (Default: 0.0)
- pool_water_inlet_node [string]
- pool_water_outlet_node [string]
- pool_heating_system_maximum_water_flow_rate [number]
- pool_miscellaneous_equipment_power [number]
- setpoint_temperature_schedule [string]
- maximum_number_of_people [number]
- people_schedule [string]
- people_heat_gain_schedule [string]

ZoneContaminantSourceAndSink:CarbonDioxide¶

Represents internal CO2 gains and sinks in the zone.

Fields
- zone_name [string]
- design_generation_rate [number]
- schedule_name [string]

ZoneContaminantSourceAndSink:Generic:Constant¶

Sets internal generic contaminant gains and sinks in a zone with constant values.

Fields
- zone_name [string]
- design_generation_rate [number]
- generation_schedule_name [string]
- design_removal_coefficient [number]
- removal_schedule_name [string]

SurfaceContaminantSourceAndSink:Generic:PressureDriven¶

Simulate generic contaminant source driven by the pressure difference across a surface.

Fields
- surface_name [string]
- design_generation_rate_coefficient [number]
- generation_schedule_name [string]
- generation_exponent [number]

ZoneContaminantSourceAndSink:Generic:CutoffModel¶

Simulate generic contaminant source driven by the cutoff concentration model.

Fields
- zone_name [string]
- design_generation_rate_coefficient [number]
- schedule_name [string]
- cutoff_generic_contaminant_at_which_emission_ceases [number]

ZoneContaminantSourceAndSink:Generic:DecaySource¶

Simulate generic contaminant source driven by the cutoff concentration model.

Fields
- zone_name [string]
- initial_emission_rate [number]
- schedule_name [string]
- delay_time_constant [number]

SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion¶

Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

Fields
- surface_name [string]
- mass_transfer_coefficient [number]
- schedule_name [string]
- henry_adsorption_constant_or_partition_coefficient [number]

SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink¶

Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

Fields
- surface_name [string]
- deposition_velocity [number]
- schedule_name [string]

ZoneContaminantSourceAndSink:Generic:DepositionRateSink¶

Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

Fields
- zone_name [string]
- deposition_rate [number]
- schedule_name [string]

Daylighting¶

Daylighting:Controls¶

Dimming of overhead electric lighting is determined from each reference point. Glare from daylighting is also calculated.

Fields
- zone_or_space_name [string]
- daylighting_method [string] (Default: SplitFlux)
- availability_schedule_name [string]
- lighting_control_type [string] (Default: Continuous)
- minimum_input_power_fraction_for_continuous_or_continuousoff_dimming_control [number] (Default: 0.3)
- minimum_light_output_fraction_for_continuous_or_continuousoff_dimming_control [number] (Default: 0.2)
- number_of_stepped_control_steps [integer] (Default: 1)
- probability_lighting_will_be_reset_when_needed_in_manual_stepped_control [number] (Default: 1.0)
- glare_calculation_daylighting_reference_point_name [string]
- glare_calculation_azimuth_angle_of_view_direction_clockwise_from_zone_y_axis [number] (Default: 0.0)
- maximum_allowable_discomfort_glare_index [number] (Default: 22.0)
- delight_gridding_resolution [number]
- control_data [Array of {daylighting_reference_point_name, fraction_of_lights_controlled_by_reference_point, illuminance_setpoint_at_reference_point}]

Daylighting:ReferencePoint¶

Used by Daylighting:Controls to identify the reference point coordinates for each sensor. Reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field.

Fields
- zone_or_space_name [string]
- x_coordinate_of_reference_point [number]
- y_coordinate_of_reference_point [number]
- z_coordinate_of_reference_point [number] (Default: 0.8)

Daylighting:DELight:ComplexFenestration¶

Used for DElight Complex Fenestration of all types

Fields
- complex_fenestration_type [string]
- building_surface_name [string]
- window_name [string]
- fenestration_rotation [number] (Default: 0.0)

DaylightingDevice:Tubular¶

Defines a tubular daylighting device (TDD) consisting of three components: a dome, a pipe, and a diffuser. The dome and diffuser are defined separately using the FenestrationSurface:Detailed object.

Fields
- dome_name [string]
- diffuser_name [string]
- construction_name [string]
- diameter [number]
- total_length [number]
- effective_thermal_resistance [number] (Default: 0.28)
- transition_lengths [Array of {transition_zone_name, transition_zone_length}]

DaylightingDevice:Shelf¶

Defines a daylighting which can have an inside shelf, an outside shelf, or both. The inside shelf is defined as a building surface and the outside shelf is defined as a shading surface.

Fields
- window_name [string]
- inside_shelf_name [string]
- outside_shelf_name [string]
- outside_shelf_construction_name [string]
- view_factor_to_outside_shelf [number]

DaylightingDevice:LightWell¶

Applies only to exterior windows in daylighting-controlled zones or in zones that share an interior window with a daylighting-controlled zone. Generally used with skylights.

Fields
- exterior_window_name [string]
- height_of_well [number]
- perimeter_of_bottom_of_well [number]
- area_of_bottom_of_well [number]
- visible_reflectance_of_well_walls [number]

Output:DaylightFactors¶

Reports hourly daylight factors for each exterior window for four sky types (clear, turbid clear, intermediate, and overcast).

Fields
- reporting_days [string]

Output:IlluminanceMap¶

reference points are given in coordinates specified in the GlobalGeometryRules object Daylighting Reference Point CoordinateSystem field

Fields
- zone_name [string]
- z_height [number] (Default: 0.0)
- x_minimum_coordinate [number] (Default: 0.0)
- x_maximum_coordinate [number] (Default: 1.0)
- number_of_x_grid_points [integer] (Default: 2)
- y_minimum_coordinate [number] (Default: 0.0)
- y_maximum_coordinate [number] (Default: 1.0)
- number_of_y_grid_points [integer] (Default: 2)

OutputControl:IlluminanceMap:Style¶

default style for the Daylighting Illuminance Map is comma – this works well for importing into spreadsheet programs such as Excel(tm) but not so well for word processing programs – there tab may be a better choice. fixed puts spaces between the “columns”

Fields
- column_separator [string] (Default: Comma)

Zone Airflow¶

ZoneInfiltration:DesignFlowRate¶

Infiltration is specified as a design level which is modified by a Schedule fraction, temperature difference and wind speed: Infiltration=Idesign * FSchedule * (A + B*|(Tzone-Todb)| + C*WindSpd + D * WindSpd**2) If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_flow_rate_calculation_method [string] (Default: Flow/Zone)
- design_flow_rate [number]
- flow_rate_per_floor_area [number]
- flow_rate_per_exterior_surface_area [number]
- air_changes_per_hour [number]
- constant_term_coefficient [number] (Default: 1.0)
- temperature_term_coefficient [number] (Default: 0.0)
- velocity_term_coefficient [number] (Default: 0.0)
- velocity_squared_term_coefficient [number] (Default: 0.0)

ZoneInfiltration:EffectiveLeakageArea¶

Infiltration is specified as effective leakage area at 4 Pa, schedule fraction, stack and wind coefficients, and is a function of temperature difference and wind speed: Infiltration=FSchedule * (AL /1000) SQRT(Cs*|(Tzone-Todb)| + Cw*WindSpd**2 ) If a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_space_name [string]
- schedule_name [string]
- effective_air_leakage_area [number]
- stack_coefficient [number]
- wind_coefficient [number]

ZoneInfiltration:FlowCoefficient¶

Infiltration is specified as flow coefficient, schedule fraction, stack and wind coefficients, and is a function of temperature difference and wind speed: Infiltration=FSchedule * SQRT( (c * Cs*|(Tzone-Todb)|**n)**2 + (c* Cw*(s * WindSpd)**2n)**2 ) If a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_space_name [string]
- schedule_name [string]
- flow_coefficient [number]
- stack_coefficient [number]
- pressure_exponent [number] (Default: 0.67)
- wind_coefficient [number]
- shelter_factor [number]

ZoneVentilation:DesignFlowRate¶

Ventilation is specified as a design level which is modified by a schedule fraction, temperature difference and wind speed: Ventilation=Vdesign * Fschedule * (A + B*|(Tzone-Todb)| + C*WindSpd + D * WindSpd**2) If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_zonelist_or_space_or_spacelist_name [string]
- schedule_name [string]
- design_flow_rate_calculation_method [string] (Default: Flow/Zone)
- design_flow_rate [number]
- flow_rate_per_floor_area [number]
- flow_rate_per_person [number]
- air_changes_per_hour [number]
- ventilation_type [string] (Default: Natural)
- fan_pressure_rise [number] (Default: 0.0)
- fan_total_efficiency [number] (Default: 1.0)
- constant_term_coefficient [number] (Default: 1.0)
- temperature_term_coefficient [number] (Default: 0.0)
- velocity_term_coefficient [number] (Default: 0.0)
- velocity_squared_term_coefficient [number] (Default: 0.0)
- minimum_indoor_temperature [number] (Default: -100.0)
- minimum_indoor_temperature_schedule_name [string]
- maximum_indoor_temperature [number] (Default: 100.0)
- maximum_indoor_temperature_schedule_name [string]
- delta_temperature [number] (Default: -100.0)
- delta_temperature_schedule_name [string]
- minimum_outdoor_temperature [number] (Default: -100.0)
- minimum_outdoor_temperature_schedule_name [string]
- maximum_outdoor_temperature [number] (Default: 100.0)
- maximum_outdoor_temperature_schedule_name [string]
- maximum_wind_speed [number] (Default: 40.0)

ZoneVentilation:WindandStackOpenArea¶

This object is specified as natural ventilation driven by wind and stack effect only: Ventilation Wind = Cw * Opening Area * Schedule * WindSpd Ventilation Stack = Cd * Opening Area * Schedule * SQRT(2*g*DH*(|(Tzone-Todb)|/Tzone)) Total Ventilation = SQRT((Ventilation Wind)^2 + (Ventilation Stack)^2) If a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Fields
- zone_or_space_name [string]
- opening_area [number] (Default: 0.0)
- opening_area_fraction_schedule_name [string]
- opening_effectiveness [unknown field type] (Default: Autocalculate)
- effective_angle [number] (Default: 0.0)
- height_difference [number] (Default: 0.0)
- discharge_coefficient_for_opening [unknown field type] (Default: Autocalculate)
- minimum_indoor_temperature [number] (Default: -100.0)
- minimum_indoor_temperature_schedule_name [string]
- maximum_indoor_temperature [number] (Default: 100.0)
- maximum_indoor_temperature_schedule_name [string]
- delta_temperature [number] (Default: -100.0)
- delta_temperature_schedule_name [string]
- minimum_outdoor_temperature [number] (Default: -100.0)
- minimum_outdoor_temperature_schedule_name [string]
- maximum_outdoor_temperature [number] (Default: 100.0)
- maximum_outdoor_temperature_schedule_name [string]
- maximum_wind_speed [number] (Default: 40.0)

ZoneAirBalance:OutdoorAir¶

Provide a combined zone outdoor air flow by including interactions between mechanical ventilation, infiltration and duct leakage. This object will combine outdoor flows from all ZoneInfiltration and ZoneVentilation objects in the same zone. Balanced flows will be summed, while unbalanced flows will be added in quadrature.

Fields
- zone_name [string]
- air_balance_method [string] (Default: Quadrature)
- induced_outdoor_air_due_to_unbalanced_duct_leakage [number] (Default: 0.0)
- induced_outdoor_air_schedule_name [string]

ZoneMixing¶

ZoneMixing is a simple air exchange from one zone or space to another. Note that this statement only affects the energy balance of the “receiving” zone or space and will not produce any effect on the “source” zone. Mixing statements can be complementary and include multiple zones, but the balancing of flows between zones is left to the user’s discretion.

Fields
- zone_or_space_name [string]
- schedule_name [string]
- design_flow_rate_calculation_method [string] (Default: Flow/Zone)
- design_flow_rate [number]
- flow_rate_per_floor_area [number]
- flow_rate_per_person [number]
- air_changes_per_hour [number]
- source_zone_or_space_name [string]
- delta_temperature [number] (Default: 0.0)
- delta_temperature_schedule_name [string]
- minimum_receiving_temperature_schedule_name [string]
- maximum_receiving_temperature_schedule_name [string]
- minimum_source_temperature_schedule_name [string]
- maximum_source_temperature_schedule_name [string]
- minimum_outdoor_temperature_schedule_name [string]
- maximum_outdoor_temperature_schedule_name [string]

ZoneCrossMixing¶

ZoneCrossMixing exchanges an equal amount of air between two zones or spaces. Note that this statement affects the energy balance of both zones or spaces.

Fields
- zone_or_space_name [string]
- schedule_name [string]
- design_flow_rate_calculation_method [string] (Default: Flow/Zone)
- design_flow_rate [number]
- flow_rate_per_floor_area [number]
- flow_rate_per_person [number]
- air_changes_per_hour [number]
- source_zone_or_space_name [string]
- delta_temperature [number] (Default: 0.0)
- delta_temperature_schedule_name [string]
- minimum_receiving_temperature_schedule_name [string]
- maximum_receiving_temperature_schedule_name [string]
- minimum_source_temperature_schedule_name [string]
- maximum_source_temperature_schedule_name [string]
- minimum_outdoor_temperature_schedule_name [string]
- maximum_outdoor_temperature_schedule_name [string]

ZoneRefrigerationDoorMixing¶

Refrigeration Door Mixing is used for an opening between two zones that are at the same elevation but have different air temperatures. In this case, the mixing air flow between the two zones is determined by the density difference between the two zones. This would typically be used between two zones in a refrigerated warehouse that are controlled at different temperatures. It could also be used to model a door to a walk-in refrigerated space if that space were modeled as a zone instead of using the object Refrigeration:WalkIn.

Fields
- zone_1_name [string]
- zone_2_name [string]
- schedule_name [string]
- door_height [number] (Default: 3.0)
- door_area [number] (Default: 9.0)
- door_protection_type [string] (Default: None)

ZoneEarthtube¶

Earth Tube is specified as a design level which is modified by a Schedule fraction, temperature difference and wind speed: Earthtube=Edesign * Fschedule * (A + B*|(Tzone-Todb)| + C*WindSpd + D * WindSpd**2)

Fields
- zone_name [string]
- schedule_name [string]
- design_flow_rate [number]
- minimum_zone_temperature_when_cooling [number]
- maximum_zone_temperature_when_heating [number]
- delta_temperature [number]
- earthtube_type [string] (Default: Natural)
- fan_pressure_rise [number] (Default: 0.0)
- fan_total_efficiency [number] (Default: 1.0)
- pipe_radius [number] (Default: 1.0)
- pipe_thickness [number] (Default: 0.2)
- pipe_length [number] (Default: 15.0)
- pipe_thermal_conductivity [number] (Default: 200.0)
- pipe_depth_under_ground_surface [number] (Default: 3.0)
- soil_condition [string] (Default: HeavyAndDamp)
- average_soil_surface_temperature [number]
- amplitude_of_soil_surface_temperature [number]
- phase_constant_of_soil_surface_temperature [number]
- constant_term_flow_coefficient [number] (Default: 1.0)
- temperature_term_flow_coefficient [number] (Default: 0.0)
- velocity_term_flow_coefficient [number] (Default: 0.0)
- velocity_squared_term_flow_coefficient [number] (Default: 0.0)

ZoneCoolTower:Shower¶

A cooltower (sometimes referred to as a wind tower or a shower cooling tower) models passive downdraught evaporative cooling (PDEC) that is designed to capture the wind at the top of a tower and cool the outdoor air using water evaporation before delivering it to a space.

Fields
- availability_schedule_name [string]
- zone_name [string]
- water_supply_storage_tank_name [string]
- flow_control_type [string] (Default: WindDrivenFlow)
- pump_flow_rate_schedule_name [string]
- maximum_water_flow_rate [number]
- effective_tower_height [number]
- airflow_outlet_area [number]
- maximum_air_flow_rate [number]
- minimum_indoor_temperature [number]
- fraction_of_water_loss [number]
- fraction_of_flow_schedule [number]
- rated_power_consumption [number]

ZoneThermalChimney¶

A thermal chimney is a vertical shaft utilizing solar radiation to enhance natural ventilation. It consists of an absorber wall, air gap and glass cover with high solar transmissivity.

Fields
- zone_name [string]
- availability_schedule_name [string]
- width_of_the_absorber_wall [number]
- cross_sectional_area_of_air_channel_outlet [number]
- discharge_coefficient [number] (Default: 0.8)
- zone_1_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_1 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_1 [number] (Default: 1.0)
- cross_sectional_areas_of_air_channel_inlet_1 [number]
- zone_2_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_2 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_2 [number]
- cross_sectional_areas_of_air_channel_inlet_2 [number]
- zone_3_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_3 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_3 [number]
- cross_sectional_areas_of_air_channel_inlet_3 [number]
- zone_4_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_4 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_4 [number]
- cross_sectional_areas_of_air_channel_inlet_4 [number]
- zone_5_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_5 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_5 [number]
- cross_sectional_areas_of_air_channel_inlet_5 [number]
- zone_6_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_6 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_6 [number]
- cross_sectional_areas_of_air_channel_inlet_6 [number]
- zone_7_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_7 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_7 [number]
- cross_sectional_areas_of_air_channel_inlet_7 [number]
- zone_8_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_8 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_8 [number]
- cross_sectional_areas_of_air_channel_inlet_8 [number]
- zone_9_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_9 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_9 [number]
- cross_sectional_areas_of_air_channel_inlet_9 [number]
- zone_10_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_10 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_10 [number]
- cross_sectional_areas_of_air_channel_inlet_10 [number]
- zone_11_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_11 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_11 [number]
- cross_sectional_areas_of_air_channel_inlet_11 [number]
- zone_12_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_12 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_12 [number]
- cross_sectional_areas_of_air_channel_inlet_12 [number]
- zone_13_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_13 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_13 [number]
- cross_sectional_areas_of_air_channel_inlet_13 [number]
- zone_14_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_14 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_14 [number]
- cross_sectional_areas_of_air_channel_inlet_14 [number]
- zone_15_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_15 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_15 [number]
- cross_sectional_areas_of_air_channel_inlet_15 [number]
- zone_16_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_16 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_16 [number]
- cross_sectional_areas_of_air_channel_inlet_16 [number]
- zone_17_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_17 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_17 [number]
- cross_sectional_areas_of_air_channel_inlet_17 [number]
- zone_18_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_18 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_18 [number]
- cross_sectional_areas_of_air_channel_inlet_18 [number]
- zone_19_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_19 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_19 [number]
- cross_sectional_areas_of_air_channel_inlet_19 [number]
- zone_20_name [string]
- distance_from_top_of_thermal_chimney_to_inlet_20 [number]
- relative_ratios_of_air_flow_rates_passing_through_zone_20 [number]
- cross_sectional_areas_of_air_channel_inlet_20 [number]

AirflowNetwork¶

AirflowNetwork:SimulationControl¶

This object defines the global parameters used in an Airflow Network simulation.

Fields
- airflownetwork_control [string] (Default: NoMultizoneOrDistribution)
- wind_pressure_coefficient_type [string] (Default: SurfaceAverageCalculation)
- height_selection_for_local_wind_pressure_calculation [string] (Default: OpeningHeight)
- building_type [string] (Default: LowRise)
- maximum_number_of_iterations [integer] (Default: 500)
- initialization_type [string] (Default: ZeroNodePressures)
- relative_airflow_convergence_tolerance [number] (Default: 0.0001)
- absolute_airflow_convergence_tolerance [number] (Default: 1e-06)
- convergence_acceleration_limit [number] (Default: -0.5)
- azimuth_angle_of_long_axis_of_building [number] (Default: 0.0)
- ratio_of_building_width_along_short_axis_to_width_along_long_axis [number] (Default: 1.0)
- height_dependence_of_external_node_temperature [string] (Default: No)
- solver [string] (Default: SkylineLU)
- allow_unsupported_zone_equipment [string] (Default: No)
- do_distribution_duct_sizing_calculation [string] (Default: No)

AirflowNetwork:MultiZone:Zone¶

This object is used to simultaneously control a thermal zone’s window and door openings, both exterior and interior.

Fields
- zone_name [string]
- ventilation_control_mode [string] (Default: NoVent)
- ventilation_control_zone_temperature_setpoint_schedule_name [string]
- minimum_venting_open_factor [number] (Default: 0.0)
- indoor_and_outdoor_temperature_difference_lower_limit_for_maximum_venting_open_factor [number] (Default: 0.0)
- indoor_and_outdoor_temperature_difference_upper_limit_for_minimum_venting_open_factor [number] (Default: 100.0)
- indoor_and_outdoor_enthalpy_difference_lower_limit_for_maximum_venting_open_factor [number] (Default: 0.0)
- indoor_and_outdoor_enthalpy_difference_upper_limit_for_minimum_venting_open_factor [number] (Default: 300000.0)
- venting_availability_schedule_name [string]
- single_sided_wind_pressure_coefficient_algorithm [string] (Default: Standard)
- facade_width [number] (Default: 10.0)
- occupant_ventilation_control_name [string]

AirflowNetwork:MultiZone:Surface¶

This object specifies the properties of a surface linkage through which air flows. Airflow Report: Node 1 as an inside face zone; Node 2 as an outside face zone or external node.

Fields
- surface_name [string]
- leakage_component_name [string]
- external_node_name [string]
- window_door_opening_factor_or_crack_factor [number] (Default: 1.0)
- ventilation_control_mode [string] (Default: ZoneLevel)
- ventilation_control_zone_temperature_setpoint_schedule_name [string]
- minimum_venting_open_factor [number] (Default: 0.0)
- indoor_and_outdoor_temperature_difference_lower_limit_for_maximum_venting_open_factor [number] (Default: 0.0)
- indoor_and_outdoor_temperature_difference_upper_limit_for_minimum_venting_open_factor [number] (Default: 100.0)
- indoor_and_outdoor_enthalpy_difference_lower_limit_for_maximum_venting_open_factor [number] (Default: 0.0)
- indoor_and_outdoor_enthalpy_difference_upper_limit_for_minimum_venting_open_factor [number] (Default: 300000.0)
- venting_availability_schedule_name [string]
- occupant_ventilation_control_name [string]
- equivalent_rectangle_method [string] (Default: PolygonHeight)
- equivalent_rectangle_aspect_ratio [number] (Default: 1.0)

AirflowNetwork:MultiZone:ReferenceCrackConditions¶

This object specifies the conditions under which the air mass flow coefficient was measured.

Fields
- reference_temperature [number]
- reference_barometric_pressure [number] (Default: 101325.0)
- reference_humidity_ratio [number] (Default: 0.0)

AirflowNetwork:MultiZone:Surface:Crack¶

This object specifies the properties of airflow through a crack.

Fields
- air_mass_flow_coefficient_at_reference_conditions [number]
- air_mass_flow_exponent [number] (Default: 0.65)
- reference_crack_conditions [string]

AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea¶

This object is used to define surface air leakage.

Fields
- effective_leakage_area [number]
- discharge_coefficient [number] (Default: 1.0)
- reference_pressure_difference [number] (Default: 4.0)
- air_mass_flow_exponent [number] (Default: 0.65)

AirflowNetwork:MultiZone:SpecifiedFlowRate¶

This object is used to define specified flow through a linkage.

Fields
- air_flow_value [number]
- air_flow_units [string] (Default: MassFlow)

AirflowNetwork:MultiZone:Component:DetailedOpening¶

This object specifies the properties of airflow through windows and doors (window, door and glass door heat transfer subsurfaces) when they are closed or open.

Fields
- air_mass_flow_coefficient_when_opening_is_closed [number]
- air_mass_flow_exponent_when_opening_is_closed [number] (Default: 0.65)
- type_of_rectangular_large_vertical_opening_lvo_ [string] (Default: NonPivoted)
- extra_crack_length_or_height_of_pivoting_axis [number] (Default: 0.0)
- number_of_sets_of_opening_factor_data [integer]
- opening_factor_1 [number] (Default: 0.0)
- discharge_coefficient_for_opening_factor_1 [number] (Default: 0.001)
- width_factor_for_opening_factor_1 [number] (Default: 0.0)
- height_factor_for_opening_factor_1 [number] (Default: 0.0)
- start_height_factor_for_opening_factor_1 [number] (Default: 0.0)
- opening_factor_2 [number]
- discharge_coefficient_for_opening_factor_2 [number] (Default: 1.0)
- width_factor_for_opening_factor_2 [number] (Default: 1.0)
- height_factor_for_opening_factor_2 [number] (Default: 1.0)
- start_height_factor_for_opening_factor_2 [number] (Default: 0.0)
- opening_factor_3 [number]
- discharge_coefficient_for_opening_factor_3 [number] (Default: 0.0)
- width_factor_for_opening_factor_3 [number] (Default: 0.0)
- height_factor_for_opening_factor_3 [number] (Default: 0.0)
- start_height_factor_for_opening_factor_3 [number] (Default: 0.0)
- opening_factor_4 [number]
- discharge_coefficient_for_opening_factor_4 [number] (Default: 0.0)
- width_factor_for_opening_factor_4 [number] (Default: 0.0)
- height_factor_for_opening_factor_4 [number] (Default: 0.0)
- start_height_factor_for_opening_factor_4 [number] (Default: 0.0)

AirflowNetwork:MultiZone:Component:SimpleOpening¶

This object specifies the properties of air flow through windows and doors (window, door and glass door heat transfer subsurfaces) when they are closed or open.

Fields
- air_mass_flow_coefficient_when_opening_is_closed [number]
- air_mass_flow_exponent_when_opening_is_closed [number] (Default: 0.65)
- minimum_density_difference_for_two_way_flow [number]
- discharge_coefficient [number]

AirflowNetwork:MultiZone:Component:HorizontalOpening¶

This object specifies the properties of air flow through a horizontal opening

Fields
- air_mass_flow_coefficient_when_opening_is_closed [number]
- air_mass_flow_exponent_when_opening_is_closed [number] (Default: 0.65)
- sloping_plane_angle [number] (Default: 90.0)
- discharge_coefficient [number]

AirflowNetwork:MultiZone:Component:ZoneExhaustFan¶

This object specifies the additional properties for a zone exhaust fan to perform multizone airflow calculations.

Fields
- air_mass_flow_coefficient_when_the_zone_exhaust_fan_is_off_at_reference_conditions [number]
- air_mass_flow_exponent_when_the_zone_exhaust_fan_is_off [number] (Default: 0.65)
- reference_crack_conditions [string]

AirflowNetwork:MultiZone:ExternalNode¶

This object defines outdoor environmental conditions outside of the building.

Fields
- external_node_height [number] (Default: 0.0)
- wind_pressure_coefficient_curve_name [string]
- symmetric_wind_pressure_coefficient_curve [string] (Default: No)
- wind_angle_type [string] (Default: Absolute)

AirflowNetwork:MultiZone:WindPressureCoefficientArray¶

Used only if Wind Pressure Coefficient (WPC) Type = Input in the AirflowNetwork:SimulationControl object. Number of WPC Values in the corresponding AirflowNetwork:MultiZone:WindPressureCoefficientValues object must be the same as the number of wind directions specified for this AirflowNetwork:MultiZone:WindPressureCoefficientArray object.

Fields
- wind_direction_1 [number]
- wind_direction_2 [number]
- wind_direction_3 [number]
- wind_direction_4 [number]
- wind_direction_5 [number]
- wind_direction_6 [number]
- wind_direction_7 [number]
- wind_direction_8 [number]
- wind_direction_9 [number]
- wind_direction_10 [number]
- wind_direction_11 [number]
- wind_direction_12 [number]
- wind_direction_13 [number]
- wind_direction_14 [number]
- wind_direction_15 [number]
- wind_direction_16 [number]
- wind_direction_17 [number]
- wind_direction_18 [number]
- wind_direction_19 [number]
- wind_direction_20 [number]
- wind_direction_21 [number]
- wind_direction_22 [number]
- wind_direction_23 [number]
- wind_direction_24 [number]
- wind_direction_25 [number]
- wind_direction_26 [number]
- wind_direction_27 [number]
- wind_direction_28 [number]
- wind_direction_29 [number]
- wind_direction_30 [number]
- wind_direction_31 [number]
- wind_direction_32 [number]
- wind_direction_33 [number]
- wind_direction_34 [number]
- wind_direction_35 [number]
- wind_direction_36 [number]

AirflowNetwork:MultiZone:WindPressureCoefficientValues¶

Used only if Wind Pressure Coefficient (WPC) Type = INPUT in the AirflowNetwork:SimulationControl object. The number of WPC numeric inputs must correspond to the number of wind direction inputs in the AirflowNetwork:Multizone:WindPressureCoefficientArray object.

Fields
- airflownetwork_multizone_windpressurecoefficientarray_name [string]
- wind_pressure_coefficient_value_1 [number]
- wind_pressure_coefficient_value_2 [number]
- wind_pressure_coefficient_value_3 [number]
- wind_pressure_coefficient_value_4 [number]
- wind_pressure_coefficient_value_5 [number]
- wind_pressure_coefficient_value_6 [number]
- wind_pressure_coefficient_value_7 [number]
- wind_pressure_coefficient_value_8 [number]
- wind_pressure_coefficient_value_9 [number]
- wind_pressure_coefficient_value_10 [number]
- wind_pressure_coefficient_value_11 [number]
- wind_pressure_coefficient_value_12 [number]
- wind_pressure_coefficient_value_13 [number]
- wind_pressure_coefficient_value_14 [number]
- wind_pressure_coefficient_value_15 [number]
- wind_pressure_coefficient_value_16 [number]
- wind_pressure_coefficient_value_17 [number]
- wind_pressure_coefficient_value_18 [number]
- wind_pressure_coefficient_value_19 [number]
- wind_pressure_coefficient_value_20 [number]
- wind_pressure_coefficient_value_21 [number]
- wind_pressure_coefficient_value_22 [number]
- wind_pressure_coefficient_value_23 [number]
- wind_pressure_coefficient_value_24 [number]
- wind_pressure_coefficient_value_25 [number]
- wind_pressure_coefficient_value_26 [number]
- wind_pressure_coefficient_value_27 [number]
- wind_pressure_coefficient_value_28 [number]
- wind_pressure_coefficient_value_29 [number]
- wind_pressure_coefficient_value_30 [number]
- wind_pressure_coefficient_value_31 [number]
- wind_pressure_coefficient_value_32 [number]
- wind_pressure_coefficient_value_33 [number]
- wind_pressure_coefficient_value_34 [number]
- wind_pressure_coefficient_value_35 [number]
- wind_pressure_coefficient_value_36 [number]

AirflowNetwork:ZoneControl:PressureController¶

This object is used to control a zone to a specified indoor pressure using the AirflowNetwork model. The specified pressure setpoint is used to control the zone exhaust fan flow rate in a controlled zone or the relief air flow rate in an air loop.

Fields
- control_zone_name [string]
- control_object_type [string]
- control_object_name [string]
- pressure_control_availability_schedule_name [string]
- pressure_setpoint_schedule_name [string]

AirflowNetwork:Distribution:Node¶

This object represents an air distribution node in the AirflowNetwork model.

Fields
- component_name_or_node_name [string]
- component_object_type_or_node_type [string] (Default: Other)
- node_height [number] (Default: 0.0)

AirflowNetwork:Distribution:Component:Leak¶

This object defines the characteristics of a supply or return air leak.

Fields
- air_mass_flow_coefficient [number]
- air_mass_flow_exponent [number] (Default: 0.65)

AirflowNetwork:Distribution:Component:LeakageRatio¶

This object is used to define supply and return air leaks with respect to the fan’s maximum air flow rate.

Fields
- effective_leakage_ratio [number]
- maximum_flow_rate [number]
- reference_pressure_difference [number]
- air_mass_flow_exponent [number] (Default: 0.65)

AirflowNetwork:Distribution:Component:Duct¶

This object defines the relationship between pressure and air flow through the duct.

Fields
- duct_length [number]
- hydraulic_diameter [number]
- cross_section_area [number]
- surface_roughness [number] (Default: 0.0009)
- coefficient_for_local_dynamic_loss_due_to_fitting [number] (Default: 0.0)
- heat_transmittance_coefficient_u_factor_for_duct_wall_construction [number] (Default: 0.943)
- overall_moisture_transmittance_coefficient_from_air_to_air [number] (Default: 0.001)
- outside_convection_coefficient [number]
- inside_convection_coefficient [number]

AirflowNetwork:Distribution:Component:Fan¶

This object defines the name of the supply Air Fan used in an Air loop.

Fields
- fan_name [string]
- supply_fan_object_type [string] (Default: Fan:ConstantVolume)

AirflowNetwork:Distribution:Component:Coil¶

This object defines the name of a coil used in an air loop.

Fields
- coil_name [string]
- coil_object_type [string]
- air_path_length [number]
- air_path_hydraulic_diameter [number]

AirflowNetwork:Distribution:Component:HeatExchanger¶

This object defines the name of an air-to-air heat exchanger used in an air loop.

Fields
- heatexchanger_name [string]
- heatexchanger_object_type [string]
- air_path_length [number]
- air_path_hydraulic_diameter [number]

AirflowNetwork:Distribution:Component:TerminalUnit¶

This object defines the name of a terminal unit in an air loop.

Fields
- terminal_unit_name [string]
- terminal_unit_object_type [string]
- air_path_length [number]
- air_path_hydraulic_diameter [number]

AirflowNetwork:Distribution:Component:ConstantPressureDrop¶

This object defines the characteristics of a constant pressure drop component (e.g. filter). Each node connected to this object can not be a node of mixer, splitter, a node of air primary loop, or zone equipment loop. It is recommended to connect to a duct component at both ends.

Fields
- pressure_difference_across_the_component [number]

AirflowNetwork:Distribution:Component:OutdoorAirFlow¶

This object includes the outdoor air flow rate set by the Controller:OutdoorAir object in the airflow network.

Fields
- outdoor_air_mixer_name [string]
- air_mass_flow_coefficient_when_no_outdoor_air_flow_at_reference_conditions [number]
- air_mass_flow_exponent_when_no_outdoor_air_flow [number] (Default: 0.65)
- reference_crack_conditions [string]

AirflowNetwork:Distribution:Component:ReliefAirFlow¶

This object allows variation of air flow rate to perform pressure.

Fields
- outdoor_air_mixer_name [string]
- air_mass_flow_coefficient_when_no_outdoor_air_flow_at_reference_conditions [number]
- air_mass_flow_exponent_when_no_outdoor_air_flow [number] (Default: 0.65)
- reference_crack_conditions [string]

AirflowNetwork:Distribution:Linkage¶

This object defines the connection between two nodes and a component.

Fields
- node_1_name [string]
- node_2_name [string]
- component_name [string]
- thermal_zone_name [string]

AirflowNetwork:Distribution:DuctViewFactors¶

This object is used to allow user-defined view factors to be used for duct-surface radiation calculations.

Fields
- linkage_name [string]
- duct_surface_exposure_fraction [number] (Default: 0.0)
- duct_surface_emittance [number] (Default: 0.9)
- surfaces [Array of {surface_name, surface_view_factor}]

AirflowNetwork:Distribution:DuctSizing¶

This object defines required parameters for duct sizing in an Airflow Network simulation. To activate duct sizing, see AirflowNetwork:SimulationControl Do Distribution Duct Sizing Calculation.

Fields
- duct_sizing_method [string] (Default: MaximumVelocity)
- duct_sizing_factor [number] (Default: 1.0)
- maximum_airflow_velocity [number] (Default: 5.0)
- total_pressure_loss_across_supply_trunk [number]
- total_pressure_loss_across_supply_branch [number]
- total_pressure_loss_across_return_trunk [number]
- total_pressure_loss_across_return_branch [number]

AirflowNetwork:OccupantVentilationControl¶

This object is used to provide advanced thermal comfort control of window opening and closing for both exterior and interior windows.

Fields
- minimum_opening_time [number] (Default: 0.0)
- minimum_closing_time [number] (Default: 0.0)
- thermal_comfort_low_temperature_curve_name [string]
- thermal_comfort_temperature_boundary_point [number] (Default: 10.0)
- thermal_comfort_high_temperature_curve_name [string]
- maximum_threshold_for_persons_dissatisfied_ppd [number] (Default: 10.0)
- occupancy_check [string] (Default: No)
- opening_probability_schedule_name [string]
- closing_probability_schedule_name [string]

AirflowNetwork:IntraZone:Node¶

This object represents a node in a zone in the combination of RoomAir and AirflowNetwork model.

Fields
- roomair_node_airflownetwork_name [string]
- zone_name [string]
- node_height [number] (Default: 0.0)

AirflowNetwork:IntraZone:Linkage¶

This object defines the connection between two nodes and a component used in the combination of RoomAir and AirflowNetwork model.

Fields
- node_1_name [string]
- node_2_name [string]
- component_name [string]
- airflownetwork_multizone_surface_name [string]

Exterior Equipment¶

Exterior:Lights¶

only used for Meter type reporting, does not affect building loads

Fields
- schedule_name [string]
- design_level [number]
- control_option [string]
- end_use_subcategory [string] (Default: General)

Exterior:FuelEquipment¶

only used for Meter type reporting, does not affect building loads

Fields
- fuel_use_type [string]
- schedule_name [string]
- design_level [number]
- end_use_subcategory [string] (Default: General)

Exterior:WaterEquipment¶

only used for Meter type reporting, does not affect building loads

Fields
- fuel_use_type [string] (Default: Water)
- schedule_name [string]
- design_level [number]
- end_use_subcategory [string] (Default: General)

HVAC Templates¶

HVACTemplate:Thermostat¶

Zone thermostat control. Referenced schedules must be defined elsewhere in the idf. Thermostat control type is dual setpoint with deadband. It is not necessary to create a thermostat object for every zone, only for each unique set of setpoint schedules. For example, an office building may have two thermostat objects, one for “Office” and one for “Storage”.

Fields
- heating_setpoint_schedule_name [string]
- constant_heating_setpoint [number]
- cooling_setpoint_schedule_name [string]
- constant_cooling_setpoint [number]

HVACTemplate:Zone:IdealLoadsAirSystem¶

Zone with ideal air system that meets heating or cooling loads

Fields
- zone_name [string]
- template_thermostat_name [string]
- system_availability_schedule_name [string]
- maximum_heating_supply_air_temperature [number] (Default: 50.0)
- minimum_cooling_supply_air_temperature [number] (Default: 13.0)
- maximum_heating_supply_air_humidity_ratio [number] (Default: 0.0156)
- minimum_cooling_supply_air_humidity_ratio [number] (Default: 0.0077)
- heating_limit [string] (Default: NoLimit)
- maximum_heating_air_flow_rate [unknown field type]
- maximum_sensible_heating_capacity [unknown field type]
- cooling_limit [string] (Default: NoLimit)
- maximum_cooling_air_flow_rate [unknown field type]
- maximum_total_cooling_capacity [unknown field type]
- heating_availability_schedule_name [string]
- cooling_availability_schedule_name [string]
- dehumidification_control_type [string] (Default: ConstantSensibleHeatRatio)
- cooling_sensible_heat_ratio [number] (Default: 0.7)
- dehumidification_setpoint [number] (Default: 60.0)
- humidification_control_type [string] (Default: None)
- humidification_setpoint [number] (Default: 30.0)
- outdoor_air_method [string] (Default: None)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- design_specification_outdoor_air_object_name [string]
- demand_controlled_ventilation_type [string] (Default: None)
- outdoor_air_economizer_type [string] (Default: NoEconomizer)
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)

HVACTemplate:Zone:BaseboardHeat¶

Zone baseboard heating system.

Fields
- zone_name [string]
- template_thermostat_name [string]
- zone_heating_sizing_factor [number]
- baseboard_heating_type [string] (Default: HotWater)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- dedicated_outdoor_air_system_name [string]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]

HVACTemplate:Zone:FanCoil¶

4 pipe fan coil unit with optional outdoor air.

Fields
- zone_name [string]
- template_thermostat_name [string]
- supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- system_availability_schedule_name [string]
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 75.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cooling_coil_type [string] (Default: ChilledWater)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_design_setpoint [number] (Default: 14.0)
- heating_coil_type [string] (Default: HotWater)
- heating_coil_availability_schedule_name [string]
- heating_coil_design_setpoint [number] (Default: 50.0)
- dedicated_outdoor_air_system_name [string]
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]
- capacity_control_method [string]
- low_speed_supply_air_flow_ratio [number] (Default: 0.33)
- medium_speed_supply_air_flow_ratio [number] (Default: 0.66)
- outdoor_air_schedule_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)

HVACTemplate:Zone:PTAC¶

Packaged Terminal Air Conditioner

Fields
- zone_name [string]
- template_thermostat_name [string]
- cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_load_supply_air_flow_rate [unknown field type]
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- system_availability_schedule_name [string]
- supply_fan_operating_mode_schedule_name [string]
- supply_fan_placement [string] (Default: DrawThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 75.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- cooling_coil_type [string] (Default: SingleSpeedDX)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_cooling_cop [number] (Default: 3.0)
- heating_coil_type [string] (Default: Electric)
- heating_coil_availability_schedule_name [string]
- heating_coil_capacity [unknown field type] (Default: Autosize)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- dedicated_outdoor_air_system_name [string]
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 14.0)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- capacity_control_method [string] (Default: None)

HVACTemplate:Zone:PTHP¶

Packaged Terminal Heat Pump

Fields
- zone_name [string]
- template_thermostat_name [string]
- cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_load_supply_air_flow_rate [unknown field type]
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- system_availability_schedule_name [string]
- supply_fan_operating_mode_schedule_name [string]
- supply_fan_placement [string] (Default: DrawThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 75.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- cooling_coil_type [string] (Default: SingleSpeedDX)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_cop [number] (Default: 3.0)
- heat_pump_heating_coil_type [string] (Default: SingleSpeedDXHeatPump)
- heat_pump_heating_coil_availability_schedule_name [string]
- heat_pump_heating_coil_gross_rated_capacity [unknown field type] (Default: Autosize)
- heat_pump_heating_coil_gross_rated_cop [number] (Default: 2.75)
- heat_pump_heating_minimum_outdoor_dry_bulb_temperature [number] (Default: -8.0)
- heat_pump_defrost_maximum_outdoor_dry_bulb_temperature [number] (Default: 5.0)
- heat_pump_defrost_strategy [string] (Default: ReverseCycle)
- heat_pump_defrost_control [string] (Default: Timed)
- heat_pump_defrost_time_period_fraction [number] (Default: 0.058333)
- supplemental_heating_coil_type [string] (Default: Electric)
- supplemental_heating_coil_availability_schedule_name [string]
- supplemental_heating_coil_capacity [unknown field type] (Default: Autosize)
- supplemental_heating_coil_maximum_outdoor_dry_bulb_temperature [number] (Default: 21.0)
- supplemental_gas_heating_coil_efficiency [number] (Default: 0.8)
- supplemental_gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- dedicated_outdoor_air_system_name [string]
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 14.0)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- capacity_control_method [string] (Default: None)

HVACTemplate:Zone:WaterToAirHeatPump¶

Water to Air Heat Pump to be used with HVACTemplate:Plant:MixedWaterLoop

Fields
- zone_name [string]
- template_thermostat_name [string]
- cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_load_supply_air_flow_rate [unknown field type]
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- system_availability_schedule_name [string]
- supply_fan_operating_mode_schedule_name [string]
- supply_fan_placement [string] (Default: DrawThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 75.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- cooling_coil_type [string] (Default: Coil:Cooling:WaterToAirHeatPump:EquationFit)
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_cop [number] (Default: 3.5)
- heat_pump_heating_coil_type [string] (Default: Coil:Heating:WaterToAirHeatPump:EquationFit)
- heat_pump_heating_coil_gross_rated_capacity [unknown field type] (Default: Autosize)
- heat_pump_heating_coil_gross_rated_cop [number] (Default: 4.2)
- supplemental_heating_coil_availability_schedule_name [string]
- supplemental_heating_coil_capacity [unknown field type] (Default: Autosize)
- maximum_cycling_rate [number] (Default: 2.5)
- heat_pump_time_constant [number] (Default: 60.0)
- fraction_of_on_cycle_power_use [number] (Default: 0.01)
- heat_pump_fan_delay_time [number] (Default: 60.0)
- dedicated_outdoor_air_system_name [string]
- supplemental_heating_coil_type [string] (Default: Electric)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 14.0)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- heat_pump_coil_water_flow_mode [string] (Default: Cycling)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)

HVACTemplate:Zone:VRF¶

Zone terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air or water-to-air heat pump). The VRF terminal units are served by an HVACTemplate:System:VRF system.

Fields
- zone_name [string]
- template_vrf_system_name [string]
- template_thermostat_name [string]
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- rated_total_heating_capacity_sizing_ratio [number] (Default: 1.0)
- cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- cooling_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- heating_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- no_load_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]
- system_availability_schedule_name [string]
- supply_fan_operating_mode_schedule_name [string]
- supply_air_fan_placement [string] (Default: BlowThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 75.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- cooling_coil_type [string] (Default: VariableRefrigerantFlowDX)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- heat_pump_heating_coil_type [string] (Default: VariableRefrigerantFlowDX)
- heat_pump_heating_coil_availability_schedule_name [string]
- heat_pump_heating_coil_gross_rated_capacity [unknown field type] (Default: Autosize)
- zone_terminal_unit_on_parasitic_electric_energy_use [number] (Default: 0.0)
- zone_terminal_unit_off_parasitic_electric_energy_use [number] (Default: 0.0)
- dedicated_outdoor_air_system_name [string]
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 14.0)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)

HVACTemplate:Zone:Unitary¶

Zone terminal unit, constant volume, no controls.

Fields
- zone_name [string]
- template_unitary_system_name [string]
- template_thermostat_name [string]
- supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- supply_plenum_name [string]
- return_plenum_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 12.8)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]

HVACTemplate:Zone:VAV¶

Zone terminal unit, variable volume, reheat optional. For heating, this unit activates reheat coil first, then increases airflow (if reverse action specified).

Fields
- zone_name [string]
- template_vav_system_name [string]
- template_thermostat_name [string]
- supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- zone_minimum_air_flow_input_method [string] (Default: Constant)
- constant_minimum_air_flow_fraction [number] (Default: 0.2)
- fixed_minimum_air_flow_rate [number]
- minimum_air_flow_fraction_schedule_name [string]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- reheat_coil_type [string] (Default: None)
- reheat_coil_availability_schedule_name [string]
- damper_heating_action [string] (Default: Reverse)
- maximum_flow_per_zone_floor_area_during_reheat [unknown field type]
- maximum_flow_fraction_during_reheat [unknown field type]
- maximum_reheat_air_temperature [number]
- design_specification_outdoor_air_object_name_for_control [string]
- supply_plenum_name [string]
- return_plenum_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 12.8)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- design_specification_outdoor_air_object_name_for_sizing [string]
- design_specification_zone_air_distribution_object_name [string]

HVACTemplate:Zone:VAV:FanPowered¶

Zone terminal unit, fan powered variable volume, reheat optional. Referenced schedules must be defined elsewhere in the idf.

Fields
- zone_name [string]
- template_vav_system_name [string]
- template_thermostat_name [string]
- primary_supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- primary_supply_air_minimum_flow_fraction [unknown field type] (Default: Autosize)
- secondary_supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- flow_type [string] (Default: Parallel)
- parallel_fan_on_flow_fraction [unknown field type] (Default: Autosize)
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- reheat_coil_type [string] (Default: Electric)
- reheat_coil_availability_schedule_name [string]
- fan_total_efficiency [number] (Default: 0.7)
- fan_delta_pressure [number] (Default: 1000.0)
- fan_motor_efficiency [number] (Default: 0.9)
- supply_plenum_name [string]
- return_plenum_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 12.8)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)
- zone_piu_fan_schedule_name [string]
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]

HVACTemplate:Zone:VAV:HeatAndCool¶

VAV system with VAV for both heating and cooling and optional reheat coil. For heating, this unit increases airflow first, then activates reheat coil.

Fields
- zone_name [string]
- template_vav_system_name [string]
- template_thermostat_name [string]
- supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- constant_minimum_air_flow_fraction [number] (Default: 0.2)
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- design_specification_outdoor_air_object_name_for_sizing [string]
- design_specification_zone_air_distribution_object_name [string]
- reheat_coil_type [string] (Default: None)
- reheat_coil_availability_schedule_name [string]
- maximum_reheat_air_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 12.8)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)

HVACTemplate:Zone:ConstantVolume¶

Zone terminal unit, constant volume, reheat optional. Referenced schedules must be defined elsewhere in the idf.

Fields
- zone_name [string]
- template_constant_volume_system_name [string]
- template_thermostat_name [string]
- supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- design_specification_outdoor_air_object_name [string]
- design_specification_zone_air_distribution_object_name [string]
- reheat_coil_type [string] (Default: None)
- reheat_coil_availability_schedule_name [string]
- maximum_reheat_air_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 12.8)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)

HVACTemplate:Zone:DualDuct¶

Zone terminal unit, dual-duct, constant or variable volume.

Fields
- zone_name [string]
- template_dual_duct_system_name [string]
- template_thermostat_name [string]
- supply_air_maximum_flow_rate [unknown field type] (Default: Autosize)
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- zone_minimum_air_flow_fraction [number] (Default: 0.2)
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_rate_per_person [number] (Default: 0.00944)
- outdoor_air_flow_rate_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_rate_per_zone [number] (Default: 0.0)
- design_specification_outdoor_air_object_name_for_sizing [string]
- design_specification_zone_air_distribution_object_name [string]
- design_specification_outdoor_air_object_name_for_control [string]
- cold_supply_plenum_name [string]
- hot_supply_plenum_name [string]
- return_plenum_name [string]
- baseboard_heating_type [string] (Default: None)
- baseboard_heating_availability_schedule_name [string]
- baseboard_heating_capacity [unknown field type] (Default: Autosize)
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number] (Default: 12.8)
- zone_cooling_design_supply_air_temperature_difference [number] (Default: 11.11)
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SystemSupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number] (Default: 50.0)
- zone_heating_design_supply_air_temperature_difference [number] (Default: 30.0)

HVACTemplate:System:VRF¶

Variable refrigerant flow (VRF) heat pump condensing unit. Serves one or more VRF zone terminal units (HVACTemplate:Zone:VRF).

Fields
- system_availability_schedule_name [string]
- gross_rated_total_cooling_capacity [unknown field type] (Default: Autosize)
- gross_rated_cooling_cop [number] (Default: 3.3)
- minimum_outdoor_temperature_in_cooling_mode [number] (Default: -6.0)
- maximum_outdoor_temperature_in_cooling_mode [number] (Default: 43.0)
- gross_rated_heating_capacity [unknown field type] (Default: Autosize)
- rated_heating_capacity_sizing_ratio [number] (Default: 1.0)
- gross_rated_heating_cop [number] (Default: 3.4)
- minimum_outdoor_temperature_in_heating_mode [number] (Default: -20.0)
- maximum_outdoor_temperature_in_heating_mode [number] (Default: 16.0)
- minimum_heat_pump_part_load_ratio [number] (Default: 0.15)
- zone_name_for_master_thermostat_location [string]
- master_thermostat_priority_control_type [string] (Default: MasterThermostatPriority)
- thermostat_priority_schedule_name [string]
- heat_pump_waste_heat_recovery [string] (Default: No)
- equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode [number] (Default: 30.0)
- vertical_height_used_for_piping_correction_factor [number] (Default: 10.0)
- equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode [number] (Default: 30.0)
- crankcase_heater_power_per_compressor [number] (Default: 33.0)
- number_of_compressors [integer] (Default: 2)
- ratio_of_compressor_size_to_total_compressor_capacity [number] (Default: 0.5)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater [number] (Default: 5.0)
- defrost_strategy [string] (Default: Resistive)
- defrost_control [string] (Default: Timed)
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: Autosize)
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- condenser_type [string] (Default: AirCooled)
- water_condenser_volume_flow_rate [unknown field type] (Default: Autosize)
- evaporative_condenser_effectiveness [number] (Default: 0.9)
- evaporative_condenser_air_flow_rate [unknown field type] (Default: Autosize)
- evaporative_condenser_pump_rated_power_consumption [unknown field type] (Default: 0.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- fuel_type [string] (Default: Electricity)
- minimum_outdoor_temperature_in_heat_recovery_mode [number] (Default: -15.0)
- maximum_outdoor_temperature_in_heat_recovery_mode [number] (Default: 45.0)

HVACTemplate:System:Unitary¶

Unitary furnace with air conditioner

Fields
- system_availability_schedule_name [string]
- control_zone_or_thermostat_location_name [string]
- supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_operating_mode_schedule_name [string]
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 600.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cooling_coil_type [string] (Default: SingleSpeedDX)
- cooling_coil_availability_schedule_name [string]
- cooling_design_supply_air_temperature [number] (Default: 12.8)
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_cop [number] (Default: 3.0)
- heating_coil_type [string]
- heating_coil_availability_schedule_name [string]
- heating_design_supply_air_temperature [number] (Default: 50.0)
- heating_coil_capacity [unknown field type] (Default: Autosize)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_lockout [string] (Default: NoLockout)
- economizer_upper_temperature_limit [number]
- economizer_lower_temperature_limit [number]
- economizer_upper_enthalpy_limit [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- supply_fan_placement [string] (Default: BlowThrough)
- night_cycle_control [string] (Default: StayOff)
- night_cycle_control_zone_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- dehumidification_control_type [string] (Default: None)
- dehumidification_setpoint [number] (Default: 60.0)
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_setpoint [number] (Default: 30.0)
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 500.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)

HVACTemplate:System:UnitaryHeatPump:AirToAir¶

Unitary furnace with electric air-to-air heat pump

Fields
- system_availability_schedule_name [string]
- control_zone_or_thermostat_location_name [string]
- cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_load_supply_air_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_operating_mode_schedule_name [string]
- supply_fan_placement [string] (Default: BlowThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 600.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cooling_coil_type [string] (Default: SingleSpeedDX)
- cooling_coil_availability_schedule_name [string]
- cooling_design_supply_air_temperature [number] (Default: 12.8)
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_cop [number] (Default: 3.0)
- heat_pump_heating_coil_type [string] (Default: SingleSpeedDXHeatPump)
- heat_pump_heating_coil_availability_schedule_name [string]
- heating_design_supply_air_temperature [number] (Default: 50.0)
- heat_pump_heating_coil_gross_rated_capacity [unknown field type] (Default: Autosize)
- heat_pump_heating_coil_rated_cop [number] (Default: 2.75)
- heat_pump_heating_minimum_outdoor_dry_bulb_temperature [number] (Default: -8.0)
- heat_pump_defrost_maximum_outdoor_dry_bulb_temperature [number] (Default: 5.0)
- heat_pump_defrost_strategy [string] (Default: ReverseCycle)
- heat_pump_defrost_control [string] (Default: Timed)
- heat_pump_defrost_time_period_fraction [number] (Default: 0.058333)
- supplemental_heating_coil_type [string] (Default: Electric)
- supplemental_heating_coil_availability_schedule_name [string]
- supplemental_heating_coil_capacity [unknown field type] (Default: Autosize)
- supplemental_heating_coil_maximum_outdoor_dry_bulb_temperature [number] (Default: 21.0)
- supplemental_gas_heating_coil_efficiency [number] (Default: 0.8)
- supplemental_gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_lockout [string] (Default: NoLockout)
- economizer_maximum_limit_dry_bulb_temperature [number]
- economizer_maximum_limit_enthalpy [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- economizer_minimum_limit_dry_bulb_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- night_cycle_control [string] (Default: StayOff)
- night_cycle_control_zone_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_setpoint [number] (Default: 30.0)
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 500.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)

HVACTemplate:System:UnitarySystem¶

Unitary HVAC system with optional cooling and heating. Supports DX and chilled water, cooling, gas, electric, and hot water heating, air-to-air and water-to-air heat pumps.

Fields
- system_availability_schedule_name [string]
- control_type [string] (Default: Load)
- control_zone_or_thermostat_location_name [string]
- cooling_supply_air_flow_rate [unknown field type] (Default: Autosize)
- heating_supply_air_flow_rate [unknown field type] (Default: Autosize)
- no_load_supply_air_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_operating_mode_schedule_name [string]
- supply_fan_placement [string] (Default: BlowThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 600.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cooling_coil_type [string] (Default: SingleSpeedDX)
- number_of_speeds_for_cooling [integer] (Default: 1)
- cooling_coil_availability_schedule_name [string]
- cooling_design_supply_air_temperature [number] (Default: 12.8)
- dx_cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- dx_cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- dx_cooling_coil_gross_rated_cop [number] (Default: 3.0)
- heating_coil_type [string] (Default: Gas)
- number_of_speeds_or_stages_for_heating [integer] (Default: 1)
- heating_coil_availability_schedule_name [string]
- heating_design_supply_air_temperature [number] (Default: 50.0)
- heating_coil_gross_rated_capacity [unknown field type] (Default: Autosize)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- heat_pump_heating_coil_gross_rated_cop [number] (Default: 2.75)
- heat_pump_heating_minimum_outdoor_dry_bulb_temperature [number] (Default: -8.0)
- heat_pump_defrost_maximum_outdoor_dry_bulb_temperature [number] (Default: 5.0)
- heat_pump_defrost_strategy [string] (Default: ReverseCycle)
- heat_pump_defrost_control [string] (Default: Timed)
- heat_pump_defrost_time_period_fraction [number] (Default: 0.058333)
- supplemental_heating_or_reheat_coil_type [string] (Default: None)
- supplemental_heating_or_reheat_coil_availability_schedule_name [string]
- supplemental_heating_or_reheat_coil_capacity [unknown field type] (Default: Autosize)
- supplemental_heating_or_reheat_coil_maximum_outdoor_dry_bulb_temperature [number] (Default: 21.0)
- supplemental_gas_heating_or_reheat_coil_efficiency [number] (Default: 0.8)
- supplemental_gas_heating_or_reheat_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_lockout [string] (Default: NoLockout)
- economizer_maximum_limit_dry_bulb_temperature [number]
- economizer_maximum_limit_enthalpy [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- economizer_minimum_limit_dry_bulb_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- heat_recovery_heat_exchanger_type [string] (Default: Plate)
- heat_recovery_frost_control_type [string] (Default: None)
- dehumidification_control_type [string] (Default: None)
- dehumidification_relative_humidity_setpoint [number] (Default: 60.0)
- dehumidification_relative_humidity_setpoint_schedule_name [string]
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_relative_humidity_setpoint [number] (Default: 30.0)
- humidifier_relative_humidity_setpoint_schedule_name [string]
- sizing_option [string] (Default: NonCoincident)
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 300.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)

HVACTemplate:System:VAV¶

Variable Air Volume (VAV) air loop with optional heating coil and optional preheat.

Fields
- system_availability_schedule_name [string]
- supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_minimum_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 1000.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cooling_coil_type [string] (Default: ChilledWater)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_setpoint_schedule_name [string]
- cooling_coil_design_setpoint [number] (Default: 12.8)
- heating_coil_type [string] (Default: None)
- heating_coil_availability_schedule_name [string]
- heating_coil_setpoint_schedule_name [string]
- heating_coil_design_setpoint [number] (Default: 10.0)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- preheat_coil_type [string] (Default: None)
- preheat_coil_availability_schedule_name [string]
- preheat_coil_setpoint_schedule_name [string]
- preheat_coil_design_setpoint [number] (Default: 7.2)
- gas_preheat_coil_efficiency [number] (Default: 0.8)
- gas_preheat_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_control_type [string] (Default: ProportionalMinimum)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_lockout [string] (Default: NoLockout)
- economizer_upper_temperature_limit [number]
- economizer_lower_temperature_limit [number]
- economizer_upper_enthalpy_limit [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- supply_fan_placement [string] (Default: DrawThrough)
- supply_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)
- night_cycle_control [string] (Default: StayOff)
- night_cycle_control_zone_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- cooling_coil_setpoint_reset_type [string] (Default: None)
- heating_coil_setpoint_reset_type [string] (Default: None)
- dehumidification_control_type [string] (Default: None)
- dehumidification_control_zone_name [string]
- dehumidification_setpoint [number] (Default: 60.0)
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_setpoint [number] (Default: 30.0)
- sizing_option [string] (Default: NonCoincident)
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 500.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- return_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)

HVACTemplate:System:PackagedVAV¶

Packaged Variable Air Volume (PVAV) air loop with optional heating coil and optional preheat.

Fields
- system_availability_schedule_name [string]
- supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_minimum_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_placement [string] (Default: DrawThrough)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 1000.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cooling_coil_type [string] (Default: TwoSpeedDX)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_setpoint_schedule_name [string]
- cooling_coil_design_setpoint [number] (Default: 12.8)
- cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- cooling_coil_gross_rated_cop [number] (Default: 3.0)
- heating_coil_type [string] (Default: None)
- heating_coil_availability_schedule_name [string]
- heating_coil_setpoint_schedule_name [string]
- heating_coil_design_setpoint [number] (Default: 10.0)
- heating_coil_capacity [unknown field type] (Default: Autosize)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_control_type [string] (Default: ProportionalMinimum)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_lockout [string] (Default: NoLockout)
- economizer_maximum_limit_dry_bulb_temperature [number]
- economizer_maximum_limit_enthalpy [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- economizer_minimum_limit_dry_bulb_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- supply_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)
- night_cycle_control [string] (Default: StayOff)
- night_cycle_control_zone_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- cooling_coil_setpoint_reset_type [string] (Default: None)
- heating_coil_setpoint_reset_type [string] (Default: None)
- dehumidification_control_type [string] (Default: None)
- dehumidification_control_zone_name [string]
- dehumidification_setpoint [number] (Default: 60.0)
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_setpoint [number] (Default: 30.0)
- sizing_option [string] (Default: NonCoincident)
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 500.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- return_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)

HVACTemplate:System:ConstantVolume¶

Constant Air Volume air loop with optional chilled water cooling coil, optional heating coil and optional preheat.

Fields
- system_availability_schedule_name [string]
- supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 600.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- supply_fan_placement [string] (Default: DrawThrough)
- cooling_coil_type [string] (Default: ChilledWater)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_setpoint_control_type [string] (Default: FixedSetpoint)
- cooling_coil_control_zone_name [string]
- cooling_coil_design_setpoint_temperature [number] (Default: 12.8)
- cooling_coil_setpoint_schedule_name [string]
- cooling_coil_setpoint_at_outdoor_dry_bulb_low [number] (Default: 15.6)
- cooling_coil_reset_outdoor_dry_bulb_low [number] (Default: 15.6)
- cooling_coil_setpoint_at_outdoor_dry_bulb_high [number] (Default: 12.8)
- cooling_coil_reset_outdoor_dry_bulb_high [number] (Default: 23.3)
- heating_coil_type [string] (Default: HotWater)
- heating_coil_availability_schedule_name [string]
- heating_coil_setpoint_control_type [string] (Default: FixedSetpoint)
- heating_coil_control_zone_name [string]
- heating_coil_design_setpoint [number] (Default: 10.0)
- heating_coil_setpoint_schedule_name [string]
- heating_coil_setpoint_at_outdoor_dry_bulb_low [number] (Default: 15.0)
- heating_coil_reset_outdoor_dry_bulb_low [number] (Default: 7.8)
- heating_coil_setpoint_at_outdoor_dry_bulb_high [number] (Default: 12.2)
- heating_coil_reset_outdoor_dry_bulb_high [number] (Default: 12.2)
- heating_coil_capacity [unknown field type] (Default: Autosize)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- preheat_coil_type [string] (Default: None)
- preheat_coil_availability_schedule_name [string]
- preheat_coil_design_setpoint [number] (Default: 7.2)
- preheat_coil_setpoint_schedule_name [string]
- gas_preheat_coil_efficiency [number] (Default: 0.8)
- gas_preheat_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_upper_temperature_limit [number]
- economizer_lower_temperature_limit [number]
- economizer_upper_enthalpy_limit [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- supply_plenum_name [string]
- return_plenum_name [string]
- night_cycle_control [string] (Default: StayOff)
- night_cycle_control_zone_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- heat_recovery_heat_exchanger_type [string] (Default: Plate)
- heat_recovery_frost_control_type [string] (Default: None)
- dehumidification_control_type [string] (Default: None)
- dehumidification_control_zone_name [string]
- dehumidification_relative_humidity_setpoint [number] (Default: 60.0)
- dehumidification_relative_humidity_setpoint_schedule_name [string]
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_relative_humidity_setpoint [number] (Default: 30.0)
- humidifier_relative_humidity_setpoint_schedule_name [string]
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 300.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)

HVACTemplate:System:DualDuct¶

Dual-duct constant volume or variable volume air loop

Fields
- system_availability_schedule_name [string]
- system_configuration_type [string] (Default: SingleFanConstantVolume)
- main_supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- main_supply_fan_minimum_flow_fraction [number] (Default: 0.2)
- main_supply_fan_total_efficiency [number] (Default: 0.7)
- main_supply_fan_delta_pressure [number] (Default: 1000.0)
- main_supply_fan_motor_efficiency [number] (Default: 0.9)
- main_supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- main_supply_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)
- cold_duct_supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- cold_duct_supply_fan_minimum_flow_fraction [number] (Default: 0.2)
- cold_duct_supply_fan_total_efficiency [number] (Default: 0.7)
- cold_duct_supply_fan_delta_pressure [number] (Default: 1000.0)
- cold_duct_supply_fan_motor_efficiency [number] (Default: 0.9)
- cold_duct_supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- cold_duct_supply_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)
- cold_duct_supply_fan_placement [string] (Default: DrawThrough)
- hot_duct_supply_fan_maximum_flow_rate [unknown field type] (Default: Autosize)
- hot_duct_supply_fan_minimum_flow_fraction [number] (Default: 0.2)
- hot_duct_supply_fan_total_efficiency [number] (Default: 0.7)
- hot_duct_supply_fan_delta_pressure [number] (Default: 1000.0)
- hot_duct_supply_fan_motor_efficiency [number] (Default: 0.9)
- hot_duct_supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- hot_duct_supply_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)
- hot_duct_supply_fan_placement [string] (Default: DrawThrough)
- cooling_coil_type [string] (Default: ChilledWater)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_setpoint_control_type [string] (Default: FixedSetpoint)
- cooling_coil_design_setpoint_temperature [number] (Default: 12.8)
- cooling_coil_setpoint_schedule_name [string]
- cooling_coil_setpoint_at_outdoor_dry_bulb_low [number] (Default: 15.6)
- cooling_coil_reset_outdoor_dry_bulb_low [number] (Default: 15.6)
- cooling_coil_setpoint_at_outdoor_dry_bulb_high [number] (Default: 12.8)
- cooling_coil_reset_outdoor_dry_bulb_high [number] (Default: 23.3)
- heating_coil_type [string] (Default: HotWater)
- heating_coil_availability_schedule_name [string]
- heating_coil_setpoint_control_type [string] (Default: FixedSetpoint)
- heating_coil_design_setpoint [number] (Default: 50.0)
- heating_coil_setpoint_schedule_name [string]
- heating_coil_setpoint_at_outdoor_dry_bulb_low [number] (Default: 50.0)
- heating_coil_reset_outdoor_dry_bulb_low [number] (Default: 7.8)
- heating_coil_setpoint_at_outdoor_dry_bulb_high [number] (Default: 20.0)
- heating_coil_reset_outdoor_dry_bulb_high [number] (Default: 12.2)
- heating_coil_capacity [unknown field type] (Default: Autosize)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- preheat_coil_type [string] (Default: None)
- preheat_coil_availability_schedule_name [string]
- preheat_coil_design_setpoint [number] (Default: 7.2)
- preheat_coil_setpoint_schedule_name [string]
- gas_preheat_coil_efficiency [number] (Default: 0.8)
- gas_preheat_coil_parasitic_electric_load [number] (Default: 0.0)
- maximum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_outdoor_air_control_type [string] (Default: ProportionalMinimum)
- minimum_outdoor_air_schedule_name [string]
- economizer_type [string] (Default: NoEconomizer)
- economizer_lockout [string] (Default: NoLockout)
- economizer_upper_temperature_limit [number]
- economizer_lower_temperature_limit [number]
- economizer_upper_enthalpy_limit [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- cold_supply_plenum_name [string]
- hot_supply_plenum_name [string]
- return_plenum_name [string]
- night_cycle_control [string] (Default: StayOff)
- night_cycle_control_zone_name [string]
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- heat_recovery_heat_exchanger_type [string] (Default: Plate)
- heat_recovery_frost_control_type [string] (Default: None)
- dehumidification_control_type [string] (Default: None)
- dehumidification_control_zone_name [string]
- dehumidification_relative_humidity_setpoint [number] (Default: 60.0)
- dehumidification_relative_humidity_setpoint_schedule_name [string]
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_control_zone_name [string]
- humidifier_relative_humidity_setpoint [number] (Default: 30.0)
- humidifier_relative_humidity_setpoint_schedule_name [string]
- sizing_option [string] (Default: NonCoincident)
- return_fan [string] (Default: No)
- return_fan_total_efficiency [number] (Default: 0.7)
- return_fan_delta_pressure [number] (Default: 500.0)
- return_fan_motor_efficiency [number] (Default: 0.9)
- return_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- return_fan_part_load_power_coefficients [string] (Default: InletVaneDampers)

HVACTemplate:System:DedicatedOutdoorAir¶

This object creates a dedicated outdoor air system that must be used with HVACTemplate:Zone:* objects for BaseboardHeat FanCoil PTAC PTHP WaterToAirHeatPump and VRF. Does not support HVACTemplate:Zone:VAV or other central multizone systems

Fields
- system_availability_schedule_name [string]
- air_outlet_type [string] (Default: DirectIntoZone)
- supply_fan_flow_rate [unknown field type] (Default: Autosize)
- supply_fan_total_efficiency [number] (Default: 0.7)
- supply_fan_delta_pressure [number] (Default: 1000.0)
- supply_fan_motor_efficiency [number] (Default: 0.9)
- supply_fan_motor_in_air_stream_fraction [number] (Default: 1.0)
- supply_fan_placement [string] (Default: DrawThrough)
- cooling_coil_type [string] (Default: ChilledWater)
- cooling_coil_availability_schedule_name [string]
- cooling_coil_setpoint_control_type [string] (Default: FixedSetpoint)
- cooling_coil_design_setpoint [number] (Default: 12.8)
- cooling_coil_setpoint_schedule_name [string]
- cooling_coil_setpoint_at_outdoor_dry_bulb_low [number] (Default: 15.6)
- cooling_coil_reset_outdoor_dry_bulb_low [number] (Default: 15.6)
- cooling_coil_setpoint_at_outdoor_dry_bulb_high [number] (Default: 12.8)
- cooling_coil_reset_outdoor_dry_bulb_high [number] (Default: 23.3)
- dx_cooling_coil_gross_rated_total_capacity [unknown field type] (Default: Autosize)
- dx_cooling_coil_gross_rated_sensible_heat_ratio [unknown field type] (Default: Autosize)
- dx_cooling_coil_gross_rated_cop [number] (Default: 3.0)
- heating_coil_type [string] (Default: HotWater)
- heating_coil_availability_schedule_name [string]
- heating_coil_setpoint_control_type [string] (Default: FixedSetpoint)
- heating_coil_design_setpoint [number] (Default: 12.2)
- heating_coil_setpoint_schedule_name [string]
- heating_coil_setpoint_at_outdoor_dry_bulb_low [number] (Default: 15.0)
- heating_coil_reset_outdoor_dry_bulb_low [number] (Default: 7.8)
- heating_coil_setpoint_at_outdoor_dry_bulb_high [number] (Default: 12.2)
- heating_coil_reset_outdoor_dry_bulb_high [number] (Default: 12.2)
- gas_heating_coil_efficiency [number] (Default: 0.8)
- gas_heating_coil_parasitic_electric_load [number] (Default: 0.0)
- heat_recovery_type [string] (Default: None)
- heat_recovery_sensible_effectiveness [number] (Default: 0.7)
- heat_recovery_latent_effectiveness [number] (Default: 0.65)
- heat_recovery_heat_exchanger_type [string] (Default: Plate)
- heat_recovery_frost_control_type [string] (Default: None)
- dehumidification_control_type [string] (Default: None)
- dehumidification_setpoint [number] (Default: 0.00924)
- humidifier_type [string] (Default: None)
- humidifier_availability_schedule_name [string]
- humidifier_rated_capacity [number] (Default: 1e-06)
- humidifier_rated_electric_power [unknown field type] (Default: Autosize)
- humidifier_constant_setpoint [number] (Default: 0.003)
- dehumidification_setpoint_schedule_name [string]
- humidifier_setpoint_schedule_name [string]

HVACTemplate:Plant:ChilledWaterLoop¶

Plant and condenser loops to serve all HVACTemplate chilled water coils, chillers, and towers.

Fields
- pump_schedule_name [string]
- pump_control_type [string] (Default: Intermittent)
- chiller_plant_operation_scheme_type [string] (Default: Default)
- chiller_plant_equipment_operation_schemes_name [string]
- chilled_water_setpoint_schedule_name [string]
- chilled_water_design_setpoint [number] (Default: 7.22)
- chilled_water_pump_configuration [string] (Default: ConstantPrimaryNoSecondary)
- primary_chilled_water_pump_rated_head [number] (Default: 179352.0)
- secondary_chilled_water_pump_rated_head [number] (Default: 179352.0)
- condenser_plant_operation_scheme_type [string] (Default: Default)
- condenser_equipment_operation_schemes_name [string]
- condenser_water_temperature_control_type [string]
- condenser_water_setpoint_schedule_name [string]
- condenser_water_design_setpoint [number] (Default: 29.4)
- condenser_water_pump_rated_head [number] (Default: 179352.0)
- chilled_water_setpoint_reset_type [string] (Default: None)
- chilled_water_setpoint_at_outdoor_dry_bulb_low [number] (Default: 12.2)
- chilled_water_reset_outdoor_dry_bulb_low [number] (Default: 15.6)
- chilled_water_setpoint_at_outdoor_dry_bulb_high [number] (Default: 6.7)
- chilled_water_reset_outdoor_dry_bulb_high [number] (Default: 26.7)
- chilled_water_primary_pump_type [string] (Default: SinglePump)
- chilled_water_secondary_pump_type [string] (Default: SinglePump)
- condenser_water_pump_type [string] (Default: SinglePump)
- chilled_water_supply_side_bypass_pipe [string] (Default: Yes)
- chilled_water_demand_side_bypass_pipe [string] (Default: Yes)
- condenser_water_supply_side_bypass_pipe [string] (Default: Yes)
- condenser_water_demand_side_bypass_pipe [string] (Default: Yes)
- fluid_type [string] (Default: Water)
- loop_design_delta_temperature [number] (Default: 6.67)
- minimum_outdoor_dry_bulb_temperature [number]
- chilled_water_load_distribution_scheme [string] (Default: SequentialLoad)
- condenser_water_load_distribution_scheme [string] (Default: SequentialLoad)

HVACTemplate:Plant:Chiller¶

This object adds a chiller to an HVACTemplate:Plant:ChilledWaterLoop.

Fields
- chiller_type [string]
- capacity [unknown field type] (Default: Autosize)
- nominal_cop [number]
- condenser_type [string] (Default: WaterCooled)
- priority [string]
- sizing_factor [number] (Default: 1.0)
- minimum_part_load_ratio [number] (Default: 0.0)
- maximum_part_load_ratio [number] (Default: 1.0)
- optimum_part_load_ratio [number] (Default: 1.0)
- minimum_unloading_ratio [number] (Default: 0.25)
- leaving_chilled_water_lower_temperature_limit [number] (Default: 5.0)

HVACTemplate:Plant:Chiller:ObjectReference¶

This object references a detailed chiller object and adds it to an HVACTemplate:Plant:ChilledWaterLoop. The user must create a complete detailed chiller object with all required curve or performance objects.

Fields
- chiller_object_type [string] (Default: Chiller:Electric:EIR)
- chiller_name [string]
- priority [number]

HVACTemplate:Plant:Tower¶

This object adds a cooling tower to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop.

Fields
- tower_type [string]
- high_speed_nominal_capacity [unknown field type] (Default: Autosize)
- high_speed_fan_power [unknown field type] (Default: Autosize)
- low_speed_nominal_capacity [unknown field type] (Default: Autosize)
- low_speed_fan_power [unknown field type] (Default: Autosize)
- free_convection_capacity [unknown field type] (Default: Autosize)
- priority [string]
- sizing_factor [number] (Default: 1.0)
- template_plant_loop_type [string]

HVACTemplate:Plant:Tower:ObjectReference¶

This object references a detailed cooling tower object and adds it to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop. The user must create a complete detailed cooling tower object with all required curve or performance objects.

Fields
- cooling_tower_object_type [string] (Default: CoolingTower:SingleSpeed)
- cooling_tower_name [string]
- priority [number]
- template_plant_loop_type [string]

HVACTemplate:Plant:HotWaterLoop¶

Plant loop to serve all HVACTemplate hot water coils and boilers.

Fields
- pump_schedule_name [string]
- pump_control_type [string] (Default: Intermittent)
- hot_water_plant_operation_scheme_type [string] (Default: Default)
- hot_water_plant_equipment_operation_schemes_name [string]
- hot_water_setpoint_schedule_name [string]
- hot_water_design_setpoint [number] (Default: 82.0)
- hot_water_pump_configuration [string] (Default: ConstantFlow)
- hot_water_pump_rated_head [number] (Default: 179352.0)
- hot_water_setpoint_reset_type [string] (Default: None)
- hot_water_setpoint_at_outdoor_dry_bulb_low [number] (Default: 82.2)
- hot_water_reset_outdoor_dry_bulb_low [number] (Default: -6.7)
- hot_water_setpoint_at_outdoor_dry_bulb_high [number] (Default: 65.6)
- hot_water_reset_outdoor_dry_bulb_high [number] (Default: 10.0)
- hot_water_pump_type [string] (Default: SinglePump)
- supply_side_bypass_pipe [string] (Default: Yes)
- demand_side_bypass_pipe [string] (Default: Yes)
- fluid_type [string] (Default: Water)
- loop_design_delta_temperature [number] (Default: 11.0)
- maximum_outdoor_dry_bulb_temperature [number]
- load_distribution_scheme [string] (Default: SequentialLoad)

HVACTemplate:Plant:Boiler¶

This object adds a boiler to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop.

Fields
- boiler_type [string]
- capacity [unknown field type] (Default: Autosize)
- efficiency [number] (Default: 0.8)
- fuel_type [string]
- priority [string]
- sizing_factor [number] (Default: 1.0)
- minimum_part_load_ratio [number] (Default: 0.0)
- maximum_part_load_ratio [number] (Default: 1.1)
- optimum_part_load_ratio [number] (Default: 1.0)
- water_outlet_upper_temperature_limit [number] (Default: 100.0)
- template_plant_loop_type [string]

HVACTemplate:Plant:Boiler:ObjectReference¶

This object references a detailed boiler object and adds it to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop. The user must create a complete detailed boiler object with all required curve or performance objects.

Fields
- boiler_object_type [string] (Default: Boiler:HotWater)
- boiler_name [string]
- priority [number]
- template_plant_loop_type [string]

HVACTemplate:Plant:MixedWaterLoop¶

Central plant loop portion of a water source heat pump system.

Fields
- pump_schedule_name [string]
- pump_control_type [string] (Default: Intermittent)
- operation_scheme_type [string] (Default: Default)
- equipment_operation_schemes_name [string]
- high_temperature_setpoint_schedule_name [string]
- high_temperature_design_setpoint [number] (Default: 33.0)
- low_temperature_setpoint_schedule_name [string]
- low_temperature_design_setpoint [number] (Default: 20.0)
- water_pump_configuration [string] (Default: ConstantFlow)
- water_pump_rated_head [number] (Default: 179352.0)
- water_pump_type [string] (Default: SinglePump)
- supply_side_bypass_pipe [string] (Default: Yes)
- demand_side_bypass_pipe [string] (Default: Yes)
- fluid_type [string] (Default: Water)
- loop_design_delta_temperature [number] (Default: 5.6)
- load_distribution_scheme [string] (Default: SequentialLoad)

HVAC Design Objects¶

DesignSpecification:OutdoorAir¶

This object is used to describe general outdoor air requirements which are referenced by other objects.

Fields
- outdoor_air_method [string] (Default: Flow/Person)
- outdoor_air_flow_per_person [number] (Default: 0.00944)
- outdoor_air_flow_per_zone_floor_area [number] (Default: 0.0)
- outdoor_air_flow_per_zone [number] (Default: 0.0)
- outdoor_air_flow_air_changes_per_hour [number] (Default: 0.0)
- outdoor_air_schedule_name [string]
- proportional_control_minimum_outdoor_air_flow_rate_schedule_name [string]

DesignSpecification:OutdoorAir:SpaceList¶

Defines a list of DesignSpecification:OutdoorAir names which can be referenced as a group. The DesignSpecification:OutdoorAir:SpaceList name may be used in Sizing:Zone and Controller:MechanicalVentilation to specify space-by-space OA requirements and anywhere else that accepts a DesignSpecification:OutdoorAir object name.

Fields
- space_specs [Array of {space_name, space_design_specification_outdoor_air_object_name}]

DesignSpecification:ZoneAirDistribution¶

This object is used to describe zone air distribution in terms of air distribution effectiveness and secondary recirculation fraction. It is referenced by Sizing:Zone and Controller:MechanicalVentilation objects

Fields
- zone_air_distribution_effectiveness_in_cooling_mode [number] (Default: 1.0)
- zone_air_distribution_effectiveness_in_heating_mode [number] (Default: 1.0)
- zone_air_distribution_effectiveness_schedule_name [string]
- zone_secondary_recirculation_fraction [number] (Default: 0.0)
- minimum_zone_ventilation_efficiency [number] (Default: 0.0)

Sizing:Parameters¶

Specifies global heating and cooling sizing factors/ratios. These ratios are applied at the zone level to all of the zone heating and cooling loads and air flow rates. Then these new loads and air flow rates are used to calculate the system level flow rates and capacities and are used in all component sizing calculations. Specifies the width (in load timesteps) of a moving average window which is used to smooth the peak load across more than one timestep.

Fields
- heating_sizing_factor [number] (Default: 1.0)
- cooling_sizing_factor [number] (Default: 1.0)
- timesteps_in_averaging_window [integer]

Sizing:Zone¶

Specifies the data needed to perform a zone design air flow calculation. The calculation is done for every sizing period included in the input. The maximum cooling and heating load and cooling, heating, and ventilation air flows are then saved for system level and zone component design calculations.

Fields
- zone_or_zonelist_name [string]
- zone_cooling_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_cooling_design_supply_air_temperature [number]
- zone_cooling_design_supply_air_temperature_difference [number]
- zone_heating_design_supply_air_temperature_input_method [string] (Default: SupplyAirTemperature)
- zone_heating_design_supply_air_temperature [number]
- zone_heating_design_supply_air_temperature_difference [number]
- zone_cooling_design_supply_air_humidity_ratio [number]
- zone_heating_design_supply_air_humidity_ratio [number]
- design_specification_outdoor_air_object_name [string]
- zone_heating_sizing_factor [number]
- zone_cooling_sizing_factor [number]
- cooling_design_air_flow_method [string] (Default: DesignDay)
- cooling_design_air_flow_rate [number] (Default: 0.0)
- cooling_minimum_air_flow_per_zone_floor_area [number] (Default: 0.000762)
- cooling_minimum_air_flow [number] (Default: 0.0)
- cooling_minimum_air_flow_fraction [number] (Default: 0.2)
- heating_design_air_flow_method [string] (Default: DesignDay)
- heating_design_air_flow_rate [number] (Default: 0.0)
- heating_maximum_air_flow_per_zone_floor_area [number] (Default: 0.002032)
- heating_maximum_air_flow [number] (Default: 0.1415762)
- heating_maximum_air_flow_fraction [number] (Default: 0.3)
- design_specification_zone_air_distribution_object_name [string]
- account_for_dedicated_outdoor_air_system [string] (Default: No)
- dedicated_outdoor_air_system_control_strategy [string] (Default: NeutralSupplyAir)
- dedicated_outdoor_air_low_setpoint_temperature_for_design [unknown field type] (Default: Autosize)
- dedicated_outdoor_air_high_setpoint_temperature_for_design [unknown field type] (Default: Autosize)
- zone_load_sizing_method [string] (Default: Sensible Load Only No Latent Load)
- zone_latent_cooling_design_supply_air_humidity_ratio_input_method [string] (Default: HumidityRatioDifference)
- zone_dehumidification_design_supply_air_humidity_ratio [number]
- zone_cooling_design_supply_air_humidity_ratio_difference [number] (Default: 0.005)
- zone_latent_heating_design_supply_air_humidity_ratio_input_method [string] (Default: HumidityRatioDifference)
- zone_humidification_design_supply_air_humidity_ratio [number]
- zone_humidification_design_supply_air_humidity_ratio_difference [number] (Default: 0.005)
- zone_humidistat_dehumidification_set_point_schedule_name [string]
- zone_humidistat_humidification_set_point_schedule_name [string]

DesignSpecification:ZoneHVAC:Sizing¶

This object is used to describe general scalable zone HVAC equipment sizing which are referenced by other objects.

Fields
- cooling_supply_air_flow_rate_method [string] (Default: SupplyAirFlowRate)
- cooling_supply_air_flow_rate [unknown field type]
- cooling_supply_air_flow_rate_per_floor_area [number]
- cooling_fraction_of_autosized_cooling_supply_air_flow_rate [number]
- cooling_supply_air_flow_rate_per_unit_cooling_capacity [number]
- no_load_supply_air_flow_rate_method [string] (Default: SupplyAirFlowRate)
- no_load_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate_per_floor_area [number]
- no_load_fraction_of_cooling_supply_air_flow_rate [number]
- no_load_fraction_of_heating_supply_air_flow_rate [number]
- heating_supply_air_flow_rate_method [string] (Default: SupplyAirFlowRate)
- heating_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate_per_floor_area [number]
- heating_fraction_of_heating_supply_air_flow_rate [number]
- heating_supply_air_flow_rate_per_unit_heating_capacity [number]
- cooling_design_capacity_method [string] (Default: None)
- cooling_design_capacity [unknown field type]
- cooling_design_capacity_per_floor_area [number]
- fraction_of_autosized_cooling_design_capacity [number]
- heating_design_capacity_method [string] (Default: None)
- heating_design_capacity [unknown field type]
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number]

DesignSpecification:AirTerminal:Sizing¶

This object is used to scale the sizing of air terminal units.

Fields
- fraction_of_design_cooling_load [number] (Default: 1.0)
- cooling_design_supply_air_temperature_difference_ratio [number] (Default: 1.0)
- fraction_of_design_heating_load [number] (Default: 1.0)
- heating_design_supply_air_temperature_difference_ratio [number] (Default: 1.0)
- fraction_of_minimum_outdoor_air_flow [number] (Default: 1.0)

Sizing:System¶

Specifies the input needed to perform sizing calculations for a central forced air system. System design air flow, heating capacity, and cooling capacity will be calculated using this input data.

Fields
- airloop_name [string]
- type_of_load_to_size_on [string] (Default: Sensible)
- design_outdoor_air_flow_rate [unknown field type] (Default: Autosize)
- central_heating_maximum_system_air_flow_ratio [unknown field type] (Default: Autosize)
- preheat_design_temperature [number]
- preheat_design_humidity_ratio [number]
- precool_design_temperature [number]
- precool_design_humidity_ratio [number]
- central_cooling_design_supply_air_temperature [number]
- central_heating_design_supply_air_temperature [number]
- type_of_zone_sum_to_use [string] (Default: NonCoincident)
- 100_outdoor_air_in_cooling [string] (Default: No)
- 100_outdoor_air_in_heating [string] (Default: No)
- central_cooling_design_supply_air_humidity_ratio [number] (Default: 0.008)
- central_heating_design_supply_air_humidity_ratio [number] (Default: 0.008)
- cooling_supply_air_flow_rate_method [string] (Default: DesignDay)
- cooling_supply_air_flow_rate [number] (Default: 0.0)
- cooling_supply_air_flow_rate_per_floor_area [number]
- cooling_fraction_of_autosized_cooling_supply_air_flow_rate [number]
- cooling_supply_air_flow_rate_per_unit_cooling_capacity [number]
- heating_supply_air_flow_rate_method [string] (Default: DesignDay)
- heating_supply_air_flow_rate [number] (Default: 0.0)
- heating_supply_air_flow_rate_per_floor_area [number]
- heating_fraction_of_autosized_heating_supply_air_flow_rate [number]
- heating_fraction_of_autosized_cooling_supply_air_flow_rate [number]
- heating_supply_air_flow_rate_per_unit_heating_capacity [number]
- system_outdoor_air_method [string] (Default: ZoneSum)
- zone_maximum_outdoor_air_fraction [number] (Default: 1.0)
- cooling_design_capacity_method [string] (Default: CoolingDesignCapacity)
- cooling_design_capacity [unknown field type] (Default: Autosize)
- cooling_design_capacity_per_floor_area [number]
- fraction_of_autosized_cooling_design_capacity [number]
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity [unknown field type] (Default: Autosize)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number]
- central_cooling_capacity_control_method [string] (Default: OnOff)
- occupant_diversity [unknown field type] (Default: Autosize)

Sizing:Plant¶

Specifies the input needed to autosize plant loop flow rates and equipment capacities. This information is initially used by components that use water for heating or cooling such as hot or chilled water coils to calculate their maximum water flow rates. These flow rates are then summed for use in calculating the Plant Loop flow rates.

Fields
- plant_or_condenser_loop_name [string]
- loop_type [string]
- design_loop_exit_temperature [number]
- loop_design_temperature_difference [number]
- sizing_option [string] (Default: NonCoincident)
- zone_timesteps_in_averaging_window [integer] (Default: 1)
- coincident_sizing_factor_mode [string]

OutputControl:Sizing:Style¶

Default style for the Sizing output files is comma – this works well for importing into spreadsheet programs such as Excel(tm) but not so well for word processing programs – there tab may be a better choice. Fixed puts spaces between the “columns”

Fields
- column_separator [string]

Zone HVAC Controls and Thermostats¶

ZoneControl:Humidistat¶

Specifies zone relative humidity setpoint schedules for humidifying and dehumidifying.

Fields
- zone_name [string]
- humidifying_relative_humidity_setpoint_schedule_name [string]
- dehumidifying_relative_humidity_setpoint_schedule_name [string]

ZoneControl:Thermostat¶

Define the Thermostat settings for a zone or list of zones. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

Fields
- zone_or_zonelist_name [string]
- control_type_schedule_name [string]
- control_1_object_type [string]
- control_1_name [string]
- control_2_object_type [string]
- control_2_name [string]
- control_3_object_type [string]
- control_3_name [string]
- control_4_object_type [string]
- control_4_name [string]
- temperature_difference_between_cutout_and_setpoint [number] (Default: 0.0)

ZoneControl:Thermostat:OperativeTemperature¶

This object can be used with the ZoneList option on a thermostat or with one of the zones on that list (but you won’t be able to use the object list to pick only one of those zones. Thermostat names are <Zone Name> <global Thermostat name> internally.

Fields
- thermostat_name [string]
- radiative_fraction_input_mode [string]
- fixed_radiative_fraction [number]
- radiative_fraction_schedule_name [string]
- adaptive_comfort_model_type [string] (Default: None)

ZoneControl:Thermostat:ThermalComfort¶

If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

Fields
- zone_or_zonelist_name [string]
- averaging_method [string] (Default: PeopleAverage)
- specific_people_name [string]
- minimum_dry_bulb_temperature_setpoint [number] (Default: 0.0)
- maximum_dry_bulb_temperature_setpoint [number] (Default: 50.0)
- thermal_comfort_control_type_schedule_name [string]
- thermal_comfort_control_1_object_type [string]
- thermal_comfort_control_1_name [string]
- thermal_comfort_control_2_object_type [string]
- thermal_comfort_control_2_name [string]
- thermal_comfort_control_3_object_type [string]
- thermal_comfort_control_3_name [string]
- thermal_comfort_control_4_object_type [string]
- thermal_comfort_control_4_name [string]

ZoneControl:Thermostat:TemperatureAndHumidity¶

This object modifies a ZoneControl:Thermostat object to effect temperature control based on zone air humidity conditions.

Fields
- thermostat_name [string]
- dehumidifying_relative_humidity_setpoint_schedule_name [string]
- dehumidification_control_type [string] (Default: Overcool)
- overcool_range_input_method [string] (Default: Constant)
- overcool_constant_range [number] (Default: 1.7)
- overcool_range_schedule_name [string]
- overcool_control_ratio [number] (Default: 3.6)

ThermostatSetpoint:SingleHeating¶

Used for a heating only thermostat. The setpoint can be scheduled and varied throughout the simulation but only heating is allowed with this control type.

Fields
- setpoint_temperature_schedule_name [string]

ThermostatSetpoint:SingleCooling¶

Used for a cooling only thermostat. The setpoint can be scheduled and varied throughout the simulation but only cooling is allowed.

Fields
- setpoint_temperature_schedule_name [string]

ThermostatSetpoint:SingleHeatingOrCooling¶

Used for a heating and cooling thermostat with a single setpoint. The setpoint can be scheduled and varied throughout the simulation for both heating and cooling.

Fields
- setpoint_temperature_schedule_name [string]

ThermostatSetpoint:DualSetpoint¶

Used for a heating and cooling thermostat with dual setpoints. The setpoints can be scheduled and varied throughout the simulation for both heating and cooling.

Fields
- heating_setpoint_temperature_schedule_name [string]
- cooling_setpoint_temperature_schedule_name [string]

ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating¶

Used for heating only thermal comfort control. The PMV setpoint can be scheduled and varied throughout the simulation but only heating is allowed with this control type.

Fields
- fanger_thermal_comfort_schedule_name [string]

ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling¶

Used for cooling only thermal comfort control. The PMV setpoint can be scheduled and varied throughout the simulation but only cooling is allowed with this control type.

Fields
- fanger_thermal_comfort_schedule_name [string]

ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling¶

Used for heating and cooling thermal comfort control with a single setpoint. The PMV setpoint can be scheduled and varied throughout the simulation for both heating and cooling.

Fields
- fanger_thermal_comfort_schedule_name [string]

ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint¶

Used for heating and cooling thermal comfort control with dual setpoints. The PMV setpoints can be scheduled and varied throughout the simulation for both heating and cooling.

Fields
- fanger_thermal_comfort_heating_schedule_name [string]
- fanger_thermal_comfort_cooling_schedule_name [string]

ZoneControl:Thermostat:StagedDualSetpoint¶

Define the Thermostat StagedDualSetpoint settings for a zone or list of zones. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

Fields
- zone_or_zonelist_name [string]
- number_of_heating_stages [integer]
- heating_temperature_setpoint_schedule_name [string]
- heating_throttling_temperature_range [number] (Default: 1.1)
- stage_1_heating_temperature_offset [number]
- stage_2_heating_temperature_offset [number]
- stage_3_heating_temperature_offset [number]
- stage_4_heating_temperature_offset [number]
- number_of_cooling_stages [integer]
- cooling_temperature_setpoint_base_schedule_name [string]
- cooling_throttling_temperature_range [number] (Default: 1.1)
- stage_1_cooling_temperature_offset [number]
- stage_2_cooling_temperature_offset [number]
- stage_3_cooling_temperature_offset [number]
- stage_4_cooling_temperature_offset [number]

ZoneControl:ContaminantController¶

Used to control a zone to a specified indoor level of CO2 or generic contaminants, or to specify minimum CO2 concentration schedule name for a zone.

Fields
- zone_name [string]
- carbon_dioxide_control_availability_schedule_name [string]
- carbon_dioxide_setpoint_schedule_name [string]
- minimum_carbon_dioxide_concentration_schedule_name [string]
- maximum_carbon_dioxide_concentration_schedule_name [string]
- generic_contaminant_control_availability_schedule_name [string]
- generic_contaminant_setpoint_schedule_name [string]

Zone HVAC Forced Air Units¶

ZoneHVAC:IdealLoadsAirSystem¶

Ideal system used to calculate loads without modeling a full HVAC system. All that is required for the ideal system are zone controls, zone equipment configurations, and the ideal loads system component. This component can be thought of as an ideal unit that mixes zone air with the specified amount of outdoor air and then adds or removes heat and moisture at 100% efficiency in order to meet the specified controls. Energy use is reported as DistrictHeating and DistrictCooling.

Fields
- availability_schedule_name [string]
- zone_supply_air_node_name [string]
- zone_exhaust_air_node_name [string]
- system_inlet_air_node_name [string]
- maximum_heating_supply_air_temperature [number] (Default: 50.0)
- minimum_cooling_supply_air_temperature [number] (Default: 13.0)
- maximum_heating_supply_air_humidity_ratio [number] (Default: 0.0156)
- minimum_cooling_supply_air_humidity_ratio [number] (Default: 0.0077)
- heating_limit [string] (Default: NoLimit)
- maximum_heating_air_flow_rate [unknown field type]
- maximum_sensible_heating_capacity [unknown field type]
- cooling_limit [string] (Default: NoLimit)
- maximum_cooling_air_flow_rate [unknown field type]
- maximum_total_cooling_capacity [unknown field type]
- heating_availability_schedule_name [string]
- cooling_availability_schedule_name [string]
- dehumidification_control_type [string] (Default: ConstantSensibleHeatRatio)
- cooling_sensible_heat_ratio [number] (Default: 0.7)
- humidification_control_type [string] (Default: None)
- design_specification_outdoor_air_object_name [string]
- outdoor_air_inlet_node_name [string]
- demand_controlled_ventilation_type [string] (Default: None)
- outdoor_air_economizer_type [string] (Default: NoEconomizer)
- heat_recovery_type [string] (Default: None)
- sensible_heat_recovery_effectiveness [number] (Default: 0.7)
- latent_heat_recovery_effectiveness [number] (Default: 0.65)
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:FourPipeFanCoil¶

Four pipe fan coil system. Forced-convection hydronic heating-cooling unit with supply fan, hot water heating coil, chilled water cooling coil, and fixed-position outdoor air mixer.

Fields
- availability_schedule_name [string]
- capacity_control_method [string]
- maximum_supply_air_flow_rate [unknown field type]
- low_speed_supply_air_flow_ratio [number] (Default: 0.33)
- medium_speed_supply_air_flow_ratio [number] (Default: 0.66)
- maximum_outdoor_air_flow_rate [unknown field type]
- outdoor_air_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_mixer_object_type [string]
- outdoor_air_mixer_name [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- maximum_cold_water_flow_rate [unknown field type]
- minimum_cold_water_flow_rate [number] (Default: 0.0)
- cooling_convergence_tolerance [number] (Default: 0.001)
- heating_coil_object_type [string]
- heating_coil_name [string]
- maximum_hot_water_flow_rate [unknown field type]
- minimum_hot_water_flow_rate [number] (Default: 0.0)
- heating_convergence_tolerance [number] (Default: 0.001)
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- minimum_supply_air_temperature_in_cooling_mode [unknown field type] (Default: Autosize)
- maximum_supply_air_temperature_in_heating_mode [unknown field type] (Default: Autosize)

ZoneHVAC:WindowAirConditioner¶

Window air conditioner. Forced-convection cooling-only unit with supply fan, direct expansion (DX) cooling coil, and fixed-position outdoor air mixer.

Fields
- availability_schedule_name [string]
- maximum_supply_air_flow_rate [unknown field type]
- maximum_outdoor_air_flow_rate [unknown field type]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_mixer_object_type [string]
- outdoor_air_mixer_name [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- cooling_coil_object_type [string]
- dx_cooling_coil_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- fan_placement [string]
- cooling_convergence_tolerance [number] (Default: 0.001)
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:PackagedTerminalAirConditioner¶

Packaged terminal air conditioner (PTAC). Forced-convection heating-cooling unit with supply fan, direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam) and fixed-position outdoor air mixer.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_mixer_object_type [string]
- outdoor_air_mixer_name [string]
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- cooling_outdoor_air_flow_rate [unknown field type]
- heating_outdoor_air_flow_rate [unknown field type]
- no_load_outdoor_air_flow_rate [unknown field type]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- fan_placement [string] (Default: DrawThrough)
- supply_air_fan_operating_mode_schedule_name [string]
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]
- capacity_control_method [string] (Default: None)
- minimum_supply_air_temperature_in_cooling_mode [unknown field type] (Default: Autosize)
- maximum_supply_air_temperature_in_heating_mode [unknown field type] (Default: Autosize)

ZoneHVAC:PackagedTerminalHeatPump¶

Packaged terminal heat pump (PTHP). Forced-convection heating-cooling unit with supply fan, direct expansion (DX) cooling coil, DX heating coil (air-to-air heat pump), supplemental heating coil (gas, electric, hot water, or steam), and fixed-position outdoor air mixer.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_mixer_object_type [string]
- outdoor_air_mixer_name [string]
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- cooling_outdoor_air_flow_rate [unknown field type]
- heating_outdoor_air_flow_rate [unknown field type]
- no_load_outdoor_air_flow_rate [unknown field type]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- heating_convergence_tolerance [number] (Default: 0.001)
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- cooling_convergence_tolerance [number] (Default: 0.001)
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- maximum_supply_air_temperature_from_supplemental_heater [unknown field type]
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- fan_placement [string] (Default: DrawThrough)
- supply_air_fan_operating_mode_schedule_name [string]
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]
- capacity_control_method [string] (Default: None)
- minimum_supply_air_temperature_in_cooling_mode [unknown field type] (Default: Autosize)
- maximum_supply_air_temperature_in_heating_mode [unknown field type] (Default: Autosize)

ZoneHVAC:WaterToAirHeatPump¶

Water-to-air heat pump. Forced-convection heating-cooling unit with supply fan, water-to-air cooling and heating coils, supplemental heating coil (gas, electric, hot water, or steam), and fixed-position outdoor air mixer.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_mixer_object_type [string]
- outdoor_air_mixer_name [string]
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- cooling_outdoor_air_flow_rate [unknown field type]
- heating_outdoor_air_flow_rate [unknown field type]
- no_load_outdoor_air_flow_rate [unknown field type]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- maximum_cycling_rate [number] (Default: 2.5)
- heat_pump_time_constant [number] (Default: 60.0)
- fraction_of_on_cycle_power_use [number] (Default: 0.01)
- heat_pump_fan_delay_time [number] (Default: 60.0)
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- maximum_supply_air_temperature_from_supplemental_heater [unknown field type] (Default: Autosize)
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- outdoor_dry_bulb_temperature_sensor_node_name [string]
- fan_placement [string] (Default: BlowThrough)
- supply_air_fan_operating_mode_schedule_name [string]
- availability_manager_list_name [string]
- heat_pump_coil_water_flow_mode [string] (Default: Cycling)
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:Dehumidifier:DX¶

This object calculates the performance of zone (room) air dehumidifiers. Meant to model conventional direct expansion (DX) cooling-based room air dehumidifiers (reject 100% of condenser heat to the zone air), but this object might be able to be used to model other room air dehumidifier types.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- rated_water_removal [number]
- rated_energy_factor [number]
- rated_air_flow_rate [number]
- water_removal_curve_name [string]
- energy_factor_curve_name [string]
- part_load_fraction_correlation_curve_name [string]
- minimum_dry_bulb_temperature_for_dehumidifier_operation [number] (Default: 10.0)
- maximum_dry_bulb_temperature_for_dehumidifier_operation [number] (Default: 35.0)
- off_cycle_parasitic_electric_load [number] (Default: 0.0)
- condensate_collection_water_storage_tank_name [string]

ZoneHVAC:EnergyRecoveryVentilator¶

This compound component models a stand-alone energy recovery ventilator (ERV) that conditions outdoor ventilation air and supplies that air directly to a zone. The ERV unit is modeled as a collection of components: air-to-air heat exchanger, supply air fan, exhaust air fan and an optional controller to avoid overheating of the supply air (economizer or free cooling operation).

Fields
- availability_schedule_name [string]
- heat_exchanger_name [string]
- supply_air_flow_rate [unknown field type]
- exhaust_air_flow_rate [unknown field type]
- supply_air_fan_name [string]
- exhaust_air_fan_name [string]
- controller_name [string]
- ventilation_rate_per_unit_floor_area [number]
- ventilation_rate_per_occupant [number]
- availability_manager_list_name [string]

ZoneHVAC:EnergyRecoveryVentilator:Controller¶

This controller is used exclusively by the ZoneHVAC:EnergyRecoveryVentilator object to allow economizer (free cooling) operation when possible.

Fields
- temperature_high_limit [number]
- temperature_low_limit [number]
- enthalpy_high_limit [number]
- dewpoint_temperature_limit [number]
- electronic_enthalpy_limit_curve_name [string]
- exhaust_air_temperature_limit [string] (Default: NoExhaustAirTemperatureLimit)
- exhaust_air_enthalpy_limit [string] (Default: NoExhaustAirEnthalpyLimit)
- time_of_day_economizer_flow_control_schedule_name [string]
- high_humidity_control_flag [string] (Default: No)
- humidistat_control_zone_name [string]
- high_humidity_outdoor_air_flow_ratio [number] (Default: 1.0)
- control_high_indoor_humidity_based_on_outdoor_humidity_ratio [string] (Default: Yes)

ZoneHVAC:UnitVentilator¶

Unit ventilator. Forced-convection ventilation unit with supply fan (constant-volume or variable-volume), optional chilled water cooling coil, optional heating coil (gas, electric, hot water, or steam) and controllable outdoor air mixer.

Fields
- availability_schedule_name [string]
- maximum_supply_air_flow_rate [unknown field type]
- outdoor_air_control_type [string]
- minimum_outdoor_air_flow_rate [unknown field type]
- minimum_outdoor_air_schedule_name [string]
- maximum_outdoor_air_flow_rate [unknown field type]
- maximum_outdoor_air_fraction_or_temperature_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_node_name [string]
- exhaust_air_node_name [string]
- mixed_air_node_name [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- coil_option [string]
- supply_air_fan_operating_mode_schedule_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- heating_convergence_tolerance [number] (Default: 0.001)
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- cooling_convergence_tolerance [number] (Default: 0.001)
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:UnitHeater¶

Unit heater. Forced-convection heating-only unit with supply fan, heating coil (gas, electric, hot water, or steam) and fixed-position outdoor air mixer.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- maximum_supply_air_flow_rate [unknown field type]
- heating_coil_object_type [string]
- heating_coil_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- supply_air_fan_operation_during_no_heating [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- heating_convergence_tolerance [number] (Default: 0.001)
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:EvaporativeCoolerUnit¶

Zone evaporative cooler. Forced-convection cooling-only unit with supply fan, 100% outdoor air supply. Optional relief exhaust node

Fields
- availability_schedule_name [string]
- availability_manager_list_name [string]
- outdoor_air_inlet_node_name [string]
- cooler_outlet_node_name [string]
- zone_relief_air_node_name [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- design_supply_air_flow_rate [unknown field type]
- fan_placement [string]
- cooler_unit_control_method [string]
- throttling_range_temperature_difference [number] (Default: 1.0)
- cooling_load_control_threshold_heat_transfer_rate [number] (Default: 100.0)
- first_evaporative_cooler_object_type [string]
- first_evaporative_cooler_object_name [string]
- second_evaporative_cooler_object_type [string]
- second_evaporative_cooler_name [string]
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:HybridUnitaryHVAC¶

Hybrid Unitary HVAC. A black box model for multi-mode packaged forced air equipment. Independent variables include outdoor air conditions and indoor air conditions. Controlled inputs include operating mode, supply air flow rate, and outdoor air faction. Emperical lookup tables are required to map supply air temperature supply air humidity, electricity use, fuel uses, water use, fan electricity use, and external static pressure as a function of each indpednent varaible and each controlled input. In each timestep the model will choose one or more combinations of settings for mode, supply air flow rate, outdoor air faction, and part runtime fraction so as to satisfy zone requests for sensible cooling, heating, ventilation, and/or dehumidification with the least resource consumption. Equipment in this class may consume electricity, water, and up to two additional fuel types.

Fields
- availability_schedule_name [string]
- availability_manager_list_name [string]
- minimum_supply_air_temperature_schedule_name [string]
- maximum_supply_air_temperature_schedule_name [string]
- minimum_supply_air_humidity_ratio_schedule_name [string]
- maximum_supply_air_humidity_ratio_schedule_name [string]
- method_to_choose_controlled_inputs_and_part_runtime_fraction [string] (Default: Automatic)
- return_air_node_name [string]
- outdoor_air_node_name [string]
- supply_air_node_name [string]
- relief_node_name [string]
- system_maximum_supply_air_flow_rate [number]
- external_static_pressure_at_system_maximum_supply_air_flow_rate [number]
- fan_heat_included_in_lookup_tables [string] (Default: No)
- fan_heat_gain_location [string] (Default: SupplyAirStream)
- fan_heat_in_air_stream_fraction [number] (Default: 1.0)
- scaling_factor [number] (Default: 1.0)
- minimum_time_between_mode_change [number] (Default: 10.0)
- first_fuel_type [string] (Default: Electricity)
- second_fuel_type [string] (Default: None)
- third_fuel_type [string] (Default: None)
- objective_function_to_minimize [string] (Default: Electricity Use)
- design_specification_outdoor_air_object_name [string]
- mode_0_name [string]
- mode_0_supply_air_temperature_lookup_table_name [string]
- mode_0_supply_air_humidity_ratio_lookup_table_name [string]
- mode_0_system_electric_power_lookup_table_name [string]
- mode_0_supply_fan_electric_power_lookup_table_name [string]
- mode_0_external_static_pressure_lookup_table_name [string]
- mode_0_system_second_fuel_consumption_lookup_table_name [string]
- mode_0_system_third_fuel_consumption_lookup_table_name [string]
- mode_0_system_water_use_lookup_table_name [string]
- mode_0_outdoor_air_fraction [number] (Default: 0.0)
- mode_0_supply_air_mass_flow_rate_ratio [number] (Default: 0.0)
- modes [Array of {mode_name, mode_supply_air_temperature_lookup_table_name, mode_supply_air_humidity_ratio_lookup_table_name, mode_system_electric_power_lookup_table_name, mode_supply_fan_electric_power_lookup_table_name, mode_external_static_pressure_lookup_table_name, mode_system_second_fuel_consumption_lookup_table_name, mode_system_third_fuel_consumption_lookup_table_name, mode_system_water_use_lookup_table_name, mode_minimum_outdoor_air_temperature, mode_maximum_outdoor_air_temperature, mode_minimum_outdoor_air_humidity_ratio, mode_maximum_outdoor_air_humidity_ratio, mode_minimum_outdoor_air_relative_humidity, mode_maximum_outdoor_air_relative_humidity, mode_minimum_return_air_temperature, mode_maximum_return_air_temperature, mode_minimum_return_air_humidity_ratio, mode_maximum_return_air_humidity_ratio, mode_minimum_return_air_relative_humidity, mode_maximum_return_air_relative_humidity, mode_minimum_outdoor_air_fraction, mode_maximum_outdoor_air_fraction, mode_minimum_supply_air_mass_flow_rate_ratio, mode_maximum_supply_air_mass_flow_rate_ratio}]

ZoneHVAC:OutdoorAirUnit¶

The zone outdoor air unit models a single-zone dedicated outdoor air system (DOAS). Forced-convection 100% outdoor air unit with supply fan and optional equipment including exhaust fan, heating coil, cooling coil, and heat recovery.

Fields
- availability_schedule_name [string]
- zone_name [string]
- outdoor_air_flow_rate [unknown field type]
- outdoor_air_schedule_name [string]
- supply_fan_name [string]
- supply_fan_placement [string] (Default: DrawThrough)
- exhaust_fan_name [string]
- exhaust_air_flow_rate [unknown field type]
- exhaust_air_schedule_name [string]
- unit_control_type [string] (Default: NeutralControl)
- high_air_control_temperature_schedule_name [string]
- low_air_control_temperature_schedule_name [string]
- outdoor_air_node_name [string]
- airoutlet_node_name [string]
- airinlet_node_name [string]
- supply_fanoutlet_node_name [string]
- outdoor_air_unit_list_name [string]
- availability_manager_list_name [string]

ZoneHVAC:OutdoorAirUnit:EquipmentList¶

Equipment list for components in a ZoneHVAC:OutdoorAirUnit. Components are simulated sequentially in the order given in the equipment list.

Fields
- component_1_object_type [string]
- component_1_name [string]
- component_2_object_type [string]
- component_2_name [string]
- component_3_object_type [string]
- component_3_name [string]
- component_4_object_type [string]
- component_4_name [string]
- component_5_object_type [string]
- component_5_name [string]
- component_6_object_type [string]
- component_6_name [string]
- component_7_object_type [string]
- component_7_name [string]
- component_8_object_type [string]
- component_8_name [string]

ZoneHVAC:TerminalUnit:VariableRefrigerantFlow¶

A terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air heat pump). The VRF terminal units are served by an AirConditioner:VariableRefrigerantFlow or AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:* system. Terminal units can be configured as zone, air loop or outside air system equipment.

Fields
- terminal_unit_availability_schedule [string]
- terminal_unit_air_inlet_node_name [string]
- terminal_unit_air_outlet_node_name [string]
- cooling_supply_air_flow_rate [unknown field type]
- no_cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_heating_supply_air_flow_rate [unknown field type]
- cooling_outdoor_air_flow_rate [unknown field type]
- heating_outdoor_air_flow_rate [unknown field type]
- no_load_outdoor_air_flow_rate [unknown field type]
- supply_air_fan_operating_mode_schedule_name [string]
- supply_air_fan_placement [string] (Default: BlowThrough)
- supply_air_fan_object_type [string] (Default: Fan:ConstantVolume)
- supply_air_fan_object_name [string]
- outside_air_mixer_object_type [string]
- outside_air_mixer_object_name [string]
- cooling_coil_object_type [string]
- cooling_coil_object_name [string]
- heating_coil_object_type [string]
- heating_coil_object_name [string]
- zone_terminal_unit_on_parasitic_electric_energy_use [number] (Default: 0.0)
- zone_terminal_unit_off_parasitic_electric_energy_use [number] (Default: 0.0)
- rated_heating_capacity_sizing_ratio [number] (Default: 1.0)
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- maximum_supply_air_temperature_from_supplemental_heater [unknown field type] (Default: Autosize)
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- controlling_zone_or_thermostat_location [string]

Zone HVAC Radiative/Convective Units¶

ZoneHVAC:Baseboard:RadiantConvective:Water:Design¶

Fields
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- convergence_tolerance [number] (Default: 0.001)
- fraction_radiant [number]
- fraction_of_radiant_energy_incident_on_people [number]

ZoneHVAC:Baseboard:RadiantConvective:Water¶

The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

Fields
- design_object [string]
- availability_schedule_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- rated_average_water_temperature [number] (Default: 87.78)
- rated_water_mass_flow_rate [number] (Default: 0.063)
- heating_design_capacity [unknown field type] (Default: Autosize)
- maximum_water_flow_rate [unknown field type]
- surface_fractions [Array of {surface_name, fraction_of_radiant_energy_to_surface}]

ZoneHVAC:Baseboard:RadiantConvective:Steam:Design¶

Fields
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- convergence_tolerance [number] (Default: 0.001)
- fraction_radiant [number]
- fraction_of_radiant_energy_incident_on_people [number]

ZoneHVAC:Baseboard:RadiantConvective:Steam¶

The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list.

Fields
- design_object [string]
- availability_schedule_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- heating_design_capacity [unknown field type] (Default: Autosize)
- degree_of_subcooling [number] (Default: 5.0)
- maximum_steam_flow_rate [unknown field type]
- surface_fractions [Array of {surface_name, fraction_of_radiant_energy_to_surface}]

ZoneHVAC:Baseboard:RadiantConvective:Electric¶

The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

Fields
- availability_schedule_name [string]
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity [unknown field type] (Default: Autosize)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- efficiency [number] (Default: 1.0)
- fraction_radiant [number]
- fraction_of_radiant_energy_incident_on_people [number]
- surface_fractions [Array of {surface_name, fraction_of_radiant_energy_to_surface}]

ZoneHVAC:CoolingPanel:RadiantConvective:Water¶

The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

Fields
- availability_schedule_name [string]
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- rated_inlet_water_temperature [number] (Default: 5.0)
- rated_inlet_space_temperature [number] (Default: 24.0)
- rated_water_mass_flow_rate [number] (Default: 0.063)
- cooling_design_capacity_method [string] (Default: CoolingDesignCapacity)
- cooling_design_capacity [unknown field type]
- cooling_design_capacity_per_floor_area [number]
- fraction_of_autosized_cooling_design_capacity [number]
- maximum_chilled_water_flow_rate [unknown field type]
- control_type [string] (Default: MeanAirTemperature)
- cooling_control_throttling_range [number] (Default: 0.5)
- cooling_control_temperature_schedule_name [string]
- condensation_control_type [string] (Default: SimpleOff)
- condensation_control_dewpoint_offset [number] (Default: 1.0)
- fraction_radiant [number]
- fraction_of_radiant_energy_incident_on_people [number]
- surface_fractions [Array of {surface_name, fraction_of_radiant_energy_to_surface}]

ZoneHVAC:Baseboard:Convective:Water¶

Hot water baseboard heater, convection-only. Natural convection hydronic heating unit.

Fields
- availability_schedule_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity [unknown field type] (Default: Autosize)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- u_factor_times_area_value [unknown field type]
- maximum_water_flow_rate [unknown field type]
- convergence_tolerance [number] (Default: 0.001)

ZoneHVAC:Baseboard:Convective:Electric¶

Electric baseboard heater, convection-only. Natural convection electric heating unit.

Fields
- availability_schedule_name [string]
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity [unknown field type] (Default: Autosize)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- efficiency [number] (Default: 1.0)

ZoneHVAC:LowTemperatureRadiant:VariableFlow¶

Low temperature hydronic radiant heating and/or cooling system embedded in a building surface (wall, ceiling, or floor). Controlled by varying the hot or chilled water flow to the unit.

Fields
- design_object [string]
- availability_schedule_name [string]
- zone_name [string]
- surface_name_or_radiant_surface_group_name [string]
- hydronic_tubing_length [unknown field type] (Default: Autosize)
- heating_design_capacity [unknown field type] (Default: Autosize)
- maximum_hot_water_flow [unknown field type]
- heating_water_inlet_node_name [string]
- heating_water_outlet_node_name [string]
- cooling_design_capacity [unknown field type]
- maximum_cold_water_flow [unknown field type]
- cooling_water_inlet_node_name [string]
- cooling_water_outlet_node_name [string]
- number_of_circuits [string] (Default: OnePerSurface)
- circuit_length [number] (Default: 106.7)

ZoneHVAC:LowTemperatureRadiant:VariableFlow:Design¶

Fields
- fluid_to_radiant_surface_heat_transfer_model [string] (Default: ConvectionOnly)
- hydronic_tubing_inside_diameter [number] (Default: 0.013)
- hydronic_tubing_outside_diameter [number] (Default: 0.016)
- hydronic_tubing_conductivity [number] (Default: 0.35)
- temperature_control_type [string] (Default: MeanAirTemperature)
- setpoint_control_type [string] (Default: HalfFlowPower)
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- heating_control_throttling_range [number] (Default: 0.5)
- heating_control_temperature_schedule_name [string]
- cooling_design_capacity_method [string] (Default: CoolingDesignCapacity)
- cooling_design_capacity_per_floor_area [number]
- fraction_of_autosized_cooling_design_capacity [number]
- cooling_control_throttling_range [number] (Default: 0.5)
- cooling_control_temperature_schedule_name [string]
- condensation_control_type [string] (Default: SimpleOff)
- condensation_control_dewpoint_offset [number] (Default: 1.0)
- changeover_delay_time_period_schedule [string]

ZoneHVAC:LowTemperatureRadiant:ConstantFlow¶

Low temperature hydronic radiant heating and/or cooling system embedded in a building surface (wall, ceiling, or floor). Controlled by varying the hot or chilled water temperature circulating through the unit.

Fields
- design_object [string]
- availability_schedule_name [string]
- zone_name [string]
- surface_name_or_radiant_surface_group_name [string]
- hydronic_tubing_length [unknown field type] (Default: Autosize)
- rated_flow_rate [unknown field type]
- pump_flow_rate_schedule_name [string]
- rated_pump_head [number] (Default: 179352.0)
- rated_power_consumption [number]
- heating_water_inlet_node_name [string]
- heating_water_outlet_node_name [string]
- heating_high_water_temperature_schedule_name [string]
- heating_low_water_temperature_schedule_name [string]
- heating_high_control_temperature_schedule_name [string]
- heating_low_control_temperature_schedule_name [string]
- cooling_water_inlet_node_name [string]
- cooling_water_outlet_node_name [string]
- cooling_high_water_temperature_schedule_name [string]
- cooling_low_water_temperature_schedule_name [string]
- cooling_high_control_temperature_schedule_name [string]
- cooling_low_control_temperature_schedule_name [string]
- number_of_circuits [string] (Default: OnePerSurface)
- circuit_length [number] (Default: 106.7)

ZoneHVAC:LowTemperatureRadiant:ConstantFlow:Design¶

Fields
- fluid_to_radiant_surface_heat_transfer_model [string] (Default: ConvectionOnly)
- hydronic_tubing_inside_diameter [number] (Default: 0.013)
- hydronic_tubing_outside_diameter [number] (Default: 0.016)
- hydronic_tubing_conductivity [number] (Default: 0.35)
- temperature_control_type [string] (Default: MeanAirTemperature)
- running_mean_outdoor_dry_bulb_temperature_weighting_factor [number] (Default: 0.8)
- motor_efficiency [number] (Default: 0.9)
- fraction_of_motor_inefficiencies_to_fluid_stream [number] (Default: 0.0)
- condensation_control_type [string] (Default: SimpleOff)
- condensation_control_dewpoint_offset [number] (Default: 1.0)
- changeover_delay_time_period_schedule [string]

ZoneHVAC:LowTemperatureRadiant:Electric¶

Electric resistance low temperature radiant system

Fields
- availability_schedule_name [string]
- zone_name [string]
- surface_name_or_radiant_surface_group_name [string]
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity [unknown field type] (Default: Autosize)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- temperature_control_type [string] (Default: MeanAirTemperature)
- setpoint_control_type [string] (Default: HalfFlowPower)
- heating_throttling_range [number] (Default: 0.0)
- heating_setpoint_temperature_schedule_name [string]

ZoneHVAC:LowTemperatureRadiant:SurfaceGroup¶

This is used to allow the coordinate control of several radiant system surfaces. Note that the following flow fractions must sum up to 1.0 The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

Fields
- surface_fractions [Array of {surface_name, flow_fraction_for_surface}]

ZoneHVAC:HighTemperatureRadiant¶

The number of surfaces can be expanded beyond 100, if necessary, by adding more groups to the end of the list

Fields
- availability_schedule_name [string]
- zone_name [string]
- heating_design_capacity_method [string] (Default: HeatingDesignCapacity)
- heating_design_capacity [unknown field type] (Default: Autosize)
- heating_design_capacity_per_floor_area [number]
- fraction_of_autosized_heating_design_capacity [number] (Default: 1.0)
- fuel_type [string]
- combustion_efficiency [number] (Default: 0.9)
- fraction_of_input_converted_to_radiant_energy [number] (Default: 0.7)
- fraction_of_input_converted_to_latent_energy [number] (Default: 0.0)
- fraction_of_input_that_is_lost [number] (Default: 0.0)
- temperature_control_type [string] (Default: OperativeTemperature)
- heating_throttling_range [number] (Default: 2.0)
- heating_setpoint_temperature_schedule_name [string]
- fraction_of_radiant_energy_incident_on_people [number]
- surface_fractions [Array of {surface_name, fraction_of_radiant_energy_to_surface}]

ZoneHVAC:VentilatedSlab¶

Ventilated slab system where outdoor air flows through hollow cores in a building surface (wall, ceiling, or floor).

Fields
- availability_schedule_name [string]
- zone_name [string]
- surface_name_or_radiant_surface_group_name [string]
- maximum_air_flow_rate [unknown field type]
- outdoor_air_control_type [string]
- minimum_outdoor_air_flow_rate [unknown field type]
- minimum_outdoor_air_schedule_name [string]
- maximum_outdoor_air_flow_rate [unknown field type]
- maximum_outdoor_air_fraction_or_temperature_schedule_name [string]
- system_configuration_type [string] (Default: SlabOnly)
- hollow_core_inside_diameter [number] (Default: 0.05)
- hollow_core_length [number]
- number_of_cores [number]
- temperature_control_type [string] (Default: OutdoorDryBulbTemperature)
- heating_high_air_temperature_schedule_name [string]
- heating_low_air_temperature_schedule_name [string]
- heating_high_control_temperature_schedule_name [string]
- heating_low_control_temperature_schedule_name [string]
- cooling_high_air_temperature_schedule_name [string]
- cooling_low_air_temperature_schedule_name [string]
- cooling_high_control_temperature_schedule_name [string]
- cooling_low_control_temperature_schedule_name [string]
- return_air_node_name [string]
- slab_in_node_name [string]
- zone_supply_air_node_name [string]
- outdoor_air_node_name [string]
- relief_air_node_name [string]
- outdoor_air_mixer_outlet_node_name [string]
- fan_outlet_node_name [string]
- fan_name [string]
- coil_option_type [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- hot_water_or_steam_inlet_node_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- cold_water_inlet_node_name [string]
- availability_manager_list_name [string]
- design_specification_zonehvac_sizing_object_name [string]

ZoneHVAC:VentilatedSlab:SlabGroup¶

This is used to allow the coordinate control of several ventilated slab system surfaces. Note that the flow fractions must sum up to 1.0. The number of surfaces can be expanded beyond 10, if necessary, by adding more groups to the end of the list

Fields
- data [Array of {zone_name, surface_name, core_diameter_for_surface, core_length_for_surface, core_numbers_for_surface, slab_inlet_node_name_for_surface, slab_outlet_node_name_for_surface}]

Zone HVAC Air Loop Terminal Units¶

AirTerminal:SingleDuct:ConstantVolume:Reheat¶

Central air system terminal unit, single duct, constant volume, with reheat coil (hot water, electric, gas, or steam).

Fields
- availability_schedule_name [string]
- air_outlet_node_name [string]
- air_inlet_node_name [string]
- maximum_air_flow_rate [unknown field type]
- reheat_coil_object_type [string]
- reheat_coil_name [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- convergence_tolerance [number] (Default: 0.001)
- maximum_reheat_air_temperature [number]

AirTerminal:SingleDuct:ConstantVolume:NoReheat¶

Central air system terminal unit, single duct, constant volume, without reheat coil

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- maximum_air_flow_rate [unknown field type]
- design_specification_outdoor_air_object_name [string]
- per_person_ventilation_rate_mode [string] (Default: CurrentOccupancy)

AirTerminal:SingleDuct:VAV:NoReheat¶

Central air system terminal unit, single duct, variable volume, with no reheat coil.

Fields
- availability_schedule_name [string]
- air_outlet_node_name [string]
- air_inlet_node_name [string]
- maximum_air_flow_rate [unknown field type]
- zone_minimum_air_flow_input_method [string] (Default: Constant)
- constant_minimum_air_flow_fraction [unknown field type] (Default: Autosize)
- fixed_minimum_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_air_flow_fraction_schedule_name [string]
- design_specification_outdoor_air_object_name [string]
- minimum_air_flow_turndown_schedule_name [string]

AirTerminal:SingleDuct:VAV:Reheat¶

Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, or steam).

Fields
- availability_schedule_name [string]
- damper_air_outlet_node_name [string]
- air_inlet_node_name [string]
- maximum_air_flow_rate [unknown field type]
- zone_minimum_air_flow_input_method [string] (Default: Constant)
- constant_minimum_air_flow_fraction [unknown field type] (Default: Autosize)
- fixed_minimum_air_flow_rate [unknown field type] (Default: Autosize)
- minimum_air_flow_fraction_schedule_name [string]
- reheat_coil_object_type [string]
- reheat_coil_name [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- air_outlet_node_name [string]
- convergence_tolerance [number] (Default: 0.001)
- damper_heating_action [string] (Default: ReverseWithLimits)
- maximum_flow_per_zone_floor_area_during_reheat [unknown field type] (Default: Autosize)
- maximum_flow_fraction_during_reheat [unknown field type] (Default: Autosize)
- maximum_reheat_air_temperature [number]
- design_specification_outdoor_air_object_name [string]
- minimum_air_flow_turndown_schedule_name [string]

AirTerminal:SingleDuct:VAV:Reheat:VariableSpeedFan¶

Central air system terminal unit, single duct, variable volume, with reheat coil (hot water, electric, gas, or steam) and variable-speed fan. These units are usually employed in underfloor air distribution (UFAD) systems where the air is supplied at low static pressure through an underfloor plenum. The fan is used to control the flow of conditioned air that enters the space.

Fields
- availability_schedule_name [string]
- maximum_cooling_air_flow_rate [unknown field type]
- maximum_heating_air_flow_rate [unknown field type]
- zone_minimum_air_flow_fraction [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- fan_object_type [string]
- fan_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- heating_convergence_tolerance [number] (Default: 0.001)
- minimum_air_flow_turndown_schedule_name [string]

AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat¶

Central air system terminal unit, single duct, variable volume for both cooling and heating, with no reheat coil.

Fields
- availability_schedule_name [string]
- air_outlet_node_name [string]
- air_inlet_node_name [string]
- maximum_air_flow_rate [unknown field type]
- zone_minimum_air_flow_fraction [number]
- minimum_air_flow_turndown_schedule_name [string]

AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat¶

Central air system terminal unit, single duct, variable volume for both cooling and heating, with reheat coil (hot water, electric, gas, or steam).

Fields
- availability_schedule_name [string]
- damper_air_outlet_node_name [string]
- air_inlet_node_name [string]
- maximum_air_flow_rate [unknown field type]
- zone_minimum_air_flow_fraction [number]
- reheat_coil_object_type [string]
- reheat_coil_name [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- air_outlet_node_name [string]
- convergence_tolerance [number] (Default: 0.001)
- maximum_reheat_air_temperature [number]
- minimum_air_flow_turndown_schedule_name [string]

AirTerminal:SingleDuct:SeriesPIU:Reheat¶

Central air system terminal unit, single duct, variable volume, series powered induction unit (PIU), with reheat coil (hot water, electric, gas, or steam).

Fields
- availability_schedule_name [string]
- maximum_air_flow_rate [unknown field type]
- maximum_primary_air_flow_rate [unknown field type]
- minimum_primary_air_flow_fraction [unknown field type]
- supply_air_inlet_node_name [string]
- secondary_air_inlet_node_name [string]
- outlet_node_name [string]
- reheat_coil_air_inlet_node_name [string]
- zone_mixer_name [string]
- fan_name [string]
- reheat_coil_object_type [string]
- reheat_coil_name [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- convergence_tolerance [number] (Default: 0.001)

AirTerminal:SingleDuct:ParallelPIU:Reheat¶

Central air system terminal unit, single duct, variable volume, parallel powered induction unit (PIU), with reheat coil (hot water, electric, gas, or steam).

Fields
- availability_schedule_name [string]
- maximum_primary_air_flow_rate [unknown field type]
- maximum_secondary_air_flow_rate [unknown field type]
- minimum_primary_air_flow_fraction [unknown field type]
- fan_on_flow_fraction [unknown field type]
- supply_air_inlet_node_name [string]
- secondary_air_inlet_node_name [string]
- outlet_node_name [string]
- reheat_coil_air_inlet_node_name [string]
- zone_mixer_name [string]
- fan_name [string]
- reheat_coil_object_type [string]
- reheat_coil_name [string]
- maximum_hot_water_or_steam_flow_rate [unknown field type]
- minimum_hot_water_or_steam_flow_rate [number] (Default: 0.0)
- convergence_tolerance [number] (Default: 0.001)

AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction¶

Central air system terminal unit, single duct, variable volume, induction unit with hot water reheat coil and chilled water recool coil.

Fields
- availability_schedule_name [string]
- maximum_total_air_flow_rate [unknown field type]
- induction_ratio [number] (Default: 2.5)
- supply_air_inlet_node_name [string]
- induced_air_inlet_node_name [string]
- air_outlet_node_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- maximum_hot_water_flow_rate [unknown field type]
- minimum_hot_water_flow_rate [number] (Default: 0.0)
- heating_convergence_tolerance [number] (Default: 0.001)
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- maximum_cold_water_flow_rate [unknown field type]
- minimum_cold_water_flow_rate [number] (Default: 0.0)
- cooling_convergence_tolerance [number] (Default: 0.001)
- zone_mixer_name [string]

AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam¶

Central air system terminal unit, single duct, constant volume, with heating and/or cooling. Operates as two-pipe unit if heating or cooling water is omitted. Heating and/or cooling can be scheduled off for dedicated ventilation.

Fields
- primary_air_availability_schedule_name [string]
- cooling_availability_schedule_name [string]
- heating_availability_schedule_name [string]
- primary_air_inlet_node_name [string]
- primary_air_outlet_node_name [string]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- hot_water_inlet_node_name [string]
- hot_water_outlet_node_name [string]
- design_primary_air_volume_flow_rate [unknown field type] (Default: Autosize)
- design_chilled_water_volume_flow_rate [unknown field type] (Default: Autosize)
- design_hot_water_volume_flow_rate [unknown field type] (Default: Autosize)
- zone_total_beam_length [unknown field type] (Default: Autosize)
- rated_primary_air_flow_rate_per_beam_length [number] (Default: 0.035)
- beam_rated_cooling_capacity_per_beam_length [number] (Default: 600.0)
- beam_rated_cooling_room_air_chilled_water_temperature_difference [number] (Default: 10.0)
- beam_rated_chilled_water_volume_flow_rate_per_beam_length [number] (Default: 5e-05)
- beam_cooling_capacity_temperature_difference_modification_factor_curve_name [string]
- beam_cooling_capacity_air_flow_modification_factor_curve_name [string]
- beam_cooling_capacity_chilled_water_flow_modification_factor_curve_name [string]
- beam_rated_heating_capacity_per_beam_length [number] (Default: 1500.0)
- beam_rated_heating_room_air_hot_water_temperature_difference [number] (Default: 27.8)
- beam_rated_hot_water_volume_flow_rate_per_beam_length [number] (Default: 5e-05)
- beam_heating_capacity_temperature_difference_modification_factor_curve_name [string]
- beam_heating_capacity_air_flow_modification_factor_curve_name [string]
- beam_heating_capacity_hot_water_flow_modification_factor_curve_name [string]

AirTerminal:SingleDuct:ConstantVolume:CooledBeam¶

Central air system terminal unit, single duct, constant volume, with cooled beam (active or passive).

Fields
- availability_schedule_name [string]
- cooled_beam_type [string]
- supply_air_inlet_node_name [string]
- supply_air_outlet_node_name [string]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- supply_air_volumetric_flow_rate [unknown field type] (Default: Autosize)
- maximum_total_chilled_water_volumetric_flow_rate [unknown field type] (Default: Autosize)
- number_of_beams [unknown field type] (Default: Autosize)
- beam_length [unknown field type] (Default: Autosize)
- design_inlet_water_temperature [number] (Default: 15.0)
- design_outlet_water_temperature [number] (Default: 17.0)
- coil_surface_area_per_coil_length [number] (Default: 5.422)
- model_parameter_a [number] (Default: 15.3)
- model_parameter_n1 [number] (Default: 0.0)
- model_parameter_n2 [number] (Default: 0.84)
- model_parameter_n3 [number] (Default: 0.12)
- model_parameter_a0 [number] (Default: 0.171)
- model_parameter_k1 [number] (Default: 0.0057)
- model_parameter_n [number] (Default: 0.4)
- coefficient_of_induction_kin [unknown field type] (Default: Autocalculate)
- leaving_pipe_inside_diameter [number] (Default: 0.0145)

AirTerminal:SingleDuct:Mixer¶

The mixer air terminal unit provides a means of supplying central system air to the air inlet or outlet side of a zoneHVAC equipment such as a four pipe fan coil unit. Normally the central air would be ventilation air from a dedicated outdoor air system (DOAS).

Fields
- zonehvac_unit_object_type [string]
- zonehvac_unit_object_name [string]
- mixer_outlet_node_name [string]
- mixer_primary_air_inlet_node_name [string]
- mixer_secondary_air_inlet_node_name [string]
- mixer_connection_type [string]
- design_specification_outdoor_air_object_name [string]
- per_person_ventilation_rate_mode [string] (Default: CurrentOccupancy)

AirTerminal:DualDuct:ConstantVolume¶

Central air system terminal unit, dual duct, constant volume.

Fields
- availability_schedule_name [string]
- air_outlet_node_name [string]
- hot_air_inlet_node_name [string]
- cold_air_inlet_node_name [string]
- maximum_air_flow_rate [unknown field type]

AirTerminal:DualDuct:VAV¶

Central air system terminal unit, dual duct, variable volume.

Fields
- availability_schedule_name [string]
- air_outlet_node_name [string]
- hot_air_inlet_node_name [string]
- cold_air_inlet_node_name [string]
- maximum_damper_air_flow_rate [unknown field type]
- zone_minimum_air_flow_fraction [number] (Default: 0.2)
- design_specification_outdoor_air_object_name [string]
- minimum_air_flow_turndown_schedule_name [string]

AirTerminal:DualDuct:VAV:OutdoorAir¶

Central air system terminal unit, dual duct, variable volume with special controls. One VAV duct is controlled to supply ventilation air and the other VAV duct is controlled to meet the zone cooling load.

Fields
- availability_schedule_name [string]
- air_outlet_node_name [string]
- outdoor_air_inlet_node_name [string]
- recirculated_air_inlet_node_name [string]
- maximum_terminal_air_flow_rate [unknown field type]
- design_specification_outdoor_air_object_name [string]
- per_person_ventilation_rate_mode [string]

ZoneHVAC:AirDistributionUnit¶

Central air system air distribution unit, serves as a wrapper for a specific type of air terminal unit. This object is referenced in a ZoneHVAC:EquipmentList.

Fields
- air_distribution_unit_outlet_node_name [string]
- air_terminal_object_type [string]
- air_terminal_name [string]
- nominal_upstream_leakage_fraction [number] (Default: 0.0)
- constant_downstream_leakage_fraction [number] (Default: 0.0)
- design_specification_air_terminal_sizing_object_name [string]

ZoneHVAC:ExhaustControl¶

Defines a controlled exhaust flow from a zone which finally feeds into one of AirLoopHVAC:ZoneMixer’s inlets, which are part of an AirLoopHVAC:ExhaustSystem.

Fields
- availability_schedule_name [string]
- zone_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- design_exhaust_flow_rate [unknown field type] (Default: Autosize)
- flow_control_type [string] (Default: Scheduled)
- exhaust_flow_fraction_schedule_name [string]
- supply_node_or_nodelist_name [string]
- minimum_zone_temperature_limit_schedule_name [string]
- minimum_exhaust_flow_fraction_schedule_name [string]
- balanced_exhaust_fraction_schedule_name [string]

Zone HVAC Equipment Connections¶

ZoneHVAC:EquipmentList¶

List equipment in simulation order. Note that an ZoneHVAC:AirDistributionUnit object must be listed in this statement if there is a forced air system serving the zone from the air loop. Equipment is simulated in the order specified by Zone Equipment Cooling Sequence and Zone Equipment Heating or No-Load Sequence, depending on the thermostat request. For equipment of similar type, assign sequence 1 to the first system intended to serve that type of load. For situations where one or more equipment types has limited capacity or limited control, order the sequence so that the most controllable piece of equipment runs last. For example, with a dedicated outdoor air system (DOAS), the air terminal for the DOAS should be assigned Heating Sequence = 1 and Cooling Sequence = 1. Any other equipment should be assigned sequence 2 or higher so that it will see the net load after the DOAS air is added to the zone.

Fields
- load_distribution_scheme [string] (Default: SequentialLoad)
- equipment [Array of {zone_equipment_object_type, zone_equipment_name, zone_equipment_cooling_sequence, zone_equipment_heating_or_no_load_sequence, zone_equipment_sequential_cooling_fraction_schedule_name, zone_equipment_sequential_heating_fraction_schedule_name}]

ZoneHVAC:EquipmentConnections¶

Specifies the HVAC equipment connections for a zone. Node names are specified for the zone air node, air inlet nodes, air exhaust nodes, and the air return node. A zone equipment list is referenced which lists all HVAC equipment connected to the zone.

Fields
- zone_name [string]
- zone_conditioning_equipment_list_name [string]
- zone_air_inlet_node_or_nodelist_name [string]
- zone_air_exhaust_node_or_nodelist_name [string]
- zone_air_node_name [string]
- zone_return_air_node_or_nodelist_name [string]
- zone_return_air_node_1_flow_rate_fraction_schedule_name [string]
- zone_return_air_node_1_flow_rate_basis_node_or_nodelist_name [string]

Fans¶

Fan:SystemModel¶

Versatile simple fan that can be used in variable air volume, constant volume, on-off cycling, two-speed or multi-speed applications. Performance at different flow rates, or speed levels, is determined using separate performance curve or table or prescribed power fractions at discrete speed levels for two-speed or multi-speed fans.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- design_maximum_air_flow_rate [unknown field type]
- speed_control_method [string] (Default: Discrete)
- electric_power_minimum_flow_rate_fraction [number] (Default: 0.2)
- design_pressure_rise [number]
- motor_efficiency [number] (Default: 0.9)
- motor_in_air_stream_fraction [number] (Default: 1.0)
- design_electric_power_consumption [unknown field type] (Default: Autosize)
- design_power_sizing_method [string] (Default: PowerPerFlowPerPressure)
- electric_power_per_unit_flow_rate [number]
- electric_power_per_unit_flow_rate_per_unit_pressure [number] (Default: 1.66667)
- fan_total_efficiency [number] (Default: 0.7)
- electric_power_function_of_flow_fraction_curve_name [string]
- night_ventilation_mode_pressure_rise [number]
- night_ventilation_mode_flow_fraction [number]
- motor_loss_zone_name [string]
- motor_loss_radiative_fraction [number]
- end_use_subcategory [string] (Default: General)
- number_of_speeds [integer] (Default: 1)
- speed_fractions [Array of {speed_flow_fraction, speed_electric_power_fraction}]

Fan:ConstantVolume¶

Constant volume fan that is intended to operate continuously based on a time schedule. This fan will not cycle on and off based on cooling/heating load or other control signals.

Fields
- availability_schedule_name [string]
- fan_total_efficiency [number] (Default: 0.7)
- pressure_rise [number]
- maximum_flow_rate [unknown field type]
- motor_efficiency [number] (Default: 0.9)
- motor_in_airstream_fraction [number] (Default: 1.0)
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- end_use_subcategory [string] (Default: General)

Fan:VariableVolume¶

Variable air volume fan where the electric power input varies according to a performance curve as a function of flow fraction.

Fields
- availability_schedule_name [string]
- fan_total_efficiency [number] (Default: 0.7)
- pressure_rise [number]
- maximum_flow_rate [unknown field type]
- fan_power_minimum_flow_rate_input_method [string] (Default: Fraction)
- fan_power_minimum_flow_fraction [number] (Default: 0.25)
- fan_power_minimum_air_flow_rate [number]
- motor_efficiency [number] (Default: 0.9)
- motor_in_airstream_fraction [number] (Default: 1.0)
- fan_power_coefficient_1 [number]
- fan_power_coefficient_2 [number]
- fan_power_coefficient_3 [number]
- fan_power_coefficient_4 [number]
- fan_power_coefficient_5 [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- end_use_subcategory [string] (Default: General)

Fan:OnOff¶

Constant volume fan that is intended to cycle on and off based on cooling/heating load or other control signals. This fan can also operate continuously like Fan:ConstantVolume.

Fields
- availability_schedule_name [string]
- fan_total_efficiency [number] (Default: 0.6)
- pressure_rise [number]
- maximum_flow_rate [unknown field type]
- motor_efficiency [number] (Default: 0.8)
- motor_in_airstream_fraction [number] (Default: 1.0)
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- fan_power_ratio_function_of_speed_ratio_curve_name [string]
- fan_efficiency_ratio_function_of_speed_ratio_curve_name [string]
- end_use_subcategory [string] (Default: General)

Fan:ZoneExhaust¶

Models a fan that exhausts air from a zone.

Fields
- availability_schedule_name [string]
- fan_total_efficiency [number] (Default: 0.6)
- pressure_rise [number]
- maximum_flow_rate [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- end_use_subcategory [string] (Default: General)
- flow_fraction_schedule_name [string]
- system_availability_manager_coupling_mode [string] (Default: Coupled)
- minimum_zone_temperature_limit_schedule_name [string]
- balanced_exhaust_fraction_schedule_name [string]

FanPerformance:NightVentilation¶

Specifies an alternate set of performance parameters for a fan. These alternate parameters are used when a system manager (such as AvailabilityManager:NightVentilation) sets a specified flow rate. May be used with Fan:ConstantVolume, Fan:VariableVolume and Fan:ComponentModel. If the fan model senses that a fixed flow rate has been set, it will use these alternate performance parameters. It is assumed that the fan will run at a fixed speed in the alternate mode.

Fields
- fan_name [string]
- fan_total_efficiency [number]
- pressure_rise [number]
- maximum_flow_rate [unknown field type]
- motor_efficiency [number]
- motor_in_airstream_fraction [number] (Default: 1.0)

Fan:ComponentModel¶

A detailed fan type for constant-air-volume (CAV) and variable-air-volume (VAV) systems. It includes inputs that describe the air-distribution system as well as the fan, drive belt (if used), motor, and variable-frequency-drive (if used).

Fields
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- availability_schedule_name [string]
- maximum_flow_rate [unknown field type]
- minimum_flow_rate [unknown field type]
- fan_sizing_factor [number] (Default: 1.0)
- fan_wheel_diameter [number]
- fan_outlet_area [number]
- maximum_fan_static_efficiency [number]
- euler_number_at_maximum_fan_static_efficiency [number]
- maximum_dimensionless_fan_airflow [number]
- motor_fan_pulley_ratio [unknown field type] (Default: 1.0)
- belt_maximum_torque [unknown field type]
- belt_sizing_factor [number] (Default: 1.0)
- belt_fractional_torque_transition [number] (Default: 0.167)
- motor_maximum_speed [number]
- maximum_motor_output_power [unknown field type]
- motor_sizing_factor [number] (Default: 1.0)
- motor_in_airstream_fraction [number] (Default: 1.0)
- vfd_efficiency_type [string]
- maximum_vfd_output_power [unknown field type]
- vfd_sizing_factor [number] (Default: 1.0)
- fan_pressure_rise_curve_name [string]
- duct_static_pressure_reset_curve_name [string]
- normalized_fan_static_efficiency_curve_name_non_stall_region [string]
- normalized_fan_static_efficiency_curve_name_stall_region [string]
- normalized_dimensionless_airflow_curve_name_non_stall_region [string]
- normalized_dimensionless_airflow_curve_name_stall_region [string]
- maximum_belt_efficiency_curve_name [string]
- normalized_belt_efficiency_curve_name_region_1 [string]
- normalized_belt_efficiency_curve_name_region_2 [string]
- normalized_belt_efficiency_curve_name_region_3 [string]
- maximum_motor_efficiency_curve_name [string]
- normalized_motor_efficiency_curve_name [string]
- vfd_efficiency_curve_name [string]
- end_use_subcategory [string] (Default: General)

Coils¶

Coil:Cooling:Water¶

Chilled water cooling coil, NTU-effectiveness model, with inputs for design entering and leaving conditions.

Fields
- availability_schedule_name [string]
- design_water_flow_rate [unknown field type] (Default: Autosize)
- design_air_flow_rate [unknown field type] (Default: Autosize)
- design_inlet_water_temperature [unknown field type] (Default: Autosize)
- design_inlet_air_temperature [unknown field type] (Default: Autosize)
- design_outlet_air_temperature [unknown field type] (Default: Autosize)
- design_inlet_air_humidity_ratio [unknown field type] (Default: Autosize)
- design_outlet_air_humidity_ratio [unknown field type] (Default: Autosize)
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- type_of_analysis [string] (Default: SimpleAnalysis)
- heat_exchanger_configuration [string] (Default: CounterFlow)
- condensate_collection_water_storage_tank_name [string]
- design_water_temperature_difference [number]

Coil:Cooling:Water:DetailedGeometry¶

Chilled water cooling coil, detailed flat fin coil model for continuous plate fins, with inputs for detailed coil geometry specifications.

Fields
- availability_schedule_name [string]
- maximum_water_flow_rate [unknown field type] (Default: Autosize)
- tube_outside_surface_area [unknown field type] (Default: Autosize)
- total_tube_inside_area [unknown field type] (Default: Autosize)
- fin_surface_area [unknown field type] (Default: Autosize)
- minimum_airflow_area [unknown field type] (Default: Autosize)
- coil_depth [unknown field type] (Default: Autosize)
- fin_diameter [unknown field type] (Default: Autosize)
- fin_thickness [number] (Default: 0.0015)
- tube_inside_diameter [number] (Default: 0.01445)
- tube_outside_diameter [number] (Default: 0.0159)
- tube_thermal_conductivity [number] (Default: 386.0)
- fin_thermal_conductivity [number] (Default: 204.0)
- fin_spacing [number] (Default: 0.0018)
- tube_depth_spacing [number] (Default: 0.026)
- number_of_tube_rows [number] (Default: 4.0)
- number_of_tubes_per_row [unknown field type] (Default: Autosize)
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- condensate_collection_water_storage_tank_name [string]
- design_water_temperature_difference [number]
- design_inlet_water_temperature [unknown field type] (Default: Autosize)

CoilSystem:Cooling:Water¶

Virtual container component that consists of a water cooling coil and its associated controls. This control object supports the available water coil types and may be placed directly on an air loop branch or in an outdoor air equipment list.

Fields
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- availability_schedule_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- dehumidification_control_type [string] (Default: None)
- run_on_sensible_load [string] (Default: Yes)
- run_on_latent_load [string] (Default: No)
- minimum_air_to_water_temperature_offset [number] (Default: 0.0)
- economizer_lockout [string] (Default: Yes)
- minimum_water_loop_temperature_for_heat_recovery [number] (Default: 0.0)
- companion_coil_used_for_heat_recovery [string]

Coil:Cooling:DX¶

New general DX cooling coil supporting on or more speeds and one or or operating modes. Includes DX evaporator coil, compressor, and condenser. Object is currently only supported by the AIRLOOPHVAC:UNITARYSYSTEM object. Remaining Coil:Cooling:DX* objects will be deprecated at a future date, after which, this object will replace all other Coil:Cooling:DX* objects.

Fields
- evaporator_inlet_node_name [string]
- evaporator_outlet_node_name [string]
- availability_schedule_name [string]
- condenser_zone_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- performance_object_name [string]
- condensate_collection_water_storage_tank_name [string]
- evaporative_condenser_supply_water_storage_tank_name [string]

Coil:Cooling:DX:CurveFit:Performance¶

DX cooling coil performance specification referencing one or more operating modes. Mode 1 is always the base design operating mode. Additional modes are optional states such as subcool reheat for humidity control.

Fields
- crankcase_heater_capacity [number] (Default: 0.0)
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -25.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- unit_internal_static_air_pressure [number]
- capacity_control_method [string] (Default: Discrete)
- evaporative_condenser_basin_heater_capacity [number] (Default: 0.0)
- evaporative_condenser_basin_heater_setpoint_temperature [number] (Default: 2.0)
- evaporative_condenser_basin_heater_operating_schedule_name [string]
- compressor_fuel_type [string] (Default: Electricity)
- base_operating_mode [string]
- alternative_operating_mode_1 [string]
- alternative_operating_mode_2 [string]

Coil:Cooling:DX:CurveFit:OperatingMode¶

DX cooling coil performance for a single operating mode which may have one or more speeds.

Fields
- rated_gross_total_cooling_capacity [unknown field type] (Default: Autosize)
- rated_evaporator_air_flow_rate [unknown field type]
- rated_condenser_air_flow_rate [unknown field type]
- maximum_cycling_rate [number] (Default: 0.0)
- ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- latent_capacity_time_constant [number] (Default: 0.0)
- nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- apply_latent_degradation_to_speeds_greater_than_1 [string] (Default: No)
- condenser_type [string] (Default: AirCooled)
- nominal_evaporative_condenser_pump_power [unknown field type] (Default: 0.0)
- nominal_speed_number [integer]
- speed_1_name [string]
- speed_2_name [string]
- speed_3_name [string]
- speed_4_name [string]
- speed_5_name [string]
- speed_6_name [string]
- speed_7_name [string]
- speed_8_name [string]
- speed_9_name [string]
- speed_10_name [string]

Coil:Cooling:DX:CurveFit:Speed¶

DX cooling coil performance for a single speed within a single operating mode.

Fields
- gross_total_cooling_capacity_fraction [number]
- evaporator_air_flow_rate_fraction [number]
- condenser_air_flow_rate_fraction [number]
- gross_sensible_heat_ratio [unknown field type] (Default: Autosize)
- gross_cooling_cop [number] (Default: 3.0)
- active_fraction_of_coil_face_area [number] (Default: 1.0)
- 2017_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- evaporative_condenser_pump_power_fraction [number] (Default: 1.0)
- evaporative_condenser_effectiveness [number] (Default: 0.9)
- total_cooling_capacity_modifier_function_of_temperature_curve_name [string]
- total_cooling_capacity_modifier_function_of_air_flow_fraction_curve_name [string]
- energy_input_ratio_modifier_function_of_temperature_curve_name [string]
- energy_input_ratio_modifier_function_of_air_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]
- rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- waste_heat_modifier_function_of_temperature_curve_name [string]
- sensible_heat_ratio_modifier_function_of_temperature_curve_name [string]
- sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name [string]

Coil:Cooling:DX:SingleSpeed¶

Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), single-speed. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation.

Fields
- availability_schedule_name [string]
- gross_rated_total_cooling_capacity [unknown field type]
- gross_rated_sensible_heat_ratio [unknown field type]
- gross_rated_cooling_cop [number] (Default: 3.0)
- rated_air_flow_rate [unknown field type]
- 2017_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- total_cooling_capacity_function_of_temperature_curve_name [string]
- total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- energy_input_ratio_function_of_temperature_curve_name [string]
- energy_input_ratio_function_of_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -25.0)
- nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- maximum_cycling_rate [number] (Default: 0.0)
- latent_capacity_time_constant [number] (Default: 0.0)
- condenser_air_inlet_node_name [string]
- condenser_type [string] (Default: AirCooled)
- evaporative_condenser_effectiveness [number] (Default: 0.9)
- evaporative_condenser_air_flow_rate [unknown field type]
- evaporative_condenser_pump_rated_power_consumption [unknown field type] (Default: 0.0)
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- supply_water_storage_tank_name [string]
- condensate_collection_water_storage_tank_name [string]
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- sensible_heat_ratio_function_of_temperature_curve_name [string]
- sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- report_ashrae_standard_127_performance_ratings [string] (Default: No)
- zone_name_for_condenser_placement [string]

Coil:Cooling:DX:TwoSpeed¶

Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), two-speed (or variable-speed). Requires two sets of performance data and will interpolate between speeds. Modeled as a single coil (multi-speed compressor or multiple compressors with row split or intertwined coil).

Fields
- availability_schedule_name [string]
- high_speed_gross_rated_total_cooling_capacity [unknown field type]
- high_speed_rated_sensible_heat_ratio [unknown field type]
- high_speed_gross_rated_cooling_cop [number] (Default: 3.0)
- high_speed_rated_air_flow_rate [unknown field type]
- unit_internal_static_air_pressure [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- total_cooling_capacity_function_of_temperature_curve_name [string]
- total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- energy_input_ratio_function_of_temperature_curve_name [string]
- energy_input_ratio_function_of_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]
- low_speed_gross_rated_total_cooling_capacity [unknown field type]
- low_speed_gross_rated_sensible_heat_ratio [unknown field type]
- low_speed_gross_rated_cooling_cop [number] (Default: 3.0)
- low_speed_rated_air_flow_rate [unknown field type]
- low_speed_total_cooling_capacity_function_of_temperature_curve_name [string]
- low_speed_energy_input_ratio_function_of_temperature_curve_name [string]
- condenser_air_inlet_node_name [string]
- condenser_type [string] (Default: AirCooled)
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -25.0)
- high_speed_evaporative_condenser_effectiveness [number] (Default: 0.9)
- high_speed_evaporative_condenser_air_flow_rate [unknown field type]
- high_speed_evaporative_condenser_pump_rated_power_consumption [unknown field type]
- low_speed_evaporative_condenser_effectiveness [number] (Default: 0.9)
- low_speed_evaporative_condenser_air_flow_rate [unknown field type]
- low_speed_evaporative_condenser_pump_rated_power_consumption [unknown field type]
- supply_water_storage_tank_name [string]
- condensate_collection_water_storage_tank_name [string]
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- sensible_heat_ratio_function_of_temperature_curve_name [string]
- sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- low_speed_sensible_heat_ratio_function_of_temperature_curve_name [string]
- low_speed_sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- zone_name_for_condenser_placement [string]

Coil:Cooling:DX:MultiSpeed¶

Direct expansion (DX) cooling coil and condensing unit (includes electric or engine-driven compressor and condenser fan), multi-speed (or variable-speed). Optional moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Requires two to four sets of performance data and will interpolate between speeds. Modeled as a single coil (multi-speed compressor or multiple compressors with row split or intertwined coil).

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- condenser_air_inlet_node_name [string]
- condenser_type [string] (Default: AirCooled)
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -25.0)
- supply_water_storage_tank_name [string]
- condensate_collection_water_storage_tank_name [string]
- apply_part_load_fraction_to_speeds_greater_than_1 [string] (Default: No)
- apply_latent_degradation_to_speeds_greater_than_1 [string] (Default: No)
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- fuel_type [string]
- number_of_speeds [integer]
- speed_1_gross_rated_total_cooling_capacity [unknown field type]
- speed_1_gross_rated_sensible_heat_ratio [unknown field type]
- speed_1_gross_rated_cooling_cop [number] (Default: 3.0)
- speed_1_rated_air_flow_rate [unknown field type]
- 2017_speed_1_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_1_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_1_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_1_total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_1_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_1_part_load_fraction_correlation_curve_name [string]
- speed_1_nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- speed_1_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- speed_1_maximum_cycling_rate [number] (Default: 0.0)
- speed_1_latent_capacity_time_constant [number] (Default: 0.0)
- speed_1_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_1_waste_heat_function_of_temperature_curve_name [string]
- speed_1_evaporative_condenser_effectiveness [number] (Default: 0.9)
- speed_1_evaporative_condenser_air_flow_rate [unknown field type]
- speed_1_rated_evaporative_condenser_pump_power_consumption [unknown field type]
- speed_2_gross_rated_total_cooling_capacity [unknown field type]
- speed_2_gross_rated_sensible_heat_ratio [unknown field type]
- speed_2_gross_rated_cooling_cop [number] (Default: 3.0)
- speed_2_rated_air_flow_rate [unknown field type]
- 2017_speed_2_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_2_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_2_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_2_total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_2_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_2_part_load_fraction_correlation_curve_name [string]
- speed_2_nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- speed_2_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- speed_2_maximum_cycling_rate [number] (Default: 0.0)
- speed_2_latent_capacity_time_constant [number] (Default: 0.0)
- speed_2_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_2_waste_heat_function_of_temperature_curve_name [string]
- speed_2_evaporative_condenser_effectiveness [number] (Default: 0.9)
- speed_2_evaporative_condenser_air_flow_rate [unknown field type]
- speed_2_rated_evaporative_condenser_pump_power_consumption [unknown field type]
- speed_3_gross_rated_total_cooling_capacity [unknown field type]
- speed_3_gross_rated_sensible_heat_ratio [unknown field type]
- speed_3_gross_rated_cooling_cop [number] (Default: 3.0)
- speed_3_rated_air_flow_rate [unknown field type]
- 2017_speed_3_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_3_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_3_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_3_total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_3_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_3_part_load_fraction_correlation_curve_name [string]
- speed_3_nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- speed_3_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- speed_3_maximum_cycling_rate [number] (Default: 0.0)
- speed_3_latent_capacity_time_constant [number] (Default: 0.0)
- speed_3_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_3_waste_heat_function_of_temperature_curve_name [string]
- speed_3_evaporative_condenser_effectiveness [number] (Default: 0.9)
- speed_3_evaporative_condenser_air_flow_rate [unknown field type]
- speed_3_rated_evaporative_condenser_pump_power_consumption [unknown field type]
- speed_4_gross_rated_total_cooling_capacity [unknown field type]
- speed_4_gross_rated_sensible_heat_ratio [unknown field type]
- speed_4_gross_rated_cooling_cop [number] (Default: 3.0)
- speed_4_rated_air_flow_rate [unknown field type]
- 2017_speed_4_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_4_rated_evaporator_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_4_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_4_total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_4_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_4_part_load_fraction_correlation_curve_name [string]
- speed_4_nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- speed_4_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- speed_4_maximum_cycling_rate [number] (Default: 0.0)
- speed_4_latent_capacity_time_constant [number] (Default: 0.0)
- speed_4_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_4_waste_heat_function_of_temperature_curve_name [string]
- speed_4_evaporative_condenser_effectiveness [number] (Default: 0.9)
- speed_4_evaporative_condenser_air_flow_rate [unknown field type]
- speed_4_rated_evaporative_condenser_pump_power_consumption [unknown field type]
- zone_name_for_condenser_placement [string]

Coil:Cooling:DX:VariableSpeed¶

Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), variable-speed. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Requires two to ten sets of performance data and will interpolate between speeds. Modeled as a single coil with variable-speed compressor.

Fields
- indoor_air_inlet_node_name [string]
- indoor_air_outlet_node_name [string]
- number_of_speeds [integer] (Default: 2)
- nominal_speed_level [integer] (Default: 2)
- gross_rated_total_cooling_capacity_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- rated_air_flow_rate_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- nominal_time_for_condensate_to_begin_leaving_the_coil [number] (Default: 0.0)
- initial_moisture_evaporation_rate_divided_by_steady_state_ac_latent_capacity [number] (Default: 0.0)
- energy_part_load_fraction_curve_name [string]
- condenser_air_inlet_node_name [string]
- condenser_type [string] (Default: AirCooled)
- evaporative_condenser_pump_rated_power_consumption [unknown field type] (Default: 0.0)
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -25.0)
- supply_water_storage_tank_name [string]
- condensate_collection_water_storage_tank_name [string]
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- speed_1_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_1_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_1_reference_unit_gross_rated_cooling_cop [number]
- speed_1_reference_unit_rated_air_flow_rate [number]
- speed_1_reference_unit_rated_condenser_air_flow_rate [number]
- speed_1_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_1_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_1_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_2_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_2_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_2_reference_unit_gross_rated_cooling_cop [number]
- speed_2_reference_unit_rated_air_flow_rate [number]
- speed_2_reference_unit_rated_condenser_air_flow_rate [number]
- speed_2_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_2_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_2_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_3_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_3_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_3_reference_unit_gross_rated_cooling_cop [number]
- speed_3_reference_unit_rated_air_flow_rate [number]
- speed_3_reference_unit_rated_condenser_air_flow_rate [number]
- speed_3_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_3_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_3_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_4_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_4_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_4_reference_unit_gross_rated_cooling_cop [number]
- speed_4_reference_unit_rated_air_flow_rate [number]
- speed_4_reference_unit_rated_condenser_air_flow_rate [number]
- speed_4_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_4_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_4_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_5_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_5_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_5_reference_unit_gross_rated_cooling_cop [number]
- speed_5_reference_unit_rated_air_flow_rate [number]
- speed_5_reference_unit_rated_condenser_air_flow_rate [number]
- speed_5_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_5_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_5_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_5_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_6_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_6_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_6_reference_unit_gross_rated_cooling_cop [number]
- speed_6_reference_unit_rated_air_flow_rate [number]
- speed_6_reference_unit_condenser_air_flow_rate [number]
- speed_6_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_6_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_6_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_6_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_7_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_7_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_7_reference_unit_gross_rated_cooling_cop [number]
- speed_7_reference_unit_rated_air_flow_rate [number]
- speed_7_reference_unit_condenser_flow_rate [number]
- speed_7_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_7_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_7_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_7_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_8_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_8_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_8_reference_unit_gross_rated_cooling_cop [number]
- speed_8_reference_unit_rated_air_flow_rate [number]
- speed_8_reference_unit_condenser_air_flow_rate [number]
- speed_8_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_8_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_8_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_8_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_9_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_9_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_9_reference_unit_gross_rated_cooling_cop [number]
- speed_9_reference_unit_rated_air_flow_rate [number]
- speed_9_reference_unit_condenser_air_flow_rate [number]
- speed_9_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_9_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_9_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_9_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_10_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_10_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_10_reference_unit_gross_rated_cooling_cop [number]
- speed_10_reference_unit_rated_air_flow_rate [number]
- speed_10_reference_unit_condenser_air_flow_rate [number]
- speed_10_reference_unit_rated_pad_effectiveness_of_evap_precooling [number]
- speed_10_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_10_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_10_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]

Coil:Cooling:DX:TwoStageWithHumidityControlMode¶

Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), two-stage with humidity control mode (e.g. sub-cool or hot gas reheat). Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Requires two to four sets of performance data, see CoilPerformance:DX:Cooling. Stages are modeled as a face-split coil.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- number_of_capacity_stages [integer] (Default: 1)
- number_of_enhanced_dehumidification_modes [integer] (Default: 0)
- normal_mode_stage_1_coil_performance_object_type [string]
- normal_mode_stage_1_coil_performance_name [string]
- normal_mode_stage_1_2_coil_performance_object_type [string]
- normal_mode_stage_1_2_coil_performance_name [string]
- dehumidification_mode_1_stage_1_coil_performance_object_type [string]
- dehumidification_mode_1_stage_1_coil_performance_name [string]
- dehumidification_mode_1_stage_1_2_coil_performance_object_type [string]
- dehumidification_mode_1_stage_1_2_coil_performance_name [string]
- supply_water_storage_tank_name [string]
- condensate_collection_water_storage_tank_name [string]
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -25.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]

CoilPerformance:DX:Cooling¶

Used to specify DX cooling coil performance for one mode of operation for a Coil:Cooling:DX:TwoStageWithHumidityControlMode object which may reference one to four CoilPerformance:DX:Cooling objects depending on the specified number of stages and dehumidification modes. In nearly all cases, the Rated Air Flow Rate will be the same for all performance objects associated with a given coil. If bypass is specified, the Rated Air Flow Rate includes both the bypassed flow and the flow through the active part of the coil.

Fields
- gross_rated_total_cooling_capacity [unknown field type]
- gross_rated_sensible_heat_ratio [unknown field type]
- gross_rated_cooling_cop [number] (Default: 3.0)
- rated_air_flow_rate [unknown field type]
- fraction_of_air_flow_bypassed_around_coil [number] (Default: 0.0)
- total_cooling_capacity_function_of_temperature_curve_name [string]
- total_cooling_capacity_function_of_flow_fraction_curve_name [string]
- energy_input_ratio_function_of_temperature_curve_name [string]
- energy_input_ratio_function_of_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]
- nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- maximum_cycling_rate [number] (Default: 0.0)
- latent_capacity_time_constant [number] (Default: 0.0)
- condenser_air_inlet_node_name [string]
- condenser_type [string] (Default: AirCooled)
- evaporative_condenser_effectiveness [number] (Default: 0.9)
- evaporative_condenser_air_flow_rate [unknown field type]
- evaporative_condenser_pump_rated_power_consumption [unknown field type] (Default: 0.0)
- sensible_heat_ratio_function_of_temperature_curve_name [string]
- sensible_heat_ratio_function_of_flow_fraction_curve_name [string]

Coil:Cooling:DX:VariableRefrigerantFlow¶

Variable refrigerant flow (VRF) direct expansion (DX) cooling coil. Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Condensing unit is modeled separately, see AirConditioner:VariableRefrigerantFlow.

Fields
- availability_schedule_name [string]
- gross_rated_total_cooling_capacity [unknown field type]
- gross_rated_sensible_heat_ratio [unknown field type]
- rated_air_flow_rate [unknown field type]
- cooling_capacity_ratio_modifier_function_of_temperature_curve_name [string]
- cooling_capacity_modifier_curve_function_of_flow_fraction_name [string]
- coil_air_inlet_node [string]
- coil_air_outlet_node [string]
- name_of_water_storage_tank_for_condensate_collection [string]

Coil:Heating:DX:VariableRefrigerantFlow¶

Variable refrigerant flow (VRF) direct expansion (DX) heating coil (air-to-air heat pump). Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Condensing unit is modeled separately, see AirConditioner:VariableRefrigerantFlow.

Fields
- availability_schedule [string]
- gross_rated_heating_capacity [unknown field type]
- rated_air_flow_rate [unknown field type]
- coil_air_inlet_node [string]
- coil_air_outlet_node [string]
- heating_capacity_ratio_modifier_function_of_temperature_curve_name [string]
- heating_capacity_modifier_function_of_flow_fraction_curve_name [string]

Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl¶

This is a key object in the new physics based VRF model applicable for Fluid Temperature Control. It describes the the indoor unit coil of the system at cooling mode. Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Outdoor unit is modeled separately, see AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl or AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR

Fields
- availability_schedule_name [string]
- coil_air_inlet_node [string]
- coil_air_outlet_node [string]
- rated_total_cooling_capacity [unknown field type]
- rated_sensible_heat_ratio [unknown field type]
- indoor_unit_reference_superheating [number] (Default: 5.0)
- indoor_unit_evaporating_temperature_function_of_superheating_curve_name [string]
- name_of_water_storage_tank_for_condensate_collection [string]

Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl¶

This is a key object in the new physics based VRF model applicable for Fluid Temperature Control. It describes the the indoor unit coil of the system at heating mode. Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Outdoor unit is modeled separately, see AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl or AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR

Fields
- availability_schedule [string]
- coil_air_inlet_node [string]
- coil_air_outlet_node [string]
- rated_total_heating_capacity [unknown field type]
- indoor_unit_reference_subcooling [number] (Default: 5.0)
- indoor_unit_condensing_temperature_function_of_subcooling_curve_name [string]

Coil:Heating:Water¶

Hot water heating coil, NTU-effectiveness model, assumes a cross-flow heat exchanger. Two options for capacity inputs: UA and water flow rate or capacity and design temperatures.

Fields
- availability_schedule_name [string]
- u_factor_times_area_value [unknown field type] (Default: Autosize)
- maximum_water_flow_rate [unknown field type] (Default: Autosize)
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- performance_input_method [string] (Default: UFactorTimesAreaAndDesignWaterFlowRate)
- rated_capacity [unknown field type] (Default: Autosize)
- rated_inlet_water_temperature [number] (Default: 82.2)
- rated_inlet_air_temperature [number] (Default: 16.6)
- rated_outlet_water_temperature [number] (Default: 71.1)
- rated_outlet_air_temperature [number] (Default: 32.2)
- rated_ratio_for_air_and_water_convection [number] (Default: 0.5)
- design_water_temperature_difference [number]

Coil:Heating:Steam¶

Steam heating coil. Condenses and sub-cools steam at loop pressure and discharges condensate through steam traps to low pressure condensate line.

Fields
- availability_schedule_name [string]
- maximum_steam_flow_rate [unknown field type]
- degree_of_subcooling [number]
- degree_of_loop_subcooling [number] (Default: 20.0)
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- coil_control_type [string]
- temperature_setpoint_node_name [string]

Coil:Heating:Electric¶

Electric heating coil. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

Fields
- availability_schedule_name [string]
- efficiency [number] (Default: 1.0)
- nominal_capacity [unknown field type]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- temperature_setpoint_node_name [string]

Coil:Heating:Electric:MultiStage¶

Electric heating coil, multi-stage. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- temperature_setpoint_node_name [string]
- number_of_stages [integer]
- stage_1_efficiency [number]
- stage_1_nominal_capacity [unknown field type]
- stage_2_efficiency [number]
- stage_2_nominal_capacity [unknown field type]
- stage_3_efficiency [number]
- stage_3_nominal_capacity [unknown field type]
- stage_4_efficiency [number]
- stage_4_nominal_capacity [unknown field type]

Coil:Heating:Fuel¶

Gas or other fuel heating coil. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

Fields
- availability_schedule_name [string]
- fuel_type [string] (Default: NaturalGas)
- burner_efficiency [number] (Default: 0.8)
- nominal_capacity [unknown field type]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- temperature_setpoint_node_name [string]
- parasitic_electric_load [number]
- part_load_fraction_correlation_curve_name [string]
- parasitic_fuel_load [number]

Coil:Heating:Gas:MultiStage¶

Gas heating coil, multi-stage. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- temperature_setpoint_node_name [string]
- part_load_fraction_correlation_curve_name [string]
- parasitic_gas_load [number]
- number_of_stages [integer]
- stage_1_gas_burner_efficiency [number]
- stage_1_nominal_capacity [unknown field type]
- stage_1_parasitic_electric_load [number]
- stage_2_gas_burner_efficiency [number]
- stage_2_nominal_capacity [unknown field type]
- stage_2_parasitic_electric_load [number]
- stage_3_gas_burner_efficiency [number]
- stage_3_nominal_capacity [unknown field type]
- stage_3_parasitic_electric_load [number]
- stage_4_gas_burner_efficiency [number]
- stage_4_nominal_capacity [unknown field type]
- stage_4_parasitic_electric_load [number]

Coil:Heating:Desuperheater¶

Desuperheater air heating coil. The heating energy provided by this coil is reclaimed from the superheated refrigerant gas leaving a compressor and does not impact the performance of the compressor. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as a unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

Fields
- availability_schedule_name [string]
- heat_reclaim_recovery_efficiency [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- heating_source_object_type [string]
- heating_source_name [string]
- temperature_setpoint_node_name [string]
- parasitic_electric_load [number]

Coil:Heating:DX:SingleSpeed¶

Direct expansion (DX) heating coil (air-to-air heat pump) and compressor unit (includes electric compressor and outdoor fan), single-speed, with defrost controls.

Fields
- availability_schedule_name [string]
- gross_rated_heating_capacity [unknown field type]
- gross_rated_heating_cop [number]
- rated_air_flow_rate [unknown field type]
- 2017_rated_supply_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_rated_supply_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- heating_capacity_function_of_temperature_curve_name [string]
- heating_capacity_function_of_flow_fraction_curve_name [string]
- energy_input_ratio_function_of_temperature_curve_name [string]
- energy_input_ratio_function_of_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]
- defrost_energy_input_ratio_function_of_temperature_curve_name [string]
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -8.0)
- outdoor_dry_bulb_temperature_to_turn_on_compressor [number]
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- defrost_strategy [string] (Default: ReverseCycle)
- defrost_control [string] (Default: Timed)
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: 0.0)
- region_number_for_calculating_hspf [integer] (Default: 4)
- evaporator_air_inlet_node_name [string]
- zone_name_for_evaporator_placement [string]
- secondary_coil_air_flow_rate [unknown field type]
- secondary_coil_fan_flow_scaling_factor [number] (Default: 1.25)
- nominal_sensible_heat_ratio_of_secondary_coil [number]
- sensible_heat_ratio_modifier_function_of_temperature_curve_name [string]
- sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name [string]

Coil:Heating:DX:MultiSpeed¶

Direct expansion (DX) heating coil (air-to-air heat pump) and compressor unit (includes electric or engine-driven compressor and outdoor fan), multi-speed (or variable-speed), with defrost controls. Requires two to four sets of performance data and will interpolate between speeds.

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -8.0)
- outdoor_dry_bulb_temperature_to_turn_on_compressor [number]
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- defrost_energy_input_ratio_function_of_temperature_curve_name [string]
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- defrost_strategy [string] (Default: ReverseCycle)
- defrost_control [string] (Default: Timed)
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: 0.0)
- apply_part_load_fraction_to_speeds_greater_than_1 [string] (Default: No)
- fuel_type [string]
- region_number_for_calculating_hspf [integer] (Default: 4)
- number_of_speeds [integer]
- speed_1_gross_rated_heating_capacity [unknown field type]
- speed_1_gross_rated_heating_cop [number]
- speed_1_rated_air_flow_rate [unknown field type]
- 2017_speed_1_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_1_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_1_heating_capacity_function_of_temperature_curve_name [string]
- speed_1_heating_capacity_function_of_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_1_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_1_part_load_fraction_correlation_curve_name [string]
- speed_1_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_1_waste_heat_function_of_temperature_curve_name [string]
- speed_2_gross_rated_heating_capacity [unknown field type]
- speed_2_gross_rated_heating_cop [number]
- speed_2_rated_air_flow_rate [unknown field type]
- 2017_speed_2_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_2_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_2_heating_capacity_function_of_temperature_curve_name [string]
- speed_2_heating_capacity_function_of_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_2_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_2_part_load_fraction_correlation_curve_name [string]
- speed_2_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_2_waste_heat_function_of_temperature_curve_name [string]
- speed_3_gross_rated_heating_capacity [unknown field type]
- speed_3_gross_rated_heating_cop [number]
- speed_3_rated_air_flow_rate [unknown field type]
- 2017_speed_3_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_3_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_3_heating_capacity_function_of_temperature_curve_name [string]
- speed_3_heating_capacity_function_of_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_3_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_3_part_load_fraction_correlation_curve_name [string]
- speed_3_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_3_waste_heat_function_of_temperature_curve_name [string]
- speed_4_gross_rated_heating_capacity [unknown field type]
- speed_4_gross_rated_heating_cop [number]
- speed_4_rated_air_flow_rate [unknown field type]
- 2017_speed_4_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 773.3)
- 2023_speed_4_rated_supply_air_fan_power_per_volume_flow_rate [number] (Default: 934.4)
- speed_4_heating_capacity_function_of_temperature_curve_name [string]
- speed_4_heating_capacity_function_of_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_4_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- speed_4_part_load_fraction_correlation_curve_name [string]
- speed_4_rated_waste_heat_fraction_of_power_input [number] (Default: 0.2)
- speed_4_waste_heat_function_of_temperature_curve_name [string]
- zone_name_for_evaporator_placement [string]
- speed_1_secondary_coil_air_flow_rate [unknown field type]
- speed_1_secondary_coil_fan_flow_scaling_factor [number] (Default: 1.25)
- speed_1_nominal_sensible_heat_ratio_of_secondary_coil [number]
- speed_1_sensible_heat_ratio_modifier_function_of_temperature_curve_name [string]
- speed_1_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name [string]
- speed_2_secondary_coil_air_flow_rate [unknown field type]
- speed_2_secondary_coil_fan_flow_scaling_factor [number] (Default: 1.25)
- speed_2_nominal_sensible_heat_ratio_of_secondary_coil [number]
- speed_2_sensible_heat_ratio_modifier_function_of_temperature_curve_name [string]
- speed_2_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name [string]
- speed_3_secondary_coil_air_flow_rate [unknown field type]
- speed_3_secondary_coil_fan_flow_scaling_factor [number] (Default: 1.25)
- speed_3_nominal_sensible_heat_ratio_of_secondary_coil [number]
- speed_3_sensible_heat_ratio_modifier_function_of_temperature_curve_name [string]
- speed_3_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name [string]
- speed_4_secondary_coil_air_flow_rate [unknown field type]
- speed_4_secondary_coil_fan_flow_scaling_factor [number] (Default: 1.25)
- speed_4_nominal_sensible_heat_ratio_of_secondary_coil [number]
- speed_4_sensible_heat_ratio_modifier_function_of_temperature_curve_name [string]
- speed_4_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name [string]

Coil:Heating:DX:VariableSpeed¶

Direct expansion (DX) heating coil (air-to-air heat pump) and compressor unit (includes electric compressor and outdoor fan), variable-speed, with defrost controls. Requires two to ten sets of performance data and will interpolate between speeds.

Fields
- indoor_air_inlet_node_name [string]
- indoor_air_outlet_node_name [string]
- number_of_speeds [integer] (Default: 2)
- nominal_speed_level [integer] (Default: 2)
- rated_heating_capacity_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- rated_air_flow_rate_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- energy_part_load_fraction_curve_name [string]
- defrost_energy_input_ratio_function_of_temperature_curve_name [string]
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -8.0)
- outdoor_dry_bulb_temperature_to_turn_on_compressor [number]
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- defrost_strategy [string] (Default: ReverseCycle)
- defrost_control [string] (Default: Timed)
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: 0.0)
- speed_1_reference_unit_gross_rated_heating_capacity [number]
- speed_1_reference_unit_gross_rated_heating_cop [number]
- speed_1_reference_unit_rated_air_flow_rate [number]
- speed_1_heating_capacity_function_of_temperature_curve_name [string]
- speed_1_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_2_reference_unit_gross_rated_heating_capacity [number]
- speed_2_reference_unit_gross_rated_heating_cop [number]
- speed_2_reference_unit_rated_air_flow_rate [number]
- speed_2_heating_capacity_function_of_temperature_curve_name [string]
- speed_2_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_3_reference_unit_gross_rated_heating_capacity [number]
- speed_3_reference_unit_gross_rated_heating_cop [number]
- speed_3_reference_unit_rated_air_flow_rate [number]
- speed_3_heating_capacity_function_of_temperature_curve_name [string]
- speed_3_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_4_reference_unit_gross_rated_heating_capacity [number]
- speed_4_reference_unit_gross_rated_heating_cop [number]
- speed_4_reference_unit_rated_air_flow_rate [number]
- speed_4_heating_capacity_function_of_temperature_curve_name [string]
- speed_4_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_5_reference_unit_gross_rated_heating_capacity [number]
- speed_5_reference_unit_gross_rated_heating_cop [number]
- speed_5_reference_unit_rated_air_flow_rate [number]
- speed_5_heating_capacity_function_of_temperature_curve_name [string]
- speed_5_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_5_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_6_reference_unit_gross_rated_heating_capacity [number]
- speed_6_reference_unit_gross_rated_heating_cop [number]
- speed_6_reference_unit_rated_air_flow_rate [number]
- speed_6_heating_capacity_function_of_temperature_curve_name [string]
- speed_6_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_6_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_7_reference_unit_gross_rated_heating_capacity [number]
- speed_7_reference_unit_gross_rated_heating_cop [number]
- speed_7_reference_unit_rated_air_flow_rate [number]
- speed_7_heating_capacity_function_of_temperature_curve_name [string]
- speed_7_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_7_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_8_reference_unit_gross_rated_heating_capacity [number]
- speed_8_reference_unit_gross_rated_heating_cop [number]
- speed_8_reference_unit_rated_air_flow_rate [number]
- speed_8_heating_capacity_function_of_temperature_curve_name [string]
- speed_8_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_8_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_9_reference_unit_gross_rated_heating_capacity [number]
- speed_9_reference_unit_gross_rated_heating_cop [number]
- speed_9_reference_unit_rated_air_flow_rate [number]
- speed_9_heating_capacity_function_of_temperature_curve_name [string]
- speed_9_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_9_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_10_reference_unit_gross_rated_heating_capacity [number]
- speed_10_reference_unit_gross_rated_heating_cop [number]
- speed_10_reference_unit_rated_air_flow_rate [number]
- speed_10_heating_capacity_function_of_temperature_curve_name [string]
- speed_10_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_10_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]

Coil:Cooling:WaterToAirHeatPump:ParameterEstimation¶

Direct expansion (DX) cooling coil for water-to-air heat pump (includes electric compressor), single-speed, parameter estimation model. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Parameter estimation model is a deterministic model that requires a consistent set of parameters to describe the operating conditions of the heat pump components.

Fields
- compressor_type [string]
- refrigerant_type [string] (Default: R22)
- design_source_side_flow_rate [number]
- nominal_cooling_coil_capacity [number]
- nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)
- high_pressure_cutoff [number]
- low_pressure_cutoff [number]
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- load_side_total_heat_transfer_coefficient [number]
- load_side_outside_surface_heat_transfer_coefficient [number]
- superheat_temperature_at_the_evaporator_outlet [number]
- compressor_power_losses [number]
- compressor_efficiency [number]
- compressor_piston_displacement [number]
- compressor_suction_discharge_pressure_drop [number]
- compressor_clearance_factor [number]
- refrigerant_volume_flow_rate [number]
- volume_ratio [number]
- leak_rate_coefficient [number]
- source_side_heat_transfer_coefficient [number]
- source_side_heat_transfer_resistance1 [number]
- source_side_heat_transfer_resistance2 [number]

Coil:Heating:WaterToAirHeatPump:ParameterEstimation¶

Direct expansion (DX) heating coil for water-to-air heat pump (includes electric compressor), single-speed, parameter estimation model. Parameter estimation model is a deterministic model that requires a consistent set of parameters to describe the operating conditions of the heat pump components.

Fields
- compressor_type [string]
- refrigerant_type [string] (Default: R22)
- design_source_side_flow_rate [number]
- gross_rated_heating_capacity [number]
- high_pressure_cutoff [number]
- low_pressure_cutoff [number]
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- load_side_total_heat_transfer_coefficient [number]
- superheat_temperature_at_the_evaporator_outlet [number]
- compressor_power_losses [number]
- compressor_efficiency [number]
- compressor_piston_displacement [number]
- compressor_suction_discharge_pressure_drop [number]
- compressor_clearance_factor [number]
- refrigerant_volume_flow_rate [number]
- volume_ratio [number]
- leak_rate_coefficient [number]
- source_side_heat_transfer_coefficient [number]
- source_side_heat_transfer_resistance1 [number]
- source_side_heat_transfer_resistance2 [number]

Coil:Cooling:WaterToAirHeatPump:EquationFit¶

Direct expansion (DX) cooling coil for water-to-air heat pump (includes electric compressor), single-speed, equation-fit model. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Equation-fit model uses normalized curves to describe the heat pump performance.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- rated_air_flow_rate [unknown field type]
- rated_water_flow_rate [unknown field type]
- gross_rated_total_cooling_capacity [unknown field type]
- gross_rated_sensible_cooling_capacity [unknown field type]
- gross_rated_cooling_cop [number]
- rated_entering_water_temperature [number] (Default: 30.0)
- rated_entering_air_dry_bulb_temperature [number] (Default: 27.0)
- rated_entering_air_wet_bulb_temperature [number] (Default: 19.0)
- total_cooling_capacity_curve_name [string]
- sensible_cooling_capacity_curve_name [string]
- cooling_power_consumption_curve_name [string]
- nominal_time_for_condensate_removal_to_begin [number] (Default: 0.0)
- ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity [number] (Default: 0.0)

Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit¶

Direct expansion (DX) cooling coil for water-to-air heat pump (includes electric compressor), variable-speed, equation-fit model. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Equation-fit model uses normalized curves to describe the heat pump performance. Requires two to ten sets of performance data and will interpolate between speeds. Modeled as a single coil with variable-speed compressor.

Fields
- water_to_refrigerant_hx_water_inlet_node_name [string]
- water_to_refrigerant_hx_water_outlet_node_name [string]
- indoor_air_inlet_node_name [string]
- indoor_air_outlet_node_name [string]
- number_of_speeds [integer] (Default: 2)
- nominal_speed_level [integer] (Default: 2)
- gross_rated_total_cooling_capacity_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- rated_air_flow_rate_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- rated_water_flow_rate_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- nominal_time_for_condensate_to_begin_leaving_the_coil [number] (Default: 0.0)
- initial_moisture_evaporation_rate_divided_by_steady_state_ac_latent_capacity [number] (Default: 0.0)
- flag_for_using_hot_gas_reheat_0_or_1 [number] (Default: 0.0)
- energy_part_load_fraction_curve_name [string]
- speed_1_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_1_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_1_reference_unit_gross_rated_cooling_cop [number]
- speed_1_reference_unit_rated_air_flow_rate [number]
- speed_1_reference_unit_rated_water_flow_rate [number]
- speed_1_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_1_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_1_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_1_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_1_waste_heat_function_of_temperature_curve_name [string]
- speed_2_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_2_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_2_reference_unit_gross_rated_cooling_cop [number]
- speed_2_reference_unit_rated_air_flow_rate [number]
- speed_2_reference_unit_rated_water_flow_rate [number]
- speed_2_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_2_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_2_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_2_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_2_waste_heat_function_of_temperature_curve_name [string]
- speed_3_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_3_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_3_reference_unit_gross_rated_cooling_cop [number]
- speed_3_reference_unit_rated_air_flow_rate [number]
- speed_3_reference_unit_rated_water_flow_rate [number]
- speed_3_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_3_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_3_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_3_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_3_waste_heat_function_of_temperature_curve_name [string]
- speed_4_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_4_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_4_reference_unit_gross_rated_cooling_cop [number]
- speed_4_reference_unit_rated_air_flow_rate [number]
- speed_4_reference_unit_rated_water_flow_rate [number]
- speed_4_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_4_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_4_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_4_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_4_waste_heat_function_of_temperature_curve_name [string]
- speed_5_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_5_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_5_reference_unit_gross_rated_cooling_cop [number]
- speed_5_reference_unit_rated_air_flow_rate [number]
- speed_5_reference_unit_rated_water_flow_rate [number]
- speed_5_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_5_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_5_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_5_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_5_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_5_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_5_waste_heat_function_of_temperature_curve_name [string]
- speed_6_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_6_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_6_reference_unit_gross_rated_cooling_cop [number]
- speed_6_reference_unit_rated_air_flow_rate [number]
- speed_6_reference_unit_rated_water_flow_rate [number]
- speed_6_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_6_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_6_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_6_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_6_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_6_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_6_waste_heat_function_of_temperature_curve_name [string]
- speed_7_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_7_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_7_reference_unit_gross_rated_cooling_cop [number]
- speed_7_reference_unit_rated_air_flow_rate [number]
- speed_7_reference_unit_rated_water_flow_rate [number]
- speed_7_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_7_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_7_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_7_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_7_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_7_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_7_waste_heat_function_of_temperature_curve_name [string]
- speed_8_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_8_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_8_reference_unit_gross_rated_cooling_cop [number]
- speed_8_reference_unit_rated_air_flow_rate [number]
- speed_8_reference_unit_rated_water_flow_rate [number]
- speed_8_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_8_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_8_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_8_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_8_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_8_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_8_waste_heat_function_of_temperature_curve_name [string]
- speed_9_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_9_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_9_reference_unit_gross_rated_cooling_cop [number]
- speed_9_reference_unit_rated_air_flow_rate [number]
- speed_9_reference_unit_rated_water_flow_rate [number]
- speed_9_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_9_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_9_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_9_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_9_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_9_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_9_waste_heat_function_of_temperature_curve_name [string]
- speed_10_reference_unit_gross_rated_total_cooling_capacity [number]
- speed_10_reference_unit_gross_rated_sensible_heat_ratio [number]
- speed_10_reference_unit_gross_rated_cooling_cop [number]
- speed_10_reference_unit_rated_air_flow_rate [number]
- speed_10_reference_unit_rated_water_flow_rate [number]
- speed_10_total_cooling_capacity_function_of_temperature_curve_name [string]
- speed_10_total_cooling_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_10_total_cooling_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_10_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_10_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_10_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_10_waste_heat_function_of_temperature_curve_name [string]

Coil:Heating:WaterToAirHeatPump:EquationFit¶

Direct expansion (DX) heating coil for water-to-air heat pump (includes electric compressor), single-speed, equation-fit model. Equation-fit model uses normalized curves to describe the heat pump performance.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- rated_air_flow_rate [unknown field type]
- rated_water_flow_rate [unknown field type]
- gross_rated_heating_capacity [unknown field type]
- gross_rated_heating_cop [number]
- rated_entering_water_temperature [number] (Default: 20.0)
- rated_entering_air_dry_bulb_temperature [number] (Default: 20.0)
- ratio_of_rated_heating_capacity_to_rated_cooling_capacity [number] (Default: 1.0)
- heating_capacity_curve_name [string]
- heating_power_consumption_curve_name [string]

Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit¶

Direct expansion (DX) heating coil for water-to-air heat pump (includes electric compressor), variable-speed, equation-fit model. Equation-fit model uses normalized curves to describe the heat pump performance. Requires two to ten sets of performance data and will interpolate between speeds.

Fields
- water_to_refrigerant_hx_water_inlet_node_name [string]
- water_to_refrigerant_hx_water_outlet_node_name [string]
- indoor_air_inlet_node_name [string]
- indoor_air_outlet_node_name [string]
- number_of_speeds [integer] (Default: 2)
- nominal_speed_level [integer] (Default: 2)
- rated_heating_capacity_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- rated_air_flow_rate_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- rated_water_flow_rate_at_selected_nominal_speed_level [unknown field type] (Default: Autosize)
- energy_part_load_fraction_curve_name [string]
- speed_1_reference_unit_gross_rated_heating_capacity [number]
- speed_1_reference_unit_gross_rated_heating_cop [number]
- speed_1_reference_unit_rated_air_flow [number]
- speed_1_reference_unit_rated_water_flow_rate [number]
- speed_1_heating_capacity_function_of_temperature_curve_name [string]
- speed_1_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_1_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_1_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_1_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_1_waste_heat_function_of_temperature_curve_name [string]
- speed_2_reference_unit_gross_rated_heating_capacity [number]
- speed_2_reference_unit_gross_rated_heating_cop [number]
- speed_2_reference_unit_rated_air_flow_rate [number]
- speed_2_reference_unit_rated_water_flow_rate [number]
- speed_2_heating_capacity_function_of_temperature_curve_name [string]
- speed_2_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_2_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_2_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_2_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_2_waste_heat_function_of_temperature_curve_name [string]
- speed_3_reference_unit_gross_rated_heating_capacity [number]
- speed_3_reference_unit_gross_rated_heating_cop [number]
- speed_3_reference_unit_rated_air_flow_rate [number]
- speed_3_reference_unit_rated_water_flow_rate [number]
- speed_3_heating_capacity_function_of_temperature_curve_name [string]
- speed_3_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_3_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_3_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_3_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_3_waste_heat_function_of_temperature_curve_name [string]
- speed_4_reference_unit_gross_rated_heating_capacity [number]
- speed_4_reference_unit_gross_rated_heating_cop [number]
- speed_4_reference_unit_rated_air_flow_rate [number]
- speed_4_reference_unit_rated_water_flow_rate [number]
- speed_4_heating_capacity_function_of_temperature_curve_name [string]
- speed_4_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_4_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_4_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_4_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_4_waste_heat_function_of_temperature_curve_name [string]
- speed_5_reference_unit_gross_rated_heating_capacity [number]
- speed_5_reference_unit_gross_rated_heating_cop [number]
- speed_5_reference_unit_rated_air_flow_rate [number]
- speed_5_reference_unit_rated_water_flow_rate [number]
- speed_5_heating_capacity_function_of_temperature_curve_name [string]
- speed_5_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_5_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_5_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_5_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_5_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_5_waste_heat_function_of_temperature_curve_name [string]
- speed_6_reference_unit_gross_rated_heating_capacity [number]
- speed_6_reference_unit_gross_rated_heating_cop [number]
- speed_6_reference_unit_rated_air_flow_rate [number]
- speed_6_reference_unit_rated_water_flow_rate [number]
- speed_6_heating_capacity_function_of_temperature_curve_name [string]
- speed_6_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_6_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_6_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_6_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_6_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_6_waste_heat_function_of_temperature_curve_name [string]
- speed_7_reference_unit_gross_rated_heating_capacity [number]
- speed_7_reference_unit_gross_rated_heating_cop [number]
- speed_7_reference_unit_rated_air_flow_rate [number]
- speed_7_reference_unit_rated_water_flow_rate [number]
- speed_7_heating_capacity_function_of_temperature_curve_name [string]
- speed_7_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_7_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_7_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_7_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_7_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_7_waste_heat_function_of_temperature_curve_name [string]
- speed_8_reference_unit_gross_rated_heating_capacity [number]
- speed_8_reference_unit_gross_rated_heating_cop [number]
- speed_8_reference_unit_rated_air_flow_rate [number]
- speed_8_reference_unit_rated_water_flow_rate [number]
- speed_8_heating_capacity_function_of_temperature_curve_name [string]
- speed_8_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_8_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_8_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_8_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_8_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_8_waste_heat_function_of_temperature_curve_name [string]
- speed_9_reference_unit_gross_rated_heating_capacity [number]
- speed_9_reference_unit_gross_rated_heating_cop [number]
- speed_9_reference_unit_rated_air_flow_rate [number]
- speed_9_reference_unit_rated_water_flow_rate [number]
- speed_9_heating_capacity_function_of_temperature_curve_name [string]
- speed_9_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_9_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_9_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_9_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_9_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_9_waste_heat_function_of_temperature_curve_name [string]
- speed_10_reference_unit_gross_rated_heating_capacity [number]
- speed_10_reference_unit_gross_rated_heating_cop [number]
- speed_10_reference_unit_rated_air_flow_rate [number]
- speed_10_reference_unit_rated_water_flow_rate [number]
- speed_10_heating_capacity_function_of_temperature_curve_name [string]
- speed_10_total_heating_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_10_heating_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_10_energy_input_ratio_function_of_temperature_curve_name [string]
- speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name [string]
- speed_10_energy_input_ratio_function_of_water_flow_fraction_curve_name [string]
- speed_10_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions [number]
- speed_10_waste_heat_function_of_temperature_curve_name [string]

Coil:WaterHeating:AirToWaterHeatPump:Pumped¶

Heat pump water heater (HPWH) heating coil, air-to-water direct-expansion (DX) system which includes a water heating coil, evaporator air coil, evaporator fan, electric compressor, and water pump. Part of a WaterHeater:HeatPump:PumpedCondenser system.

Fields
- rated_heating_capacity [number]
- rated_cop [number] (Default: 3.2)
- rated_sensible_heat_ratio [number] (Default: 0.85)
- rated_evaporator_inlet_air_dry_bulb_temperature [number] (Default: 19.7)
- rated_evaporator_inlet_air_wet_bulb_temperature [number] (Default: 13.5)
- rated_condenser_inlet_water_temperature [number] (Default: 57.5)
- rated_evaporator_air_flow_rate [unknown field type]
- rated_condenser_water_flow_rate [unknown field type]
- evaporator_fan_power_included_in_rated_cop [string] (Default: Yes)
- condenser_pump_power_included_in_rated_cop [string] (Default: No)
- condenser_pump_heat_included_in_rated_heating_capacity_and_rated_cop [string] (Default: No)
- condenser_water_pump_power [number] (Default: 0.0)
- fraction_of_condenser_pump_heat_to_water [number] (Default: 0.2)
- evaporator_air_inlet_node_name [string]
- evaporator_air_outlet_node_name [string]
- condenser_water_inlet_node_name [string]
- condenser_water_outlet_node_name [string]
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_ambient_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- evaporator_air_temperature_type_for_curve_objects [string] (Default: WetBulbTemperature)
- heating_capacity_function_of_temperature_curve_name [string]
- heating_capacity_function_of_air_flow_fraction_curve_name [string]
- heating_capacity_function_of_water_flow_fraction_curve_name [string]
- heating_cop_function_of_temperature_curve_name [string]
- heating_cop_function_of_air_flow_fraction_curve_name [string]
- heating_cop_function_of_water_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]

Coil:WaterHeating:AirToWaterHeatPump:Wrapped¶

Fields
- rated_heating_capacity [number]
- rated_cop [number] (Default: 3.2)
- rated_sensible_heat_ratio [number] (Default: 0.85)
- rated_evaporator_inlet_air_dry_bulb_temperature [number] (Default: 19.7)
- rated_evaporator_inlet_air_wet_bulb_temperature [number] (Default: 13.5)
- rated_condenser_water_temperature [number] (Default: 57.5)
- rated_evaporator_air_flow_rate [unknown field type]
- evaporator_fan_power_included_in_rated_cop [string] (Default: Yes)
- evaporator_air_inlet_node_name [string]
- evaporator_air_outlet_node_name [string]
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_ambient_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- evaporator_air_temperature_type_for_curve_objects [string] (Default: WetBulbTemperature)
- heating_capacity_function_of_temperature_curve_name [string]
- heating_capacity_function_of_air_flow_fraction_curve_name [string]
- heating_cop_function_of_temperature_curve_name [string]
- heating_cop_function_of_air_flow_fraction_curve_name [string]
- part_load_fraction_correlation_curve_name [string]

Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed¶

vairlable-speed Heat pump water heater (VSHPWH) heating coil, air-to-water direct-expansion (DX) system which includes a variable-speed water heating coil, evaporator air coil, evaporator fan, electric compressor, and water pump. Part of a WaterHeater:HeatPump system.

Fields
- number_of_speeds [integer] (Default: 1)
- nominal_speed_level [integer] (Default: 1)
- rated_water_heating_capacity [number]
- rated_evaporator_inlet_air_dry_bulb_temperature [number] (Default: 19.7)
- rated_evaporator_inlet_air_wet_bulb_temperature [number] (Default: 13.5)
- rated_condenser_inlet_water_temperature [number] (Default: 57.5)
- rated_evaporator_air_flow_rate [unknown field type]
- rated_condenser_water_flow_rate [unknown field type]
- evaporator_fan_power_included_in_rated_cop [string] (Default: Yes)
- condenser_pump_power_included_in_rated_cop [string] (Default: No)
- condenser_pump_heat_included_in_rated_heating_capacity_and_rated_cop [string] (Default: No)
- fraction_of_condenser_pump_heat_to_water [number] (Default: 0.2)
- evaporator_air_inlet_node_name [string]
- evaporator_air_outlet_node_name [string]
- condenser_water_inlet_node_name [string]
- condenser_water_outlet_node_name [string]
- crankcase_heater_capacity [number] (Default: 0.0)
- maximum_ambient_temperature_for_crankcase_heater_operation [number] (Default: 10.0)
- evaporator_air_temperature_type_for_curve_objects [string] (Default: WetBulbTemperature)
- part_load_fraction_correlation_curve_name [string]
- rated_water_heating_capacity_at_speed_1 [number]
- rated_water_heating_cop_at_speed_1 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_1 [number] (Default: 0.85)
- speed_1_reference_unit_rated_air_flow_rate [number]
- speed_1_reference_unit_rated_water_flow_rate [number]
- speed_1_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_1_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_1_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_1_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_1_cop_function_of_temperature_curve_name [string]
- speed_1_cop_function_of_air_flow_fraction_curve_name [string]
- speed_1_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_2 [number]
- rated_water_heating_cop_at_speed_2 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_2 [number] (Default: 0.85)
- speed_2_reference_unit_rated_air_flow_rate [number]
- speed_2_reference_unit_rated_water_flow_rate [number]
- speed_2_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_2_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_2_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_2_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_2_cop_function_of_temperature_curve_name [string]
- speed_2_cop_function_of_air_flow_fraction_curve_name [string]
- speed_2_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_3 [number]
- rated_water_heating_cop_at_speed_3 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_3 [number] (Default: 0.85)
- speed_3_reference_unit_rated_air_flow_rate [number]
- speed_3_reference_unit_rated_water_flow_rate [number]
- speed_3_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_3_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_3_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_3_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_3_cop_function_of_temperature_curve_name [string]
- speed_3_cop_function_of_air_flow_fraction_curve_name [string]
- speed_3_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_4 [number]
- rated_water_heating_cop_at_speed_4 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_4 [number] (Default: 0.85)
- speed_4_reference_unit_rated_air_flow_rate [number]
- speed_4_reference_unit_rated_water_flow_rate [number]
- speed_4_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_4_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_4_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_4_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_4_cop_function_of_temperature_curve_name [string]
- speed_4_cop_function_of_air_flow_fraction_curve_name [string]
- speed_4_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_5 [number]
- rated_water_heating_cop_at_speed_5 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_5 [number] (Default: 0.85)
- speed_5_reference_unit_rated_air_flow_rate [number]
- speed_5_reference_unit_rated_water_flow_rate [number]
- speed_5_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_5_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_5_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_5_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_5_cop_function_of_temperature_curve_name [string]
- speed_5_cop_function_of_air_flow_fraction_curve_name [string]
- speed_5_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_6 [number]
- rated_water_heating_cop_at_speed_6 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_6 [number] (Default: 0.85)
- speed_6_reference_unit_rated_air_flow_rate [number]
- speed_6_reference_unit_rated_water_flow_rate [number]
- speed_6_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_6_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_6_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_6_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_6_cop_function_of_temperature_curve_name [string]
- speed_6_cop_function_of_air_flow_fraction_curve_name [string]
- speed_6_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_7 [number]
- rated_water_heating_cop_at_speed_7 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_7 [number] (Default: 0.85)
- speed_7_reference_unit_rated_air_flow_rate [number]
- speed_7_reference_unit_rated_water_flow_rate [number]
- speed_7_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_7_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_7_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_7_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_7_cop_function_of_temperature_curve_name [string]
- speed_7_cop_function_of_air_flow_fraction_curve_name [string]
- speed_7_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_8 [number]
- rated_water_heating_cop_at_speed_8 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_8 [number] (Default: 0.85)
- speed_8_reference_unit_rated_air_flow_rate [number]
- speed_8_reference_unit_rated_water_flow_rate [number]
- speed_8_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_8_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_8_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_8_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_8_cop_function_of_temperature_curve_name [string]
- speed_8_cop_function_of_air_flow_fraction_curve_name [string]
- speed_8_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_9 [number]
- rated_water_heating_cop_at_speed_9 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_9 [number] (Default: 0.85)
- speed_9_reference_unit_rated_air_flow_rate [number]
- speed_9_reference_unit_rated_water_flow_rate [number]
- speed_9_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_9_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_9_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_9_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_9_cop_function_of_temperature_curve_name [string]
- speed_9_cop_function_of_air_flow_fraction_curve_name [string]
- speed_9_cop_function_of_water_flow_fraction_curve_name [string]
- rated_water_heating_capacity_at_speed_10 [number]
- rated_water_heating_cop_at_speed_10 [number] (Default: 3.2)
- rated_sensible_heat_ratio_at_speed_10 [number] (Default: 0.85)
- speed_10_reference_unit_rated_air_flow_rate [number]
- speed_10_reference_unit_rated_water_flow_rate [number]
- speed_10_reference_unit_water_pump_input_power_at_rated_conditions [number]
- speed_10_total_wh_capacity_function_of_temperature_curve_name [string]
- speed_10_total_wh_capacity_function_of_air_flow_fraction_curve_name [string]
- speed_10_total_wh_capacity_function_of_water_flow_fraction_curve_name [string]
- speed_10_cop_function_of_temperature_curve_name [string]
- speed_10_cop_function_of_air_flow_fraction_curve_name [string]
- speed_10_cop_function_of_water_flow_fraction_curve_name [string]

Coil:WaterHeating:Desuperheater¶

Fields
- availability_schedule_name [string]
- setpoint_temperature_schedule_name [string]
- dead_band_temperature_difference [number] (Default: 5.0)
- rated_heat_reclaim_recovery_efficiency [number]
- rated_inlet_water_temperature [number]
- rated_outdoor_air_temperature [number]
- maximum_inlet_water_temperature_for_heat_reclaim [number]
- heat_reclaim_efficiency_function_of_temperature_curve_name [string]
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- tank_object_type [string] (Default: WaterHeater:Mixed)
- tank_name [string]
- heating_source_object_type [string]
- heating_source_name [string]
- water_flow_rate [number]
- water_pump_power [number] (Default: 0.0)
- fraction_of_pump_heat_to_water [number] (Default: 0.2)
- on_cycle_parasitic_electric_load [number] (Default: 0.0)
- off_cycle_parasitic_electric_load [number] (Default: 0.0)

CoilSystem:Cooling:DX¶

Virtual container component that consists of a DX cooling coil and its associated controls. This control object supports several different types of DX cooling coils and may be placed directly in an air loop branch or outdoor air equipment list.

Fields
- availability_schedule_name [string]
- dx_cooling_coil_system_inlet_node_name [string]
- dx_cooling_coil_system_outlet_node_name [string]
- dx_cooling_coil_system_sensor_node_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- dehumidification_control_type [string] (Default: None)
- run_on_sensible_load [string] (Default: Yes)
- run_on_latent_load [string] (Default: No)
- use_outdoor_air_dx_cooling_coil [string] (Default: No)
- outdoor_air_dx_cooling_coil_leaving_minimum_air_temperature [number] (Default: 2.0)

CoilSystem:Heating:DX¶

Virtual container component that consists of a DX heating coil (heat pump) and its associated controls. This control object supports two different types of DX heating coils and may be placed directly in an air loop branch or outdoor air equipment list.

Fields
- availability_schedule_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]

CoilSystem:Cooling:Water:HeatExchangerAssisted¶

Virtual component consisting of a chilled-water cooling coil and an air-to-air heat exchanger. The air-to-air heat exchanger precools the air entering the cooling coil and reuses this energy to reheat the supply air leaving the cooling coil. This heat exchange process improves the latent removal performance of the cooling coil (lower sensible heat ratio).

Fields
- heat_exchanger_object_type [string]
- heat_exchanger_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]

CoilSystem:Cooling:DX:HeatExchangerAssisted¶

Virtual component consisting of a direct expansion (DX) cooling coil and an air-to-air heat exchanger. The air-to-air heat exchanger precools the air entering the cooling coil and reuses this energy to reheat the supply air leaving the cooling coil. This heat exchange process improves the latent removal performance of the cooling coil (lower sensible heat ratio).

Fields
- heat_exchanger_object_type [string]
- heat_exchanger_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]

CoilSystem:IntegratedHeatPump:AirSource¶

This object is used for air-source integrated heat pump, a collection of its working modes.

Fields
- supply_hot_water_flow_sensor_node_name [string]
- space_cooling_coil_name [string]
- space_heating_coil_name [string]
- dedicated_water_heating_coil_name [string]
- scwh_coil_name [string]
- scdwh_cooling_coil_name [string]
- scdwh_water_heating_coil_name [string]
- shdwh_heating_coil_name [string]
- shdwh_water_heating_coil_name [string]
- indoor_temperature_limit_for_scwh_mode [number] (Default: 20.0)
- ambient_temperature_limit_for_scwh_mode [number] (Default: 27.0)
- indoor_temperature_above_which_wh_has_higher_priority [number] (Default: 20.0)
- ambient_temperature_above_which_wh_has_higher_priority [number] (Default: 20.0)
- flag_to_indicate_load_control_in_scwh_mode [integer] (Default: 0)
- minimum_speed_level_for_scwh_mode [integer] (Default: 1)
- maximum_water_flow_volume_before_switching_from_scdwh_to_scwh_mode [number] (Default: 0.0)
- minimum_speed_level_for_scdwh_mode [integer] (Default: 1)
- maximum_running_time_before_allowing_electric_resistance_heat_use_during_shdwh_mode [number] (Default: 360.0)
- minimum_speed_level_for_shdwh_mode [integer] (Default: 1)

Coil:Cooling:DX:SingleSpeed:ThermalStorage¶

Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), single-speed with packaged integrated thermal storage for cooling.

Fields
- availability_schedule_name [string]
- operating_mode_control_method [string]
- operation_mode_control_schedule_name [string]
- storage_type [string]
- user_defined_fluid_type [string]
- fluid_storage_volume [unknown field type]
- ice_storage_capacity [unknown field type]
- storage_capacity_sizing_factor [number]
- storage_tank_ambient_temperature_node_name [string]
- storage_tank_to_ambient_u_value_times_area_heat_transfer_coefficient [number]
- fluid_storage_tank_rating_temperature [number]
- rated_evaporator_air_flow_rate [unknown field type]
- evaporator_air_inlet_node_name [string]
- evaporator_air_outlet_node_name [string]
- cooling_only_mode_available [string]
- cooling_only_mode_rated_total_evaporator_cooling_capacity [unknown field type]
- cooling_only_mode_rated_sensible_heat_ratio [number] (Default: 0.7)
- cooling_only_mode_rated_cop [number] (Default: 3.0)
- cooling_only_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name [string]
- cooling_only_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name [string]
- cooling_only_mode_energy_input_ratio_function_of_temperature_curve_name [string]
- cooling_only_mode_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- cooling_only_mode_part_load_fraction_correlation_curve_name [string]
- cooling_only_mode_sensible_heat_ratio_function_of_temperature_curve_name [string]
- cooling_only_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- cooling_and_charge_mode_available [string]
- cooling_and_charge_mode_rated_total_evaporator_cooling_capacity [unknown field type]
- cooling_and_charge_mode_capacity_sizing_factor [number] (Default: 0.5)
- cooling_and_charge_mode_rated_storage_charging_capacity [unknown field type]
- cooling_and_charge_mode_storage_capacity_sizing_factor [number] (Default: 0.5)
- cooling_and_charge_mode_rated_sensible_heat_ratio [number] (Default: 0.7)
- cooling_and_charge_mode_cooling_rated_cop [number] (Default: 3.0)
- cooling_and_charge_mode_charging_rated_cop [number] (Default: 3.0)
- cooling_and_charge_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name [string]
- cooling_and_charge_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name [string]
- cooling_and_charge_mode_evaporator_energy_input_ratio_function_of_temperature_curve_name [string]
- cooling_and_charge_mode_evaporator_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- cooling_and_charge_mode_evaporator_part_load_fraction_correlation_curve_name [string]
- cooling_and_charge_mode_storage_charge_capacity_function_of_temperature_curve_name [string]
- cooling_and_charge_mode_storage_charge_capacity_function_of_total_evaporator_plr_curve_name [string]
- cooling_and_charge_mode_storage_energy_input_ratio_function_of_temperature_curve_name [string]
- cooling_and_charge_mode_storage_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- cooling_and_charge_mode_storage_energy_part_load_fraction_correlation_curve_name [string]
- cooling_and_charge_mode_sensible_heat_ratio_function_of_temperature_curve_name [string]
- cooling_and_charge_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- cooling_and_discharge_mode_available [string]
- cooling_and_discharge_mode_rated_total_evaporator_cooling_capacity [unknown field type]
- cooling_and_discharge_mode_evaporator_capacity_sizing_factor [number] (Default: 1.0)
- cooling_and_discharge_mode_rated_storage_discharging_capacity [unknown field type]
- cooling_and_discharge_mode_storage_discharge_capacity_sizing_factor [number] (Default: 1.0)
- cooling_and_discharge_mode_rated_sensible_heat_ratio [number] (Default: 0.7)
- cooling_and_discharge_mode_cooling_rated_cop [number] (Default: 3.0)
- cooling_and_discharge_mode_discharging_rated_cop [number] (Default: 3.0)
- cooling_and_discharge_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name [string]
- cooling_and_discharge_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name [string]
- cooling_and_discharge_mode_evaporator_energy_input_ratio_function_of_temperature_curve_name [string]
- cooling_and_discharge_mode_evaporator_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- cooling_and_discharge_mode_evaporator_part_load_fraction_correlation_curve_name [string]
- cooling_and_discharge_mode_storage_discharge_capacity_function_of_temperature_curve_name [string]
- cooling_and_discharge_mode_storage_discharge_capacity_function_of_flow_fraction_curve_name [string]
- cooling_and_discharge_mode_storage_discharge_capacity_function_of_total_evaporator_plr_curve_name [string]
- cooling_and_discharge_mode_storage_energy_input_ratio_function_of_temperature_curve_name [string]
- cooling_and_discharge_mode_storage_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- cooling_and_discharge_mode_storage_energy_part_load_fraction_correlation_curve_name [string]
- cooling_and_discharge_mode_sensible_heat_ratio_function_of_temperature_curve_name [string]
- cooling_and_discharge_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- charge_only_mode_available [string]
- charge_only_mode_rated_storage_charging_capacity [unknown field type]
- charge_only_mode_capacity_sizing_factor [number] (Default: 1.0)
- charge_only_mode_charging_rated_cop [number] (Default: 3.0)
- charge_only_mode_storage_charge_capacity_function_of_temperature_curve_name [string]
- charge_only_mode_storage_energy_input_ratio_function_of_temperature_curve_name [string]
- discharge_only_mode_available [string]
- discharge_only_mode_rated_storage_discharging_capacity [unknown field type]
- discharge_only_mode_capacity_sizing_factor [number] (Default: 1.0)
- discharge_only_mode_rated_sensible_heat_ratio [number]
- discharge_only_mode_rated_cop [number] (Default: 3.0)
- discharge_only_mode_storage_discharge_capacity_function_of_temperature_curve_name [string]
- discharge_only_mode_storage_discharge_capacity_function_of_flow_fraction_curve_name [string]
- discharge_only_mode_energy_input_ratio_function_of_temperature_curve_name [string]
- discharge_only_mode_energy_input_ratio_function_of_flow_fraction_curve_name [string]
- discharge_only_mode_part_load_fraction_correlation_curve_name [string]
- discharge_only_mode_sensible_heat_ratio_function_of_temperature_curve_name [string]
- discharge_only_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name [string]
- ancillary_electric_power [number]
- cold_weather_operation_minimum_outdoor_air_temperature [number]
- cold_weather_operation_ancillary_power [number]
- condenser_air_inlet_node_name [string]
- condenser_air_outlet_node_name [string]
- condenser_design_air_flow_rate [unknown field type]
- condenser_air_flow_sizing_factor [number] (Default: 1.0)
- condenser_type [string] (Default: AirCooled)
- evaporative_condenser_effectiveness [number] (Default: 0.7)
- evaporative_condenser_pump_rated_power_consumption [unknown field type] (Default: 0.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_availability_schedule_name [string]
- supply_water_storage_tank_name [string]
- condensate_collection_water_storage_tank_name [string]
- storage_tank_plant_connection_inlet_node_name [string]
- storage_tank_plant_connection_outlet_node_name [string]
- storage_tank_plant_connection_design_flow_rate [number]
- storage_tank_plant_connection_heat_transfer_effectiveness [number] (Default: 0.7)
- storage_tank_minimum_operating_limit_fluid_temperature [number]
- storage_tank_maximum_operating_limit_fluid_temperature [number]

Evaporative Coolers¶

EvaporativeCooler:Direct:CelDekPad¶

Direct evaporative cooler with rigid media evaporative pad and recirculating water pump. This model has no controls other than its availability schedule.

Fields
- availability_schedule_name [string]
- direct_pad_area [unknown field type] (Default: Autosize)
- direct_pad_depth [unknown field type] (Default: Autosize)
- recirculating_water_pump_power_consumption [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- control_type [string]
- water_supply_storage_tank_name [string]

EvaporativeCooler:Indirect:CelDekPad¶

Indirect evaporative cooler with rigid media evaporative pad, recirculating water pump, and secondary air fan. This model has no controls other than its availability schedule.

Fields
- availability_schedule_name [string]
- direct_pad_area [unknown field type] (Default: Autosize)
- direct_pad_depth [unknown field type] (Default: Autosize)
- recirculating_water_pump_power_consumption [number]
- secondary_air_fan_flow_rate [number]
- secondary_air_fan_total_efficiency [number]
- secondary_air_fan_delta_pressure [number]
- indirect_heat_exchanger_effectiveness [number]
- primary_air_inlet_node_name [string]
- primary_air_outlet_node_name [string]
- control_type [string]
- water_supply_storage_tank_name [string]
- secondary_air_inlet_node_name [string]

EvaporativeCooler:Indirect:WetCoil¶

Indirect evaporative cooler with wetted coil, recirculating water pump, and secondary air fan. This model has no controls other than its availability schedule.

Fields
- availability_schedule_name [string]
- coil_maximum_efficiency [number]
- coil_flow_ratio [number]
- recirculating_water_pump_power_consumption [number]
- secondary_air_fan_flow_rate [number]
- secondary_air_fan_total_efficiency [number]
- secondary_air_fan_delta_pressure [number]
- primary_air_inlet_node_name [string]
- primary_air_outlet_node_name [string]
- control_type [string]
- water_supply_storage_tank_name [string]
- secondary_air_inlet_node_name [string]

EvaporativeCooler:Indirect:ResearchSpecial¶

Indirect evaporative cooler with user-specified effectiveness (can represent rigid pad or wetted coil), recirculating water pump, and secondary air fan. This model is controlled to meet the primary air outlet temperature setpoint.

Fields
- availability_schedule_name [string]
- cooler_wetbulb_design_effectiveness [number]
- wetbulb_effectiveness_flow_ratio_modifier_curve_name [string]
- cooler_drybulb_design_effectiveness [number]
- drybulb_effectiveness_flow_ratio_modifier_curve_name [string]
- recirculating_water_pump_design_power [unknown field type] (Default: Autosize)
- water_pump_power_sizing_factor [number] (Default: 90.0)
- water_pump_power_modifier_curve_name [string]
- secondary_air_design_flow_rate [unknown field type] (Default: Autosize)
- secondary_air_flow_scaling_factor [number] (Default: 1.0)
- secondary_air_fan_design_power [unknown field type] (Default: Autosize)
- secondary_air_fan_sizing_specific_power [number] (Default: 250.0)
- secondary_air_fan_power_modifier_curve_name [string]
- primary_air_inlet_node_name [string]
- primary_air_outlet_node_name [string]
- primary_air_design_flow_rate [unknown field type] (Default: Autosize)
- dewpoint_effectiveness_factor [number]
- secondary_air_inlet_node_name [string]
- secondary_air_outlet_node_name [string]
- sensor_node_name [string]
- relief_air_inlet_node_name [string]
- water_supply_storage_tank_name [string]
- drift_loss_fraction [number] (Default: 0.0)
- blowdown_concentration_ratio [number]
- evaporative_operation_minimum_limit_secondary_air_drybulb_temperature [number]
- evaporative_operation_maximum_limit_outdoor_wetbulb_temperature [number]
- dry_operation_maximum_limit_outdoor_drybulb_temperature [number]

EvaporativeCooler:Direct:ResearchSpecial¶

Direct evaporative cooler with user-specified effectiveness (can represent rigid pad or similar media), and recirculating water pump, and secondary air fan. This model is controlled to meet the primary air outlet temperature setpoint.

Fields
- availability_schedule_name [string]
- cooler_design_effectiveness [number]
- effectiveness_flow_ratio_modifier_curve_name [string]
- primary_air_design_flow_rate [unknown field type] (Default: Autosize)
- recirculating_water_pump_design_power [unknown field type] (Default: Autosize)
- water_pump_power_sizing_factor [number] (Default: 90.0)
- water_pump_power_modifier_curve_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- sensor_node_name [string]
- water_supply_storage_tank_name [string]
- drift_loss_fraction [number]
- blowdown_concentration_ratio [number]
- evaporative_operation_minimum_drybulb_temperature [number]
- evaporative_operation_maximum_limit_wetbulb_temperature [number]
- evaporative_operation_maximum_limit_drybulb_temperature [number]

Humidifiers and Dehumidifiers¶

Humidifier:Steam:Electric¶

Electrically heated steam humidifier with fan.

Fields
- availability_schedule_name [string]
- rated_capacity [unknown field type]
- rated_power [unknown field type]
- rated_fan_power [number]
- standby_power [number]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- water_storage_tank_name [string]

Humidifier:Steam:Gas¶

Natural gas fired steam humidifier with optional blower fan.

Fields
- availability_schedule_name [string]
- rated_capacity [unknown field type]
- rated_gas_use_rate [unknown field type]
- thermal_efficiency [number] (Default: 0.8)
- thermal_efficiency_modifier_curve_name [string]
- rated_fan_power [number]
- auxiliary_electric_power [number] (Default: 0.0)
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- water_storage_tank_name [string]
- inlet_water_temperature_option [string] (Default: FixedInletWaterTemperature)

Dehumidifier:Desiccant:NoFans¶

This object models a solid desiccant dehumidifier. The process air stream is the air which is dehumidified. The regeneration air stream is the air which is heated to regenerate the desiccant. This object determines the process air outlet conditions, the load on the regeneration heating coil, the electric power consumption for the wheel rotor motor, and the regeneration air fan mass flow rate. All other heat exchangers are modeled as separate objects connected to the inlet and outlet nodes of the dehumidifier. The solid desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem, but can also be specified in any AirLoopHVAC.

Fields
- availability_schedule_name [string]
- process_air_inlet_node_name [string]
- process_air_outlet_node_name [string]
- regeneration_air_inlet_node_name [string]
- regeneration_fan_inlet_node_name [string]
- control_type [string]
- leaving_maximum_humidity_ratio_setpoint [number]
- nominal_process_air_flow_rate [number]
- nominal_process_air_velocity [number]
- rotor_power [number]
- regeneration_coil_object_type [string]
- regeneration_coil_name [string]
- regeneration_fan_object_type [string]
- regeneration_fan_name [string]
- performance_model_type [string]
- leaving_dry_bulb_function_of_entering_dry_bulb_and_humidity_ratio_curve_name [string]
- leaving_dry_bulb_function_of_air_velocity_curve_name [string]
- leaving_humidity_ratio_function_of_entering_dry_bulb_and_humidity_ratio_curve_name [string]
- leaving_humidity_ratio_function_of_air_velocity_curve_name [string]
- regeneration_energy_function_of_entering_dry_bulb_and_humidity_ratio_curve_name [string]
- regeneration_energy_function_of_air_velocity_curve_name [string]
- regeneration_velocity_function_of_entering_dry_bulb_and_humidity_ratio_curve_name [string]
- regeneration_velocity_function_of_air_velocity_curve_name [string]
- nominal_regeneration_temperature [number]

Dehumidifier:Desiccant:System¶

This compound object models a desiccant heat exchanger, an optional heater, and associated fans. The process air stream is the air which is dehumidified. The regeneration air stream is the air which is heated to regenerate the desiccant. The desiccant heat exchanger transfers both sensible and latent energy between the process and regeneration air streams. The desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem, but can also be specified in any AirLoopHVAC.

Fields
- availability_schedule_name [string]
- desiccant_heat_exchanger_object_type [string]
- desiccant_heat_exchanger_name [string]
- sensor_node_name [string]
- regeneration_air_fan_object_type [string]
- regeneration_air_fan_name [string]
- regeneration_air_fan_placement [string] (Default: DrawThrough)
- regeneration_air_heater_object_type [string]
- regeneration_air_heater_name [string]
- regeneration_inlet_air_setpoint_temperature [number] (Default: 46.0)
- companion_cooling_coil_object_type [string]
- companion_cooling_coil_name [string]
- companion_cooling_coil_upstream_of_dehumidifier_process_inlet [string] (Default: No)
- companion_coil_regeneration_air_heating [string] (Default: No)
- exhaust_fan_maximum_flow_rate [number]
- exhaust_fan_maximum_power [number]
- exhaust_fan_power_curve_name [string]

Heat Recovery¶

HeatExchanger:AirToAir:FlatPlate¶

Flat plate air-to-air heat exchanger, typically used for exhaust or relief air heat recovery.

Fields
- availability_schedule_name [string]
- flow_arrangement_type [string]
- economizer_lockout [string] (Default: Yes)
- ratio_of_supply_to_secondary_ha_values [number]
- nominal_supply_air_flow_rate [unknown field type] (Default: Autosize)
- nominal_supply_air_inlet_temperature [number]
- nominal_supply_air_outlet_temperature [number]
- nominal_secondary_air_flow_rate [unknown field type]
- nominal_secondary_air_inlet_temperature [number]
- nominal_electric_power [number]
- supply_air_inlet_node_name [string]
- supply_air_outlet_node_name [string]
- secondary_air_inlet_node_name [string]
- secondary_air_outlet_node_name [string]

HeatExchanger:AirToAir:SensibleAndLatent¶

This object models an air-to-air heat exchanger using effectiveness relationships. The heat exchanger can transfer sensible energy, latent energy, or both between the supply (primary) and exhaust (secondary) air streams.

Fields
- availability_schedule_name [string]
- nominal_supply_air_flow_rate [unknown field type]
- sensible_effectiveness_at_100_heating_air_flow [number] (Default: 0.0)
- latent_effectiveness_at_100_heating_air_flow [number] (Default: 0.0)
- sensible_effectiveness_at_75_heating_air_flow [number] (Default: 0.0)
- latent_effectiveness_at_75_heating_air_flow [number] (Default: 0.0)
- sensible_effectiveness_at_100_cooling_air_flow [number] (Default: 0.0)
- latent_effectiveness_at_100_cooling_air_flow [number] (Default: 0.0)
- sensible_effectiveness_at_75_cooling_air_flow [number] (Default: 0.0)
- latent_effectiveness_at_75_cooling_air_flow [number] (Default: 0.0)
- supply_air_inlet_node_name [string]
- supply_air_outlet_node_name [string]
- exhaust_air_inlet_node_name [string]
- exhaust_air_outlet_node_name [string]
- nominal_electric_power [number] (Default: 0.0)
- supply_air_outlet_temperature_control [string] (Default: No)
- heat_exchanger_type [string] (Default: Plate)
- frost_control_type [string] (Default: None)
- threshold_temperature [number] (Default: 1.7)
- initial_defrost_time_fraction [number] (Default: 0.083)
- rate_of_defrost_time_fraction_increase [number] (Default: 0.012)
- economizer_lockout [string] (Default: Yes)

HeatExchanger:Desiccant:BalancedFlow¶

This object models a balanced desiccant heat exchanger. The heat exchanger transfers both sensible and latent energy between the process and regeneration air streams. The air flow rate and face velocity are assumed to be the same on both the process and regeneration sides of the heat exchanger.

Fields
- availability_schedule_name [string]
- regeneration_air_inlet_node_name [string]
- regeneration_air_outlet_node_name [string]
- process_air_inlet_node_name [string]
- process_air_outlet_node_name [string]
- heat_exchanger_performance_object_type [string] (Default: HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1)
- heat_exchanger_performance_name [string]
- economizer_lockout [string] (Default: No)

HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1¶

RTO = B1 + B2*RWI + B3*RTI + B4*(RWI/RTI) + B5*PWI + B6*PTI + B7*(PWI/PTI) + B8*RFV RWO = C1 + C2*RWI + C3*RTI + C4*(RWI/RTI) + C5*PWI + C6*PTI + C7*(PWI/PTI) + C8*RFV where, RTO = Dry-bulb temperature of the regeneration outlet air (C) RWO = Humidity ratio of the regeneration outlet air (kgWater/kgDryAir) RWI = Humidity ratio of the regeneration inlet air (kgWater/kgDryAir) RTI = Dry-bulb temperature of the regeneration inlet air (C) PWI = Humidity ratio of the process inlet air (kgWater/kgDryAir) PTI = Dry-bulb temperature of the process inlet air (C) RFV = Regeneration Face Velocity (m/s)

Fields
- nominal_air_flow_rate [unknown field type]
- nominal_air_face_velocity [unknown field type]
- nominal_electric_power [number] (Default: 0.0)
- temperature_equation_coefficient_1 [number]
- temperature_equation_coefficient_2 [number]
- temperature_equation_coefficient_3 [number]
- temperature_equation_coefficient_4 [number]
- temperature_equation_coefficient_5 [number]
- temperature_equation_coefficient_6 [number]
- temperature_equation_coefficient_7 [number]
- temperature_equation_coefficient_8 [number]
- minimum_regeneration_inlet_air_humidity_ratio_for_temperature_equation [number]
- maximum_regeneration_inlet_air_humidity_ratio_for_temperature_equation [number]
- minimum_regeneration_inlet_air_temperature_for_temperature_equation [number]
- maximum_regeneration_inlet_air_temperature_for_temperature_equation [number]
- minimum_process_inlet_air_humidity_ratio_for_temperature_equation [number]
- maximum_process_inlet_air_humidity_ratio_for_temperature_equation [number]
- minimum_process_inlet_air_temperature_for_temperature_equation [number]
- maximum_process_inlet_air_temperature_for_temperature_equation [number]
- minimum_regeneration_air_velocity_for_temperature_equation [number]
- maximum_regeneration_air_velocity_for_temperature_equation [number]
- minimum_regeneration_outlet_air_temperature_for_temperature_equation [number]
- maximum_regeneration_outlet_air_temperature_for_temperature_equation [number]
- minimum_regeneration_inlet_air_relative_humidity_for_temperature_equation [number]
- maximum_regeneration_inlet_air_relative_humidity_for_temperature_equation [number]
- minimum_process_inlet_air_relative_humidity_for_temperature_equation [number]
- maximum_process_inlet_air_relative_humidity_for_temperature_equation [number]
- humidity_ratio_equation_coefficient_1 [number]
- humidity_ratio_equation_coefficient_2 [number]
- humidity_ratio_equation_coefficient_3 [number]
- humidity_ratio_equation_coefficient_4 [number]
- humidity_ratio_equation_coefficient_5 [number]
- humidity_ratio_equation_coefficient_6 [number]
- humidity_ratio_equation_coefficient_7 [number]
- humidity_ratio_equation_coefficient_8 [number]
- minimum_regeneration_inlet_air_humidity_ratio_for_humidity_ratio_equation [number]
- maximum_regeneration_inlet_air_humidity_ratio_for_humidity_ratio_equation [number]
- minimum_regeneration_inlet_air_temperature_for_humidity_ratio_equation [number]
- maximum_regeneration_inlet_air_temperature_for_humidity_ratio_equation [number]
- minimum_process_inlet_air_humidity_ratio_for_humidity_ratio_equation [number]
- maximum_process_inlet_air_humidity_ratio_for_humidity_ratio_equation [number]
- minimum_process_inlet_air_temperature_for_humidity_ratio_equation [number]
- maximum_process_inlet_air_temperature_for_humidity_ratio_equation [number]
- minimum_regeneration_air_velocity_for_humidity_ratio_equation [number]
- maximum_regeneration_air_velocity_for_humidity_ratio_equation [number]
- minimum_regeneration_outlet_air_humidity_ratio_for_humidity_ratio_equation [number]
- maximum_regeneration_outlet_air_humidity_ratio_for_humidity_ratio_equation [number]
- minimum_regeneration_inlet_air_relative_humidity_for_humidity_ratio_equation [number]
- maximum_regeneration_inlet_air_relative_humidity_for_humidity_ratio_equation [number]
- minimum_process_inlet_air_relative_humidity_for_humidity_ratio_equation [number]
- maximum_process_inlet_air_relative_humidity_for_humidity_ratio_equation [number]

Unitary Equipment¶

AirLoopHVAC:UnitarySystem¶

AirloopHVAC:UnitarySystem is a generic HVAC system type that allows any configuration of coils and/or fan. This object is a replacement of other AirloopHVAC objects. This object can be used in outdoor air systems, outdoor air units, air loops, and as zone equipment if desired.

Fields
- control_type [string] (Default: Load)
- controlling_zone_or_thermostat_location [string]
- dehumidification_control_type [string] (Default: None)
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- supply_fan_object_type [string]
- supply_fan_name [string]
- fan_placement [string]
- supply_air_fan_operating_mode_schedule_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- dx_heating_coil_sizing_ratio [number] (Default: 1.0)
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- use_doas_dx_cooling_coil [string] (Default: No)
- minimum_supply_air_temperature [unknown field type] (Default: 2.0)
- latent_load_control [string] (Default: SensibleOnlyLoadControl)
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- cooling_supply_air_flow_rate_method [string]
- cooling_supply_air_flow_rate [unknown field type]
- cooling_supply_air_flow_rate_per_floor_area [number]
- cooling_fraction_of_autosized_cooling_supply_air_flow_rate [number]
- cooling_supply_air_flow_rate_per_unit_of_capacity [number]
- heating_supply_air_flow_rate_method [string]
- heating_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate_per_floor_area [number]
- heating_fraction_of_autosized_heating_supply_air_flow_rate [number]
- heating_supply_air_flow_rate_per_unit_of_capacity [number]
- no_load_supply_air_flow_rate_method [string]
- no_load_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate_per_floor_area [number]
- no_load_fraction_of_autosized_cooling_supply_air_flow_rate [number]
- no_load_fraction_of_autosized_heating_supply_air_flow_rate [number]
- no_load_supply_air_flow_rate_per_unit_of_capacity_during_cooling_operation [number]
- no_load_supply_air_flow_rate_per_unit_of_capacity_during_heating_operation [number]
- maximum_supply_air_temperature [unknown field type] (Default: 80.0)
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- outdoor_dry_bulb_temperature_sensor_node_name [string]
- maximum_cycling_rate [number] (Default: 2.5)
- heat_pump_time_constant [number] (Default: 60.0)
- fraction_of_on_cycle_power_use [number] (Default: 0.01)
- heat_pump_fan_delay_time [number] (Default: 60.0)
- ancillary_on_cycle_electric_power [number] (Default: 0.0)
- ancillary_off_cycle_electric_power [number] (Default: 0.0)
- design_heat_recovery_water_flow_rate [number] (Default: 0.0)
- maximum_temperature_for_heat_recovery [number] (Default: 80.0)
- heat_recovery_water_inlet_node_name [string]
- heat_recovery_water_outlet_node_name [string]
- design_specification_multispeed_object_type [string]
- design_specification_multispeed_object_name [string]

UnitarySystemPerformance:Multispeed¶

The UnitarySystemPerformance object is used to specify the air flow ratio at each operating speed. This object is primarily used for multispeed DX and water coils to allow operation at alternate flow rates different from those specified in the coil object.

Fields
- number_of_speeds_for_heating [integer]
- number_of_speeds_for_cooling [integer]
- single_mode_operation [string] (Default: No)
- no_load_supply_air_flow_rate_ratio [number] (Default: 1.0)
- flow_ratios [Array of {heating_speed_supply_air_flow_ratio, cooling_speed_supply_air_flow_ratio}]

AirLoopHVAC:Unitary:Furnace:HeatOnly¶

Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, electric, hot water, or steam). Identical to AirLoopHVAC:UnitaryHeatOnly.

Fields
- availability_schedule_name [string]
- furnace_air_inlet_node_name [string]
- furnace_air_outlet_node_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- maximum_supply_air_temperature [unknown field type] (Default: 80.0)
- heating_supply_air_flow_rate [unknown field type]
- controlling_zone_or_thermostat_location [string]
- supply_fan_object_type [string]
- supply_fan_name [string]
- fan_placement [string] (Default: BlowThrough)
- heating_coil_object_type [string]
- heating_coil_name [string]

AirLoopHVAC:Unitary:Furnace:HeatCool¶

Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam), and optional reheat coil for dehumidification control. Identical to AirLoopHVAC:UnitaryHeatCool.

Fields
- availability_schedule_name [string]
- furnace_air_inlet_node_name [string]
- furnace_air_outlet_node_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- maximum_supply_air_temperature [unknown field type] (Default: 80.0)
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- controlling_zone_or_thermostat_location [string]
- supply_fan_object_type [string]
- supply_fan_name [string]
- fan_placement [string] (Default: BlowThrough)
- heating_coil_object_type [string]
- heating_coil_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- dehumidification_control_type [string] (Default: None)
- reheat_coil_object_type [string]
- reheat_coil_name [string]

AirLoopHVAC:UnitaryHeatOnly¶

Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, electric, hot water, or steam). Identical to AirLoopHVAC:Unitary:Furnace:HeatOnly.

Fields
- availability_schedule_name [string]
- unitary_system_air_inlet_node_name [string]
- unitary_system_air_outlet_node_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- maximum_supply_air_temperature [unknown field type] (Default: 80.0)
- heating_supply_air_flow_rate [unknown field type]
- controlling_zone_or_thermostat_location [string]
- supply_fan_object_type [string]
- supply_fan_name [string]
- fan_placement [string] (Default: BlowThrough)
- heating_coil_object_type [string]
- heating_coil_name [string]

AirLoopHVAC:UnitaryHeatCool¶

Fields
- availability_schedule_name [string]
- unitary_system_air_inlet_node_name [string]
- unitary_system_air_outlet_node_name [string]
- supply_air_fan_operating_mode_schedule_name [string]
- maximum_supply_air_temperature [unknown field type] (Default: 80.0)
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- controlling_zone_or_thermostat_location [string]
- supply_fan_object_type [string]
- supply_fan_name [string]
- fan_placement [string] (Default: BlowThrough)
- heating_coil_object_type [string]
- heating_coil_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- dehumidification_control_type [string] (Default: None)
- reheat_coil_object_type [string]
- reheat_coil_name [string]

AirLoopHVAC:UnitaryHeatPump:AirToAir¶

Unitary heat pump system, heating and cooling, single-speed with supply fan, direct expansion (DX) cooling coil, DX heating coil (air-to-air heat pump), and supplemental heating coil (gas, electric, hot water, or steam).

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- controlling_zone_or_thermostat_location [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- maximum_supply_air_temperature_from_supplemental_heater [unknown field type]
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- fan_placement [string] (Default: BlowThrough)
- supply_air_fan_operating_mode_schedule_name [string]
- dehumidification_control_type [string] (Default: None)

AirLoopHVAC:UnitaryHeatPump:WaterToAir¶

Unitary heat pump system, heating and cooling, single-speed with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, DX heating coil (water-to-air heat pump), and supplemental heating coil (gas, electric, hot water, or steam).

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- supply_air_flow_rate [unknown field type]
- controlling_zone_or_thermostat_location [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- heating_convergence [number] (Default: 0.001)
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- cooling_convergence [number] (Default: 0.001)
- maximum_cycling_rate [number] (Default: 2.5)
- heat_pump_time_constant [number] (Default: 60.0)
- fraction_of_on_cycle_power_use [number] (Default: 0.01)
- heat_pump_fan_delay_time [number] (Default: 60.0)
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- maximum_supply_air_temperature_from_supplemental_heater [unknown field type]
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- outdoor_dry_bulb_temperature_sensor_node_name [string]
- fan_placement [string] (Default: BlowThrough)
- supply_air_fan_operating_mode_schedule_name [string]
- dehumidification_control_type [string] (Default: None)
- heat_pump_coil_water_flow_mode [string] (Default: Cycling)

AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass¶

Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, steam, or DX air-to-air heat pump) and bypass damper for variable volume flow to terminal units. Used with AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat or AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat.

Fields
- availability_schedule_name [string]
- cooling_supply_air_flow_rate [unknown field type]
- heating_supply_air_flow_rate [unknown field type]
- no_load_supply_air_flow_rate [unknown field type]
- cooling_outdoor_air_flow_rate [unknown field type]
- heating_outdoor_air_flow_rate [unknown field type]
- no_load_outdoor_air_flow_rate [unknown field type]
- outdoor_air_flow_rate_multiplier_schedule_name [string]
- air_inlet_node_name [string]
- bypass_duct_mixer_node_name [string]
- bypass_duct_splitter_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_mixer_object_type [string]
- outdoor_air_mixer_name [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- supply_air_fan_placement [string]
- supply_air_fan_operating_mode_schedule_name [string]
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- priority_control_mode [string] (Default: ZonePriority)
- minimum_outlet_air_temperature_during_cooling_operation [number] (Default: 8.0)
- maximum_outlet_air_temperature_during_heating_operation [number] (Default: 50.0)
- dehumidification_control_type [string] (Default: None)
- plenum_or_mixer_inlet_node_name [string]
- minimum_runtime_before_operating_mode_change [number] (Default: 0.25)

AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed¶

Unitary system, heating and cooling, multi-speed with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (DX air-to-air heat pump, gas, electric, hot water, or steam), and supplemental heating coil (gas, electric, hot water, or steam).

Fields
- availability_schedule_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- controlling_zone_or_thermostat_location [string]
- supply_air_fan_object_type [string]
- supply_air_fan_name [string]
- supply_air_fan_placement [string]
- supply_air_fan_operating_mode_schedule_name [string]
- heating_coil_object_type [string]
- heating_coil_name [string]
- minimum_outdoor_dry_bulb_temperature_for_compressor_operation [number] (Default: -8.0)
- cooling_coil_object_type [string]
- cooling_coil_name [string]
- supplemental_heating_coil_object_type [string]
- supplemental_heating_coil_name [string]
- maximum_supply_air_temperature_from_supplemental_heater [unknown field type]
- maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation [number] (Default: 21.0)
- auxiliary_on_cycle_electric_power [number] (Default: 0.0)
- auxiliary_off_cycle_electric_power [number] (Default: 0.0)
- design_heat_recovery_water_flow_rate [number] (Default: 0.0)
- maximum_temperature_for_heat_recovery [number] (Default: 80.0)
- heat_recovery_water_inlet_node_name [string]
- heat_recovery_water_outlet_node_name [string]
- no_load_supply_air_flow_rate [unknown field type]
- number_of_speeds_for_heating [integer]
- number_of_speeds_for_cooling [integer]
- heating_speed_1_supply_air_flow_rate [unknown field type]
- heating_speed_2_supply_air_flow_rate [unknown field type]
- heating_speed_3_supply_air_flow_rate [unknown field type]
- heating_speed_4_supply_air_flow_rate [unknown field type]
- cooling_speed_1_supply_air_flow_rate [unknown field type]
- cooling_speed_2_supply_air_flow_rate [unknown field type]
- cooling_speed_3_supply_air_flow_rate [unknown field type]
- cooling_speed_4_supply_air_flow_rate [unknown field type]

Variable Refrigerant Flow Equipment¶

AirConditioner:VariableRefrigerantFlow¶

Variable refrigerant flow (VRF) air-to-air heat pump condensing unit (includes one or more electric compressors and outdoor fan). Serves one or more VRF zone terminal units. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and ZoneTerminalUnitList.

Fields
- availability_schedule_name [string]
- gross_rated_total_cooling_capacity [unknown field type]
- gross_rated_cooling_cop [number] (Default: 3.3)
- minimum_condenser_inlet_node_temperature_in_cooling_mode [number] (Default: -6.0)
- maximum_condenser_inlet_node_temperature_in_cooling_mode [number] (Default: 43.0)
- cooling_capacity_ratio_modifier_function_of_low_temperature_curve_name [string]
- cooling_capacity_ratio_boundary_curve_name [string]
- cooling_capacity_ratio_modifier_function_of_high_temperature_curve_name [string]
- cooling_energy_input_ratio_modifier_function_of_low_temperature_curve_name [string]
- cooling_energy_input_ratio_boundary_curve_name [string]
- cooling_energy_input_ratio_modifier_function_of_high_temperature_curve_name [string]
- cooling_energy_input_ratio_modifier_function_of_low_part_load_ratio_curve_name [string]
- cooling_energy_input_ratio_modifier_function_of_high_part_load_ratio_curve_name [string]
- cooling_combination_ratio_correction_factor_curve_name [string]
- cooling_part_load_fraction_correlation_curve_name [string]
- gross_rated_heating_capacity [unknown field type]
- rated_heating_capacity_sizing_ratio [number] (Default: 1.0)
- gross_rated_heating_cop [number] (Default: 3.4)
- minimum_condenser_inlet_node_temperature_in_heating_mode [number] (Default: -20.0)
- maximum_condenser_inlet_node_temperature_in_heating_mode [number] (Default: 16.0)
- heating_capacity_ratio_modifier_function_of_low_temperature_curve_name [string]
- heating_capacity_ratio_boundary_curve_name [string]
- heating_capacity_ratio_modifier_function_of_high_temperature_curve_name [string]
- heating_energy_input_ratio_modifier_function_of_low_temperature_curve_name [string]
- heating_energy_input_ratio_boundary_curve_name [string]
- heating_energy_input_ratio_modifier_function_of_high_temperature_curve_name [string]
- heating_performance_curve_outdoor_temperature_type [string] (Default: WetBulbTemperature)
- heating_energy_input_ratio_modifier_function_of_low_part_load_ratio_curve_name [string]
- heating_energy_input_ratio_modifier_function_of_high_part_load_ratio_curve_name [string]
- heating_combination_ratio_correction_factor_curve_name [string]
- heating_part_load_fraction_correlation_curve_name [string]
- minimum_heat_pump_part_load_ratio [number] (Default: 0.15)
- zone_name_for_master_thermostat_location [string]
- master_thermostat_priority_control_type [string] (Default: MasterThermostatPriority)
- thermostat_priority_schedule_name [string]
- zone_terminal_unit_list_name [string]
- heat_pump_waste_heat_recovery [string] (Default: No)
- equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode [number]
- vertical_height_used_for_piping_correction_factor [number]
- piping_correction_factor_for_length_in_cooling_mode_curve_name [string]
- piping_correction_factor_for_height_in_cooling_mode_coefficient [number] (Default: 0.0)
- equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode [number]
- piping_correction_factor_for_length_in_heating_mode_curve_name [string]
- piping_correction_factor_for_height_in_heating_mode_coefficient [number] (Default: 0.0)
- crankcase_heater_power_per_compressor [number] (Default: 33.0)
- number_of_compressors [integer] (Default: 2)
- ratio_of_compressor_size_to_total_compressor_capacity [number] (Default: 0.5)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater [number] (Default: 5.0)
- defrost_strategy [string] (Default: Resistive)
- defrost_control [string] (Default: Timed)
- defrost_energy_input_ratio_modifier_function_of_temperature_curve_name [string]
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- condenser_type [string] (Default: AirCooled)
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- water_condenser_volume_flow_rate [unknown field type]
- evaporative_condenser_effectiveness [number] (Default: 0.9)
- evaporative_condenser_air_flow_rate [unknown field type]
- evaporative_condenser_pump_rated_power_consumption [unknown field type] (Default: 0.0)
- supply_water_storage_tank_name [string]
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- fuel_type [string] (Default: Electricity)
- minimum_condenser_inlet_node_temperature_in_heat_recovery_mode [number]
- maximum_condenser_inlet_node_temperature_in_heat_recovery_mode [number]
- heat_recovery_cooling_capacity_modifier_curve_name [string]
- initial_heat_recovery_cooling_capacity_fraction [number] (Default: 0.5)
- heat_recovery_cooling_capacity_time_constant [number] (Default: 0.15)
- heat_recovery_cooling_energy_modifier_curve_name [string]
- initial_heat_recovery_cooling_energy_fraction [number] (Default: 1.0)
- heat_recovery_cooling_energy_time_constant [number] (Default: 0.0)
- heat_recovery_heating_capacity_modifier_curve_name [string]
- initial_heat_recovery_heating_capacity_fraction [number] (Default: 1.0)
- heat_recovery_heating_capacity_time_constant [number] (Default: 0.15)
- heat_recovery_heating_energy_modifier_curve_name [string]
- initial_heat_recovery_heating_energy_fraction [number] (Default: 1.0)
- heat_recovery_heating_energy_time_constant [number] (Default: 0.0)

AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl¶

This is a key object in the new physics based VRF model applicable for Fluid Temperature Control It describes the Variable Refrigerant Flow system excluding the performance of indoor units Indoor units are modeled separately, see ZoneHVAC:TerminalUnit:VariableRefrigerantFlow

Fields
- heat_pump_name [string]
- availability_schedule_name [string]
- zone_terminal_unit_list_name [string]
- refrigerant_type [string] (Default: R410A)
- rated_evaporative_capacity [unknown field type] (Default: 40000.0)
- rated_compressor_power_per_unit_of_rated_evaporative_capacity [number] (Default: 0.35)
- minimum_outdoor_air_temperature_in_cooling_mode [number] (Default: -6.0)
- maximum_outdoor_air_temperature_in_cooling_mode [number] (Default: 43.0)
- minimum_outdoor_air_temperature_in_heating_mode [number] (Default: -20.0)
- maximum_outdoor_air_temperature_in_heating_mode [number] (Default: 16.0)
- reference_outdoor_unit_superheating [number] (Default: 3.0)
- reference_outdoor_unit_subcooling [number] (Default: 5.0)
- refrigerant_temperature_control_algorithm_for_indoor_unit [string] (Default: VariableTemp)
- reference_evaporating_temperature_for_indoor_unit [number] (Default: 6.0)
- reference_condensing_temperature_for_indoor_unit [number] (Default: 44.0)
- variable_evaporating_temperature_minimum_for_indoor_unit [number] (Default: 4.0)
- variable_evaporating_temperature_maximum_for_indoor_unit [number] (Default: 13.0)
- variable_condensing_temperature_minimum_for_indoor_unit [number] (Default: 42.0)
- variable_condensing_temperature_maximum_for_indoor_unit [number] (Default: 46.0)
- outdoor_unit_fan_power_per_unit_of_rated_evaporative_capacity [number] (Default: 0.00425)
- outdoor_unit_fan_flow_rate_per_unit_of_rated_evaporative_capacity [number] (Default: 7.5e-05)
- outdoor_unit_evaporating_temperature_function_of_superheating_curve_name [string]
- outdoor_unit_condensing_temperature_function_of_subcooling_curve_name [string]
- diameter_of_main_pipe_connecting_outdoor_unit_to_the_first_branch_joint [number] (Default: 0.0762)
- length_of_main_pipe_connecting_outdoor_unit_to_the_first_branch_joint [number] (Default: 30.0)
- equivalent_length_of_main_pipe_connecting_outdoor_unit_to_the_first_branch_joint [number] (Default: 36.0)
- height_difference_between_outdoor_unit_and_indoor_units [number] (Default: 5.0)
- main_pipe_insulation_thickness [number] (Default: 0.02)
- main_pipe_insulation_thermal_conductivity [number] (Default: 0.032)
- crankcase_heater_power_per_compressor [number] (Default: 33.0)
- number_of_compressors [integer] (Default: 2)
- ratio_of_compressor_size_to_total_compressor_capacity [number] (Default: 0.5)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater [number] (Default: 5.0)
- defrost_strategy [string] (Default: Resistive)
- defrost_control [string] (Default: Timed)
- defrost_energy_input_ratio_modifier_function_of_temperature_curve_name [string]
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- compressor_maximum_delta_pressure [number] (Default: 4500000.0)
- number_of_compressor_loading_index_entries [integer] (Default: 2)
- loading_indices [Array of {compressor_speed_at_loading_index, loading_index_evaporative_capacity_multiplier_function_of_temperature_curve_name, loading_index_compressor_power_multiplier_function_of_temperature_curve_name}]

AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR¶

This is a key object in the new physics based VRF Heat Recovery (HR) model applicable for Fluid Temperature Control. It describes the VRF HR system excluding the performance of indoor units. Indoor units are modeled separately in the ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object

Fields
- availability_schedule_name [string]
- zone_terminal_unit_list_name [string]
- refrigerant_type [string] (Default: R410A)
- rated_evaporative_capacity [unknown field type] (Default: 40000.0)
- rated_compressor_power_per_unit_of_rated_evaporative_capacity [number] (Default: 0.35)
- minimum_outdoor_air_temperature_in_cooling_only_mode [number] (Default: -6.0)
- maximum_outdoor_air_temperature_in_cooling_only_mode [number] (Default: 43.0)
- minimum_outdoor_air_temperature_in_heating_only_mode [number] (Default: -20.0)
- maximum_outdoor_air_temperature_in_heating_only_mode [number] (Default: 16.0)
- minimum_outdoor_temperature_in_heat_recovery_mode [number] (Default: -20.0)
- maximum_outdoor_temperature_in_heat_recovery_mode [number] (Default: 43.0)
- refrigerant_temperature_control_algorithm_for_indoor_unit [string] (Default: VariableTemp)
- reference_evaporating_temperature_for_indoor_unit [number] (Default: 6.0)
- reference_condensing_temperature_for_indoor_unit [number] (Default: 44.0)
- variable_evaporating_temperature_minimum_for_indoor_unit [number] (Default: 4.0)
- variable_evaporating_temperature_maximum_for_indoor_unit [number] (Default: 13.0)
- variable_condensing_temperature_minimum_for_indoor_unit [number] (Default: 42.0)
- variable_condensing_temperature_maximum_for_indoor_unit [number] (Default: 46.0)
- outdoor_unit_evaporator_reference_superheating [number] (Default: 3.0)
- outdoor_unit_condenser_reference_subcooling [number] (Default: 5.0)
- outdoor_unit_evaporator_rated_bypass_factor [number] (Default: 0.4)
- outdoor_unit_condenser_rated_bypass_factor [number] (Default: 0.2)
- difference_between_outdoor_unit_evaporating_temperature_and_outdoor_air_temperature_in_heat_recovery_mode [number] (Default: 5.0)
- outdoor_unit_heat_exchanger_capacity_ratio [number] (Default: 0.3)
- outdoor_unit_fan_power_per_unit_of_rated_evaporative_capacity [number] (Default: 0.00425)
- outdoor_unit_fan_flow_rate_per_unit_of_rated_evaporative_capacity [number] (Default: 7.5e-05)
- outdoor_unit_evaporating_temperature_function_of_superheating_curve_name [string]
- outdoor_unit_condensing_temperature_function_of_subcooling_curve_name [string]
- diameter_of_main_pipe_for_suction_gas [number] (Default: 0.0762)
- diameter_of_main_pipe_for_discharge_gas [number] (Default: 0.0762)
- length_of_main_pipe_connecting_outdoor_unit_to_the_first_branch_joint [number] (Default: 30.0)
- equivalent_length_of_main_pipe_connecting_outdoor_unit_to_the_first_branch_joint [number] (Default: 36.0)
- height_difference_between_outdoor_unit_and_indoor_units [number] (Default: 5.0)
- main_pipe_insulation_thickness [number] (Default: 0.02)
- main_pipe_insulation_thermal_conductivity [number] (Default: 0.032)
- crankcase_heater_power_per_compressor [number] (Default: 33.0)
- number_of_compressors [integer] (Default: 2)
- ratio_of_compressor_size_to_total_compressor_capacity [number] (Default: 0.5)
- maximum_outdoor_dry_bulb_temperature_for_crankcase_heater [number] (Default: 5.0)
- defrost_strategy [string] (Default: Resistive)
- defrost_control [string] (Default: Timed)
- defrost_energy_input_ratio_modifier_function_of_temperature_curve_name [string]
- defrost_time_period_fraction [number] (Default: 0.058333)
- resistive_defrost_heater_capacity [unknown field type] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- initial_heat_recovery_cooling_capacity_fraction [number] (Default: 1.0)
- heat_recovery_cooling_capacity_time_constant [number] (Default: 0.0)
- initial_heat_recovery_cooling_energy_fraction [number] (Default: 1.0)
- heat_recovery_cooling_energy_time_constant [number] (Default: 0.0)
- initial_heat_recovery_heating_capacity_fraction [number] (Default: 1.0)
- heat_recovery_heating_capacity_time_constant [number] (Default: 0.0)
- initial_heat_recovery_heating_energy_fraction [number] (Default: 1.0)
- heat_recovery_heating_energy_time_constant [number] (Default: 0.0)
- compressor_maximum_delta_pressure [number] (Default: 4500000.0)
- compressor_inverter_efficiency [number] (Default: 0.95)
- compressor_evaporative_capacity_correction_factor [number] (Default: 1.0)
- number_of_compressor_loading_index_entries [integer] (Default: 2)
- loading_indices [Array of {compressor_speed_at_loading_index, loading_index_evaporative_capacity_multiplier_function_of_temperature_curve_name, loading_index_compressor_power_multiplier_function_of_temperature_curve_name}]

ZoneTerminalUnitList¶

List of variable refrigerant flow (VRF) terminal units served by a given VRF condensing unit. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and AirConditioner:VariableRefrigerantFlow.

Fields
- zone_terminal_unit_list_name [string]
- terminal_units [Array of {zone_terminal_unit_name}]

Controllers¶

Controller:WaterCoil¶

Controller for a water coil which is located directly in an air loop branch or outdoor air equipment list. Controls the coil water flow to meet the specified leaving air setpoint(s). Used with Coil:Heating:Water, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, and CoilSystem:Cooling:Water:HeatexchangerAssisted.

Fields
- control_variable [string]
- action [string]
- actuator_variable [string]
- sensor_node_name [string]
- actuator_node_name [string]
- controller_convergence_tolerance [unknown field type] (Default: Autosize)
- maximum_actuated_flow [unknown field type] (Default: Autosize)
- minimum_actuated_flow [number] (Default: 0.0)

Controller:OutdoorAir¶

Controller to set the outdoor air flow rate for an air loop. Control options include fixed, proportional, scheduled, economizer, and demand-controlled ventilation.

Fields
- relief_air_outlet_node_name [string]
- return_air_node_name [string]
- mixed_air_node_name [string]
- actuator_node_name [string]
- minimum_outdoor_air_flow_rate [unknown field type]
- maximum_outdoor_air_flow_rate [unknown field type]
- economizer_control_type [string] (Default: NoEconomizer)
- economizer_control_action_type [string] (Default: ModulateFlow)
- economizer_maximum_limit_dry_bulb_temperature [number]
- economizer_maximum_limit_enthalpy [number]
- economizer_maximum_limit_dewpoint_temperature [number]
- electronic_enthalpy_limit_curve_name [string]
- economizer_minimum_limit_dry_bulb_temperature [number]
- lockout_type [string] (Default: NoLockout)
- minimum_limit_type [string] (Default: ProportionalMinimum)
- minimum_outdoor_air_schedule_name [string]
- minimum_fraction_of_outdoor_air_schedule_name [string]
- maximum_fraction_of_outdoor_air_schedule_name [string]
- mechanical_ventilation_controller_name [string]
- time_of_day_economizer_control_schedule_name [string]
- high_humidity_control [string] (Default: No)
- humidistat_control_zone_name [string]
- high_humidity_outdoor_air_flow_ratio [number] (Default: 1.0)
- control_high_indoor_humidity_based_on_outdoor_humidity_ratio [string] (Default: Yes)
- heat_recovery_bypass_control_type [string] (Default: BypassWhenWithinEconomizerLimits)

Controller:MechanicalVentilation¶

This object is used in conjunction with Controller:OutdoorAir to specify outdoor ventilation air based on outdoor air specified in the DesignSpecification:OutdoorAir object The Controller:OutdoorAir object is associated with a specific air loop, so the outdoor air flow rates specified in Controller:MechanicalVentilation correspond to the zones attached to that specific air loop. Duplicate groups of Zone name, Design Specification Outdoor Air Object Name, and Design Specification Zone Air Distribution Object Name to increase allowable number of entries

Fields
- availability_schedule_name [string]
- demand_controlled_ventilation [string] (Default: No)
- system_outdoor_air_method [string] (Default: Standard62.1VentilationRateProcedure)
- zone_maximum_outdoor_air_fraction [number] (Default: 1.0)
- zone_specifications [Array of {zone_or_zonelist_name, design_specification_outdoor_air_object_name, design_specification_zone_air_distribution_object_name}]

AirLoopHVAC:ControllerList¶

List controllers in order of control sequence

Fields
- controller_1_object_type [string]
- controller_1_name [string]
- controller_2_object_type [string]
- controller_2_name [string]
- controller_3_object_type [string]
- controller_3_name [string]
- controller_4_object_type [string]
- controller_4_name [string]
- controller_5_object_type [string]
- controller_5_name [string]
- controller_6_object_type [string]
- controller_6_name [string]
- controller_7_object_type [string]
- controller_7_name [string]
- controller_8_object_type [string]
- controller_8_name [string]

Air Distribution¶

AirLoopHVAC¶

Defines a central forced air system.

Fields
- controller_list_name [string]
- availability_manager_list_name [string]
- design_supply_air_flow_rate [unknown field type] (Default: 0.0)
- branch_list_name [string]
- connector_list_name [string]
- supply_side_inlet_node_name [string]
- demand_side_outlet_node_name [string]
- demand_side_inlet_node_names [string]
- supply_side_outlet_node_names [string]
- design_return_air_flow_fraction_of_supply_air_flow [number] (Default: 1.0)

AirLoopHVAC:OutdoorAirSystem:EquipmentList¶

List equipment in simulation order

Fields
- component_1_object_type [string]
- component_1_name [string]
- component_2_object_type [string]
- component_2_name [string]
- component_3_object_type [string]
- component_3_name [string]
- component_4_object_type [string]
- component_4_name [string]
- component_5_object_type [string]
- component_5_name [string]
- component_6_object_type [string]
- component_6_name [string]
- component_7_object_type [string]
- component_7_name [string]
- component_8_object_type [string]
- component_8_name [string]
- component_9_object_type [string]
- component_9_name [string]

AirLoopHVAC:OutdoorAirSystem¶

Outdoor air subsystem for an AirLoopHVAC. Includes an outdoor air mixing box and optional outdoor air conditioning equipment such as heat recovery, preheat, and precool coils. From the perspective of the primary air loop the outdoor air system is treated as a single component.

Fields
- controller_list_name [string]
- outdoor_air_equipment_list_name [string]

OutdoorAir:Mixer¶

Outdoor air mixer. Node names cannot be duplicated within a single OutdoorAir:Mixer object or across all outdoor air mixers.

Fields
- mixed_air_node_name [string]
- outdoor_air_stream_node_name [string]
- relief_air_stream_node_name [string]
- return_air_stream_node_name [string]

AirLoopHVAC:ZoneSplitter¶

Split one air stream into N outlet streams (currently 500 per air loop, but extensible). Node names cannot be duplicated within a single zone splitter (AirLoopHVAC:ZoneSplitter) list.

Fields
- inlet_node_name [string]
- nodes [Array of {outlet_node_name}]

AirLoopHVAC:SupplyPlenum¶

Connects 1 zone inlet air stream, through zone supply plenum, to one or more outlets. Node names cannot be duplicated within a single supply plenum list.

Fields
- zone_name [string]
- zone_node_name [string]
- inlet_node_name [string]
- nodes [Array of {outlet_node_name}]

AirLoopHVAC:SupplyPath¶

A supply path can only contain AirLoopHVAC:ZoneSplitter and AirLoopHVAC:SupplyPlenum objects which may be in series or parallel.

Fields
- supply_air_path_inlet_node_name [string]
- components [Array of {component_object_type, component_name}]

AirLoopHVAC:ZoneMixer¶

Mix N inlet air streams into one (currently 500 per air loop, but extensible). Node names cannot be duplicated within a single zone mixer (AirLoopHVAC:ZoneMixer) list.

Fields
- outlet_node_name [string]
- nodes [Array of {inlet_node_name}]

AirLoopHVAC:ReturnPlenum¶

Connects N zone inlet air streams, through zone return plenum, to outlet (currently 500 per air loop) Node names cannot be duplicated within a single plenum list.

Fields
- zone_name [string]
- zone_node_name [string]
- outlet_node_name [string]
- induced_air_outlet_node_or_nodelist_name [string]
- nodes [Array of {inlet_node_name}]

AirLoopHVAC:ReturnPath¶

A return air path can only contain one AirLoopHVAC:ZoneMixer and one or more AirLoopHVAC:ReturnPlenum objects.

Fields
- return_air_path_outlet_node_name [string]
- components [Array of {component_object_type, component_name}]

AirLoopHVAC:ExhaustSystem¶

Defines a general exhaust system with a central exhaust fan drawing from one or more ZoneHVAC:ExhaustControl outlet nodes via an AirLoopHVAC:ZoneMixer.

Fields
- zone_mixer_name [string]
- fan_object_type [string]
- fan_name [string]

AirLoopHVAC:DedicatedOutdoorAirSystem¶

Defines a central forced air system to provide dedicated outdoor air to multiple AirLoopHVACs.

Fields
- airloophvac_outdoorairsystem_name [string]
- availability_schedule_name [string]
- airloophvac_mixer_name [string]
- airloophvac_splitter_name [string]
- preheat_design_temperature [number]
- preheat_design_humidity_ratio [number]
- precool_design_temperature [number]
- precool_design_humidity_ratio [number]
- number_of_airloophvac [integer]
- airloophvacs [Array of {airloophvac_name}]

AirLoopHVAC:Mixer¶

Mix N inlet air streams from Relief Air Stream Node in OutdoorAir:Mixer objects served by AirLoopHVAC objects listed in AirLoopHVAC:DedicatedOutdoorAirSystem into one (currently 10 as default, but extensible). Node names cannot be duplicated within a single mixer list.

Fields
- outlet_node_name [string]
- nodes [Array of {inlet_node_name}]

AirLoopHVAC:Splitter¶

Split one air stream from AirLoopHVAC:DedicatedOutdoorAirSystem outlet node into N outlet streams (currently 10 as default, but extensible). Node names should be Outdoor Air Stream Node Name in OutdoorAir:Mixer objects served by AirLoopHVAC objects listed in AirLoopHVAC:DedicatedOutdoorAirSystem.

Fields
- inlet_node_name [string]
- nodes [Array of {outlet_node_name}]

Node-Branch Management¶

Branch¶

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

Fields
- pressure_drop_curve_name [string]
- components [Array of {component_object_type, component_name, component_inlet_node_name, component_outlet_node_name}]

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.

Fields
- branches [Array of {branch_name}]

Connector:Splitter¶

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

Fields
- inlet_branch_name [string]
- branches [Array of {outlet_branch_name}]

Connector:Mixer¶

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

Fields
- outlet_branch_name [string]
- branches [Array of {inlet_branch_name}]

ConnectorList¶

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

Fields
- connector_1_object_type [string]
- connector_1_name [string]
- connector_2_object_type [string]
- connector_2_name [string]

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

Fields
- nodes [Array of {node_name}]

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

Fields
- height_above_ground [number] (Default: -1.0)
- drybulb_temperature_schedule_name [string]
- wetbulb_temperature_schedule_name [string]
- wind_speed_schedule_name [string]
- wind_direction_schedule_name [string]
- wind_pressure_coefficient_curve_name [string]
- symmetric_wind_pressure_coefficient_curve [string] (Default: No)
- wind_angle_type [string] (Default: Absolute)

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.

Fields
- nodes [Array of {node_or_nodelist_name}]

Pipe:Adiabatic¶

Passes Inlet Node state variables to Outlet Node state variables

Fields
- inlet_node_name [string]
- outlet_node_name [string]

Pipe:Adiabatic:Steam¶

Passes Inlet Node state variables to Outlet Node state variables

Fields
- inlet_node_name [string]
- outlet_node_name [string]

Pipe:Indoor¶

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

Fields
- construction_name [string]
- fluid_inlet_node_name [string]
- fluid_outlet_node_name [string]
- environment_type [string] (Default: Zone)
- ambient_temperature_zone_name [string]
- ambient_temperature_schedule_name [string]
- ambient_air_velocity_schedule_name [string]
- pipe_inside_diameter [number]
- pipe_length [number]

Pipe:Outdoor¶

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

Fields
- construction_name [string]
- fluid_inlet_node_name [string]
- fluid_outlet_node_name [string]
- ambient_temperature_outdoor_air_node_name [string]
- pipe_inside_diameter [number]
- pipe_length [number]

Pipe:Underground¶

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

Fields
- construction_name [string]
- fluid_inlet_node_name [string]
- fluid_outlet_node_name [string]
- sun_exposure [string]
- pipe_inside_diameter [number]
- pipe_length [number]
- soil_material_name [string]
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]

PipingSystem:Underground:Domain¶

The ground domain object for underground piping system simulation.

Fields
- xmax [number]
- ymax [number]
- zmax [number]
- x_direction_mesh_density_parameter [integer] (Default: 4)
- x_direction_mesh_type [string]
- x_direction_geometric_coefficient [number] (Default: 1.3)
- y_direction_mesh_density_parameter [integer] (Default: 4)
- y_direction_mesh_type [string]
- y_direction_geometric_coefficient [number] (Default: 1.3)
- z_direction_mesh_density_parameter [integer] (Default: 4)
- z_direction_mesh_type [string]
- z_direction_geometric_coefficient [number] (Default: 1.3)
- soil_thermal_conductivity [number]
- soil_density [number]
- soil_specific_heat [number]
- soil_moisture_content_volume_fraction [number] (Default: 30.0)
- soil_moisture_content_volume_fraction_at_saturation [number] (Default: 50.0)
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]
- this_domain_includes_basement_surface_interaction [string] (Default: No)
- width_of_basement_floor_in_ground_domain [number]
- depth_of_basement_wall_in_ground_domain [number]
- shift_pipe_x_coordinates_by_basement_width [string]
- name_of_basement_wall_boundary_condition_model [string]
- name_of_basement_floor_boundary_condition_model [string]
- convergence_criterion_for_the_outer_cartesian_domain_iteration_loop [number] (Default: 0.001)
- maximum_iterations_in_the_outer_cartesian_domain_iteration_loop [integer] (Default: 500)
- evapotranspiration_ground_cover_parameter [number] (Default: 0.4)
- number_of_pipe_circuits_entered_for_this_domain [integer]
- pipe_circuits [Array of {pipe_circuit}]

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.

Fields
- pipe_thermal_conductivity [number]
- pipe_density [number]
- pipe_specific_heat [number]
- pipe_inner_diameter [number]
- pipe_outer_diameter [number]
- design_flow_rate [number]
- circuit_inlet_node [string]
- circuit_outlet_node [string]
- convergence_criterion_for_the_inner_radial_iteration_loop [number] (Default: 0.001)
- maximum_iterations_in_the_inner_radial_iteration_loop [integer] (Default: 500)
- number_of_soil_nodes_in_the_inner_radial_near_pipe_mesh_region [integer] (Default: 3)
- radial_thickness_of_inner_radial_near_pipe_mesh_region [number]
- number_of_pipe_segments_entered_for_this_pipe_circuit [integer]
- pipe_segments [Array of {pipe_segment}]

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

Fields
- x_position [number]
- y_position [number]
- flow_direction [string]

Duct¶

Passes inlet node state variables to outlet node state variables

Fields
- inlet_node_name [string]
- outlet_node_name [string]

Pumps¶

Pump:VariableSpeed¶

This pump model is described in the ASHRAE secondary HVAC toolkit.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- design_maximum_flow_rate [unknown field type]
- design_pump_head [number] (Default: 179352.0)
- design_power_consumption [unknown field type]
- motor_efficiency [number] (Default: 0.9)
- fraction_of_motor_inefficiencies_to_fluid_stream [number] (Default: 0.0)
- coefficient_1_of_the_part_load_performance_curve [number] (Default: 0.0)
- coefficient_2_of_the_part_load_performance_curve [number] (Default: 1.0)
- coefficient_3_of_the_part_load_performance_curve [number] (Default: 0.0)
- coefficient_4_of_the_part_load_performance_curve [number] (Default: 0.0)
- design_minimum_flow_rate [unknown field type] (Default: Autosize)
- pump_control_type [string] (Default: Continuous)
- pump_flow_rate_schedule_name [string]
- pump_curve_name [string]
- impeller_diameter [number]
- vfd_control_type [string]
- pump_rpm_schedule_name [string]
- minimum_pressure_schedule [string]
- maximum_pressure_schedule [string]
- minimum_rpm_schedule [string]
- maximum_rpm_schedule [string]
- zone_name [string]
- skin_loss_radiative_fraction [number]
- design_power_sizing_method [string] (Default: PowerPerFlowPerPressure)
- design_electric_power_per_unit_flow_rate [number] (Default: 348701.1)
- design_shaft_power_per_unit_flow_rate_per_unit_head [number] (Default: 1.282051282)
- design_minimum_flow_rate_fraction [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

Pump:ConstantSpeed¶

This pump model is described in the ASHRAE secondary HVAC toolkit.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- design_flow_rate [unknown field type]
- design_pump_head [number] (Default: 179352.0)
- design_power_consumption [unknown field type]
- motor_efficiency [number] (Default: 0.9)
- fraction_of_motor_inefficiencies_to_fluid_stream [number] (Default: 0.0)
- pump_control_type [string] (Default: Continuous)
- pump_flow_rate_schedule_name [string]
- pump_curve_name [string]
- impeller_diameter [number]
- rotational_speed [number]
- zone_name [string]
- skin_loss_radiative_fraction [number]
- design_power_sizing_method [string] (Default: PowerPerFlowPerPressure)
- design_electric_power_per_unit_flow_rate [number] (Default: 348701.1)
- design_shaft_power_per_unit_flow_rate_per_unit_head [number] (Default: 1.282051282)
- end_use_subcategory [string] (Default: General)

Pump:VariableSpeed:Condensate¶

This pump model is described in the ASHRAE secondary HVAC toolkit. Variable Speed Condensate pump for Steam Systems

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- design_steam_volume_flow_rate [unknown field type]
- design_pump_head [number] (Default: 179352.0)
- design_power_consumption [unknown field type]
- motor_efficiency [number] (Default: 0.9)
- fraction_of_motor_inefficiencies_to_fluid_stream [number] (Default: 0.0)
- coefficient_1_of_the_part_load_performance_curve [number] (Default: 0.0)
- coefficient_2_of_the_part_load_performance_curve [number] (Default: 1.0)
- coefficient_3_of_the_part_load_performance_curve [number] (Default: 0.0)
- coefficient_4_of_the_part_load_performance_curve [number] (Default: 0.0)
- pump_flow_rate_schedule_name [string]
- zone_name [string]
- skin_loss_radiative_fraction [number]
- design_power_sizing_method [string] (Default: PowerPerFlowPerPressure)
- design_electric_power_per_unit_flow_rate [number] (Default: 348701.1)
- design_shaft_power_per_unit_flow_rate_per_unit_head [number] (Default: 1.282051282)
- end_use_subcategory [string] (Default: General)

HeaderedPumps:ConstantSpeed¶

This Headered pump object describes a pump bank with more than 1 pump in parallel

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- total_design_flow_rate [unknown field type]
- number_of_pumps_in_bank [integer]
- flow_sequencing_control_scheme [string] (Default: Sequential)
- design_pump_head [number] (Default: 179352.0)
- design_power_consumption [unknown field type]
- motor_efficiency [number] (Default: 0.9)
- fraction_of_motor_inefficiencies_to_fluid_stream [number] (Default: 0.0)
- pump_control_type [string] (Default: Continuous)
- pump_flow_rate_schedule_name [string]
- zone_name [string]
- skin_loss_radiative_fraction [number]
- design_power_sizing_method [string] (Default: PowerPerFlowPerPressure)
- design_electric_power_per_unit_flow_rate [number] (Default: 348701.1)
- design_shaft_power_per_unit_flow_rate_per_unit_head [number] (Default: 1.282051282)
- end_use_subcategory [string] (Default: General)

HeaderedPumps:VariableSpeed¶

This Headered pump object describes a pump bank with more than 1 pump in parallel

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- total_design_flow_rate [unknown field type]
- number_of_pumps_in_bank [integer]
- flow_sequencing_control_scheme [string] (Default: Sequential)
- design_pump_head [number] (Default: 179352.0)
- design_power_consumption [unknown field type]
- motor_efficiency [number] (Default: 0.9)
- fraction_of_motor_inefficiencies_to_fluid_stream [number] (Default: 0.0)
- coefficient_1_of_the_part_load_performance_curve [number] (Default: 0.0)
- coefficient_2_of_the_part_load_performance_curve [number] (Default: 1.0)
- coefficient_3_of_the_part_load_performance_curve [number] (Default: 0.0)
- coefficient_4_of_the_part_load_performance_curve [number] (Default: 0.0)
- minimum_flow_rate_fraction [number] (Default: 0.0)
- pump_control_type [string] (Default: Continuous)
- pump_flow_rate_schedule_name [string]
- zone_name [string]
- skin_loss_radiative_fraction [number]
- design_power_sizing_method [string] (Default: PowerPerFlowPerPressure)
- design_electric_power_per_unit_flow_rate [number] (Default: 348701.1)
- design_shaft_power_per_unit_flow_rate_per_unit_head [number] (Default: 1.282051282)
- end_use_subcategory [string] (Default: General)

Plant-Condenser Flow Control¶

TemperingValve¶

Temperature-controlled diversion valve used to divert flow around one or more plant components such as a hot water heater. It can only be used on one of two branches between a Splitter and a Mixer.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- stream_2_source_node_name [string]
- temperature_setpoint_node_name [string]
- pump_outlet_node_name [string]

Non-Zone Equipment¶

LoadProfile:Plant¶

Used to simulate a scheduled plant loop demand profile. Load and flow rate are specified using schedules. Positive values are heating loads, and negative values are cooling loads. The actual load met is dependent on the performance of the supply loop components.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- load_schedule_name [string]
- peak_flow_rate [number]
- flow_rate_fraction_schedule_name [string]

Solar Collectors¶

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.

Fields
- gross_area [number]
- test_fluid [string] (Default: Water)
- test_flow_rate [number]
- test_correlation_type [string]
- coefficient_1_of_efficiency_equation [number]
- coefficient_2_of_efficiency_equation [number]
- coefficient_3_of_efficiency_equation [number]
- coefficient_2_of_incident_angle_modifier [number]
- coefficient_3_of_incident_angle_modifier [number]

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.

Fields
- solarcollectorperformance_name [string]
- surface_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- maximum_flow_rate [number]

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.

Fields
- surface_name [string]
- photovoltaic_thermal_model_performance_name [string]
- photovoltaic_name [string]
- thermal_working_fluid_type [string]
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- design_flow_rate [unknown field type]

SolarCollectorPerformance:PhotovoltaicThermal:Simple¶

Thermal performance parameters for a hybrid photovoltaic-thermal (PVT) solar collector.

Fields
- fraction_of_surface_area_with_active_thermal_collector [number]
- thermal_conversion_efficiency_input_mode_type [string]
- value_for_thermal_conversion_efficiency_if_fixed [number]
- thermal_conversion_efficiency_schedule_name [string]
- front_surface_emittance [number] (Default: 0.84)

SolarCollectorPerformance:PhotovoltaicThermal:BIPVT¶

Thermal performance parameters for Building-Integrated Photovoltaic-Thermal (BIPVT) solar collector.

Fields
- boundary_conditions_model_name [string]
- availability_schedule_name [string]
- effective_plenum_gap_thickness_behind_pv_modules [number]
- pv_cell_normal_transmittance_absorptance_product [number] (Default: 0.957)
- backing_material_normal_transmittance_absorptance_product [number] (Default: 0.87)
- cladding_normal_transmittance_absorptance_product [number] (Default: 0.85)
- fraction_of_collector_gross_area_covered_by_pv_module [number] (Default: 0.85)
- fraction_of_pv_cell_area_to_pv_module_area [number] (Default: 0.9)
- pv_module_top_thermal_resistance [number] (Default: 0.0044)
- pv_module_bottom_thermal_resistance [number] (Default: 0.0039)
- pv_module_front_longwave_emissivity [number] (Default: 0.85)
- pv_module_back_longwave_emissivity [number] (Default: 0.9)
- glass_thickness [number] (Default: 0.002)
- glass_refraction_index [number] (Default: 1.526)
- glass_extinction_coefficient [number] (Default: 4.0)

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.

Fields
- integralcollectorstorageparameters_name [string]
- surface_name [string]
- bottom_surface_boundary_conditions_type [string] (Default: AmbientAir)
- boundary_condition_model_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- maximum_flow_rate [number]

SolarCollectorPerformance:IntegralCollectorStorage¶

Thermal and optical performance parameters for a single glazed solar collector with integral storage unit.

Fields
- ics_collector_type [string] (Default: RectangularTank)
- gross_area [number]
- collector_water_volume [number]
- bottom_heat_loss_conductance [number] (Default: 0.4)
- side_heat_loss_conductance [number] (Default: 0.6)
- aspect_ratio [number] (Default: 0.8)
- collector_side_height [number] (Default: 0.2)
- thermal_mass_of_absorber_plate [number] (Default: 0.0)
- number_of_covers [integer] (Default: 2)
- cover_spacing [number] (Default: 0.05)
- refractive_index_of_outer_cover [number] (Default: 1.526)
- extinction_coefficient_times_thickness_of_outer_cover [number] (Default: 0.045)
- emissivity_of_outer_cover [number] (Default: 0.88)
- refractive_index_of_inner_cover [number] (Default: 1.37)
- extinction_coefficient_times_thickness_of_the_inner_cover [number] (Default: 0.008)
- emissivity_of_inner_cover [number] (Default: 0.88)
- absorptance_of_absorber_plate [number] (Default: 0.96)
- emissivity_of_absorber_plate [number] (Default: 0.3)

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.

Fields
- boundary_conditions_model_name [string]
- availability_schedule_name [string]
- inlet_node_name [string]
- outlet_node_name [string]
- setpoint_node_name [string]
- zone_node_name [string]
- free_heating_setpoint_schedule_name [string]
- diameter_of_perforations_in_collector [number]
- distance_between_perforations_in_collector [number]
- thermal_emissivity_of_collector_surface [number]
- solar_absorbtivity_of_collector_surface [number]
- effective_overall_height_of_collector [number]
- effective_gap_thickness_of_plenum_behind_collector [number]
- effective_cross_section_area_of_plenum_behind_collector [number]
- hole_layout_pattern_for_pitch [string] (Default: Square)
- heat_exchange_effectiveness_correlation [string] (Default: Kutscher1994)
- ratio_of_actual_collector_surface_area_to_projected_surface_area [number] (Default: 1.0)
- roughness_of_collector [string]
- collector_thickness [number]
- effectiveness_for_perforations_with_respect_to_wind [number] (Default: 0.25)
- discharge_coefficient_for_openings_with_respect_to_buoyancy_driven_flow [number] (Default: 0.65)
- surfaces [Array of {surface_name}]

SolarCollector:UnglazedTranspired:Multisystem¶

quad-tuples of inlet, outlet, control, and zone nodes for multiple different outdoor air systems attached to same collector

Fields
- solar_collector_name [string]
- systems [Array of {outdoor_air_system_collector_inlet_node, outdoor_air_system_collector_outlet_node, outdoor_air_system_mixed_air_node, outdoor_air_system_zone_node}]

Plant Heating and Cooling Equipment¶

Boiler:HotWater¶

This boiler model is an adaptation of the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Boiler performance curves are generated by fitting catalog data to polynomial equations. A constant efficiency boiler may be modeled by leaving the normalized boiler efficiency curve name input blank.

Fields
- fuel_type [string]
- nominal_capacity [unknown field type]
- nominal_thermal_efficiency [number]
- efficiency_curve_temperature_evaluation_variable [string]
- normalized_boiler_efficiency_curve_name [string]
- design_water_flow_rate [unknown field type] (Default: Autosize)
- minimum_part_load_ratio [number] (Default: 0.0)
- maximum_part_load_ratio [number] (Default: 1.0)
- optimum_part_load_ratio [number] (Default: 1.0)
- boiler_water_inlet_node_name [string]
- boiler_water_outlet_node_name [string]
- water_outlet_upper_temperature_limit [number] (Default: 99.9)
- boiler_flow_mode [string] (Default: NotModulated)
- parasitic_electric_load [number] (Default: 0.0)
- sizing_factor [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)

Boiler:Steam¶

This boiler model is an adaptation of the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Boiler performance curves are generated by fitting catalog data to third order polynomial equations. A constant efficiency boiler is modeled by setting the fuel use coefficients as follows: N9=1, N10=0, N11=0

Fields
- fuel_type [string]
- maximum_operating_pressure [number] (Default: 160000.0)
- theoretical_efficiency [number] (Default: 0.8)
- design_outlet_steam_temperature [number] (Default: 100.0)
- nominal_capacity [unknown field type]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- coefficient_1_of_fuel_use_function_of_part_load_ratio_curve [number]
- coefficient_2_of_fuel_use_function_of_part_load_ratio_curve [number]
- coefficient_3_of_fuel_use_function_of_part_load_ratio_curve [number]
- water_inlet_node_name [string]
- steam_outlet_node_name [string]
- sizing_factor [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)

Chiller:Electric:ASHRAE205¶

This chiller model utilizes ASHRAE Standard 205 compliant representations for chillers (Representation Specification RS0001).

Fields
- representation_file_name [string]
- performance_interpolation_method [string] (Default: Linear)
- rated_capacity [unknown field type] (Default: Autosize)
- sizing_factor [number] (Default: 1.0)
- ambient_temperature_indicator [string]
- ambient_temperature_schedule_name [string]
- ambient_temperature_zone_name [string]
- ambient_temperature_outdoor_air_node_name [string]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- chilled_water_maximum_requested_flow_rate [unknown field type] (Default: Autosize)
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- condenser_maximum_requested_flow_rate [unknown field type] (Default: Autosize)
- chiller_flow_mode [string] (Default: NotModulated)
- oil_cooler_inlet_node_name [string]
- oil_cooler_outlet_node_name [string]
- oil_cooler_design_flow_rate [number]
- auxiliary_inlet_node_name [string]
- auxiliary_outlet_node_name [string]
- auxiliary_cooling_design_flow_rate [number]
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- end_use_subcategory [string] (Default: General)

Chiller:Electric:EIR¶

This chiller model is the empirical model from the DOE-2 building Energy simulation program. Chiller performance at off-reference conditions is modeled using three polynomial equations. Three curves objects are required.

Fields
- reference_capacity [unknown field type]
- reference_cop [number]
- reference_leaving_chilled_water_temperature [number] (Default: 6.67)
- reference_entering_condenser_fluid_temperature [number] (Default: 29.4)
- reference_chilled_water_flow_rate [unknown field type]
- reference_condenser_fluid_flow_rate [unknown field type]
- cooling_capacity_function_of_temperature_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- minimum_part_load_ratio [number] (Default: 0.1)
- maximum_part_load_ratio [number] (Default: 1.0)
- optimum_part_load_ratio [number] (Default: 1.0)
- minimum_unloading_ratio [number] (Default: 0.2)
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- condenser_type [string] (Default: WaterCooled)
- condenser_fan_power_ratio [number] (Default: 0.0)
- fraction_of_compressor_electric_consumption_rejected_by_condenser [number] (Default: 1.0)
- leaving_chilled_water_lower_temperature_limit [number] (Default: 2.0)
- chiller_flow_mode [string] (Default: NotModulated)
- design_heat_recovery_water_flow_rate [unknown field type] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- sizing_factor [number] (Default: 1.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- condenser_heat_recovery_relative_capacity_fraction [number]
- heat_recovery_inlet_high_temperature_limit_schedule_name [string]
- heat_recovery_leaving_temperature_setpoint_node_name [string]
- end_use_subcategory [string] (Default: General)

Chiller:Electric:ReformulatedEIR¶

This chiller model is an empirical model, a reformulated version of Chiller:Electric:EIR where the performance is a function of condenser leaving fluid Temperature instead of condenser entering fluid Temperature. Chiller performance at off-reference conditions is modeled using three polynomial equations. Three curve objects are required.

Fields
- reference_capacity [unknown field type]
- reference_cop [number]
- reference_leaving_chilled_water_temperature [number] (Default: 6.67)
- reference_leaving_condenser_water_temperature [number] (Default: 35.0)
- reference_chilled_water_flow_rate [unknown field type]
- reference_condenser_water_flow_rate [unknown field type]
- cooling_capacity_function_of_temperature_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_type [string] (Default: LeavingCondenserWaterTemperature)
- electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- minimum_part_load_ratio [number] (Default: 0.1)
- maximum_part_load_ratio [number] (Default: 1.0)
- optimum_part_load_ratio [number] (Default: 1.0)
- minimum_unloading_ratio [number] (Default: 0.2)
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- fraction_of_compressor_electric_consumption_rejected_by_condenser [number] (Default: 1.0)
- leaving_chilled_water_lower_temperature_limit [number] (Default: 2.0)
- chiller_flow_mode_type [string] (Default: NotModulated)
- design_heat_recovery_water_flow_rate [unknown field type] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- sizing_factor [number] (Default: 1.0)
- condenser_heat_recovery_relative_capacity_fraction [number]
- heat_recovery_inlet_high_temperature_limit_schedule_name [string]
- heat_recovery_leaving_temperature_setpoint_node_name [string]
- end_use_subcategory [string] (Default: General)

Chiller:Electric¶

This chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. Three sets of coefficients are required.

Fields
- condenser_type [string] (Default: AirCooled)
- nominal_capacity [unknown field type]
- nominal_cop [number]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- design_condenser_inlet_temperature [number]
- temperature_rise_coefficient [number]
- design_chilled_water_outlet_temperature [number]
- design_chilled_water_flow_rate [unknown field type]
- design_condenser_fluid_flow_rate [unknown field type]
- coefficient_1_of_capacity_ratio_curve [number]
- coefficient_2_of_capacity_ratio_curve [number]
- coefficient_3_of_capacity_ratio_curve [number]
- coefficient_1_of_power_ratio_curve [number]
- coefficient_2_of_power_ratio_curve [number]
- coefficient_3_of_power_ratio_curve [number]
- coefficient_1_of_full_load_ratio_curve [number]
- coefficient_2_of_full_load_ratio_curve [number]
- coefficient_3_of_full_load_ratio_curve [number]
- chilled_water_outlet_temperature_lower_limit [number]
- chiller_flow_mode [string] (Default: NotModulated)
- design_heat_recovery_water_flow_rate [unknown field type] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- sizing_factor [number] (Default: 1.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- condenser_heat_recovery_relative_capacity_fraction [number]
- heat_recovery_inlet_high_temperature_limit_schedule_name [string]
- heat_recovery_leaving_temperature_setpoint_node_name [string]
- end_use_subcategory [string] (Default: General)

Chiller:Absorption:Indirect¶

This indirect absorption chiller model is an enhanced model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. The chiller capacity is a function of condenser, chilled water, and generator temperatures. The heat input is a function of part-load ratio, condenser temperature, and chilled water temperature.

Fields
- nominal_capacity [unknown field type]
- nominal_pumping_power [unknown field type]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- design_condenser_inlet_temperature [number] (Default: 30.0)
- condenser_inlet_temperature_lower_limit [number] (Default: 15.0)
- chilled_water_outlet_temperature_lower_limit [number] (Default: 5.0)
- design_chilled_water_flow_rate [unknown field type] (Default: Autosize)
- design_condenser_water_flow_rate [unknown field type] (Default: Autosize)
- chiller_flow_mode [string] (Default: NotModulated)
- generator_heat_input_function_of_part_load_ratio_curve_name [string]
- pump_electric_input_function_of_part_load_ratio_curve_name [string]
- generator_inlet_node_name [string]
- generator_outlet_node_name [string]
- capacity_correction_function_of_condenser_temperature_curve_name [string]
- capacity_correction_function_of_chilled_water_temperature_curve_name [string]
- capacity_correction_function_of_generator_temperature_curve_name [string]
- generator_heat_input_correction_function_of_condenser_temperature_curve_name [string]
- generator_heat_input_correction_function_of_chilled_water_temperature_curve_name [string]
- generator_heat_source_type [string] (Default: Steam)
- design_generator_fluid_flow_rate [unknown field type]
- temperature_lower_limit_generator_inlet [number] (Default: 0.0)
- degree_of_subcooling_in_steam_generator [number] (Default: 1.0)
- degree_of_subcooling_in_steam_condensate_loop [number] (Default: 0.0)
- sizing_factor [number] (Default: 1.0)

Chiller:Absorption¶

This indirect absorption chiller model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Chiller performance curves are generated by fitting catalog data to third order polynomial equations. Two sets of coefficients are required.

Fields
- nominal_capacity [unknown field type]
- nominal_pumping_power [unknown field type]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- design_condenser_inlet_temperature [number]
- design_chilled_water_flow_rate [unknown field type]
- design_condenser_water_flow_rate [unknown field type]
- coefficient_1_of_the_hot_water_or_steam_use_part_load_ratio_curve [number]
- coefficient_2_of_the_hot_water_or_steam_use_part_load_ratio_curve [number]
- coefficient_3_of_the_hot_water_or_steam_use_part_load_ratio_curve [number]
- coefficient_1_of_the_pump_electric_use_part_load_ratio_curve [number]
- coefficient_2_of_the_pump_electric_use_part_load_ratio_curve [number]
- coefficient_3_of_the_pump_electric_use_part_load_ratio_curve [number]
- chilled_water_outlet_temperature_lower_limit [number]
- generator_inlet_node_name [string]
- generator_outlet_node_name [string]
- chiller_flow_mode [string] (Default: NotModulated)
- generator_heat_source_type [string] (Default: Steam)
- design_generator_fluid_flow_rate [unknown field type]
- degree_of_subcooling_in_steam_generator [number] (Default: 1.0)
- sizing_factor [number] (Default: 1.0)

Chiller:ConstantCOP¶

This constant COP chiller model provides a means of quickly specifying a Chiller where performance data is not available.

Fields
- nominal_capacity [unknown field type]
- nominal_cop [number]
- design_chilled_water_flow_rate [unknown field type]
- design_condenser_water_flow_rate [unknown field type]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- condenser_type [string] (Default: AirCooled)
- chiller_flow_mode [string] (Default: NotModulated)
- sizing_factor [number] (Default: 1.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]

Chiller:EngineDriven¶

Fields
- condenser_type [string] (Default: AirCooled)
- nominal_capacity [unknown field type]
- nominal_cop [number]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- design_condenser_inlet_temperature [number]
- temperature_rise_coefficient [number]
- design_chilled_water_outlet_temperature [number]
- design_chilled_water_flow_rate [unknown field type]
- design_condenser_water_flow_rate [unknown field type]
- coefficient_1_of_capacity_ratio_curve [number]
- coefficient_2_of_capacity_ratio_curve [number]
- coefficient_3_of_capacity_ratio_curve [number]
- coefficient_1_of_power_ratio_curve [number]
- coefficient_2_of_power_ratio_curve [number]
- coefficient_3_of_power_ratio_curve [number]
- coefficient_1_of_full_load_ratio_curve [number]
- coefficient_2_of_full_load_ratio_curve [number]
- coefficient_3_of_full_load_ratio_curve [number]
- chilled_water_outlet_temperature_lower_limit [number]
- fuel_use_curve_name [string]
- jacket_heat_recovery_curve_name [string]
- lube_heat_recovery_curve_name [string]
- total_exhaust_energy_curve_name [string]
- exhaust_temperature_curve_name [string]
- coefficient_1_of_u_factor_times_area_curve [number]
- coefficient_2_of_u_factor_times_area_curve [number]
- maximum_exhaust_flow_per_unit_of_power_output [number]
- design_minimum_exhaust_temperature [number]
- fuel_type [string]
- fuel_higher_heating_value [number]
- design_heat_recovery_water_flow_rate [unknown field type] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- chiller_flow_mode [string] (Default: NotModulated)
- maximum_temperature_for_heat_recovery_at_heat_recovery_outlet_node [number] (Default: 60.0)
- sizing_factor [number] (Default: 1.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- condenser_heat_recovery_relative_capacity_fraction [number]

Chiller:CombustionTurbine¶

Fields
- condenser_type [string] (Default: AirCooled)
- nominal_capacity [unknown field type]
- nominal_cop [number]
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- design_condenser_inlet_temperature [number]
- temperature_rise_coefficient [number]
- design_chilled_water_outlet_temperature [number]
- design_chilled_water_flow_rate [unknown field type]
- design_condenser_water_flow_rate [unknown field type]
- coefficient_1_of_capacity_ratio_curve [number]
- coefficient_2_of_capacity_ratio_curve [number]
- coefficient_3_of_capacity_ratio_curve [number]
- coefficient_1_of_power_ratio_curve [number]
- coefficient_2_of_power_ratio_curve [number]
- coefficient_3_of_power_ratio_curve [number]
- coefficient_1_of_full_load_ratio_curve [number]
- coefficient_2_of_full_load_ratio_curve [number]
- coefficient_3_of_full_load_ratio_curve [number]
- chilled_water_outlet_temperature_lower_limit [number]
- coefficient_1_of_fuel_input_curve [number]
- coefficient_2_of_fuel_input_curve [number]
- coefficient_3_of_fuel_input_curve [number]
- coefficient_1_of_temperature_based_fuel_input_curve [number]
- coefficient_2_of_temperature_based_fuel_input_curve [number]
- coefficient_3_of_temperature_based_fuel_input_curve [number]
- coefficient_1_of_exhaust_flow_curve [number]
- coefficient_2_of_exhaust_flow_curve [number]
- coefficient_3_of_exhaust_flow_curve [number]
- coefficient_1_of_exhaust_gas_temperature_curve [number]
- coefficient_2_of_exhaust_gas_temperature_curve [number]
- coefficient_3_of_exhaust_gas_temperature_curve [number]
- coefficient_1_of_temperature_based_exhaust_gas_temperature_curve [number]
- coefficient_2_of_temperature_based_exhaust_gas_temperature_curve [number]
- coefficient_3_of_temperature_based_exhaust_gas_temperature_curve [number]
- coefficient_1_of_recovery_lube_heat_curve [number]
- coefficient_2_of_recovery_lube_heat_curve [number]
- coefficient_3_of_recovery_lube_heat_curve [number]
- coefficient_1_of_u_factor_times_area_curve [number]
- coefficient_2_of_u_factor_times_area_curve [number]
- gas_turbine_engine_capacity [unknown field type]
- maximum_exhaust_flow_per_unit_of_power_output [number]
- design_steam_saturation_temperature [number]
- fuel_higher_heating_value [number]
- design_heat_recovery_water_flow_rate [unknown field type] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- chiller_flow_mode [string] (Default: NotModulated)
- fuel_type [string] (Default: NaturalGas)
- heat_recovery_maximum_temperature [number] (Default: 80.0)
- sizing_factor [number] (Default: 1.0)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- condenser_heat_recovery_relative_capacity_fraction [number]
- turbine_engine_efficiency [number] (Default: 0.35)

ChillerHeater:Absorption:DirectFired¶

Direct fired gas absorption chiller-heater using performance curves similar to DOE-2

Fields
- nominal_cooling_capacity [unknown field type] (Default: Autosize)
- heating_to_cooling_capacity_ratio [number] (Default: 0.8)
- fuel_input_to_cooling_output_ratio [number] (Default: 0.97)
- fuel_input_to_heating_output_ratio [number] (Default: 1.25)
- electric_input_to_cooling_output_ratio [number] (Default: 0.01)
- electric_input_to_heating_output_ratio [number] (Default: 0.0)
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- hot_water_inlet_node_name [string]
- hot_water_outlet_node_name [string]
- minimum_part_load_ratio [number] (Default: 0.1)
- maximum_part_load_ratio [number] (Default: 1.0)
- optimum_part_load_ratio [number] (Default: 1.0)
- design_entering_condenser_water_temperature [number] (Default: 29.0)
- design_leaving_chilled_water_temperature [number] (Default: 7.0)
- design_chilled_water_flow_rate [unknown field type] (Default: Autosize)
- design_condenser_water_flow_rate [unknown field type] (Default: Autosize)
- design_hot_water_flow_rate [unknown field type] (Default: Autosize)
- cooling_capacity_function_of_temperature_curve_name [string]
- fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- heating_capacity_function_of_cooling_capacity_curve_name [string]
- fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name [string]
- temperature_curve_input_variable [string] (Default: EnteringCondenser)
- condenser_type [string] (Default: WaterCooled)
- chilled_water_temperature_lower_limit [number] (Default: 2.0)
- fuel_higher_heating_value [number] (Default: 0.0)
- fuel_type [string] (Default: NaturalGas)
- sizing_factor [number] (Default: 1.0)

ChillerHeater:Absorption:DoubleEffect¶

Exhaust fired absorption chiller-heater using performance curves similar to DOE-2

Fields
- nominal_cooling_capacity [unknown field type] (Default: Autosize)
- heating_to_cooling_capacity_ratio [number] (Default: 0.8)
- thermal_energy_input_to_cooling_output_ratio [number] (Default: 0.97)
- thermal_energy_input_to_heating_output_ratio [number] (Default: 1.25)
- electric_input_to_cooling_output_ratio [number] (Default: 0.01)
- electric_input_to_heating_output_ratio [number] (Default: 0.0)
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- condenser_inlet_node_name [string]
- condenser_outlet_node_name [string]
- hot_water_inlet_node_name [string]
- hot_water_outlet_node_name [string]
- minimum_part_load_ratio [number] (Default: 0.1)
- maximum_part_load_ratio [number] (Default: 1.0)
- optimum_part_load_ratio [number] (Default: 1.0)
- design_entering_condenser_water_temperature [number] (Default: 29.0)
- design_leaving_chilled_water_temperature [number] (Default: 7.0)
- design_chilled_water_flow_rate [unknown field type] (Default: Autosize)
- design_condenser_water_flow_rate [unknown field type] (Default: Autosize)
- design_hot_water_flow_rate [unknown field type] (Default: Autosize)
- cooling_capacity_function_of_temperature_curve_name [string]
- fuel_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- fuel_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- heating_capacity_function_of_cooling_capacity_curve_name [string]
- fuel_input_to_heat_output_ratio_during_heating_only_operation_curve_name [string]
- temperature_curve_input_variable [string] (Default: EnteringCondenser)
- condenser_type [string] (Default: WaterCooled)
- chilled_water_temperature_lower_limit [number] (Default: 2.0)
- exhaust_source_object_type [string]
- exhaust_source_object_name [string]
- sizing_factor [number] (Default: 1.0)

HeatPump:PlantLoop:EIR:Cooling¶

An EIR formulated water to water heat pump model, cooling operation.

Fields
- load_side_inlet_node_name [string]
- load_side_outlet_node_name [string]
- condenser_type [string] (Default: WaterSource)
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- companion_heat_pump_name [string]
- load_side_reference_flow_rate [unknown field type] (Default: Autosize)
- source_side_reference_flow_rate [unknown field type] (Default: Autosize)
- reference_capacity [unknown field type] (Default: Autosize)
- reference_coefficient_of_performance [number] (Default: 7.5)
- sizing_factor [number] (Default: 1.0)
- capacity_modifier_function_of_temperature_curve_name [string]
- electric_input_to_output_ratio_modifier_function_of_temperature_curve_name [string]
- electric_input_to_output_ratio_modifier_function_of_part_load_ratio_curve_name [string]

HeatPump:PlantLoop:EIR:Heating¶

An EIR formulated water to water heat pump model, heating operation

Fields
- load_side_inlet_node_name [string]
- load_side_outlet_node_name [string]
- condenser_type [string] (Default: WaterSource)
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- companion_heat_pump_name [string]
- load_side_reference_flow_rate [unknown field type] (Default: Autosize)
- source_side_reference_flow_rate [unknown field type] (Default: Autosize)
- reference_capacity [unknown field type] (Default: Autosize)
- reference_coefficient_of_performance [number] (Default: 7.5)
- sizing_factor [number] (Default: 1.0)
- capacity_modifier_function_of_temperature_curve_name [string]
- electric_input_to_output_ratio_modifier_function_of_temperature_curve_name [string]
- electric_input_to_output_ratio_modifier_function_of_part_load_ratio_curve_name [string]

HeatPump:AirToWater:FuelFired:Heating¶

The object defines a fuel-fired absorption heat pump based on equation-fit models.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_source_node_name [string]
- companion_cooling_heat_pump_name [string]
- fuel_type [string] (Default: NaturalGas)
- end_use_subcategory [string] (Default: General)
- nominal_heating_capacity [unknown field type]
- nominal_cop [number] (Default: 1.0)
- design_flow_rate [unknown field type]
- design_supply_temperature [number] (Default: 60.0)
- design_temperature_lift [unknown field type] (Default: 11.1)
- sizing_factor [number] (Default: 1.0)
- flow_mode [string] (Default: NotModulated)
- outdoor_air_temperature_curve_input_variable [string] (Default: DryBulb)
- water_temperature_curve_input_variable [string] (Default: EnteringCondenser)
- normalized_capacity_function_of_temperature_curve_name [string]
- fuel_energy_input_ratio_function_of_temperature_curve_name [string]
- fuel_energy_input_ratio_function_of_plr_curve_name [string]
- minimum_part_load_ratio [number] (Default: 0.1)
- maximum_part_load_ratio [number] (Default: 1.0)
- defrost_control_type [string] (Default: Timed)
- defrost_operation_time_fraction [number] (Default: 0.0)
- fuel_energy_input_ratio_defrost_adjustment_curve_name [string]
- resistive_defrost_heater_capacity [number] (Default: 0.0)
- maximum_outdoor_dry_bulb_temperature_for_defrost_operation [number] (Default: 5.0)
- cycling_ratio_factor_curve_name [string]
- nominal_auxiliary_electric_power [number]
- auxiliary_electric_energy_input_ratio_function_of_temperature_curve_name [string]
- auxiliary_electric_energy_input_ratio_function_of_plr_curve_name [string]
- standby_electric_power [number] (Default: 0.0)

HeatPump:AirToWater:FuelFired:Cooling¶

The object defines a fuel-fired absorption heat pump based on equation-fit models.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- air_source_node_name [string]
- companion_heating_heat_pump_name [string]
- fuel_type [string] (Default: NaturalGas)
- end_use_subcategory [string] (Default: General)
- nominal_cooling_capacity [unknown field type]
- nominal_cop [number] (Default: 1.0)
- design_flow_rate [unknown field type]
- design_supply_temperature [number] (Default: 7.0)
- design_temperature_lift [unknown field type] (Default: 11.1)
- sizing_factor [number] (Default: 1.0)
- flow_mode [string] (Default: NotModulated)
- outdoor_air_temperature_curve_input_variable [string] (Default: DryBulb)
- water_temperature_curve_input_variable [string] (Default: EnteringEvaporator)
- normalized_capacity_function_of_temperature_curve_name [string]
- fuel_energy_input_ratio_function_of_temperature_curve_name [string]
- fuel_energy_input_ratio_function_of_plr_curve_name [string]
- minimum_part_load_ratio [number] (Default: 0.1)
- maximum_part_load_ratio [number] (Default: 1.0)
- cycling_ratio_factor_curve_name [string]
- nominal_auxiliary_electric_power [number]
- auxiliary_electric_energy_input_ratio_function_of_temperature_curve_name [string]
- auxiliary_electric_energy_input_ratio_function_of_plr_curve_name [string]
- standby_electric_power [number] (Default: 0.0)

HeatPump:WaterToWater:EquationFit:Heating¶

simple water-water hp curve-fit model

Fields
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- load_side_inlet_node_name [string]
- load_side_outlet_node_name [string]
- reference_load_side_flow_rate [unknown field type]
- reference_source_side_flow_rate [unknown field type]
- reference_heating_capacity [unknown field type]
- reference_heating_power_consumption [unknown field type]
- heating_capacity_curve_name [string]
- heating_compressor_power_curve_name [string]
- reference_coefficient_of_performance [number] (Default: 7.5)
- sizing_factor [number] (Default: 1.0)
- companion_cooling_heat_pump_name [string]

HeatPump:WaterToWater:EquationFit:Cooling¶

simple water-water heat pump curve-fit model

Fields
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- load_side_inlet_node_name [string]
- load_side_outlet_node_name [string]
- reference_load_side_flow_rate [unknown field type]
- reference_source_side_flow_rate [unknown field type]
- reference_cooling_capacity [unknown field type]
- reference_cooling_power_consumption [unknown field type]
- cooling_capacity_curve_name [string]
- cooling_compressor_power_curve_name [string]
- reference_coefficient_of_performance [number] (Default: 8.0)
- sizing_factor [number] (Default: 1.0)
- companion_heating_heat_pump_name [string]

HeatPump:WaterToWater:ParameterEstimation:Cooling¶

OSU parameter estimation model

Fields
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- load_side_inlet_node_name [string]
- load_side_outlet_node_name [string]
- nominal_cop [number]
- nominal_capacity [number]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- load_side_flow_rate [number]
- source_side_flow_rate [number]
- load_side_heat_transfer_coefficient [number]
- source_side_heat_transfer_coefficient [number]
- piston_displacement [number]
- compressor_clearance_factor [number]
- compressor_suction_and_discharge_pressure_drop [number]
- superheating [number]
- constant_part_of_electromechanical_power_losses [number]
- loss_factor [number]
- high_pressure_cut_off [number] (Default: 500000000.0)
- low_pressure_cut_off [number] (Default: 0.0)

HeatPump:WaterToWater:ParameterEstimation:Heating¶

OSU parameter estimation model

Fields
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- load_side_inlet_node_name [string]
- load_side_outlet_node_name [string]
- nominal_cop [number]
- nominal_capacity [number]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- load_side_flow_rate [number]
- source_side_flow_rate [number]
- load_side_heat_transfer_coefficient [number]
- source_side_heat_transfer_coefficient [number]
- piston_displacement [number]
- compressor_clearance_factor [number]
- compressor_suction_and_discharge_pressure_drop [number]
- superheating [number]
- constant_part_of_electromechanical_power_losses [number]
- loss_factor [number]
- high_pressure_cut_off [number] (Default: 500000000.0)
- low_pressure_cut_off [number] (Default: 0.0)

DistrictCooling¶

Centralized source of chilled water, such as a district cooling system.

Fields
- chilled_water_inlet_node_name [string]
- chilled_water_outlet_node_name [string]
- nominal_capacity [unknown field type]
- capacity_fraction_schedule_name [string]

DistrictHeating¶

Centralized source of hot water, such as a district heating system.

Fields
- hot_water_inlet_node_name [string]
- hot_water_outlet_node_name [string]
- nominal_capacity [unknown field type]
- capacity_fraction_schedule_name [string]

PlantComponent:TemperatureSource¶

Simulates an object of pre-determined (constant or scheduled) source temperature The object introduces fluid into the plant loop at the specified temperature and at the same flow rate as the fluid enters the component Fluid entering the component vanishes equivalent to the relief air in an air system

Fields
- inlet_node [string]
- outlet_node [string]
- design_volume_flow_rate [unknown field type]
- temperature_specification_type [string]
- source_temperature [number]
- source_temperature_schedule_name [string]

CentralHeatPumpSystem¶

This chiller bank can contain multiple chiller heaters and heat pump performance objects. Its function is to encapsulate the extra controls needed to turn individual modules on/off and whether they are to operate in cooling-only, heating-only or simultaneous cooling/heating mode and whether to connect the source water to the evaporator or condenser side.

Fields
- control_method [string] (Default: SmartMixing)
- cooling_loop_inlet_node_name [string]
- cooling_loop_outlet_node_name [string]
- source_loop_inlet_node_name [string]
- source_loop_outlet_node_name [string]
- heating_loop_inlet_node_name [string]
- heating_loop_outlet_node_name [string]
- ancillary_power [number] (Default: 0.0)
- ancillary_operation_schedule_name [string]
- chiller_heater_modules_performance_component_object_type_1 [string]
- chiller_heater_modules_performance_component_name_1 [string]
- chiller_heater_modules_control_schedule_name_1 [string]
- number_of_chiller_heater_modules_1 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_2 [string]
- chiller_heater_modules_performance_component_name_2 [string]
- chiller_heater_modules_control_schedule_name_2 [string]
- number_of_chiller_heater_modules_2 [integer] (Default: 1)
- chiller_heater_performance_component_object_type_3 [string]
- chiller_heater_performance_component_name_3 [string]
- chiller_heater_modules_control_schedule_name_3 [string]
- number_of_chiller_heater_modules_3 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_4 [string]
- chiller_heater_modules_performance_component_name_4 [string]
- chiller_heater_modules_control_schedule_name_4 [string]
- number_of_chiller_heater_modules_4 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_5 [string]
- chiller_heater_models_performance_component_name_5 [string]
- chiller_heater_modules_control_schedule_name_5 [string]
- number_of_chiller_heater_modules_5 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_6 [string]
- chiller_heater_modules_performance_component_name_6 [string]
- chiller_heater_modules_control_schedule_name_6 [string]
- number_of_chiller_heater_modules_6 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_7 [string]
- chiller_heater_modules_performance_component_name_7 [string]
- chiller_heater_modules_control_schedule_name_7 [string]
- number_of_chiller_heater_modules_7 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_8 [string]
- chiller_heater_modules_performance_component_name_8 [string]
- chiller_heater_modules_control_schedule_name_8 [string]
- number_of_chiller_heater_modules_8 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_9 [string]
- chiller_heater_modules_performance_component_name_9 [string]
- chiller_heater_modules_control_schedule_name_9 [string]
- number_of_chiller_heater_modules_9 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_10 [string]
- chiller_heater_modules_performance_component_name_10 [string]
- chiller_heater_modules_control_schedule_name_10 [string]
- number_of_chiller_heater_modules_10 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_11 [string]
- chiller_heater_modules_performance_component_name_11 [string]
- chiller_heater_module_control_schedule_name_11 [string]
- number_of_chiller_heater_modules_11 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_12 [string]
- chiller_heater_modules_performance_component_name_12 [string]
- chiller_heater_modules_control_schedule_name_12 [string]
- number_of_chiller_heater_modules_12 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_13 [string]
- chiller_heater_modules_performance_component_name_13 [string]
- chiller_heater_modules_control_schedule_name_13 [string]
- number_of_chiller_heater_modules_13 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_14 [string]
- chiller_heater_modules_performance_component_name_14 [string]
- chiller_heater_modules_control_schedule_name_14 [string]
- number_of_chiller_heater_modules_14 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_15 [string]
- chiller_heater_modules_performance_component_name_15 [string]
- chiller_heater_modules_control_schedule_name_15 [string]
- number_of_chiller_heater_modules_15 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_16 [string]
- chiller_heater_modules_performance_component_name_16 [string]
- chiller_heater_modules_control_schedule_name_16 [string]
- number_of_chiller_heater_modules_16 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_17 [string]
- chiller_heater_modules_performance_component_name_17 [string]
- chiller_heater_modules_control_schedule_name_17 [string]
- number_of_chiller_heater_modules_17 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_18 [string]
- chiller_heater_modules_performance_component_name_18 [string]
- chiller_heater_modules_control_control_schedule_name_18 [string]
- number_of_chiller_heater_modules_18 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_19 [string]
- chiller_heater_modules_performance_component_name_19 [string]
- chiller_heater_modules_control_schedule_name_19 [string]
- number_of_chiller_heater_modules_19 [integer] (Default: 1)
- chiller_heater_modules_performance_component_object_type_20 [string]
- chiller_heater_modules_performance_component_name_20 [string]
- chiller_heater_modules_control_schedule_name_20 [string]
- number_of_chiller_heater_modules_20 [integer] (Default: 1)

ChillerHeaterPerformance:Electric:EIR¶

This chiller model is a generic chiller-heater where the cooling mode performance is a function of condenser entering or leaving fluid temperature and the heating mode performance is typically a function of condenser leaving fluid temperature. Performance at off-reference conditions is modeled using three polynomial equations per mode. Six curve objects are required.

Fields
- reference_cooling_mode_evaporator_capacity [unknown field type]
- reference_cooling_mode_cop [number]
- reference_cooling_mode_leaving_chilled_water_temperature [number] (Default: 6.67)
- reference_cooling_mode_entering_condenser_fluid_temperature [number] (Default: 29.44)
- reference_cooling_mode_leaving_condenser_water_temperature [number] (Default: 35.0)
- reference_heating_mode_cooling_capacity_ratio [number] (Default: 0.75)
- reference_heating_mode_cooling_power_input_ratio [number] (Default: 1.38)
- reference_heating_mode_leaving_chilled_water_temperature [number] (Default: 6.67)
- reference_heating_mode_leaving_condenser_water_temperature [number] (Default: 49.0)
- reference_heating_mode_entering_condenser_fluid_temperature [number] (Default: 29.44)
- heating_mode_entering_chilled_water_temperature_low_limit [number] (Default: 12.22)
- chilled_water_flow_mode_type [string] (Default: ConstantFlow)
- design_chilled_water_flow_rate [unknown field type]
- design_condenser_water_flow_rate [unknown field type]
- design_hot_water_flow_rate [number] (Default: 0.0)
- compressor_motor_efficiency [number] (Default: 1.0)
- condenser_type [string] (Default: WaterCooled)
- cooling_mode_temperature_curve_condenser_water_independent_variable [string] (Default: EnteringCondenser)
- cooling_mode_cooling_capacity_function_of_temperature_curve_name [string]
- cooling_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- cooling_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- cooling_mode_cooling_capacity_optimum_part_load_ratio [number] (Default: 1.0)
- heating_mode_temperature_curve_condenser_water_independent_variable [string] (Default: LeavingCondenser)
- heating_mode_cooling_capacity_function_of_temperature_curve_name [string]
- heating_mode_electric_input_to_cooling_output_ratio_function_of_temperature_curve_name [string]
- heating_mode_electric_input_to_cooling_output_ratio_function_of_part_load_ratio_curve_name [string]
- heating_mode_cooling_capacity_optimum_part_load_ratio [number] (Default: 1.0)
- sizing_factor [number] (Default: 1.0)

Condenser Equipment and Heat Exchangers¶

CoolingTower:SingleSpeed¶

This tower model is based on Merkel’s theory, which is also the basis for the tower model in ASHRAE’s HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a single-speed fan drawing air through the tower (induced-draft configuration). Added fluid bypass as an additional capacity control. 8/2008. For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- design_water_flow_rate [unknown field type]
- design_air_flow_rate [unknown field type]
- design_fan_power [unknown field type]
- design_u_factor_times_area_value [unknown field type]
- free_convection_regime_air_flow_rate [unknown field type] (Default: 0.0)
- free_convection_regime_air_flow_rate_sizing_factor [number] (Default: 0.1)
- free_convection_regime_u_factor_times_area_value [unknown field type] (Default: 0.0)
- free_convection_u_factor_times_area_value_sizing_factor [number] (Default: 0.1)
- performance_input_method [string] (Default: UFactorTimesAreaAndDesignWaterFlowRate)
- heat_rejection_capacity_and_nominal_capacity_sizing_ratio [number] (Default: 1.25)
- nominal_capacity [number]
- free_convection_capacity [unknown field type]
- free_convection_nominal_capacity_sizing_factor [number] (Default: 0.1)
- design_inlet_air_dry_bulb_temperature [number] (Default: 35.0)
- design_inlet_air_wet_bulb_temperature [number] (Default: 25.6)
- design_approach_temperature [unknown field type] (Default: Autosize)
- design_range_temperature [unknown field type] (Default: Autosize)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- evaporation_loss_mode [string] (Default: SaturatedExit)
- evaporation_loss_factor [number] (Default: 0.2)
- drift_loss_percent [number] (Default: 0.008)
- blowdown_calculation_mode [string] (Default: ConcentrationRatio)
- blowdown_concentration_ratio [number] (Default: 3.0)
- blowdown_makeup_water_usage_schedule_name [string]
- supply_water_storage_tank_name [string]
- outdoor_air_inlet_node_name [string]
- capacity_control [string] (Default: FanCycling)
- number_of_cells [integer] (Default: 1)
- cell_control [string] (Default: MaximalCell)
- cell_minimum_water_flow_rate_fraction [number] (Default: 0.33)
- cell_maximum_water_flow_rate_fraction [number] (Default: 2.5)
- sizing_factor [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)

CoolingTower:TwoSpeed¶

This tower model is based on Merkel’s theory, which is also the basis for the tower model in ASHRAE’s HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a two-speed fan drawing air through the tower (induced-draft configuration). For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- design_water_flow_rate [unknown field type]
- high_fan_speed_air_flow_rate [unknown field type]
- high_fan_speed_fan_power [unknown field type]
- high_fan_speed_u_factor_times_area_value [unknown field type]
- low_fan_speed_air_flow_rate [unknown field type]
- low_fan_speed_air_flow_rate_sizing_factor [number] (Default: 0.5)
- low_fan_speed_fan_power [unknown field type]
- low_fan_speed_fan_power_sizing_factor [number] (Default: 0.16)
- low_fan_speed_u_factor_times_area_value [unknown field type]
- low_fan_speed_u_factor_times_area_sizing_factor [number] (Default: 0.6)
- free_convection_regime_air_flow_rate [unknown field type] (Default: 0.0)
- free_convection_regime_air_flow_rate_sizing_factor [number] (Default: 0.1)
- free_convection_regime_u_factor_times_area_value [unknown field type] (Default: 0.0)
- free_convection_u_factor_times_area_value_sizing_factor [number] (Default: 0.1)
- performance_input_method [string] (Default: UFactorTimesAreaAndDesignWaterFlowRate)
- heat_rejection_capacity_and_nominal_capacity_sizing_ratio [number] (Default: 1.25)
- high_speed_nominal_capacity [number]
- low_speed_nominal_capacity [unknown field type]
- low_speed_nominal_capacity_sizing_factor [number] (Default: 0.5)
- free_convection_nominal_capacity [unknown field type]
- free_convection_nominal_capacity_sizing_factor [number] (Default: 0.1)
- design_inlet_air_dry_bulb_temperature [number] (Default: 35.0)
- design_inlet_air_wet_bulb_temperature [number] (Default: 25.6)
- design_approach_temperature [unknown field type] (Default: Autosize)
- design_range_temperature [unknown field type] (Default: Autosize)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- evaporation_loss_mode [string] (Default: SaturatedExit)
- evaporation_loss_factor [number] (Default: 0.2)
- drift_loss_percent [number] (Default: 0.008)
- blowdown_calculation_mode [string] (Default: ConcentrationRatio)
- blowdown_concentration_ratio [number] (Default: 3.0)
- blowdown_makeup_water_usage_schedule_name [string]
- supply_water_storage_tank_name [string]
- outdoor_air_inlet_node_name [string]
- number_of_cells [integer] (Default: 1)
- cell_control [string] (Default: MaximalCell)
- cell_minimum_water_flow_rate_fraction [number] (Default: 0.33)
- cell_maximum_water_flow_rate_fraction [number] (Default: 2.5)
- sizing_factor [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)

CoolingTower:VariableSpeed:Merkel¶

This tower model is based on Merkel’s theory, which is also the basis for the tower model in ASHRAE’s HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a variable-speed fan drawing air through the tower (induced-draft configuration). For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- performance_input_method [string] (Default: NominalCapacity)
- heat_rejection_capacity_and_nominal_capacity_sizing_ratio [number] (Default: 1.25)
- nominal_capacity [unknown field type]
- free_convection_nominal_capacity [unknown field type]
- free_convection_nominal_capacity_sizing_factor [number] (Default: 0.1)
- design_water_flow_rate [unknown field type]
- design_water_flow_rate_per_unit_of_nominal_capacity [number] (Default: 5.382e-08)
- design_air_flow_rate [unknown field type]
- design_air_flow_rate_per_unit_of_nominal_capacity [number] (Default: 2.76316e-05)
- minimum_air_flow_rate_ratio [number] (Default: 0.2)
- design_fan_power [unknown field type]
- design_fan_power_per_unit_of_nominal_capacity [number] (Default: 0.0105)
- fan_power_modifier_function_of_air_flow_rate_ratio_curve_name [string]
- free_convection_regime_air_flow_rate [unknown field type] (Default: 0.0)
- free_convection_regime_air_flow_rate_sizing_factor [number] (Default: 0.1)
- design_air_flow_rate_u_factor_times_area_value [unknown field type]
- free_convection_regime_u_factor_times_area_value [unknown field type] (Default: 0.0)
- free_convection_u_factor_times_area_value_sizing_factor [number] (Default: 0.1)
- u_factor_times_area_modifier_function_of_air_flow_ratio_curve_name [string]
- u_factor_times_area_modifier_function_of_wetbulb_temperature_difference_curve_name [string]
- u_factor_times_area_modifier_function_of_water_flow_ratio_curve_name [string]
- design_inlet_air_dry_bulb_temperature [number] (Default: 35.0)
- design_inlet_air_wet_bulb_temperature [number] (Default: 25.6)
- design_approach_temperature [unknown field type] (Default: Autosize)
- design_range_temperature [unknown field type] (Default: Autosize)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- evaporation_loss_mode [string] (Default: SaturatedExit)
- evaporation_loss_factor [number] (Default: 0.2)
- drift_loss_percent [number] (Default: 0.008)
- blowdown_calculation_mode [string] (Default: ConcentrationRatio)
- blowdown_concentration_ratio [number] (Default: 3.0)
- blowdown_makeup_water_usage_schedule_name [string]
- supply_water_storage_tank_name [string]
- outdoor_air_inlet_node_name [string]
- number_of_cells [integer] (Default: 1)
- cell_control [string] (Default: MaximalCell)
- cell_minimum_water_flow_rate_fraction [number] (Default: 0.33)
- cell_maximum_water_flow_rate_fraction [number] (Default: 2.5)
- sizing_factor [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)

CoolingTower:VariableSpeed¶

This open wet tower model is based on purely empirical algorithms derived from manufacturer’s performance data or field measurements. The user can select from two existing algorithms (CoolTools or YorkCalc), or they can enter their own correlation for approach temperature by using a variable speed tower model coefficient object. For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- model_type [string] (Default: YorkCalc)
- model_coefficient_name [string]
- design_inlet_air_wet_bulb_temperature [number] (Default: 25.6)
- design_approach_temperature [number] (Default: 3.9)
- design_range_temperature [number] (Default: 5.6)
- design_water_flow_rate [unknown field type]
- design_air_flow_rate [unknown field type]
- design_fan_power [unknown field type]
- fan_power_ratio_function_of_air_flow_rate_ratio_curve_name [string]
- minimum_air_flow_rate_ratio [number] (Default: 0.2)
- fraction_of_tower_capacity_in_free_convection_regime [number] (Default: 0.125)
- basin_heater_capacity [number] (Default: 0.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- basin_heater_operating_schedule_name [string]
- evaporation_loss_mode [string] (Default: SaturatedExit)
- evaporation_loss_factor [number] (Default: 0.2)
- drift_loss_percent [number] (Default: 0.008)
- blowdown_calculation_mode [string] (Default: ConcentrationRatio)
- blowdown_concentration_ratio [number] (Default: 3.0)
- blowdown_makeup_water_usage_schedule_name [string]
- supply_water_storage_tank_name [string]
- outdoor_air_inlet_node_name [string]
- number_of_cells [integer] (Default: 1)
- cell_control [string] (Default: MaximalCell)
- cell_minimum_water_flow_rate_fraction [number] (Default: 0.33)
- cell_maximum_water_flow_rate_fraction [number] (Default: 2.5)
- sizing_factor [number] (Default: 1.0)
- end_use_subcategory [string] (Default: General)

CoolingTowerPerformance:CoolTools¶

This object is used to define coefficients for the approach temperature correlation for a variable speed cooling tower when tower Model Type is specified as CoolToolsUserDefined in the object CoolingTower:VariableSpeed.

Fields
- minimum_inlet_air_wet_bulb_temperature [number]
- maximum_inlet_air_wet_bulb_temperature [number]
- minimum_range_temperature [number]
- maximum_range_temperature [number]
- minimum_approach_temperature [number]
- maximum_approach_temperature [number]
- minimum_water_flow_rate_ratio [number]
- maximum_water_flow_rate_ratio [number]
- coefficient_1 [number]
- coefficient_2 [number]
- coefficient_3 [number]
- coefficient_4 [number]
- coefficient_5 [number]
- coefficient_6 [number]
- coefficient_7 [number]
- coefficient_8 [number]
- coefficient_9 [number]
- coefficient_10 [number]
- coefficient_11 [number]
- coefficient_12 [number]
- coefficient_13 [number]
- coefficient_14 [number]
- coefficient_15 [number]
- coefficient_16 [number]
- coefficient_17 [number]
- coefficient_18 [number]
- coefficient_19 [number]
- coefficient_20 [number]
- coefficient_21 [number]
- coefficient_22 [number]
- coefficient_23 [number]
- coefficient_24 [number]
- coefficient_25 [number]
- coefficient_26 [number]
- coefficient_27 [number]
- coefficient_28 [number]
- coefficient_29 [number]
- coefficient_30 [number]
- coefficient_31 [number]
- coefficient_32 [number]
- coefficient_33 [number]
- coefficient_34 [number]
- coefficient_35 [number]

CoolingTowerPerformance:YorkCalc¶

This object is used to define coefficients for the approach temperature correlation for a variable speed cooling tower when tower Model Type is specified as YorkCalcUserDefined in the object CoolingTower:VariableSpeed.

Fields
- minimum_inlet_air_wet_bulb_temperature [number]
- maximum_inlet_air_wet_bulb_temperature [number]
- minimum_range_temperature [number]
- maximum_range_temperature [number]
- minimum_approach_temperature [number]
- maximum_approach_temperature [number]
- minimum_water_flow_rate_ratio [number]
- maximum_water_flow_rate_ratio [number]
- maximum_liquid_to_gas_ratio [number]
- coefficient_1 [number]
- coefficient_2 [number]
- coefficient_3 [number]
- coefficient_4 [number]
- coefficient_5 [number]
- coefficient_6 [number]
- coefficient_7 [number]
- coefficient_8 [number]
- coefficient_9 [number]
- coefficient_10 [number]
- coefficient_11 [number]
- coefficient_12 [number]
- coefficient_13 [number]
- coefficient_14 [number]
- coefficient_15 [number]
- coefficient_16 [number]
- coefficient_17 [number]
- coefficient_18 [number]
- coefficient_19 [number]
- coefficient_20 [number]
- coefficient_21 [number]
- coefficient_22 [number]
- coefficient_23 [number]
- coefficient_24 [number]
- coefficient_25 [number]
- coefficient_26 [number]
- coefficient_27 [number]

EvaporativeFluidCooler:SingleSpeed¶

This model is based on Merkel’s theory, which is also the basis for the cooling tower model in EnergyPlus. The Evaporative fluid cooler is modeled as a counter flow heat exchanger.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- design_air_flow_rate [unknown field type]
- design_air_flow_rate_fan_power [unknown field type]
- design_spray_water_flow_rate [number]
- performance_input_method [string]
- outdoor_air_inlet_node_name [string]
- heat_rejection_capacity_and_nominal_capacity_sizing_ratio [number] (Default: 1.25)
- standard_design_capacity [number]
- design_air_flow_rate_u_factor_times_area_value [unknown field type]
- design_water_flow_rate [unknown field type]
- user_specified_design_capacity [number]
- design_entering_water_temperature [number]
- design_entering_air_temperature [number]
- design_entering_air_wet_bulb_temperature [number]
- capacity_control [string] (Default: FanCycling)
- sizing_factor [number] (Default: 1.0)
- evaporation_loss_mode [string] (Default: SaturatedExit)
- evaporation_loss_factor [number]
- drift_loss_percent [number] (Default: 0.008)
- blowdown_calculation_mode [string] (Default: ConcentrationRatio)
- blowdown_concentration_ratio [number] (Default: 3.0)
- blowdown_makeup_water_usage_schedule_name [string]
- supply_water_storage_tank_name [string]

EvaporativeFluidCooler:TwoSpeed¶

This model is based on Merkel’s theory, which is also the basis for the cooling tower model in EnergyPlus. The Evaporative fluid cooler is modeled as a counter flow heat exchanger.

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- high_fan_speed_air_flow_rate [unknown field type]
- high_fan_speed_fan_power [unknown field type]
- low_fan_speed_air_flow_rate [unknown field type]
- low_fan_speed_air_flow_rate_sizing_factor [number] (Default: 0.5)
- low_fan_speed_fan_power [unknown field type]
- low_fan_speed_fan_power_sizing_factor [number] (Default: 0.16)
- design_spray_water_flow_rate [number]
- performance_input_method [string]
- outdoor_air_inlet_node_name [string]
- heat_rejection_capacity_and_nominal_capacity_sizing_ratio [number] (Default: 1.25)
- high_speed_standard_design_capacity [number]
- low_speed_standard_design_capacity [unknown field type]
- low_speed_standard_capacity_sizing_factor [number] (Default: 0.5)
- high_fan_speed_u_factor_times_area_value [unknown field type]
- low_fan_speed_u_factor_times_area_value [unknown field type]
- low_fan_speed_u_factor_times_area_sizing_factor [number] (Default: 0.6)
- design_water_flow_rate [unknown field type]
- high_speed_user_specified_design_capacity [number]
- low_speed_user_specified_design_capacity [unknown field type]
- low_speed_user_specified_design_capacity_sizing_factor [number] (Default: 0.5)
- design_entering_water_temperature [number]
- design_entering_air_temperature [number]
- design_entering_air_wet_bulb_temperature [number]
- high_speed_sizing_factor [number] (Default: 1.0)
- evaporation_loss_mode [string] (Default: SaturatedExit)
- evaporation_loss_factor [number]
- drift_loss_percent [number] (Default: 0.008)
- blowdown_calculation_mode [string] (Default: ConcentrationRatio)
- blowdown_concentration_ratio [number] (Default: 3.0)
- blowdown_makeup_water_usage_schedule_name [string]
- supply_water_storage_tank_name [string]

FluidCooler:SingleSpeed¶

The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with single-speed fans (induced draft configuration).

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- performance_input_method [string] (Default: NominalCapacity)
- design_air_flow_rate_u_factor_times_area_value [unknown field type]
- nominal_capacity [number]
- design_entering_water_temperature [number]
- design_entering_air_temperature [number]
- design_entering_air_wetbulb_temperature [number]
- design_water_flow_rate [unknown field type]
- design_air_flow_rate [unknown field type]
- design_air_flow_rate_fan_power [unknown field type]
- outdoor_air_inlet_node_name [string]

FluidCooler:TwoSpeed¶

The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with two-speed fans (induced draft configuration).

Fields
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- performance_input_method [string] (Default: NominalCapacity)
- high_fan_speed_u_factor_times_area_value [unknown field type]
- low_fan_speed_u_factor_times_area_value [unknown field type]
- low_fan_speed_u_factor_times_area_sizing_factor [number] (Default: 0.6)
- high_speed_nominal_capacity [number]
- low_speed_nominal_capacity [unknown field type]
- low_speed_nominal_capacity_sizing_factor [number] (Default: 0.5)
- design_entering_water_temperature [number]
- design_entering_air_temperature [number]
- design_entering_air_wet_bulb_temperature [number]
- design_water_flow_rate [unknown field type]
- high_fan_speed_air_flow_rate [unknown field type]
- high_fan_speed_fan_power [unknown field type]
- low_fan_speed_air_flow_rate [unknown field type]
- low_fan_speed_air_flow_rate_sizing_factor [number] (Default: 0.5)
- low_fan_speed_fan_power [unknown field type]
- low_fan_speed_fan_power_sizing_factor [number] (Default: 0.16)
- outdoor_air_inlet_node_name [string]

GroundHeatExchanger:System¶

Models vertical ground heat exchangers systems using the response factor approach developed by Eskilson. Response factors are calculated using a finite line source model assuming uniform heat flux at the borehole wall if UHFcalc is specified, or uniform borehole wall temperature if UBHWTcalc is specified.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- design_flow_rate [number]
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]
- ground_thermal_conductivity [number]
- ground_thermal_heat_capacity [number]
- ghe_vertical_responsefactors_object_name [string]
- g_function_calculation_method [string] (Default: UHFcalc)
- ghe_vertical_array_object_name [string]
- vertical_well_locations [Array of {ghe_vertical_single_object_name}]

GroundHeatExchanger:Vertical:Properties¶

Properties for vertical ground heat exchanger systems

Fields
- depth_of_top_of_borehole [number]
- borehole_length [number]
- borehole_diameter [number]
- grout_thermal_conductivity [number]
- grout_thermal_heat_capacity [number]
- pipe_thermal_conductivity [number]
- pipe_thermal_heat_capacity [number]
- pipe_outer_diameter [number]
- pipe_thickness [number]
- u_tube_distance [number]

GroundHeatExchanger:Vertical:Array¶

Fields
- ghe_vertical_properties_object_name [string]
- number_of_boreholes_in_x_direction [integer]
- number_of_boreholes_in_y_direction [integer]
- borehole_spacing [number]

GroundHeatExchanger:Vertical:Single¶

Fields
- ghe_vertical_properties_object_name [string]
- x_location [number]
- y_location [number]

GroundHeatExchanger:ResponseFactors¶

Response factor definitions from third-party tool, commonly referred to a “g-functions”

Fields
- ghe_vertical_properties_object_name [string]
- number_of_boreholes [integer]
- g_function_reference_ratio [number] (Default: 0.0005)
- g_functions [Array of {g_function_ln_t_ts_value, g_function_g_value}]

GroundHeatExchanger:Pond¶

A model of a shallow pond with immersed pipe loops. Typically used in hybrid geothermal systems and included in the condenser loop. This component may also be used as a simple solar collector.

Fields
- fluid_inlet_node_name [string]
- fluid_outlet_node_name [string]
- pond_depth [number]
- pond_area [number]
- hydronic_tubing_inside_diameter [number]
- hydronic_tubing_outside_diameter [number]
- hydronic_tubing_thermal_conductivity [number]
- ground_thermal_conductivity [number]
- number_of_tubing_circuits [integer]
- length_of_each_tubing_circuit [number]

GroundHeatExchanger:Surface¶

A hydronic surface/panel consisting of a multi-layer construction with embedded rows of tubes. Typically used in hybrid geothermal systems and included in the condenser loop. This component may also be used as a simple solar collector. The bottom surface may be defined as ground-coupled or exposed to wind (eg. bridge deck).

Fields
- construction_name [string]
- fluid_inlet_node_name [string]
- fluid_outlet_node_name [string]
- hydronic_tubing_inside_diameter [number]
- number_of_tubing_circuits [integer]
- hydronic_tube_spacing [number]
- surface_length [number]
- surface_width [number]
- lower_surface_environment [string] (Default: Ground)

GroundHeatExchanger:HorizontalTrench¶

This models a horizontal heat exchanger placed in a series of trenches The model uses the PipingSystem:Underground underlying algorithms, but provides a more usable input interface.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- design_flow_rate [number]
- trench_length_in_pipe_axial_direction [number] (Default: 50.0)
- number_of_trenches [integer] (Default: 1)
- horizontal_spacing_between_pipes [number] (Default: 1.0)
- pipe_inner_diameter [number] (Default: 0.016)
- pipe_outer_diameter [number] (Default: 0.026)
- burial_depth [number] (Default: 1.5)
- soil_thermal_conductivity [number] (Default: 1.08)
- soil_density [number] (Default: 962.0)
- soil_specific_heat [number] (Default: 2576.0)
- pipe_thermal_conductivity [number] (Default: 0.3895)
- pipe_density [number] (Default: 641.0)
- pipe_specific_heat [number] (Default: 2405.0)
- soil_moisture_content_percent [number] (Default: 30.0)
- soil_moisture_content_percent_at_saturation [number] (Default: 50.0)
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]
- evapotranspiration_ground_cover_parameter [number] (Default: 0.4)

GroundHeatExchanger:Slinky¶

This models a slinky horizontal heat exchanger placed in a series of trenches The model uses the model developed by: Xiong, Z., D.E. Fisher, and J.D. Spitler. 2015. Development and Validation of a Slinky Ground Heat Exchanger Model. Applied Energy 141: 57-69.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- design_flow_rate [number] (Default: 0.002)
- soil_thermal_conductivity [number] (Default: 1.08)
- soil_density [number] (Default: 962.0)
- soil_specific_heat [number] (Default: 2576.0)
- pipe_thermal_conductivity [number] (Default: 0.4)
- pipe_density [number] (Default: 641.0)
- pipe_specific_heat [number] (Default: 2405.0)
- pipe_outer_diameter [number] (Default: 0.02667)
- pipe_thickness [number] (Default: 0.002413)
- heat_exchanger_configuration [string]
- coil_diameter [number] (Default: 1.0)
- coil_pitch [number] (Default: 0.2)
- trench_depth [number] (Default: 1.8)
- trench_length [number] (Default: 10.0)
- number_of_trenches [integer] (Default: 1)
- horizontal_spacing_between_pipes [number] (Default: 2.0)
- undisturbed_ground_temperature_model_type [string]
- undisturbed_ground_temperature_model_name [string]
- maximum_length_of_simulation [number]

HeatExchanger:FluidToFluid¶

A fluid/fluid heat exchanger designed to couple the supply side of one loop to the demand side of another loop Loops can be either plant or condenser loops but no air side connections are allowed

Fields
- availability_schedule_name [string]
- loop_demand_side_inlet_node_name [string]
- loop_demand_side_outlet_node_name [string]
- loop_demand_side_design_flow_rate [unknown field type]
- loop_supply_side_inlet_node_name [string]
- loop_supply_side_outlet_node_name [string]
- loop_supply_side_design_flow_rate [unknown field type]
- heat_exchange_model_type [string] (Default: Ideal)
- heat_exchanger_u_factor_times_area_value [unknown field type]
- control_type [string] (Default: UncontrolledOn)
- heat_exchanger_setpoint_node_name [string]
- minimum_temperature_difference_to_activate_heat_exchanger [number] (Default: 0.01)
- heat_transfer_metering_end_use_type [string] (Default: LoopToLoop)
- component_override_loop_supply_side_inlet_node_name [string]
- component_override_loop_demand_side_inlet_node_name [string]
- component_override_cooling_control_temperature_mode [string] (Default: Loop)
- sizing_factor [number] (Default: 1.0)
- operation_minimum_temperature_limit [number]
- operation_maximum_temperature_limit [number]

Water Heaters and Thermal Storage¶

WaterHeater:Mixed¶

Water heater with well-mixed, single-node water tank. May be used to model a tankless water heater (small tank volume), a hot water storage tank (zero heater capacity), or a heat pump water heater (see WaterHeater:HeatPump:PumpedCondenser.)

Fields
- tank_volume [unknown field type] (Default: 0.0)
- setpoint_temperature_schedule_name [string]
- deadband_temperature_difference [number] (Default: 0.0)
- maximum_temperature_limit [number]
- heater_control_type [string] (Default: Cycle)
- heater_maximum_capacity [unknown field type]
- heater_minimum_capacity [number]
- heater_ignition_minimum_flow_rate [number] (Default: 0.0)
- heater_ignition_delay [number] (Default: 0.0)
- heater_fuel_type [string]
- heater_thermal_efficiency [number]
- part_load_factor_curve_name [string]
- off_cycle_parasitic_fuel_consumption_rate [number] (Default: 0.0)
- off_cycle_parasitic_fuel_type [string]
- off_cycle_parasitic_heat_fraction_to_tank [number] (Default: 0.0)
- on_cycle_parasitic_fuel_consumption_rate [number] (Default: 0.0)
- on_cycle_parasitic_fuel_type [string]
- on_cycle_parasitic_heat_fraction_to_tank [number] (Default: 0.0)
- ambient_temperature_indicator [string]
- ambient_temperature_schedule_name [string]
- ambient_temperature_zone_name [string]
- ambient_temperature_outdoor_air_node_name [string]
- off_cycle_loss_coefficient_to_ambient_temperature [number]
- off_cycle_loss_fraction_to_zone [number] (Default: 1.0)
- on_cycle_loss_coefficient_to_ambient_temperature [number]
- on_cycle_loss_fraction_to_zone [number] (Default: 1.0)
- peak_use_flow_rate [number]
- use_flow_rate_fraction_schedule_name [string]
- cold_water_supply_temperature_schedule_name [string]
- use_side_inlet_node_name [string]
- use_side_outlet_node_name [string]
- use_side_effectiveness [number] (Default: 1.0)
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- source_side_effectiveness [number] (Default: 1.0)
- use_side_design_flow_rate [unknown field type] (Default: Autosize)
- source_side_design_flow_rate [unknown field type] (Default: Autosize)
- indirect_water_heating_recovery_time [number] (Default: 1.5)
- source_side_flow_control_mode [string] (Default: IndirectHeatPrimarySetpoint)
- indirect_alternate_setpoint_temperature_schedule_name [string]
- end_use_subcategory [string] (Default: General)

WaterHeater:Stratified¶

Water heater with stratified, multi-node water tank. May be used to model a tankless water heater (small tank volume), a hot water storage tank (zero heater capacity), or a heat pump water heater (see WaterHeater:HeatPump:*.)

Fields
- end_use_subcategory [string] (Default: General)
- tank_volume [unknown field type]
- tank_height [unknown field type]
- tank_shape [string] (Default: VerticalCylinder)
- tank_perimeter [number]
- maximum_temperature_limit [number]
- heater_priority_control [string] (Default: MasterSlave)
- heater_1_setpoint_temperature_schedule_name [string]
- heater_1_deadband_temperature_difference [number] (Default: 0.0)
- heater_1_capacity [unknown field type]
- heater_1_height [number]
- heater_2_setpoint_temperature_schedule_name [string]
- heater_2_deadband_temperature_difference [number] (Default: 0.0)
- heater_2_capacity [number]
- heater_2_height [number]
- heater_fuel_type [string]
- heater_thermal_efficiency [number]
- off_cycle_parasitic_fuel_consumption_rate [number] (Default: 0.0)
- off_cycle_parasitic_fuel_type [string]
- off_cycle_parasitic_heat_fraction_to_tank [number] (Default: 0.0)
- off_cycle_parasitic_height [number] (Default: 0.0)
- on_cycle_parasitic_fuel_consumption_rate [number] (Default: 0.0)
- on_cycle_parasitic_fuel_type [string]
- on_cycle_parasitic_heat_fraction_to_tank [number] (Default: 0.0)
- on_cycle_parasitic_height [number] (Default: 0.0)
- ambient_temperature_indicator [string]
- ambient_temperature_schedule_name [string]
- ambient_temperature_zone_name [string]
- ambient_temperature_outdoor_air_node_name [string]
- uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature [number]
- skin_loss_fraction_to_zone [number] (Default: 1.0)
- off_cycle_flue_loss_coefficient_to_ambient_temperature [number]
- off_cycle_flue_loss_fraction_to_zone [number] (Default: 1.0)
- peak_use_flow_rate [number]
- use_flow_rate_fraction_schedule_name [string]
- cold_water_supply_temperature_schedule_name [string]
- use_side_inlet_node_name [string]
- use_side_outlet_node_name [string]
- use_side_effectiveness [number] (Default: 1.0)
- use_side_inlet_height [number] (Default: 0.0)
- use_side_outlet_height [unknown field type] (Default: Autocalculate)
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- source_side_effectiveness [number] (Default: 1.0)
- source_side_inlet_height [unknown field type] (Default: Autocalculate)
- source_side_outlet_height [number] (Default: 0.0)
- inlet_mode [string] (Default: Fixed)
- use_side_design_flow_rate [unknown field type] (Default: Autosize)
- source_side_design_flow_rate [unknown field type] (Default: Autosize)
- indirect_water_heating_recovery_time [number] (Default: 1.5)
- number_of_nodes [integer] (Default: 1)
- additional_destratification_conductivity [number] (Default: 0.0)
- node_1_additional_loss_coefficient [number] (Default: 0.0)
- node_2_additional_loss_coefficient [number] (Default: 0.0)
- node_3_additional_loss_coefficient [number] (Default: 0.0)
- node_4_additional_loss_coefficient [number] (Default: 0.0)
- node_5_additional_loss_coefficient [number] (Default: 0.0)
- node_6_additional_loss_coefficient [number] (Default: 0.0)
- node_7_additional_loss_coefficient [number] (Default: 0.0)
- node_8_additional_loss_coefficient [number] (Default: 0.0)
- node_9_additional_loss_coefficient [number] (Default: 0.0)
- node_10_additional_loss_coefficient [number] (Default: 0.0)
- node_11_additional_loss_coefficient [number] (Default: 0.0)
- node_12_additional_loss_coefficient [number] (Default: 0.0)
- source_side_flow_control_mode [string] (Default: IndirectHeatPrimarySetpoint)
- indirect_alternate_setpoint_temperature_schedule_name [string]

WaterHeater:Sizing¶

This input object is used with WaterHeater:Mixed or with WaterHeater:Stratified to autosize tank volume and heater capacity This object is not needed if water heaters are not autosized.

Fields
- waterheater_name [string]
- design_mode [string]
- time_storage_can_meet_peak_draw [number]
- time_for_tank_recovery [number]
- nominal_tank_volume_for_autosizing_plant_connections [number]
- number_of_bedrooms [integer]
- number_of_bathrooms [integer]
- storage_capacity_per_person [number]
- recovery_capacity_per_person [number]
- storage_capacity_per_floor_area [number]
- recovery_capacity_per_floor_area [number]
- number_of_units [number]
- storage_capacity_per_unit [number]
- recovery_capacity_perunit [number]
- storage_capacity_per_collector_area [number]
- height_aspect_ratio [number]

WaterHeater:HeatPump:PumpedCondenser¶

This object models an air-source heat pump for water heating where the water is pumped out of the tank, through a heating coil and returned to the tank. For wrapped condenser HPWHs, see WaterHeater:HeatPump:WrappedCondenser. WaterHeater:HeatPump:PumpedCondenser is a compound object that references other component objects - Coil:WaterHeating:AirToWaterHeatPump:*, Fan:OnOff, WaterHeater:Mixed or WaterHeater:Stratified

Fields
- availability_schedule_name [string]
- compressor_setpoint_temperature_schedule_name [string]
- dead_band_temperature_difference [number] (Default: 5.0)
- condenser_water_inlet_node_name [string]
- condenser_water_outlet_node_name [string]
- condenser_water_flow_rate [unknown field type]
- evaporator_air_flow_rate [unknown field type]
- inlet_air_configuration [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_node_name [string]
- exhaust_air_node_name [string]
- inlet_air_temperature_schedule_name [string]
- inlet_air_humidity_schedule_name [string]
- inlet_air_zone_name [string]
- tank_object_type [string] (Default: WaterHeater:Mixed)
- tank_name [string]
- tank_use_side_inlet_node_name [string]
- tank_use_side_outlet_node_name [string]
- dx_coil_object_type [string] (Default: Coil:WaterHeating:AirToWaterHeatPump:Pumped)
- dx_coil_name [string]
- minimum_inlet_air_temperature_for_compressor_operation [number] (Default: 10.0)
- maximum_inlet_air_temperature_for_compressor_operation [number] (Default: 48.88888888889)
- compressor_location [string]
- compressor_ambient_temperature_schedule_name [string]
- fan_object_type [string] (Default: Fan:OnOff)
- fan_name [string]
- fan_placement [string] (Default: DrawThrough)
- on_cycle_parasitic_electric_load [number] (Default: 0.0)
- off_cycle_parasitic_electric_load [number] (Default: 0.0)
- parasitic_heat_rejection_location [string] (Default: Outdoors)
- inlet_air_mixer_node_name [string]
- outlet_air_splitter_node_name [string]
- inlet_air_mixer_schedule_name [string]
- tank_element_control_logic [string] (Default: Simultaneous)
- control_sensor_1_height_in_stratified_tank [number]
- control_sensor_1_weight [number] (Default: 1.0)
- control_sensor_2_height_in_stratified_tank [number]

WaterHeater:HeatPump:WrappedCondenser¶

This object models an air-source heat pump for water heating where the heating coil is wrapped around the tank, which is typical of residential HPWHs. For pumped condenser HPWHs, see WaterHeater:HeatPump:PumpedCondenser. WaterHeater:HeatPump:WrappedCondenser is a compound object that references other component objects - Coil:WaterHeating:AirToWaterHeatPump:Pumped, Fan:OnOff, WaterHeater:Mixed

Fields
- availability_schedule_name [string]
- compressor_setpoint_temperature_schedule_name [string]
- dead_band_temperature_difference [number] (Default: 5.0)
- condenser_bottom_location [number] (Default: 0.0)
- condenser_top_location [number]
- evaporator_air_flow_rate [unknown field type]
- inlet_air_configuration [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- outdoor_air_node_name [string]
- exhaust_air_node_name [string]
- inlet_air_temperature_schedule_name [string]
- inlet_air_humidity_schedule_name [string]
- inlet_air_zone_name [string]
- tank_object_type [string] (Default: WaterHeater:Stratified)
- tank_name [string]
- tank_use_side_inlet_node_name [string]
- tank_use_side_outlet_node_name [string]
- dx_coil_object_type [string] (Default: Coil:WaterHeating:AirToWaterHeatPump:Wrapped)
- dx_coil_name [string]
- minimum_inlet_air_temperature_for_compressor_operation [number] (Default: 10.0)
- maximum_inlet_air_temperature_for_compressor_operation [number] (Default: 48.88888888889)
- compressor_location [string]
- compressor_ambient_temperature_schedule_name [string]
- fan_object_type [string] (Default: Fan:OnOff)
- fan_name [string]
- fan_placement [string] (Default: DrawThrough)
- on_cycle_parasitic_electric_load [number] (Default: 0.0)
- off_cycle_parasitic_electric_load [number] (Default: 0.0)
- parasitic_heat_rejection_location [string] (Default: Outdoors)
- inlet_air_mixer_node_name [string]
- outlet_air_splitter_node_name [string]
- inlet_air_mixer_schedule_name [string]
- tank_element_control_logic [string] (Default: Simultaneous)
- control_sensor_1_height_in_stratified_tank [number]
- control_sensor_1_weight [number] (Default: 1.0)
- control_sensor_2_height_in_stratified_tank [number]

ThermalStorage:Ice:Simple¶

This ice storage model is a simplified model It requires a setpoint placed on the Chilled Water Side Outlet Node It should be placed in the chilled water supply side outlet branch followed by a pipe. Use the PlantEquipmentOperation:ComponentSetpoint plant operation scheme.

Fields
- ice_storage_type [string]
- capacity [number]
- inlet_node_name [string]
- outlet_node_name [string]

ThermalStorage:Ice:Detailed¶

This input syntax is intended to describe a thermal storage system that includes smaller containers filled with water that are placed in a larger tank or series of tanks. The model uses polynomial equations to describe the system performance.

Fields
- availability_schedule_name [string]
- capacity [number]
- inlet_node_name [string]
- outlet_node_name [string]
- discharging_curve_variable_specifications [string]
- discharging_curve_name [string]
- charging_curve_variable_specifications [string]
- charging_curve_name [string]
- timestep_of_the_curve_data [number]
- parasitic_electric_load_during_discharging [number]
- parasitic_electric_load_during_charging [number]
- tank_loss_coefficient [number]
- freezing_temperature_of_storage_medium [number] (Default: 0.0)
- thaw_process_indicator [string] (Default: OutsideMelt)

ThermalStorage:ChilledWater:Mixed¶

Chilled water storage with a well-mixed, single-node tank. The chilled water is “used” by drawing from the “Use Side” of the water tank. The tank is indirectly charged by circulating cold water through the “Source Side” of the water tank.

Fields
- tank_volume [number] (Default: 0.1)
- setpoint_temperature_schedule_name [string]
- deadband_temperature_difference [number] (Default: 0.5)
- minimum_temperature_limit [number]
- nominal_cooling_capacity [number]
- ambient_temperature_indicator [string]
- ambient_temperature_schedule_name [string]
- ambient_temperature_zone_name [string]
- ambient_temperature_outdoor_air_node_name [string]
- heat_gain_coefficient_from_ambient_temperature [number]
- use_side_inlet_node_name [string]
- use_side_outlet_node_name [string]
- use_side_heat_transfer_effectiveness [number] (Default: 1.0)
- use_side_availability_schedule_name [string]
- use_side_design_flow_rate [unknown field type] (Default: Autosize)
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- source_side_heat_transfer_effectiveness [number] (Default: 1.0)
- source_side_availability_schedule_name [string]
- source_side_design_flow_rate [unknown field type] (Default: Autosize)
- tank_recovery_time [number] (Default: 4.0)

ThermalStorage:ChilledWater:Stratified¶

Chilled water storage with a stratified, multi-node tank. The chilled water is “used” by drawing from the “Use Side” of the water tank. The tank is indirectly charged by circulating cold water through the “Source Side” of the water tank.

Fields
- tank_volume [number]
- tank_height [number]
- tank_shape [string] (Default: VerticalCylinder)
- tank_perimeter [number]
- setpoint_temperature_schedule_name [string]
- deadband_temperature_difference [number] (Default: 0.0)
- temperature_sensor_height [number]
- minimum_temperature_limit [number]
- nominal_cooling_capacity [number]
- ambient_temperature_indicator [string]
- ambient_temperature_schedule_name [string]
- ambient_temperature_zone_name [string]
- ambient_temperature_outdoor_air_node_name [string]
- uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature [number]
- use_side_inlet_node_name [string]
- use_side_outlet_node_name [string]
- use_side_heat_transfer_effectiveness [number] (Default: 1.0)
- use_side_availability_schedule_name [string]
- use_side_inlet_height [unknown field type] (Default: Autocalculate)
- use_side_outlet_height [number] (Default: 0.0)
- use_side_design_flow_rate [unknown field type] (Default: Autosize)
- source_side_inlet_node_name [string]
- source_side_outlet_node_name [string]
- source_side_heat_transfer_effectiveness [number] (Default: 1.0)
- source_side_availability_schedule_name [string]
- source_side_inlet_height [number] (Default: 0.0)
- source_side_outlet_height [unknown field type] (Default: Autocalculate)
- source_side_design_flow_rate [unknown field type] (Default: Autosize)
- tank_recovery_time [number] (Default: 4.0)
- inlet_mode [string] (Default: Fixed)
- number_of_nodes [integer] (Default: 1)
- additional_destratification_conductivity [number] (Default: 0.0)
- node_1_additional_loss_coefficient [number] (Default: 0.0)
- node_2_additional_loss_coefficient [number] (Default: 0.0)
- node_3_additional_loss_coefficient [number] (Default: 0.0)
- node_4_additional_loss_coefficient [number] (Default: 0.0)
- node_5_additional_loss_coefficient [number] (Default: 0.0)
- node_6_additional_loss_coefficient [number] (Default: 0.0)
- node_7_additional_loss_coefficient [number] (Default: 0.0)
- node_8_additional_loss_coefficient [number] (Default: 0.0)
- node_9_additional_loss_coefficient [number] (Default: 0.0)
- node_10_additional_loss_coefficient [number] (Default: 0.0)

Plant-Condenser Loops¶

PlantLoop¶

Defines a central plant loop.

Fields
- fluid_type [string] (Default: Water)
- user_defined_fluid_type [string]
- plant_equipment_operation_scheme_name [string]
- loop_temperature_setpoint_node_name [string]
- maximum_loop_temperature [number]
- minimum_loop_temperature [number]
- maximum_loop_flow_rate [unknown field type]
- minimum_loop_flow_rate [number] (Default: 0.0)
- plant_loop_volume [unknown field type] (Default: Autocalculate)
- plant_side_inlet_node_name [string]
- plant_side_outlet_node_name [string]
- plant_side_branch_list_name [string]
- plant_side_connector_list_name [string]
- demand_side_inlet_node_name [string]
- demand_side_outlet_node_name [string]
- demand_side_branch_list_name [string]
- demand_side_connector_list_name [string]
- load_distribution_scheme [string] (Default: SequentialLoad)
- availability_manager_list_name [string]
- plant_loop_demand_calculation_scheme [string] (Default: SingleSetpoint)
- common_pipe_simulation [string] (Default: None)
- pressure_simulation_type [string] (Default: None)
- loop_circulation_time [number] (Default: 2.0)

CondenserLoop¶

Defines a central plant condenser loop. CondenserLoop and PlantLoop are nearly identical except some components and operation schemes are applicable to only one loop type or the other.

Fields
- fluid_type [string] (Default: Water)
- user_defined_fluid_type [string]
- condenser_equipment_operation_scheme_name [string]
- condenser_loop_temperature_setpoint_node_name [string]
- maximum_loop_temperature [number]
- minimum_loop_temperature [number]
- maximum_loop_flow_rate [unknown field type]
- minimum_loop_flow_rate [number] (Default: 0.0)
- condenser_loop_volume [unknown field type] (Default: Autocalculate)
- condenser_side_inlet_node_name [string]
- condenser_side_outlet_node_name [string]
- condenser_side_branch_list_name [string]
- condenser_side_connector_list_name [string]
- demand_side_inlet_node_name [string]
- demand_side_outlet_node_name [string]
- condenser_demand_side_branch_list_name [string]
- condenser_demand_side_connector_list_name [string]
- load_distribution_scheme [string] (Default: SequentialLoad)
- pressure_simulation_type [string] (Default: None)
- loop_circulation_time [number] (Default: 2.0)

Plant-Condenser Control¶

PlantEquipmentList¶

List plant equipment in order of operating priority, 1st in list will be used 1st, etc Use only plant equipment in this list. If no equipment object types and equipment names are specified, then the corresponding PlantEquipmentOperation:* object will assume all available plant equipment for the loop should be OFF (not operate) within the specified lower/upper limit.

Fields
- equipment [Array of {equipment_object_type, equipment_name}]

CondenserEquipmentList¶

List condenser equipment in order of operating priority, 1st in list will be used 1st, etc Use only condenser equipment in this list. If no equipment object types and equipment names are specified, then the corresponding PlantEquipmentOperation:* object will assume all available condenser equipment for the loop should be OFF (not operate) within the specified lower/upper limit.

Fields
- equipment [Array of {equipment_object_type, equipment_name}]

PlantEquipmentOperation:Uncontrolled¶

Plant equipment operation scheme for uncontrolled operation. Specifies a group of equipment that runs if the loop is active, unless turned off by the loop flow resolver to maintain continuity in the fluid loop.

Fields
- equipment_list_name [string]

PlantEquipmentOperation:CoolingLoad¶

Plant equipment operation scheme for cooling load range operation. Specifies one or more groups of equipment which are available to operate for successive cooling load ranges.

Fields
- load_range_1_lower_limit [number]
- load_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- load_range_2_lower_limit [number]
- load_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- load_range_3_lower_limit [number]
- load_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- load_range_4_lower_limit [number]
- load_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- load_range_5_lower_limit [number]
- load_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- load_range_6_lower_limit [number]
- load_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- load_range_7_lower_limit [number]
- load_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- load_range_8_lower_limit [number]
- load_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- load_range_9_lower_limit [number]
- load_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- load_range_10_lower_limit [number]
- load_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:HeatingLoad¶

Plant equipment operation scheme for heating load range operation. Specifies one or more groups of equipment which are available to operate for successive heating load ranges.

Fields
- load_range_1_lower_limit [number]
- load_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- load_range_2_lower_limit [number]
- load_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- load_range_3_lower_limit [number]
- load_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- load_range_4_lower_limit [number]
- load_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- load_range_5_lower_limit [number]
- load_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- load_range_6_lower_limit [number]
- load_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- load_range_7_lower_limit [number]
- load_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- load_range_8_lower_limit [number]
- load_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- load_range_9_lower_limit [number]
- load_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- load_range_10_lower_limit [number]
- load_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:OutdoorDryBulb¶

Plant equipment operation scheme for outdoor dry-bulb temperature range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor dry-bulb temperature ranges.

Fields
- dry_bulb_temperature_range_1_lower_limit [number]
- dry_bulb_temperature_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- dry_bulb_temperature_range_2_lower_limit [number]
- dry_bulb_temperature_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- dry_bulb_temperature_range_3_lower_limit [number]
- dry_bulb_temperature_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- dry_bulb_temperature_range_4_lower_limit [number]
- dry_bulb_temperature_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- dry_bulb_temperature_range_5_lower_limit [number]
- dry_bulb_temperature_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- dry_bulb_temperature_range_6_lower_limit [number]
- dry_bulb_temperature_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- dry_bulb_temperature_range_7_lower_limit [number]
- dry_bulb_temperature_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- dry_bulb_temperature_range_8_lower_limit [number]
- dry_bulb_temperature_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- dry_bulb_temperature_range_9_lower_limit [number]
- dry_bulb_temperature_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- dry_bulb_temperature_range_10_lower_limit [number]
- dry_bulb_temperature_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:OutdoorWetBulb¶

Plant equipment operation scheme for outdoor wet-bulb temperature range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor wet-bulb temperature ranges.

Fields
- wet_bulb_temperature_range_1_lower_limit [number]
- wet_bulb_temperature_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- wet_bulb_temperature_range_2_lower_limit [number]
- wet_bulb_temperature_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- wet_bulb_temperature_range_3_lower_limit [number]
- wet_bulb_temperature_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- wet_bulb_temperature_range_4_lower_limit [number]
- wet_bulb_temperature_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- wet_bulb_temperature_range_5_lower_limit [number]
- wet_bulb_temperature_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- wet_bulb_temperature_range_6_lower_limit [number]
- wet_bulb_temperature_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- wet_bulb_temperature_range_7_lower_limit [number]
- wet_bulb_temperature_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- wet_bulb_temperature_range_8_lower_limit [number]
- wet_bulb_temperature_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- wet_bulb_temperature_range_9_lower_limit [number]
- wet_bulb_temperature_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- wet_bulb_temperature_range_10_lower_limit [number]
- wet_bulb_temperature_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:OutdoorRelativeHumidity¶

Plant equipment operation scheme for outdoor relative humidity range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor relative humidity ranges.

Fields
- relative_humidity_range_1_lower_limit [number]
- relative_humidity_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- relative_humidity_range_2_lower_limit [number]
- relative_humidity_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- relative_humidity_range_3_lower_limit [number]
- relative_humidity_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- relative_humidity_range_4_lower_limit [number]
- relative_humidity_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- relative_humidity_range_5_lower_limit [number]
- relative_humidity_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- relative_humidity_range_6_lower_limit [number]
- relative_humidity_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- relative_humidity_range_7_lower_limit [number]
- relative_humidity_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- relative_humidity_range_8_lower_limit [number]
- relative_humidity_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- relative_humidity_range_9_lower_limit [number]
- relative_humidity_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- relative_humidity_range_10_lower_limit [number]
- relative_humidity_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:OutdoorDewpoint¶

Plant equipment operation scheme for outdoor dewpoint temperature range operation. Specifies one or more groups of equipment which are available to operate for successive outdoor dewpoint temperature ranges.

Fields
- dewpoint_temperature_range_1_lower_limit [number]
- dewpoint_temperature_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- dewpoint_temperature_range_2_lower_limit [number]
- dewpoint_temperature_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- dewpoint_temperature_range_3_lower_limit [number]
- dewpoint_temperature_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- dewpoint_temperature_range_4_lower_limit [number]
- dewpoint_temperature_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- dewpoint_temperature_range_5_lower_limit [number]
- dewpoint_temperature_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- dewpoint_temperature_range_6_lower_limit [number]
- dewpoint_temperature_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- dewpoint_temperature_range_7_lower_limit [number]
- dewpoint_temperature_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- dewpoint_temperature_range_8_lower_limit [number]
- dewpoint_temperature_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- dewpoint_temperature_range_9_lower_limit [number]
- dewpoint_temperature_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- dewpoint_temperature_range_10_lower_limit [number]
- dewpoint_temperature_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:ComponentSetpoint¶

Plant equipment operation scheme for component setpoint operation. Specifies one or pieces of equipment which are controlled to meet the temperature setpoint at the component outlet node.

Fields
- equipment_1_object_type [string]
- equipment_1_name [string]
- demand_calculation_1_node_name [string]
- setpoint_1_node_name [string]
- component_1_flow_rate [unknown field type]
- operation_1_type [string]
- equipment_2_object_type [string]
- equipment_2_name [string]
- demand_calculation_2_node_name [string]
- setpoint_2_node_name [string]
- component_2_flow_rate [unknown field type]
- operation_2_type [string]
- equipment_3_object_type [string]
- equipment_3_name [string]
- demand_calculation_3_node_name [string]
- setpoint_3_node_name [string]
- component_3_flow_rate [unknown field type]
- operation_3_type [string]
- equipment_4_object_type [string]
- equipment_4_name [string]
- demand_calculation_4_node_name [string]
- setpoint_4_node_name [string]
- component_4_flow_rate [unknown field type]
- operation_4_type [string]
- equipment_5_object_type [string]
- equipment_5_name [string]
- demand_calculation_5_node_name [string]
- setpoint_5_node_name [string]
- component_5_flow_rate [unknown field type]
- operation_5_type [string]
- equipment_6_object_type [string]
- equipment_6_name [string]
- demand_calculation_6_node_name [string]
- setpoint_6_node_name [string]
- component_6_flow_rate [unknown field type]
- operation_6_type [string]
- equipment_7_object_type [string]
- equipment_7_name [string]
- demand_calculation_7_node_name [string]
- setpoint_7_node_name [string]
- component_7_flow_rate [unknown field type]
- operation_7_type [string]
- equipment_8_object_type [string]
- equipment_8_name [string]
- demand_calculation_8_node_name [string]
- setpoint_8_node_name [string]
- component_8_flow_rate [unknown field type]
- operation_8_type [string]
- equipment_9_object_type [string]
- equipment_9_name [string]
- demand_calculation_9_node_name [string]
- setpoint_9_node_name [string]
- component_9_flow_rate [unknown field type]
- operation_9_type [string]
- equipment_10_object_type [string]
- equipment_10_name [string]
- demand_calculation_10_node_name [string]
- setpoint_10_node_name [string]
- component_10_flow_rate [unknown field type]
- operation_10_type [string]

PlantEquipmentOperation:ThermalEnergyStorage¶

Plant equipment operation scheme for simpler input to control thermal (ice) energy storage systems. It replaces a host of setpoint managers with simple, single input values. For more complex controls, use the ComponentSetpoint scheme.

Fields
- on_peak_schedule [string]
- charging_availability_schedule [string]
- non_charging_chilled_water_temperature [number]
- charging_chilled_water_temperature [number]
- component_1_object_type [string]
- component_1_name [string]
- component_1_demand_calculation_node_name [string]
- component_1_setpoint_node_name [string]
- component_1_flow_rate [unknown field type]
- component_1_operation_type [string]
- component_2_object_type [string]
- component_2_name [string]
- component_2_demand_calculation_node_name [string]
- component_2_setpoint_node_name [string]
- component_2_flow_rate [unknown field type]
- component_2_operation_type [string]
- component_3_object_type [string]
- component_3_name [string]
- component_3_demand_calculation_node_name [string]
- component_3_setpoint_node_name [string]
- component_3_flow_rate [unknown field type]
- component_3_operation_type [string]
- component_4_object_type [string]
- component_4_name [string]
- component_4_demand_calculation_node_name [string]
- component_4_setpoint_node_name [string]
- component_4_flow_rate [unknown field type]
- component_4_operation_type [string]
- component_5_object_type [string]
- component_5_name [string]
- component_5_demand_calculation_node_name [string]
- component_5_setpoint_node_name [string]
- component_5_flow_rate [unknown field type]
- component_5_operation_type [string]
- component_6_object_type [string]
- component_6_name [string]
- component_6_demand_calculation_node_name [string]
- component_6_setpoint_node_name [string]
- component_6_flow_rate [unknown field type]
- component_6_operation_type [string]
- component_7_object_type [string]
- component_7_name [string]
- component_7_demand_calculation_node_name [string]
- component_7_setpoint_node_name [string]
- component_7_flow_rate [unknown field type]
- component_7_operation_type [string]
- component_8_object_type [string]
- component_8_name [string]
- component_8_demand_calculation_node_name [string]
- component_8_setpoint_node_name [string]
- component_8_flow_rate [unknown field type]
- component_8_operation_type [string]
- component_9_object_type [string]
- component_9_name [string]
- component_9_demand_calculation_node_name [string]
- component_9_setpoint_node_name [string]
- component_9_flow_rate [unknown field type]
- component_9_operation_type [string]
- component_10_object_type [string]
- component_10_name [string]
- component_10_demand_calculation_node_name [string]
- component_10_setpoint_node_name [string]
- component_10_flow_rate [unknown field type]
- component_10_operation_type [string]

PlantEquipmentOperation:OutdoorDryBulbDifference¶

Plant equipment operation scheme for outdoor dry-bulb temperature difference operation. Specifies one or more groups of equipment which are available to operate for successive ranges based the difference between a reference node temperature and the outdoor dry-bulb temperature.

Fields
- reference_temperature_node_name [string]
- dry_bulb_temperature_difference_range_1_lower_limit [number]
- dry_bulb_temperature_difference_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- dry_bulb_temperature_difference_range_2_lower_limit [number]
- dry_bulb_temperature_difference_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- dry_bulb_temperature_difference_range_3_lower_limit [number]
- dry_bulb_temperature_difference_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- dry_bulb_temperature_difference_range_4_lower_limit [number]
- dry_bulb_temperature_difference_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- dry_bulb_temperature_difference_range_5_lower_limit [number]
- dry_bulb_temperature_difference_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- dry_bulb_temperature_difference_range_6_lower_limit [number]
- dry_bulb_temperature_difference_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- dry_bulb_temperature_difference_range_7_lower_limit [number]
- dry_bulb_temperature_difference_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- dry_bulb_temperature_difference_range_8_lower_limit [number]
- dry_bulb_temperature_difference_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- dry_bulb_temperature_difference_range_9_lower_limit [number]
- dry_bulb_temperature_difference_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- dry_bulb_temperature_difference_range_10_lower_limit [number]
- dry_bulb_temperature_difference_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:OutdoorWetBulbDifference¶

Plant equipment operation scheme for outdoor wet-bulb temperature difference operation. Specifies one or more groups of equipment which are available to operate for successive ranges based the difference between a reference node temperature and the outdoor wet-bulb temperature.

Fields
- reference_temperature_node_name [string]
- wet_bulb_temperature_difference_range_1_lower_limit [number]
- wet_bulb_temperature_difference_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- wet_bulb_temperature_difference_range_2_lower_limit [number]
- wet_bulb_temperature_difference_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- wet_bulb_temperature_difference_range_3_lower_limit [number]
- wet_bulb_temperature_difference_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- wet_bulb_temperature_difference_range_4_lower_limit [number]
- wet_bulb_temperature_difference_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- wet_bulb_temperature_difference_range_5_lower_limit [number]
- wet_bulb_temperature_difference_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- wet_bulb_temperature_difference_range_6_lower_limit [number]
- wet_bulb_temperature_difference_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- wet_bulb_temperature_difference_range_7_lower_limit [number]
- wet_bulb_temperature_difference_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- wet_bulb_temperature_difference_range_8_lower_limit [number]
- wet_bulb_temperature_difference_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- wet_bulb_temperature_difference_range_9_lower_limit [number]
- wet_bulb_temperature_difference_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- wet_bulb_temperature_difference_range_10_lower_limit [number]
- wet_bulb_temperature_difference_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperation:OutdoorDewpointDifference¶

Plant equipment operation scheme for outdoor dewpoint temperature difference operation. Specifies one or more groups of equipment which are available to operate for successive ranges based the difference between a reference node temperature and the outdoor dewpoint temperature.

Fields
- reference_temperature_node_name [string]
- dewpoint_temperature_difference_range_1_lower_limit [number]
- dewpoint_temperature_difference_range_1_upper_limit [number]
- range_1_equipment_list_name [string]
- dewpoint_temperature_difference_range_2_lower_limit [number]
- dewpoint_temperature_difference_range_2_upper_limit [number]
- range_2_equipment_list_name [string]
- dewpoint_temperature_difference_range_3_lower_limit [number]
- dewpoint_temperature_difference_range_3_upper_limit [number]
- range_3_equipment_list_name [string]
- dewpoint_temperature_difference_range_4_lower_limit [number]
- dewpoint_temperature_difference_range_4_upper_limit [number]
- range_4_equipment_list_name [string]
- dewpoint_temperature_difference_range_5_lower_limit [number]
- dewpoint_temperature_difference_range_5_upper_limit [number]
- range_5_equipment_list_name [string]
- dewpoint_temperature_difference_range_6_lower_limit [number]
- dewpoint_temperature_difference_range_6_upper_limit [number]
- range_6_equipment_list_name [string]
- dewpoint_temperature_difference_range_7_lower_limit [number]
- dewpoint_temperature_difference_range_7_upper_limit [number]
- range_7_equipment_list_name [string]
- dewpoint_temperature_difference_range_8_lower_limit [number]
- dewpoint_temperature_difference_range_8_upper_limit [number]
- range_8_equipment_list_name [string]
- dewpoint_temperature_difference_range_9_lower_limit [number]
- dewpoint_temperature_difference_range_9_upper_limit [number]
- range_9_equipment_list_name [string]
- dewpoint_temperature_difference_range_10_lower_limit [number]
- dewpoint_temperature_difference_range_10_upper_limit [number]
- range_10_equipment_list_name [string]

PlantEquipmentOperationSchemes¶

Operation schemes are listed in “priority” order. Note that each scheme must address the entire load and/or condition ranges for the simulation. The actual one selected for use will be the first that is “Scheduled” on. That is, if control scheme 1 is not “on” and control scheme 2 is – then control scheme 2 is selected. Only plant equipment should be listed on a Control Scheme for this item.

Fields
- control_scheme_1_object_type [string]
- control_scheme_1_name [string]
- control_scheme_1_schedule_name [string]
- control_scheme_2_object_type [string]
- control_scheme_2_name [string]
- control_scheme_2_schedule_name [string]
- control_scheme_3_object_type [string]
- control_scheme_3_name [string]
- control_scheme_3_schedule_name [string]
- control_scheme_4_object_type [string]
- control_scheme_4_name [string]
- control_scheme_4_schedule_name [string]
- control_scheme_5_object_type [string]
- control_scheme_5_name [string]
- control_scheme_5_schedule_name [string]
- control_scheme_6_object_type [string]
- control_scheme_6_name [string]
- control_scheme_6_schedule_name [string]
- control_scheme_7_object_type [string]
- control_scheme_7_name [string]
- control_scheme_7_schedule_name [string]
- control_scheme_8_object_type [string]
- control_scheme_8_name [string]
- control_scheme_8_schedule_name [string]

CondenserEquipmentOperationSchemes¶

Operation schemes are listed in “priority” order. Note that each scheme must address the entire load and/or condition ranges for the simulation. The actual one selected for use will be the first that is “Scheduled” on. That is, if control scheme 1 is not “on” and control scheme 2 is – then control scheme 2 is selected. Only condenser equipment should be listed on a Control Scheme for this item.

Fields
- control_scheme_1_object_type [string]
- control_scheme_1_name [string]
- control_scheme_1_schedule_name [string]
- control_scheme_2_object_type [string]
- control_scheme_2_name [string]
- control_scheme_2_schedule_name [string]
- control_scheme_3_object_type [string]
- control_scheme_3_name [string]
- control_scheme_3_schedule_name [string]
- control_scheme_4_object_type [string]
- control_scheme_4_name [string]
- control_scheme_4_schedule_name [string]
- control_scheme_5_object_type [string]
- control_scheme_5_name [string]
- control_scheme_5_schedule_name [string]
- control_scheme_6_object_type [string]
- control_scheme_6_name [string]
- control_scheme_6_schedule_name [string]
- control_scheme_7_object_type [string]
- control_scheme_7_name [string]
- control_scheme_7_schedule_name [string]
- control_scheme_8_object_type [string]
- control_scheme_8_name [string]
- control_scheme_8_schedule_name [string]

Energy Management System (EMS)¶

EnergyManagementSystem:Sensor¶

Declares EMS variable as a sensor a list of output variables and meters that can be reported are available after a run on the report (.rdd) or meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Fields
- output_variable_or_output_meter_index_key_name [string]
- output_variable_or_output_meter_name [string]

EnergyManagementSystem:Actuator¶

Hardware portion of EMS used to set up actuators in the model

Fields
- actuated_component_unique_name [string]
- actuated_component_type [string]
- actuated_component_control_type [string]

EnergyManagementSystem:ProgramCallingManager¶

Input EMS program. a program needs a name a description of when it should be called and then lines of program code for EMS Runtime language

Fields
- energyplus_model_calling_point [string]
- programs [Array of {program_name}]

EnergyManagementSystem:Program¶

This input defines an Erl program Each field after the name is a line of EMS Runtime Language

Fields
- lines [Array of {program_line}]

EnergyManagementSystem:Subroutine¶

This input defines an Erl program subroutine Each field after the name is a line of EMS Runtime Language

Fields
- lines [Array of {program_line}]

EnergyManagementSystem:GlobalVariable¶

Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

Fields
- variables [Array of {erl_variable_name}]

EnergyManagementSystem:OutputVariable¶

This object sets up an EnergyPlus output variable from an Erl variable

Fields
- ems_variable_name [string]
- type_of_data_in_variable [string]
- update_frequency [string]
- ems_program_or_subroutine_name [string]
- units [string]

EnergyManagementSystem:MeteredOutputVariable¶

This object sets up an EnergyPlus output variable from an Erl variable

Fields
- ems_variable_name [string]
- update_frequency [string]
- ems_program_or_subroutine_name [string]
- resource_type [string]
- group_type [string]
- end_use_category [string]
- end_use_subcategory [string]
- units [string]

EnergyManagementSystem:TrendVariable¶

This object sets up an EMS trend variable from an Erl variable A trend variable logs values across timesteps

Fields
- ems_variable_name [string]
- number_of_timesteps_to_be_logged [integer]

EnergyManagementSystem:InternalVariable¶

Declares EMS variable as an internal data variable

Fields
- internal_data_index_key_name [string]
- internal_data_type [string]

EnergyManagementSystem:CurveOrTableIndexVariable¶

Declares EMS variable that identifies a curve or table

Fields
- curve_or_table_object_name [string]

EnergyManagementSystem:ConstructionIndexVariable¶

Declares EMS variable that identifies a construction

Fields
- construction_object_name [string]

External Interface¶

ExternalInterface¶

This object activates the external interface of EnergyPlus. If the object ExternalInterface is present, then all ExtnernalInterface:* objects will receive their values from the BCVTB interface or from FMUs at each zone time step. If this object is not present, then the values of these objects will be fixed at the value declared in the “initial value” field of the corresponding object, and a warning will be written to the EnergyPlus error file.

Fields
- name_of_external_interface [string]

ExternalInterface:Schedule¶

A ExternalInterface:Schedule contains only one value, which is used during the warm-up period and the system sizing.

Fields
- schedule_type_limits_name [string]
- initial_value [number]

ExternalInterface:Variable¶

This input object is similar to EnergyManagementSystem:GlobalVariable. However, at the beginning of each zone time step, its value is set to the value received from the external interface. During the warm-up period and the system sizing, its value is set to the value specified by the field “initial value.” This object can be used to move data into Erl subroutines.

Fields
- initial_value [number]

ExternalInterface:Actuator¶

Hardware portion of EMS used to set up actuators in the model

Fields
- actuated_component_unique_name [string]
- actuated_component_type [string]
- actuated_component_control_type [string]
- optional_initial_value [number]

ExternalInterface:FunctionalMockupUnitImport¶

This object declares an FMU

Fields
- fmu_file_name [string]
- fmu_timeout [number] (Default: 0.0)
- fmu_loggingon [integer] (Default: 0)

ExternalInterface:FunctionalMockupUnitImport:From:Variable¶

This object declares an FMU input variable

Fields
- output_variable_index_key_name [string]
- output_variable_name [string]
- fmu_file_name [string]
- fmu_instance_name [string]
- fmu_variable_name [string]

ExternalInterface:FunctionalMockupUnitImport:To:Schedule¶

This objects contains only one value, which is used during the first call of EnergyPlus

Fields
- schedule_type_limits_names [string]
- fmu_file_name [string]
- fmu_instance_name [string]
- fmu_variable_name [string]
- initial_value [number]

ExternalInterface:FunctionalMockupUnitImport:To:Actuator¶

Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.

Fields
- actuated_component_unique_name [string]
- actuated_component_type [string]
- actuated_component_control_type [string]
- fmu_file_name [string]
- fmu_instance_name [string]
- fmu_variable_name [string]
- initial_value [number]

ExternalInterface:FunctionalMockupUnitImport:To:Variable¶

Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

Fields
- fmu_file_name [string]
- fmu_instance_name [string]
- fmu_variable_name [string]
- initial_value [number]

ExternalInterface:FunctionalMockupUnitExport:From:Variable¶

This object declares an FMU input variable

Fields
- output_variable_index_key_name [string]
- output_variable_name [string]
- fmu_variable_name [string]

ExternalInterface:FunctionalMockupUnitExport:To:Schedule¶

This objects contains only one value, which is used during the first call of EnergyPlus

Fields
- schedule_name [string]
- schedule_type_limits_names [string]
- fmu_variable_name [string]
- initial_value [number]

ExternalInterface:FunctionalMockupUnitExport:To:Actuator¶

Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.

Fields
- actuated_component_unique_name [string]
- actuated_component_type [string]
- actuated_component_control_type [string]
- fmu_variable_name [string]
- initial_value [number]

ExternalInterface:FunctionalMockupUnitExport:To:Variable¶

Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

Fields
- fmu_variable_name [string]
- initial_value [number]

User Defined HVAC and Plant Component Models¶

ZoneHVAC:ForcedAir:UserDefined¶

Defines a generic zone air unit for custom modeling using Energy Management System or External Interface

Fields
- overall_model_simulation_program_calling_manager_name [string]
- model_setup_and_sizing_program_calling_manager_name [string]
- primary_air_inlet_node_name [string]
- primary_air_outlet_node_name [string]
- secondary_air_inlet_node_name [string]
- secondary_air_outlet_node_name [string]
- number_of_plant_loop_connections [integer]
- plant_connection_1_inlet_node_name [string]
- plant_connection_1_outlet_node_name [string]
- plant_connection_2_inlet_node_name [string]
- plant_connection_2_outlet_node_name [string]
- plant_connection_3_inlet_node_name [string]
- plant_connection_3_outlet_node_name [string]
- supply_inlet_water_storage_tank_name [string]
- collection_outlet_water_storage_tank_name [string]
- ambient_zone_name [string]

AirTerminal:SingleDuct:UserDefined¶

Defines a generic single duct air terminal unit for custom modeling using Energy Management System or External Interface

Fields
- overall_model_simulation_program_calling_manager_name [string]
- model_setup_and_sizing_program_calling_manager_name [string]
- primary_air_inlet_node_name [string]
- primary_air_outlet_node_name [string]
- secondary_air_inlet_node_name [string]
- secondary_air_outlet_node_name [string]
- number_of_plant_loop_connections [integer]
- plant_connection_1_inlet_node_name [string]
- plant_connection_1_outlet_node_name [string]
- plant_connection_2_inlet_node_name [string]
- plant_connection_2_outlet_node_name [string]
- supply_inlet_water_storage_tank_name [string]
- collection_outlet_water_storage_tank_name [string]
- ambient_zone_name [string]

Coil:UserDefined¶

Defines a generic air system component for custom modeling using Energy Management System or External Interface

Fields
- overall_model_simulation_program_calling_manager_name [string]
- model_setup_and_sizing_program_calling_manager_name [string]
- number_of_air_connections [integer]
- air_connection_1_inlet_node_name [string]
- air_connection_1_outlet_node_name [string]
- air_connection_2_inlet_node_name [string]
- air_connection_2_outlet_node_name [string]
- plant_connection_is_used [string]
- plant_connection_inlet_node_name [string]
- plant_connection_outlet_node_name [string]
- supply_inlet_water_storage_tank_name [string]
- collection_outlet_water_storage_tank_name [string]
- ambient_zone_name [string]

PlantComponent:UserDefined¶

Defines a generic plant component for custom modeling using Energy Management System or External Interface

Fields
- main_model_program_calling_manager_name [string]
- number_of_plant_loop_connections [integer]
- plant_connection_1_inlet_node_name [string]
- plant_connection_1_outlet_node_name [string]
- plant_connection_1_loading_mode [string]
- plant_connection_1_loop_flow_request_mode [string]
- plant_connection_1_initialization_program_calling_manager_name [string]
- plant_connection_1_simulation_program_calling_manager_name [string]
- plant_connection_2_inlet_node_name [string]
- plant_connection_2_outlet_node_name [string]
- plant_connection_2_loading_mode [string]
- plant_connection_2_loop_flow_request_mode [string]
- plant_connection_2_initialization_program_calling_manager_name [string]
- plant_connection_2_simulation_program_calling_manager_name [string]
- plant_connection_3_inlet_node_name [string]
- plant_connection_3_outlet_node_name [string]
- plant_connection_3_loading_mode [string]
- plant_connection_3_loop_flow_request_mode [string]
- plant_connection_3_initialization_program_calling_manager_name [string]
- plant_connection_3_simulation_program_calling_manager_name [string]
- plant_connection_4_inlet_node_name [string]
- plant_connection_4_outlet_node_name [string]
- plant_connection_4_loading_mode [string]
- plant_connection_4_loop_flow_request_mode [string]
- plant_connection_4_initialization_program_calling_manager_name [string]
- plant_connection_4_simulation_program_calling_manager_name [string]
- air_connection_inlet_node_name [string]
- air_connection_outlet_node_name [string]
- supply_inlet_water_storage_tank_name [string]
- collection_outlet_water_storage_tank_name [string]
- ambient_zone_name [string]

PlantEquipmentOperation:UserDefined¶

Defines a generic plant operation scheme for custom supervisory control using Energy Management System or External Interface to dispatch loads

Fields
- main_model_program_calling_manager_name [string]
- initialization_program_calling_manager_name [string]
- equipment_1_object_type [string]
- equipment_1_name [string]
- equipment_2_object_type [string]
- equipment_2_name [string]
- equipment_3_object_type [string]
- equipment_3_name [string]
- equipment_4_object_type [string]
- equipment_4_name [string]
- equipment_5_object_type [string]
- equipment_5_name [string]
- equipment_6_object_type [string]
- equipment_6_name [string]
- equipment_7_object_type [string]
- equipment_7_name [string]
- equipment_8_object_type [string]
- equipment_8_name [string]
- equipment_9_object_type [string]
- equipment_9_name [string]
- equipment_10_object_type [string]
- equipment_10_name [string]

System Availability Managers¶

AvailabilityManager:Scheduled¶

Determines the availability of a loop or system: whether it is on or off. Schedule overrides fan/pump schedule.

Fields
- schedule_name [string]

AvailabilityManager:ScheduledOn¶

Determines the availability of a loop or system: only controls the turn on action. Schedule overrides fan/pump schedule.

Fields
- schedule_name [string]

AvailabilityManager:ScheduledOff¶

Determines the availability of a loop or system: only controls the turn off action. Schedule overrides fan/pump schedule.

Fields
- schedule_name [string]

AvailabilityManager:OptimumStart¶

Determines the optimal start of HVAC systems before occupancy.

Fields
- applicability_schedule_name [string]
- fan_schedule_name [string]
- control_type [string] (Default: ControlZone)
- control_zone_name [string]
- zone_list_name [string]
- maximum_value_for_optimum_start_time [number] (Default: 6.0)
- control_algorithm [string] (Default: AdaptiveASHRAE)
- constant_temperature_gradient_during_cooling [number]
- constant_temperature_gradient_during_heating [number]
- initial_temperature_gradient_during_cooling [number]
- initial_temperature_gradient_during_heating [number]
- constant_start_time [number]
- number_of_previous_days [integer] (Default: 2)

AvailabilityManager:NightCycle¶

Determines the availability of a loop or system: whether it is on or off. Depending on zone temperatures, overrides Schedules and forces system Fans on.

Fields
- applicability_schedule_name [string]
- fan_schedule_name [string]
- control_type [string] (Default: StayOff)
- thermostat_tolerance [number] (Default: 1.0)
- cycling_run_time_control_type [string] (Default: FixedRunTime)
- cycling_run_time [number] (Default: 3600.0)
- control_zone_or_zone_list_name [string]
- cooling_control_zone_or_zone_list_name [string]
- heating_control_zone_or_zone_list_name [string]
- heating_zone_fans_only_zone_or_zone_list_name [string]

AvailabilityManager:DifferentialThermostat¶

Overrides fan/pump schedules depending on temperature difference between two nodes.

Fields
- hot_node_name [string]
- cold_node_name [string]
- temperature_difference_on_limit [number]
- temperature_difference_off_limit [number]

AvailabilityManager:HighTemperatureTurnOff¶

Overrides fan/pump schedules depending on temperature at sensor node.

Fields
- sensor_node_name [string]
- temperature [number]

AvailabilityManager:HighTemperatureTurnOn¶

Overrides fan/pump schedules depending on temperature at sensor node.

Fields
- sensor_node_name [string]
- temperature [number]

AvailabilityManager:LowTemperatureTurnOff¶

Overrides fan/pump schedules depending on temperature at sensor node.

Fields
- sensor_node_name [string]
- temperature [number]
- applicability_schedule_name [string]

AvailabilityManager:LowTemperatureTurnOn¶

Overrides fan/pump schedules depending on temperature at sensor node.

Fields
- sensor_node_name [string]
- temperature [number]

AvailabilityManager:NightVentilation¶

depending on zone and outdoor conditions overrides fan schedule to do precooling with outdoor air

Fields
- applicability_schedule_name [string]
- fan_schedule_name [string]
- ventilation_temperature_schedule_name [string]
- ventilation_temperature_difference [number] (Default: 2.0)
- ventilation_temperature_low_limit [number] (Default: 15.0)
- night_venting_flow_fraction [number] (Default: 1.0)
- control_zone_name [string]

AvailabilityManager:HybridVentilation¶

Depending on zone and outdoor conditions overrides window/door opening controls to maximize natural ventilation and turn off an HVAC system when ventilation control conditions are met. This object (zone ventilation object name) has not been instrumented to work with global Zone or Zone List names option for Ventilation:DesignFlowRate. In order to use, you must enter the single <Ventilation:DesignFlowRate> name in that field. If it is a part of a global ventilation assignment the name will be <Zone Name> <global Ventilation:DesignFlowRate> name. Currently, hybrid ventilation manager is restricted to one per zone. It can either be applied through the air loop or directly to the zone. If hybrid ventilation manager is applied to an air loop and one of the zones served by that air loop also has hybrid ventilation manager, then zone hybrid ventilation manager is disabled.

Fields
- hvac_air_loop_name [string]
- control_zone_name [string]
- ventilation_control_mode_schedule_name [string]
- use_weather_file_rain_indicators [string] (Default: Yes)
- maximum_wind_speed [number] (Default: 40.0)
- minimum_outdoor_temperature [number] (Default: -100.0)
- maximum_outdoor_temperature [number] (Default: 100.0)
- minimum_outdoor_enthalpy [number]
- maximum_outdoor_enthalpy [number]
- minimum_outdoor_dewpoint [number] (Default: -100.0)
- maximum_outdoor_dewpoint [number] (Default: 100.0)
- minimum_outdoor_ventilation_air_schedule_name [string]
- opening_factor_function_of_wind_speed_curve_name [string]
- airflownetwork_control_type_schedule_name [string]
- simple_airflow_control_type_schedule_name [string]
- zoneventilation_object_name [string]
- minimum_hvac_operation_time [number] (Default: 0.0)
- minimum_ventilation_time [number] (Default: 0.0)

AvailabilityManagerAssignmentList¶

Defines the applicable managers used for an AirLoopHVAC or PlantLoop. The priority of availability managers is based on a set of rules and are specific to the type of loop. The output from each availability manager is an availability status flag: NoAction, ForceOff, CycleOn, or CycleOnZoneFansOnly (used only for air loops).

Fields
- managers [Array of {availability_manager_object_type, availability_manager_name}]

Setpoint Managers¶

SetpointManager:Scheduled¶

The simplest Setpoint Manager simply uses a schedule to determine one or more setpoints. Values of the nodes are not used as input.

Fields
- control_variable [string]
- schedule_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:Scheduled:DualSetpoint¶

This setpoint manager places a high and low schedule value on one or more nodes.

Fields
- control_variable [string] (Default: Temperature)
- high_setpoint_schedule_name [string]
- low_setpoint_schedule_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:OutdoorAirReset¶

This Setpoint Manager is used to place a setpoint temperature on system node according to the outdoor air temperature using a reset rule. The outdoor air temperature is obtained from the weather information during the simulation.

Fields
- control_variable [string] (Default: Temperature)
- setpoint_at_outdoor_low_temperature [number]
- outdoor_low_temperature [number]
- setpoint_at_outdoor_high_temperature [number]
- outdoor_high_temperature [number]
- setpoint_node_or_nodelist_name [string]
- schedule_name [string]
- setpoint_at_outdoor_low_temperature_2 [number]
- outdoor_low_temperature_2 [number]
- setpoint_at_outdoor_high_temperature_2 [number]
- outdoor_high_temperature_2 [number]

SetpointManager:SingleZone:Reheat¶

This setpoint manager detects the control zone load, zone inlet node flow rate, and zone node temperature and calculates a setpoint temperature for the supply air that will satisfy the zone load (heating or cooling) for the control zone. This setpoint manager is not limited to reheat applications.

Fields
- control_variable [string] (Default: Temperature)
- minimum_supply_air_temperature [number] (Default: -99.0)
- maximum_supply_air_temperature [number] (Default: 99.0)
- control_zone_name [string]
- zone_node_name [string]
- zone_inlet_node_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:SingleZone:Heating¶

This setpoint manager detects the control zone load to meet the current heating setpoint, zone inlet node flow rate, and zone node temperature, and calculates a setpoint temperature for the supply air that will satisfy the zone heating load for the control zone.

Fields
- control_variable [string] (Default: Temperature)
- minimum_supply_air_temperature [number] (Default: -99.0)
- maximum_supply_air_temperature [number] (Default: 99.0)
- control_zone_name [string]
- zone_node_name [string]
- zone_inlet_node_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:SingleZone:Cooling¶

This setpoint manager detects the control zone load to meet the current cooling setpoint, zone inlet node flow rate, and zone node temperature, and calculates a setpoint temperature for the supply air that will satisfy the zone cooling load for the control zone.

Fields
- control_variable [string] (Default: Temperature)
- minimum_supply_air_temperature [number] (Default: -99.0)
- maximum_supply_air_temperature [number] (Default: 99.0)
- control_zone_name [string]
- zone_node_name [string]
- zone_inlet_node_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:SingleZone:Humidity:Minimum¶

The Single Zone Minimum Humidity Setpoint Manager allows the control of a single zone minimum humidity level. This setpoint manager can be used in conjunction with object ZoneControl:Humidistat to detect humidity levels.

Fields
- setpoint_node_or_nodelist_name [string]
- control_zone_air_node_name [string]

SetpointManager:SingleZone:Humidity:Maximum¶

The Single Zone Maximum Humidity Setpoint Manager allows the control of a single zone maximum humidity level. This setpoint manager can be used in conjunction with object ZoneControl:Humidistat to detect humidity levels.

Fields
- setpoint_node_or_nodelist_name [string]
- control_zone_air_node_name [string]

SetpointManager:MixedAir¶

The Mixed Air Setpoint Manager is meant to be used in conjunction with a Controller:OutdoorAir object. This setpoint manager is used to establish a temperature setpoint at the mixed air node.

Fields
- control_variable [string] (Default: Temperature)
- reference_setpoint_node_name [string]
- fan_inlet_node_name [string]
- fan_outlet_node_name [string]
- setpoint_node_or_nodelist_name [string]
- cooling_coil_inlet_node_name [string]
- cooling_coil_outlet_node_name [string]
- minimum_temperature_at_cooling_coil_outlet_node [number] (Default: 7.2)

SetpointManager:OutdoorAirPretreat¶

This setpoint manager determines the required conditions at the outdoor air stream node which will produce the reference setpoint condition at the mixed air node when mixed with the return air stream

Fields
- control_variable [string]
- minimum_setpoint_temperature [number] (Default: -99.0)
- maximum_setpoint_temperature [number] (Default: 99.0)
- minimum_setpoint_humidity_ratio [number] (Default: 1e-05)
- maximum_setpoint_humidity_ratio [number] (Default: 1.0)
- reference_setpoint_node_name [string]
- mixed_air_stream_node_name [string]
- outdoor_air_stream_node_name [string]
- return_air_stream_node_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:Warmest¶

This SetpointManager resets the cooling supply air temperature of a central forced air HVAC system according to the cooling demand of the warmest zone.

Fields
- control_variable [string] (Default: Temperature)
- hvac_air_loop_name [string]
- minimum_setpoint_temperature [number] (Default: 12.0)
- maximum_setpoint_temperature [number] (Default: 18.0)
- strategy [string] (Default: MaximumTemperature)
- setpoint_node_or_nodelist_name [string]

SetpointManager:Coldest¶

This SetpointManager is used in dual duct systems to reset the setpoint temperature of the air in the heating supply duct. Usually it is used in conjunction with a SetpointManager:Warmest resetting the temperature of the air in the cooling supply duct.

Fields
- control_variable [string] (Default: Temperature)
- hvac_air_loop_name [string]
- minimum_setpoint_temperature [number] (Default: 20.0)
- maximum_setpoint_temperature [number] (Default: 50.0)
- strategy [string] (Default: MinimumTemperature)
- setpoint_node_or_nodelist_name [string]

SetpointManager:ReturnAirBypassFlow¶

This setpoint manager determines the required mass flow rate through a return air bypass duct to meet the specified temperature setpoint

Fields
- control_variable [string] (Default: Flow)
- hvac_air_loop_name [string]
- temperature_setpoint_schedule_name [string]

SetpointManager:WarmestTemperatureFlow¶

This setpoint manager sets both the supply air temperature and the supply air flow rate.

Fields
- control_variable [string]
- hvac_air_loop_name [string]
- minimum_setpoint_temperature [number] (Default: 12.0)
- maximum_setpoint_temperature [number] (Default: 18.0)
- strategy [string] (Default: TemperatureFirst)
- setpoint_node_or_nodelist_name [string]
- minimum_turndown_ratio [number] (Default: 0.2)

SetpointManager:MultiZone:Heating:Average¶

This setpoint manager sets the average supply air temperature based on the heating load requirements of all controlled zones in an air loop served by a central air-conditioner.

Fields
- hvac_air_loop_name [string]
- minimum_setpoint_temperature [number] (Default: 20.0)
- maximum_setpoint_temperature [number] (Default: 50.0)
- setpoint_node_or_nodelist_name [string]

SetpointManager:MultiZone:Cooling:Average¶

This setpoint manager sets the average supply air temperature based on the cooling load requirements of all controlled zones in an air loop served by a central air-conditioner.

Fields
- hvac_air_loop_name [string]
- minimum_setpoint_temperature [number] (Default: 12.0)
- maximum_setpoint_temperature [number] (Default: 18.0)
- setpoint_node_or_nodelist_name [string]

SetpointManager:MultiZone:MinimumHumidity:Average¶

This setpoint manager sets the average supply air minimum humidity ratio based on moisture load requirements of all controlled zones in an air loop served by a central air-conditioner.

Fields
- hvac_air_loop_name [string]
- minimum_setpoint_humidity_ratio [number] (Default: 0.005)
- maximum_setpoint_humidity_ratio [number] (Default: 0.012)
- setpoint_node_or_nodelist_name [string]

SetpointManager:MultiZone:MaximumHumidity:Average¶

This setpoint manager sets the average supply air maximum humidity ratio based on moisture load requirements of all controlled zones in an air loop served by a central air-conditioner.

Fields
- hvac_air_loop_name [string]
- minimum_setpoint_humidity_ratio [number] (Default: 0.008)
- maximum_setpoint_humidity_ratio [number] (Default: 0.015)
- setpoint_node_or_nodelist_name [string]

SetpointManager:MultiZone:Humidity:Minimum¶

This setpoint manager sets the minimum supply air humidity ratio based on humidification requirements of a controlled zone with critical humidity ratio setpoint (i.e., a zone with the highest humidity ratio setpoint) in an air loop served by a central air-conditioner.

Fields
- hvac_air_loop_name [string]
- minimum_setpoint_humidity_ratio [number] (Default: 0.005)
- maximum_setpoint_humidity_ratio [number] (Default: 0.012)
- setpoint_node_or_nodelist_name [string]

SetpointManager:MultiZone:Humidity:Maximum¶

This setpoint manager sets the maximum supply air humidity ratio based on dehumidification requirements of a controlled zone with critical humidity ratio setpoint (i.e., a zone with the lowest humidity ratio setpoint) in an air loop served by a central air-conditioner.

Fields
- hvac_air_loop_name [string]
- minimum_setpoint_humidity_ratio [number] (Default: 0.008)
- maximum_setpoint_humidity_ratio [number] (Default: 0.015)
- setpoint_node_or_nodelist_name [string]

SetpointManager:FollowOutdoorAirTemperature¶

This setpoint manager is used to place a temperature setpoint on a system node that is derived from the current outdoor air environmental conditions. The outdoor air conditions are obtained from the weather information during the simulation.

Fields
- control_variable [string] (Default: Temperature)
- reference_temperature_type [string] (Default: OutdoorAirWetBulb)
- offset_temperature_difference [number]
- maximum_setpoint_temperature [number]
- minimum_setpoint_temperature [number]
- setpoint_node_or_nodelist_name [string]

SetpointManager:FollowSystemNodeTemperature¶

This setpoint manager is used to place a temperature setpoint on a system node that is derived from the current temperatures at a separate system node. The current value of the temperature at a reference node is obtained and used to generate setpoint on a second system node. If the reference node is also designated to be an outdoor air (intake) node, then this setpoint manager can be used to follow outdoor air conditions that are adjusted for altitude.

Fields
- control_variable [string] (Default: Temperature)
- reference_node_name [string]
- reference_temperature_type [string] (Default: NodeDryBulb)
- offset_temperature_difference [number]
- maximum_limit_setpoint_temperature [number]
- minimum_limit_setpoint_temperature [number]
- setpoint_node_or_nodelist_name [string]

SetpointManager:FollowGroundTemperature¶

This setpoint manager is used to place a temperature setpoint on a system node that is derived from a current ground temperature. The ground temperatures are specified in different Site:GroundTemperature:* objects and used during the simulation. This setpoint manager is primarily intended for condenser or plant loops using some type of ground heat exchanger.

Fields
- control_variable [string] (Default: Temperature)
- reference_ground_temperature_object_type [string]
- offset_temperature_difference [number]
- maximum_setpoint_temperature [number]
- minimum_setpoint_temperature [number]
- setpoint_node_or_nodelist_name [string]

SetpointManager:CondenserEnteringReset¶

This setpoint manager uses one curve to determine the optimum condenser entering water temperature for a given timestep and two other curves to place boundary conditions on the setpoint value.

Fields
- control_variable [string] (Default: Temperature)
- default_condenser_entering_water_temperature_schedule_name [string]
- minimum_design_wetbulb_temperature_curve_name [string]
- minimum_outside_air_wetbulb_temperature_curve_name [string]
- optimized_cond_entering_water_temperature_curve_name [string]
- minimum_lift [number] (Default: 11.1)
- maximum_condenser_entering_water_temperature [number] (Default: 32.0)
- cooling_tower_design_inlet_air_wet_bulb_temperature [number] (Default: 25.56)
- setpoint_node_or_nodelist_name [string]

SetpointManager:CondenserEnteringReset:Ideal¶

This setpoint manager determine the ideal optimum condenser entering water temperature setpoint for a given timestep.

Fields
- control_variable [string] (Default: Temperature)
- minimum_lift [number] (Default: 11.1)
- maximum_condenser_entering_water_temperature [number] (Default: 32.0)
- setpoint_node_or_nodelist_name [string]

SetpointManager:SingleZone:OneStageCooling¶

This object can be used with CoilSystem:Cooling:DX to model on/off cycling control of single stage air systems. Setpoints are modulated to run coil full on or full off depending on zone conditions. Intended for use with ZoneControl:Thermostat:StagedDualSetpoint

Fields
- cooling_stage_on_supply_air_setpoint_temperature [number] (Default: -99.0)
- cooling_stage_off_supply_air_setpoint_temperature [number] (Default: 99.0)
- control_zone_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:SingleZone:OneStageHeating¶

This object can be used with CoilSystem:Heating:DX, Coil:Heating:Fuel, Coil:Heating:Electric to model on/off cycling control of single stage air systems. Setpoints are modulated to run coil full on or full off depending on zone conditions. Intended for use with ZoneControl:Thermostat:StagedDualSetpoint.

Fields
- heating_stage_on_supply_air_setpoint_temperature [number] (Default: 99.0)
- heating_stage_off_supply_air_setpoint_temperature [number] (Default: -99.0)
- control_zone_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:ReturnTemperature:ChilledWater¶

This setpoint manager is used to place a temperature setpoint on a plant supply outlet node based on a target return water setpoint. The setpoint manager attempts to achieve the desired return water temperature by adjusting the supply temperature setpoint based on the plant conditions at each system time step.

Fields
- plant_loop_supply_outlet_node [string]
- plant_loop_supply_inlet_node [string]
- minimum_supply_temperature_setpoint [number] (Default: 5.0)
- maximum_supply_temperature_setpoint [number] (Default: 10.0)
- return_temperature_setpoint_input_type [string]
- return_temperature_setpoint_constant_value [number] (Default: 13.0)
- return_temperature_setpoint_schedule_name [string]

SetpointManager:ReturnTemperature:HotWater¶

Fields
- plant_loop_supply_outlet_node [string]
- plant_loop_supply_inlet_node [string]
- minimum_supply_temperature_setpoint [number] (Default: 77.0)
- maximum_supply_temperature_setpoint [number] (Default: 82.0)
- return_temperature_setpoint_input_type [string]
- return_temperature_setpoint_constant_value [number] (Default: 71.0)
- return_temperature_setpoint_schedule_name [string]

SetpointManager:SystemNodeReset:Temperature¶

This Setpoint Manager is used to place a temperature setpoint on a system node according to the reference (e.g., return) temperature using a reset rule. The temperature setpoint is obtained by retrieving the temperature of the user specified reference system node.

Fields
- control_variable [string]
- setpoint_at_low_reference_temperature [number]
- setpoint_at_high_reference_temperature [number]
- low_reference_temperature [number]
- high_reference_temperature [number]
- reference_node_name [string]
- setpoint_node_or_nodelist_name [string]

SetpointManager:SystemNodeReset:Humidity¶

This Setpoint Manager is used to place a humidity ratio setpoint on a system node according to the reference (e.g., return) humidity ratio using a reset rule. The humidity ratio setpoint is obtained by retrieving the humidity ratio of the user specified reference system node.

Fields
- control_variable [string]
- setpoint_at_low_reference_humidity_ratio [number]
- setpoint_at_high_reference_humidity_ratio [number]
- low_reference_humidity_ratio [number]
- high_reference_humidity_ratio [number]
- reference_node_name [string]
- setpoint_node_or_nodelist_name [string]

Refrigeration¶

Refrigeration:Case¶

The Refrigeration Case object works in conjunction with a compressor rack, a refrigeration system, or a secondary loop to simulate the performance of a refrigerated case system. The object calculates the energy use for lights, fans and anti-sweat heaters and accounts for the sensible and latent heat exchange with the surrounding environment (termed “case credits”) which impacts the temperature and humidity in the zone where the case is located.

Fields
- availability_schedule_name [string]
- zone_name [string]
- rated_ambient_temperature [number] (Default: 23.9)
- rated_ambient_relative_humidity [number] (Default: 55.0)
- rated_total_cooling_capacity_per_unit_length [number] (Default: 1900.0)
- rated_latent_heat_ratio [number] (Default: 0.3)
- rated_runtime_fraction [number] (Default: 0.85)
- case_length [number] (Default: 3.0)
- case_operating_temperature [number] (Default: 1.1)
- latent_case_credit_curve_type [string] (Default: CaseTemperatureMethod)
- latent_case_credit_curve_name [string]
- standard_case_fan_power_per_unit_length [number] (Default: 75.0)
- operating_case_fan_power_per_unit_length [number] (Default: 75.0)
- standard_case_lighting_power_per_unit_length [number] (Default: 90.0)
- installed_case_lighting_power_per_unit_length [number]
- case_lighting_schedule_name [string]
- fraction_of_lighting_energy_to_case [number] (Default: 1.0)
- case_anti_sweat_heater_power_per_unit_length [number] (Default: 0.0)
- minimum_anti_sweat_heater_power_per_unit_length [number] (Default: 0.0)
- anti_sweat_heater_control_type [string] (Default: None)
- humidity_at_zero_anti_sweat_heater_energy [number] (Default: -10.0)
- case_height [number] (Default: 1.5)
- fraction_of_anti_sweat_heater_energy_to_case [number] (Default: 1.0)
- case_defrost_power_per_unit_length [number] (Default: 0.0)
- case_defrost_type [string] (Default: OffCycle)
- case_defrost_schedule_name [string]
- case_defrost_drip_down_schedule_name [string]
- defrost_energy_correction_curve_type [string] (Default: None)
- defrost_energy_correction_curve_name [string]
- under_case_hvac_return_air_fraction [number] (Default: 0.0)
- refrigerated_case_restocking_schedule_name [string]
- case_credit_fraction_schedule_name [string]
- design_evaporator_temperature_or_brine_inlet_temperature [number]
- average_refrigerant_charge_inventory [number] (Default: 0.0)
- under_case_hvac_return_air_node_name [string]

Refrigeration:CompressorRack¶

Works in conjunction with the refrigeration case and walk-in objects to simulate the performance of a refrigerated case system. This object models the electric consumption of the rack compressors and the condenser fans. Heat can be rejected either outdoors or to a zone. Compressor rack waste heat can also be reclaimed for use by an optional air- or water-heating coil (Coil:Heating:Desuperheater and Coil:WaterHeating:Desuperheater).

Fields
- heat_rejection_location [string] (Default: Outdoors)
- design_compressor_rack_cop [number] (Default: 2.0)
- compressor_rack_cop_function_of_temperature_curve_name [string]
- design_condenser_fan_power [number] (Default: 250.0)
- condenser_fan_power_function_of_temperature_curve_name [string]
- condenser_type [string] (Default: AirCooled)
- water_cooled_condenser_inlet_node_name [string]
- water_cooled_condenser_outlet_node_name [string]
- water_cooled_loop_flow_type [string] (Default: VariableFlow)
- water_cooled_condenser_outlet_temperature_schedule_name [string]
- water_cooled_condenser_design_flow_rate [number]
- water_cooled_condenser_maximum_flow_rate [number]
- water_cooled_condenser_maximum_water_outlet_temperature [number] (Default: 55.0)
- water_cooled_condenser_minimum_water_inlet_temperature [number] (Default: 10.0)
- evaporative_condenser_availability_schedule_name [string]
- evaporative_condenser_effectiveness [number] (Default: 0.9)
- evaporative_condenser_air_flow_rate [unknown field type] (Default: Autocalculate)
- basin_heater_capacity [number] (Default: 200.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- design_evaporative_condenser_water_pump_power [unknown field type] (Default: 1000.0)
- evaporative_water_supply_tank_name [string]
- condenser_air_inlet_node_name [string]
- end_use_subcategory [string] (Default: General)
- refrigeration_case_name_or_walkin_name_or_caseandwalkinlist_name [string]
- heat_rejection_zone_name [string]

Refrigeration:CaseAndWalkInList¶

Provides a list of all the refrigerated cases, walk in coolers, or air chillers cooled by a single refrigeration system. Note that the names of all cases, walk-ins ,air chillers, and CaseAndWalkInLists must be unique. That is, you cannot give a list the same name as one of list items. This list may contain a combination of case and walk-in names OR a list of air chiller names. Air chillers may not be included in any list that also includes cases or walk-ins.

Fields
- cases_and_walkins [Array of {case_or_walkin_name}]

Refrigeration:Condenser:AirCooled¶

Air cooled condenser for a refrigeration system (Refrigeration:System).

Fields
- rated_effective_total_heat_rejection_rate_curve_name [string]
- rated_subcooling_temperature_difference [number] (Default: 0.0)
- condenser_fan_speed_control_type [string] (Default: Fixed)
- rated_fan_power [number] (Default: 250.0)
- minimum_fan_air_flow_ratio [number] (Default: 0.2)
- air_inlet_node_name_or_zone_name [string]
- end_use_subcategory [string] (Default: General)
- condenser_refrigerant_operating_charge_inventory [number] (Default: 0.0)
- condensate_receiver_refrigerant_inventory [number] (Default: 0.0)
- condensate_piping_refrigerant_inventory [number] (Default: 0.0)

Refrigeration:Condenser:EvaporativeCooled¶

Evaporative-cooled condenser for a refrigeration system (Refrigeration:System).

Fields
- rated_effective_total_heat_rejection_rate [number]
- rated_subcooling_temperature_difference [number] (Default: 0.0)
- fan_speed_control_type [string] (Default: Fixed)
- rated_fan_power [number]
- minimum_fan_air_flow_ratio [number] (Default: 0.2)
- approach_temperature_constant_term [number] (Default: 6.63)
- approach_temperature_coefficient_2 [number] (Default: 0.468)
- approach_temperature_coefficient_3 [number] (Default: 17.93)
- approach_temperature_coefficient_4 [number] (Default: -0.322)
- minimum_capacity_factor [number] (Default: 0.5)
- maximum_capacity_factor [number] (Default: 5.0)
- air_inlet_node_name [string]
- rated_air_flow_rate [unknown field type] (Default: Autocalculate)
- basin_heater_capacity [number] (Default: 200.0)
- basin_heater_setpoint_temperature [number] (Default: 2.0)
- rated_water_pump_power [unknown field type] (Default: 1000.0)
- evaporative_water_supply_tank_name [string]
- evaporative_condenser_availability_schedule_name [string]
- end_use_subcategory [string] (Default: General)
- condenser_refrigerant_operating_charge_inventory [number] (Default: 0.0)
- condensate_receiver_refrigerant_inventory [number] (Default: 0.0)
- condensate_piping_refrigerant_inventory [number] (Default: 0.0)

Refrigeration:Condenser:WaterCooled¶

Water cooled condenser for a refrigeration system (Refrigeration:System).

Fields
- rated_effective_total_heat_rejection_rate [number]
- rated_condensing_temperature [number]
- rated_subcooling_temperature_difference [number] (Default: 0.0)
- rated_water_inlet_temperature [number]
- water_inlet_node_name [string]
- water_outlet_node_name [string]
- water_cooled_loop_flow_type [string] (Default: VariableFlow)
- water_outlet_temperature_schedule_name [string]
- water_design_flow_rate [number]
- water_maximum_flow_rate [number]
- water_maximum_water_outlet_temperature [number] (Default: 55.0)
- water_minimum_water_inlet_temperature [number] (Default: 10.0)
- end_use_subcategory [string] (Default: General)
- condenser_refrigerant_operating_charge_inventory [number]
- condensate_receiver_refrigerant_inventory [number]
- condensate_piping_refrigerant_inventory [number]

Refrigeration:Condenser:Cascade¶

Cascade condenser for a refrigeration system (Refrigeration:System). The cascade condenser is unlike the other condenser options because it rejects heat to another, higher-temperature, refrigeration system. That is, the cascade condenser acts as a heat rejection object for one system, but acts as a refrigeration load for another system.

Fields
- rated_condensing_temperature [number]
- rated_approach_temperature_difference [number] (Default: 3.0)
- rated_effective_total_heat_rejection_rate [number]
- condensing_temperature_control_type [string] (Default: Fixed)
- condenser_refrigerant_operating_charge_inventory [number]
- condensate_receiver_refrigerant_inventory [number]
- condensate_piping_refrigerant_inventory [number]

Refrigeration:GasCooler:AirCooled¶

The transcritical refrigeration system requires a single gas cooler to reject the system heat.

Fields
- rated_total_heat_rejection_rate_curve_name [string]
- gas_cooler_fan_speed_control_type [string] (Default: Fixed)
- rated_fan_power [number] (Default: 5000.0)
- minimum_fan_air_flow_ratio [number] (Default: 0.2)
- transition_temperature [number] (Default: 27.0)
- transcritical_approach_temperature [number] (Default: 3.0)
- subcritical_temperature_difference [number] (Default: 10.0)
- minimum_condensing_temperature [number] (Default: 10.0)
- air_inlet_node_name [string]
- end_use_subcategory [string] (Default: General)
- gas_cooler_refrigerant_operating_charge_inventory [number] (Default: 0.0)
- gas_cooler_receiver_refrigerant_inventory [number] (Default: 0.0)
- gas_cooler_outlet_piping_refrigerant_inventory [number] (Default: 0.0)

Refrigeration:TransferLoadList¶

A refrigeration system may provide cooling to other, secondary, systems through either a secondary loop or a cascade condenser. If multiple transfer loads are served by a single primary system, use this list to group them together for reference by the primary system (see the field “Refrigeration Transfer Load or TransferLoad List Name” in the Refrigeration:System object).

Fields
- transfer_loads [Array of {cascade_condenser_name_or_secondary_system_name}]

Refrigeration:Subcooler¶

Two types of subcoolers are modeled by the detailed refrigeration system. The liquid suction heat exchanger uses cool suction gas to subcool the hot condensate after it leaves the condenser and before it reaches the thermal expansion valve. A mechanical subcooler is used to transfer cooling capacity from one refrigeration system to another.

Fields
- subcooler_type [string] (Default: LiquidSuction)
- liquid_suction_design_subcooling_temperature_difference [number]
- design_liquid_inlet_temperature [number]
- design_vapor_inlet_temperature [number]
- capacity_providing_system [string]
- outlet_control_temperature [number]

Refrigeration:Compressor¶

Refrigeration system compressor. Data is available for many compressors in the RefrigerationCompressor.idf dataset

Fields
- refrigeration_compressor_power_curve_name [string]
- refrigeration_compressor_capacity_curve_name [string]
- rated_superheat [number]
- rated_return_gas_temperature [number]
- rated_liquid_temperature [number]
- rated_subcooling [number]
- end_use_subcategory [string] (Default: General)
- mode_of_operation [string] (Default: Subcritical)
- transcritical_compressor_power_curve_name [string]
- transcritical_compressor_capacity_curve_name [string]

Refrigeration:CompressorList¶

List of all the compressors included within a single refrigeration system (Refrigeration:System). Each list must contain at least one compressor. The order in which the individual compressors are listed here will be the order in which the compressors are dispatched to meet the system load. IMPORTANT: List compressor names in the order in which the compressors will be loaded Data is available for many compressors in the RefrigerationCompressor.idf dataset

Fields
- compressors [Array of {refrigeration_compressor_name}]

Refrigeration:System¶

Simulates the performance of a supermarket refrigeration system when used along with other objects to define the refrigeration load(s), the compressor(s), and the condenser.

Fields
- refrigerated_case_or_walkin_or_caseandwalkinlist_name [string]
- refrigeration_transfer_load_or_transferload_list_name [string]
- refrigeration_condenser_name [string]
- compressor_or_compressorlist_name [string]
- minimum_condensing_temperature [number]
- refrigeration_system_working_fluid_type [string]
- suction_temperature_control_type [string] (Default: ConstantSuctionTemperature)
- mechanical_subcooler_name [string]
- liquid_suction_heat_exchanger_subcooler_name [string]
- sum_ua_suction_piping [number] (Default: 0.0)
- suction_piping_zone_name [string]
- end_use_subcategory [string] (Default: General)
- number_of_compressor_stages [unknown field type] (Default: 1.0)
- intercooler_type [string] (Default: None)
- shell_and_coil_intercooler_effectiveness [number] (Default: 0.8)
- high_stage_compressor_or_compressorlist_name [string]

Refrigeration:TranscriticalSystem¶

Detailed transcritical carbon dioxide (CO2) booster refrigeration systems used in supermarkets. The object allows for modeling either a single stage system with medium-temperature loads or a two stage system with both medium- and low-temperature loads.

Fields
- system_type [string]
- medium_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name [string]
- low_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name [string]
- refrigeration_gas_cooler_name [string]
- high_pressure_compressor_or_compressorlist_name [string]
- low_pressure_compressor_or_compressorlist_name [string]
- receiver_pressure [number] (Default: 4000000.0)
- subcooler_effectiveness [number] (Default: 0.4)
- refrigeration_system_working_fluid_type [string]
- sum_ua_suction_piping_for_medium_temperature_loads [number] (Default: 0.0)
- medium_temperature_suction_piping_zone_name [string]
- sum_ua_suction_piping_for_low_temperature_loads [number] (Default: 0.0)
- low_temperature_suction_piping_zone_name [string]
- end_use_subcategory [string] (Default: General)

Refrigeration:SecondarySystem¶

Works in conjunction with refrigerated cases and walkins to simulate the performance of a secondary loop supermarket refrigeration system. Heat from the refrigeration loads served by the secondary loop is absorbed by a primary refrigeration system (Refrigeration:System). The SecondarySystem object simulates a heat exchanger that is an evaporator, or refrigeration load, on the primary refrigeration system.

Fields
- refrigerated_case_or_walkin_or_caseandwalkinlist_name [string]
- circulating_fluid_type [string]
- circulating_fluid_name [string]
- evaporator_capacity [number]
- evaporator_flow_rate_for_secondary_fluid [number]
- evaporator_evaporating_temperature [number]
- evaporator_approach_temperature_difference [number]
- evaporator_range_temperature_difference [number]
- number_of_pumps_in_loop [integer] (Default: 1)
- total_pump_flow_rate [number]
- total_pump_power [number]
- total_pump_head [number]
- phasechange_circulating_rate [number] (Default: 2.5)
- pump_drive_type [string] (Default: Constant)
- variable_speed_pump_cubic_curve_name [string]
- pump_motor_heat_to_fluid [number] (Default: 0.85)
- sum_ua_distribution_piping [number] (Default: 0.0)
- distribution_piping_zone_name [string]
- sum_ua_receiver_separator_shell [number] (Default: 0.0)
- receiver_separator_zone_name [string]
- evaporator_refrigerant_inventory [number] (Default: 0.0)
- end_use_subcategory [string] (Default: General)

Refrigeration:WalkIn¶

Works in conjunction with a compressor rack, a refrigeration system, or a refrigeration secondary system to simulate the performance of a walk-in cooler. The walk-in cooler model uses information at rated conditions along with input descriptions for heat transfer surfaces facing multiple zones to determine performance.

Fields
- availability_schedule_name [string]
- rated_coil_cooling_capacity [number]
- operating_temperature [number]
- rated_cooling_source_temperature [number]
- rated_total_heating_power [number]
- heating_power_schedule_name [string]
- rated_cooling_coil_fan_power [number] (Default: 375.0)
- rated_circulation_fan_power [number] (Default: 0.0)
- rated_total_lighting_power [number]
- lighting_schedule_name [string]
- defrost_type [string] (Default: Electric)
- defrost_control_type [string] (Default: TimeSchedule)
- defrost_schedule_name [string]
- defrost_drip_down_schedule_name [string]
- defrost_power [number]
- temperature_termination_defrost_fraction_to_ice [number]
- restocking_schedule_name [string]
- average_refrigerant_charge_inventory [number] (Default: 0.0)
- insulated_floor_surface_area [number]
- insulated_floor_u_value [number] (Default: 0.3154)
- zone_data [Array of {zone_name, total_insulated_surface_area_facing_zone, insulated_surface_u_value_facing_zone, area_of_glass_reach_in_doors_facing_zone, height_of_glass_reach_in_doors_facing_zone, glass_reach_in_door_u_value_facing_zone, glass_reach_in_door_opening_schedule_name_facing_zone, area_of_stocking_doors_facing_zone, height_of_stocking_doors_facing_zone, stocking_door_u_value_facing_zone, stocking_door_opening_schedule_name_facing_zone, stocking_door_opening_protection_type_facing_zone}]

Refrigeration:AirChiller¶

Works in conjunction with a refrigeration chiller set, compressor rack, a refrigeration system, or a refrigeration secondary system to simulate the performance of an air chiller, similar to one found in a refrigerated warehouse. Energy use for fans and heaters is modeled based on inputs for nominal power, schedules, and control type. The air chiller model accounts for the sensible and latent heat exchange with the surrounding environment.

Fields
- availability_schedule_name [string]
- capacity_rating_type [string]
- rated_unit_load_factor [number]
- rated_capacity [number]
- rated_relative_humidity [number] (Default: 85.0)
- rated_cooling_source_temperature [number]
- rated_temperature_difference_dt1 [number]
- maximum_temperature_difference_between_inlet_air_and_evaporating_temperature [number]
- coil_material_correction_factor [number] (Default: 1.0)
- refrigerant_correction_factor [number] (Default: 1.0)
- capacity_correction_curve_type [string]
- capacity_correction_curve_name [string]
- shr60_correction_factor [number] (Default: 1.48)
- rated_total_heating_power [number]
- heating_power_schedule_name [string]
- fan_speed_control_type [string] (Default: Fixed)
- rated_fan_power [number] (Default: 375.0)
- rated_air_flow [number]
- minimum_fan_air_flow_ratio [number] (Default: 0.2)
- defrost_type [string] (Default: Electric)
- defrost_control_type [string] (Default: TimeSchedule)
- defrost_schedule_name [string]
- defrost_drip_down_schedule_name [string]
- defrost_power [number]
- temperature_termination_defrost_fraction_to_ice [number]
- vertical_location [string] (Default: Middle)
- average_refrigerant_charge_inventory [number] (Default: 0.0)

ZoneHVAC:RefrigerationChillerSet¶

Works in conjunction with one or multiple air chillers, compressor racks, refrigeration systems, or refrigeration secondary system objects to simulate the performance of a group of air chillers cooling a single zone. The chiller set model passes information about the zone conditions to determine the performance of individual chiller coils within the set, thus providing the sensible and latent heat exchange with the zone environment.

Fields
- availability_schedule_name [string]
- zone_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- chillers [Array of {air_chiller_name}]

Demand Limiting Controls¶

DemandManagerAssignmentList¶

A high level control that makes demand limiting decisions based on a list of possible demand limiting strategies.

Fields
- meter_name [string]
- demand_limit_schedule_name [string]
- demand_limit_safety_fraction [number]
- billing_period_schedule_name [string]
- peak_period_schedule_name [string]
- demand_window_length [integer]
- demand_manager_priority [string]
- manager_data [Array of {demandmanager_object_type, demandmanager_name}]

DemandManager:ExteriorLights¶

used for demand limiting Exterior:Lights objects.

Fields
- availability_schedule_name [string]
- limit_control [string]
- minimum_limit_duration [integer]
- maximum_limit_fraction [number]
- limit_step_change [number]
- selection_control [string]
- rotation_duration [integer]
- lights [Array of {exterior_lights_name}]

DemandManager:Lights¶

used for demand limiting Lights objects.

Fields
- availability_schedule_name [string]
- limit_control [string]
- minimum_limit_duration [integer]
- maximum_limit_fraction [number]
- limit_step_change [number]
- selection_control [string]
- rotation_duration [integer]
- lights [Array of {lights_name}]

DemandManager:ElectricEquipment¶

used for demand limiting ElectricEquipment objects.

Fields
- availability_schedule_name [string]
- limit_control [string]
- minimum_limit_duration [integer]
- maximum_limit_fraction [number]
- limit_step_change [number]
- selection_control [string]
- rotation_duration [integer]
- equipment [Array of {electric_equipment_name}]

DemandManager:Thermostats¶

used for demand limiting ZoneControl:Thermostat objects.

Fields
- availability_schedule_name [string]
- reset_control [string]
- minimum_reset_duration [integer]
- maximum_heating_setpoint_reset [number]
- maximum_cooling_setpoint_reset [number]
- reset_step_change [number]
- selection_control [string]
- rotation_duration [integer]
- thermostats [Array of {thermostat_name}]

DemandManager:Ventilation¶

used for demand limiting Controller:OutdoorAir objects.

Fields
- availability_schedule_name [string]
- limit_control [string]
- minimum_limit_duration [integer]
- fixed_rate [number]
- reduction_ratio [number]
- limit_step_change [number]
- selection_control [string] (Default: All)
- rotation_duration [integer]
- controllers [Array of {controller_outdoor_air_name}]

Electric Load Center-Generator Specifications¶

Generator:InternalCombustionEngine¶

This generator model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Engine performance curves are generated by fitting catalog data to second order polynomial equations. Three sets of coefficients are required.

Fields
- rated_power_output [number]
- electric_circuit_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- shaft_power_curve_name [string]
- jacket_heat_recovery_curve_name [string]
- lube_heat_recovery_curve_name [string]
- total_exhaust_energy_curve_name [string]
- exhaust_temperature_curve_name [string]
- coefficient_1_of_u_factor_times_area_curve [number]
- coefficient_2_of_u_factor_times_area_curve [number]
- maximum_exhaust_flow_per_unit_of_power_output [number]
- design_minimum_exhaust_temperature [number]
- fuel_higher_heating_value [number]
- design_heat_recovery_water_flow_rate [number] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- fuel_type [string] (Default: Diesel)
- heat_recovery_maximum_temperature [number] (Default: 80.0)

Generator:CombustionTurbine¶

This generator model is the empirical model from the Building Loads and System Thermodynamics (BLAST) program. Generator performance curves are generated by fitting catalog data to second order polynomial equations. Three sets of coefficients are required.

Fields
- rated_power_output [number]
- electric_circuit_node_name [string]
- minimum_part_load_ratio [number]
- maximum_part_load_ratio [number]
- optimum_part_load_ratio [number]
- part_load_based_fuel_input_curve_name [string]
- temperature_based_fuel_input_curve_name [string]
- exhaust_flow_curve_name [string]
- part_load_based_exhaust_temperature_curve_name [string]
- temperature_based_exhaust_temperature_curve_name [string]
- heat_recovery_lube_energy_curve_name [string]
- coefficient_1_of_u_factor_times_area_curve [number]
- coefficient_2_of_u_factor_times_area_curve [number]
- maximum_exhaust_flow_per_unit_of_power_output [number]
- design_minimum_exhaust_temperature [number]
- design_air_inlet_temperature [number]
- fuel_higher_heating_value [number]
- design_heat_recovery_water_flow_rate [number] (Default: 0.0)
- heat_recovery_inlet_node_name [string]
- heat_recovery_outlet_node_name [string]
- fuel_type [string] (Default: NaturalGas)
- heat_recovery_maximum_temperature [number] (Default: 80.0)
- outdoor_air_inlet_node_name [string]

Generator:MicroTurbine¶

MicroTurbine generators are small combustion turbines (e.g., 25kW to 500kW). The model calculates electrical power output, fuel use, standby and ancillary power. Energy recovery from exhaust air can be used to heat water.

Fields
- reference_electrical_power_output [number]
- minimum_full_load_electrical_power_output [number] (Default: 0.0)
- maximum_full_load_electrical_power_output [number]
- reference_electrical_efficiency_using_lower_heating_value [number]
- reference_combustion_air_inlet_temperature [number] (Default: 15.0)
- reference_combustion_air_inlet_humidity_ratio [number] (Default: 0.00638)
- reference_elevation [number] (Default: 0.0)
- electrical_power_function_of_temperature_and_elevation_curve_name [string]
- electrical_efficiency_function_of_temperature_curve_name [string]
- electrical_efficiency_function_of_part_load_ratio_curve_name [string]
- fuel_type [string] (Default: NaturalGas)
- fuel_higher_heating_value [number] (Default: 50000.0)
- fuel_lower_heating_value [number] (Default: 45450.0)
- standby_power [number] (Default: 0.0)
- ancillary_power [number] (Default: 0.0)
- ancillary_power_function_of_fuel_input_curve_name [string]
- heat_recovery_water_inlet_node_name [string]
- heat_recovery_water_outlet_node_name [string]
- reference_thermal_efficiency_using_lower_heat_value [number] (Default: 0.0)
- reference_inlet_water_temperature [number]
- heat_recovery_water_flow_operating_mode [string] (Default: PlantControl)
- reference_heat_recovery_water_flow_rate [number]
- heat_recovery_water_flow_rate_function_of_temperature_and_power_curve_name [string]
- thermal_efficiency_function_of_temperature_and_elevation_curve_name [string]
- heat_recovery_rate_function_of_part_load_ratio_curve_name [string]
- heat_recovery_rate_function_of_inlet_water_temperature_curve_name [string]
- heat_recovery_rate_function_of_water_flow_rate_curve_name [string]
- minimum_heat_recovery_water_flow_rate [number] (Default: 0.0)
- maximum_heat_recovery_water_flow_rate [number] (Default: 0.0)
- maximum_heat_recovery_water_temperature [number]
- combustion_air_inlet_node_name [string]
- combustion_air_outlet_node_name [string]
- reference_exhaust_air_mass_flow_rate [number]
- exhaust_air_flow_rate_function_of_temperature_curve_name [string]
- exhaust_air_flow_rate_function_of_part_load_ratio_curve_name [string]
- nominal_exhaust_air_outlet_temperature [number]
- exhaust_air_temperature_function_of_temperature_curve_name [string]
- exhaust_air_temperature_function_of_part_load_ratio_curve_name [string]

Generator:Photovoltaic¶

Describes an array of photovoltaic (PV) modules. A series of different PV arrays can be connected to a single electric load center (and inverter) by listing them all in an ElectricLoadCenter:Generator object. PV performance is taken from the referenced PhotovoltaicPerformance:* object. Array tilt, azimuth, and gross area are taken from the referenced building surface or shading surface. The array surface participates normally in all shading calculations.

Fields
- surface_name [string]
- photovoltaic_performance_object_type [string]
- module_performance_name [string]
- heat_transfer_integration_mode [string] (Default: Decoupled)
- number_of_series_strings_in_parallel [number] (Default: 1.0)
- number_of_modules_in_series [number] (Default: 1.0)

PhotovoltaicPerformance:Simple¶

Describes a simple model of photovoltaics that may be useful for early phase design analysis. In this model the user has direct access to the efficiency with which surfaces convert incident solar radiation to electricity and need not specify arrays of specific modules.

Fields
- fraction_of_surface_area_with_active_solar_cells [number]
- conversion_efficiency_input_mode [string]
- value_for_cell_efficiency_if_fixed [number]
- efficiency_schedule_name [string]

PhotovoltaicPerformance:EquivalentOne-Diode¶

Describes the performance characteristics of Photovoltaic (PV) modules to be modeled using an equivalent one-diode circuit. This model is also known as the 4- or 5-parameter TRNSYS model for photovoltaics.

Fields
- cell_type [string]
- number_of_cells_in_series [integer] (Default: 36)
- active_area [number] (Default: 0.89)
- transmittance_absorptance_product [number] (Default: 0.95)
- semiconductor_bandgap [number] (Default: 1.12)
- shunt_resistance [number] (Default: 1000000.0)
- short_circuit_current [number] (Default: 6.5)
- open_circuit_voltage [number] (Default: 21.6)
- reference_temperature [number] (Default: 25.0)
- reference_insolation [number] (Default: 1000.0)
- module_current_at_maximum_power [number] (Default: 5.9)
- module_voltage_at_maximum_power [number] (Default: 17.0)
- temperature_coefficient_of_short_circuit_current [number] (Default: 0.02)
- temperature_coefficient_of_open_circuit_voltage [number] (Default: -0.079)
- nominal_operating_cell_temperature_test_ambient_temperature [number] (Default: 20.0)
- nominal_operating_cell_temperature_test_cell_temperature [number] (Default: 40.0)
- nominal_operating_cell_temperature_test_insolation [number] (Default: 800.0)
- module_heat_loss_coefficient [number] (Default: 30.0)
- total_heat_capacity [number] (Default: 50000.0)

PhotovoltaicPerformance:Sandia¶

Describes performance input data needed for specific makes and models of production PV panels using the empirical coefficients assembled by Sandia National Laboratory.

Fields
- active_area [number] (Default: 1.0)
- number_of_cells_in_series [integer] (Default: 1)
- number_of_cells_in_parallel [integer] (Default: 1)
- short_circuit_current [number]
- open_circuit_voltage [number]
- current_at_maximum_power_point [number]
- voltage_at_maximum_power_point [number]
- sandia_database_parameter_aisc [number]
- sandia_database_parameter_aimp [number]
- sandia_database_parameter_c0 [number]
- sandia_database_parameter_c1 [number]
- sandia_database_parameter_bvoc0 [number]
- sandia_database_parameter_mbvoc [number]
- sandia_database_parameter_bvmp0 [number]
- sandia_database_parameter_mbvmp [number]
- diode_factor [number]
- sandia_database_parameter_c2 [number]
- sandia_database_parameter_c3 [number]
- sandia_database_parameter_a0 [number]
- sandia_database_parameter_a1 [number]
- sandia_database_parameter_a2 [number]
- sandia_database_parameter_a3 [number]
- sandia_database_parameter_a4 [number]
- sandia_database_parameter_b0 [number]
- sandia_database_parameter_b1 [number]
- sandia_database_parameter_b2 [number]
- sandia_database_parameter_b3 [number]
- sandia_database_parameter_b4 [number]
- sandia_database_parameter_b5 [number]
- sandia_database_parameter_delta_tc_ [number]
- sandia_database_parameter_fd [number]
- sandia_database_parameter_a [number]
- sandia_database_parameter_b [number]
- sandia_database_parameter_c4 [number]
- sandia_database_parameter_c5 [number]
- sandia_database_parameter_ix0 [number]
- sandia_database_parameter_ixx0 [number]
- sandia_database_parameter_c6 [number]
- sandia_database_parameter_c7 [number]

Generator:PVWatts¶

Describes a simple set of inputs for an array of photovoltaic (PV) modules as described in the PVWatts software. A series of different PVWatts arrays can be connected to a single electric load center (preferably through an ElectricLoadCenter:Inverter:PVWatts). Array tilt and azimuth can be either specified on this object or taken from a referenced building surface or shading surface. If a surface is specified, the array participates normally in all shading calculations.

Fields
- pvwatts_version [string]
- dc_system_capacity [number]
- module_type [string]
- array_type [string]
- system_losses [number] (Default: 0.14)
- array_geometry_type [string] (Default: TiltAzimuth)
- tilt_angle [number] (Default: 20.0)
- azimuth_angle [number] (Default: 180.0)
- surface_name [string]
- ground_coverage_ratio [number] (Default: 0.4)

ElectricLoadCenter:Inverter:PVWatts¶

Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load center that contains Generator:PVWatts objects. It implements the PVWatts inverter performance curves.

Fields
- dc_to_ac_size_ratio [number] (Default: 1.1)
- inverter_efficiency [number] (Default: 0.96)

Generator:FuelCell¶

This generator model is the FC model from IEA Annex 42

Fields
- power_module_name [string]
- air_supply_name [string]
- fuel_supply_name [string]
- water_supply_name [string]
- auxiliary_heater_name [string]
- heat_exchanger_name [string]
- electrical_storage_name [string]
- inverter_name [string]
- stack_cooler_name [string]

Generator:FuelCell:PowerModule¶

Describe the core power module subsystem of a fuel cell power generator. This includes the fuel cell stack, fuel reformer, and whatever ancillary devices are included inside. If the model has multiple FC generators that are of the exact same type, then only one of these objects is needed and all the Generator:FuelCell objects can reference it.

Fields
- efficiency_curve_mode [string]
- efficiency_curve_name [string]
- nominal_efficiency [number]
- nominal_electrical_power [number]
- number_of_stops_at_start_of_simulation [number]
- cycling_performance_degradation_coefficient [number]
- number_of_run_hours_at_beginning_of_simulation [number]
- accumulated_run_time_degradation_coefficient [number]
- run_time_degradation_initiation_time_threshold [number]
- power_up_transient_limit [number]
- power_down_transient_limit [number]
- start_up_time [number]
- start_up_fuel [number]
- start_up_electricity_consumption [number]
- start_up_electricity_produced [number]
- shut_down_time [number]
- shut_down_fuel [number]
- shut_down_electricity_consumption [number]
- ancillary_electricity_constant_term [number]
- ancillary_electricity_linear_term [number]
- skin_loss_calculation_mode [string]
- zone_name [string]
- skin_loss_radiative_fraction [number]
- constant_skin_loss_rate [number]
- skin_loss_u_factor_times_area_term [number]
- skin_loss_quadratic_curve_name [string]
- dilution_air_flow_rate [number]
- stack_heat_loss_to_dilution_air [number]
- dilution_inlet_air_node_name [string]
- dilution_outlet_air_node_name [string]
- minimum_operating_point [number]
- maximum_operating_point [number]

Generator:FuelCell:AirSupply¶

Used to define details of the air supply subsystem for a fuel cell power generator.

Fields
- air_inlet_node_name [string]
- blower_power_curve_name [string]
- blower_heat_loss_factor [number]
- air_supply_rate_calculation_mode [string]
- stoichiometric_ratio [number]
- air_rate_function_of_electric_power_curve_name [string]
- air_rate_air_temperature_coefficient [number]
- air_rate_function_of_fuel_rate_curve_name [string]
- air_intake_heat_recovery_mode [string]
- air_supply_constituent_mode [string]
- number_of_userdefined_constituents [number]
- constituent_fractions [Array of {constituent_name, molar_fraction}]

Generator:FuelCell:WaterSupply¶

Used to provide details of the water supply subsystem for a fuel cell power generator. This water is used for steam reforming of the fuel and is not the same as the water used for thermal heat recovery.

Fields
- reformer_water_flow_rate_function_of_fuel_rate_curve_name [string]
- reformer_water_pump_power_function_of_fuel_rate_curve_name [string]
- pump_heat_loss_factor [number]
- water_temperature_modeling_mode [string]
- water_temperature_reference_node_name [string]
- water_temperature_schedule_name [string]

Generator:FuelCell:AuxiliaryHeater¶

Intended for modeling an auxiliary heater for a fuel cell power generator, however this portion of the model is not yet available. The program still requires one of these objects be included even though the data are not yet used (so that internal data structures can be allocated).

Fields
- excess_air_ratio [number]
- ancillary_power_constant_term [number]
- ancillary_power_linear_term [number]
- skin_loss_u_factor_times_area_value [number]
- skin_loss_destination [string]
- zone_name_to_receive_skin_losses [string]
- heating_capacity_units [string]
- maximum_heating_capacity_in_watts [number]
- minimum_heating_capacity_in_watts [number]
- maximum_heating_capacity_in_kmol_per_second [number]
- minimum_heating_capacity_in_kmol_per_second [number]

Generator:FuelCell:ExhaustGasToWaterHeatExchanger¶

Describes the exhaust gas heat exchanger subsystem of a fuel cell power generator used to recovery thermal energy

Fields
- heat_recovery_water_inlet_node_name [string]
- heat_recovery_water_outlet_node_name [string]
- heat_recovery_water_maximum_flow_rate [number]
- exhaust_outlet_air_node_name [string]
- heat_exchanger_calculation_method [string]
- method_1_heat_exchanger_effectiveness [number]
- method_2_parameter_hxs0 [number]
- method_2_parameter_hxs1 [number]
- method_2_parameter_hxs2 [number]
- method_2_parameter_hxs3 [number]
- method_2_parameter_hxs4 [number]
- method_3_h0gas_coefficient [number]
- method_3_ndotgasref_coefficient [number]
- method_3_n_coefficient [number]
- method_3_gas_area [number]
- method_3_h0_water_coefficient [number]
- method_3_n_dot_water_ref_coefficient [number]
- method_3_m_coefficient [number]
- method_3_water_area [number]
- method_3_f_adjustment_factor [number]
- method_4_hxl1_coefficient [number]
- method_4_hxl2_coefficient [number]
- method_4_condensation_threshold [number]

Generator:FuelCell:ElectricalStorage¶

Used to describe the electrical storage subsystem for a fuel cell power generator. The electrical storage model is a very simple “constrained bucket” model. Note that this electrical storage is embedded within the FC device.

Fields
- choice_of_model [string]
- nominal_charging_energetic_efficiency [number]
- nominal_discharging_energetic_efficiency [number]
- simple_maximum_capacity [number]
- simple_maximum_power_draw [number]
- simple_maximum_power_store [number]
- initial_charge_state [number]

Generator:FuelCell:Inverter¶

Used to describe the power condition unit subsystem of a fuel cell power generator. This object models an inverter system contained within a fuel cell system that converts from direct current (DC) to alternating current (AC).

Fields
- inverter_efficiency_calculation_mode [string]
- inverter_efficiency [number]
- efficiency_function_of_dc_power_curve_name [string]

Generator:FuelCell:StackCooler¶

This object is optional and is used to define details needed to model the stack cooler on PEMFC.

Fields
- heat_recovery_water_inlet_node_name [string]
- heat_recovery_water_outlet_node_name [string]
- nominal_stack_temperature [number]
- actual_stack_temperature [number]
- coefficient_r0 [number]
- coefficient_r1 [number]
- coefficient_r2 [number]
- coefficient_r3 [number]
- stack_coolant_flow_rate [number]
- stack_cooler_u_factor_times_area_value [number]
- fs_cogen_adjustment_factor [number]
- stack_cogeneration_exchanger_area [number]
- stack_cogeneration_exchanger_nominal_flow_rate [number]
- stack_cogeneration_exchanger_nominal_heat_transfer_coefficient [number]
- stack_cogeneration_exchanger_nominal_heat_transfer_coefficient_exponent [number]
- stack_cooler_pump_power [number]
- stack_cooler_pump_heat_loss_fraction [number]
- stack_air_cooler_fan_coefficient_f0 [number]
- stack_air_cooler_fan_coefficient_f1 [number]
- stack_air_cooler_fan_coefficient_f2 [number]

Generator:MicroCHP¶

Small-scale combined heat and power (micro CHP) electric generator using the model developed by IEA/ECBCS Annex 42 see www.cogen-sim.net. The model was developed for both internal combustion and Stirling cycle engines, but might be used for other types of residential CHP devices.

Fields
- performance_parameters_name [string]
- zone_name [string]
- cooling_water_inlet_node_name [string]
- cooling_water_outlet_node_name [string]
- air_inlet_node_name [string]
- air_outlet_node_name [string]
- generator_fuel_supply_name [string]
- availability_schedule_name [string]

Generator:MicroCHP:NonNormalizedParameters¶

This object is referenced by a Generator:MicroCHP object and provides the non-normalized parameters for the MicroCHP generator model.

Fields
- maximum_electric_power [number]
- minimum_electric_power [number]
- minimum_cooling_water_flow_rate [number]
- maximum_cooling_water_temperature [number]
- electrical_efficiency_curve_name [string]
- thermal_efficiency_curve_name [string]
- cooling_water_flow_rate_mode [string]
- cooling_water_flow_rate_curve_name [string]
- air_flow_rate_curve_name [string]
- maximum_net_electrical_power_rate_of_change [number]
- maximum_fuel_flow_rate_of_change [number]
- heat_exchanger_u_factor_times_area_value [number]
- skin_loss_u_factor_times_area_value [number]
- skin_loss_radiative_fraction [number]
- aggregated_thermal_mass_of_energy_conversion_portion_of_generator [number]
- aggregated_thermal_mass_of_heat_recovery_portion_of_generator [number]
- standby_power [number]
- warm_up_mode [string]
- warm_up_fuel_flow_rate_coefficient [number]
- nominal_engine_operating_temperature [number]
- warm_up_power_coefficient [number]
- warm_up_fuel_flow_rate_limit_ratio [number]
- warm_up_delay_time [number]
- cool_down_power [number]
- cool_down_delay_time [number]
- restart_mode [string]

Generator:FuelSupply¶

Used only with Generator:FuelCell and Generator:MicroCHP

Fields
- fuel_temperature_modeling_mode [string]
- fuel_temperature_reference_node_name [string]
- fuel_temperature_schedule_name [string]
- compressor_power_multiplier_function_of_fuel_rate_curve_name [string]
- compressor_heat_loss_factor [number]
- fuel_type [string]
- liquid_generic_fuel_lower_heating_value [number]
- liquid_generic_fuel_higher_heating_value [number]
- liquid_generic_fuel_molecular_weight [number]
- liquid_generic_fuel_co2_emission_factor [number]
- number_of_constituents_in_gaseous_constituent_fuel_supply [number]
- constituent_1_name [string]
- constituent_1_molar_fraction [number]
- constituent_2_name [string]
- constituent_2_molar_fraction [number]
- constituent_3_name [string]
- constituent_3_molar_fraction [number]
- constituent_4_name [string]
- constituent_4_molar_fraction [number]
- constituent_5_name [string]
- constituent_5_molar_fraction [number]
- constituent_6_name [string]
- constituent_6_molar_fraction [number]
- constituent_7_name [string]
- constituent_7_molar_fraction [number]
- constituent_8_name [string]
- constituent_8_molar_fraction [number]
- constituent_9_name [string]
- constituent_9_molar_fraction [number]
- constituent_10_name [string]
- constituent_10_molar_fraction [number]
- constituent_11_name [string]
- constituent_11_molar_fraction [number]
- constituent_12_name [string]
- constituent_12_molar_fraction [number]

Generator:WindTurbine¶

Wind turbine generator.

Fields
- availability_schedule_name [string]
- rotor_type [string] (Default: HorizontalAxisWindTurbine)
- power_control [string] (Default: VariableSpeedVariablePitch)
- rated_rotor_speed [number]
- rotor_diameter [number]
- overall_height [number]
- number_of_blades [number] (Default: 3.0)
- rated_power [number]
- rated_wind_speed [number]
- cut_in_wind_speed [number]
- cut_out_wind_speed [number]
- fraction_system_efficiency [number] (Default: 0.835)
- maximum_tip_speed_ratio [number] (Default: 5.0)
- maximum_power_coefficient [number] (Default: 0.25)
- annual_local_average_wind_speed [number]
- height_for_local_average_wind_speed [number] (Default: 50.0)
- blade_chord_area [number]
- blade_drag_coefficient [number] (Default: 0.9)
- blade_lift_coefficient [number] (Default: 0.05)
- power_coefficient_c1 [number] (Default: 0.5176)
- power_coefficient_c2 [number] (Default: 116.0)
- power_coefficient_c3 [number] (Default: 0.4)
- power_coefficient_c4 [number] (Default: 0.0)
- power_coefficient_c5 [number] (Default: 5.0)
- power_coefficient_c6 [number] (Default: 21.0)

ElectricLoadCenter:Generators¶

List of electric power generators to include in the simulation including the name and type of each generators along with availability schedule, rated power output, and thermal-to-electrical power ratio.

Fields
- generator_outputs [Array of {generator_name, generator_object_type, generator_rated_electric_power_output, generator_availability_schedule_name, generator_rated_thermal_to_electrical_power_ratio}]

ElectricLoadCenter:Inverter:Simple¶

Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load center that contains photovoltaic modules. This input object is for the simplest inverter model and uses a fixed efficiency.

Fields
- availability_schedule_name [string]
- zone_name [string]
- radiative_fraction [number]
- inverter_efficiency [number]

ElectricLoadCenter:Inverter:FunctionOfPower¶

Electric power inverter to convert from direct current (DC) to alternating current (AC) in an electric load center that contains photovoltaic modules. This input object is for an inverter model where efficiency is a function of normalized power.

Fields
- availability_schedule_name [string]
- zone_name [string]
- radiative_fraction [number]
- efficiency_function_of_power_curve_name [string]
- rated_maximum_continuous_input_power [number]
- minimum_efficiency [number]
- maximum_efficiency [number]
- minimum_power_output [number]
- maximum_power_output [number]
- ancillary_power_consumed_in_standby [number]

ElectricLoadCenter:Inverter:LookUpTable¶

California Energy Commission tests and publishes data on inverters This inverter model interpolates using CEC test data Input data are at http://www.gosolarcalifornia.org/equipment/inverter_tests/summaries

Fields
- availability_schedule_name [string]
- zone_name [string]
- radiative_fraction [number]
- rated_maximum_continuous_output_power [number]
- night_tare_loss_power [number]
- nominal_voltage_input [number]
- efficiency_at_10_power_and_nominal_voltage [number]
- efficiency_at_20_power_and_nominal_voltage [number]
- efficiency_at_30_power_and_nominal_voltage [number]
- efficiency_at_50_power_and_nominal_voltage [number]
- efficiency_at_75_power_and_nominal_voltage [number]
- efficiency_at_100_power_and_nominal_voltage [number]

ElectricLoadCenter:Storage:Simple¶

Used to model storage of electricity in an electric load center. This is a simple model that does not attempt to represent any of the characteristics of a real storage device such as a battery. The type of power, AC or DC, depends on the configuration chosen as the Electrical Buss Type in the ElectricLoadCenter:Distribution object.

Fields
- availability_schedule_name [string]
- zone_name [string]
- radiative_fraction_for_zone_heat_gains [number]
- nominal_energetic_efficiency_for_charging [number]
- nominal_discharging_energetic_efficiency [number]
- maximum_storage_capacity [number]
- maximum_power_for_discharging [number]
- maximum_power_for_charging [number]
- initial_state_of_charge [number]

ElectricLoadCenter:Storage:Battery¶

Uses the kinetic battery model (KiBaM) to simulate rechargeable battery banks in an electrical load center. The battery bank is a collection of one or more individual battery modules. Given the surplus or deficit power from the electrical system and the state of charge from the previous time step, this object can model the voltage, current, and energy losses with charging and discharging during each time step. The cumulative battery damage can be also modeled and reported at the end of each simulation run.

Fields
- availability_schedule_name [string]
- zone_name [string]
- radiative_fraction [number] (Default: 0.0)
- number_of_battery_modules_in_parallel [integer] (Default: 1)
- number_of_battery_modules_in_series [integer] (Default: 1)
- maximum_module_capacity [number]
- initial_fractional_state_of_charge [number] (Default: 1.0)
- fraction_of_available_charge_capacity [number]
- change_rate_from_bound_charge_to_available_charge [number]
- fully_charged_module_open_circuit_voltage [number]
- fully_discharged_module_open_circuit_voltage [number]
- voltage_change_curve_name_for_charging [string]
- voltage_change_curve_name_for_discharging [string]
- module_internal_electrical_resistance [number]
- maximum_module_discharging_current [number]
- module_cut_off_voltage [number]
- module_charge_rate_limit [number] (Default: 1.0)
- battery_life_calculation [string] (Default: No)
- number_of_cycle_bins [integer] (Default: 10)
- battery_life_curve_name [string]

ElectricLoadCenter:Storage:LiIonNMCBattery¶

Uses Lithium Ion NMC model to simulate rechargeable battery banks in an electrical load center. The battery bank is a collection of one or more individual battery modules. Given the surplus or deficit power from the electrical system and the state of charge from the previous time step, this object can model the voltage, current, and energy losses with charging and discharging during each time step. The cumulative battery damage can be also modeled and reported at the end of each simulation run.

Fields
- availability_schedule_name [string]
- zone_name [string]
- radiative_fraction [number] (Default: 0.0)
- lifetime_model [string] (Default: KandlerSmith)
- number_of_cells_in_series [integer]
- number_of_strings_in_parallel [integer]
- initial_fractional_state_of_charge [number] (Default: 0.5)
- dc_to_dc_charging_efficiency [number] (Default: 0.95)
- battery_mass [number]
- battery_surface_area [number]
- battery_specific_heat_capacity [number] (Default: 1500.0)
- heat_transfer_coefficient_between_battery_and_ambient [number] (Default: 7.5)
- fully_charged_cell_voltage [number] (Default: 4.2)
- cell_voltage_at_end_of_exponential_zone [number] (Default: 3.53)
- cell_voltage_at_end_of_nominal_zone [number] (Default: 3.342)
- default_nominal_cell_voltage [number] (Default: 3.342)
- fully_charged_cell_capacity [number] (Default: 3.2)
- fraction_of_cell_capacity_removed_at_the_end_of_exponential_zone [number] (Default: 0.8075)
- fraction_of_cell_capacity_removed_at_the_end_of_nominal_zone [number] (Default: 0.976875)
- charge_rate_at_which_voltage_vs_capacity_curve_was_generated [number] (Default: 1.0)
- battery_cell_internal_electrical_resistance [number] (Default: 0.09)

ElectricLoadCenter:Transformer¶

This object is used to model the energy losses of transformers when they are used to transfer electricity from the grid to a building (as distribution transformers) or transfer electricity from onsite generators to the grid.

Fields
- availability_schedule_name [string]
- transformer_usage [string] (Default: PowerInFromGrid)
- zone_name [string]
- radiative_fraction [number] (Default: 0.0)
- rated_capacity [number]
- phase [unknown field type] (Default: 3.0)
- conductor_material [string] (Default: Aluminum)
- full_load_temperature_rise [number] (Default: 150.0)
- fraction_of_eddy_current_losses [number] (Default: 0.1)
- performance_input_method [string] (Default: RatedLosses)
- rated_no_load_loss [number]
- rated_load_loss [number]
- nameplate_efficiency [number] (Default: 0.98)
- per_unit_load_for_nameplate_efficiency [number] (Default: 0.35)
- reference_temperature_for_nameplate_efficiency [number] (Default: 75.0)
- per_unit_load_for_maximum_efficiency [number]
- consider_transformer_loss_for_utility_cost [string] (Default: Yes)
- meters [Array of {meter_name}]

ElectricLoadCenter:Distribution¶

ElectricLoadCenter:Distribution objects are used to include on-site electricity generators and or storage in a simulation.

Fields
- generator_list_name [string]
- generator_operation_scheme_type [string]
- generator_demand_limit_scheme_purchased_electric_demand_limit [number]
- generator_track_schedule_name_scheme_schedule_name [string]
- generator_track_meter_scheme_meter_name [string]
- electrical_buss_type [string] (Default: AlternatingCurrent)
- inverter_name [string]
- electrical_storage_object_name [string]
- transformer_object_name [string]
- storage_operation_scheme [string] (Default: TrackFacilityElectricDemandStoreExcessOnSite)
- storage_control_track_meter_name [string]
- storage_converter_object_name [string]
- maximum_storage_state_of_charge_fraction [number] (Default: 1.0)
- minimum_storage_state_of_charge_fraction [number] (Default: 0.0)
- design_storage_control_charge_power [number]
- storage_charge_power_fraction_schedule_name [string]
- design_storage_control_discharge_power [number]
- storage_discharge_power_fraction_schedule_name [string]
- storage_control_utility_demand_target [number]
- storage_control_utility_demand_target_fraction_schedule_name [string]

ElectricLoadCenter:Storage:Converter¶

This model is for converting AC to DC for grid-supplied charging of DC storage

Fields
- availability_schedule_name [string]
- power_conversion_efficiency_method [string] (Default: SimpleFixed)
- simple_fixed_efficiency [number] (Default: 0.95)
- design_maximum_continuous_input_power [number]
- efficiency_function_of_power_curve_name [string]
- ancillary_power_consumed_in_standby [number]
- zone_name [string]
- radiative_fraction [number]

Water Systems¶

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.

Fields
- end_use_subcategory [string] (Default: General)
- peak_flow_rate [number]
- flow_rate_fraction_schedule_name [string]
- target_temperature_schedule_name [string]
- hot_water_supply_temperature_schedule_name [string]
- cold_water_supply_temperature_schedule_name [string]
- zone_name [string]
- sensible_fraction_schedule_name [string]
- latent_fraction_schedule_name [string]

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.

Fields
- inlet_node_name [string]
- outlet_node_name [string]
- supply_water_storage_tank_name [string]
- reclamation_water_storage_tank_name [string]
- hot_water_supply_temperature_schedule_name [string]
- cold_water_supply_temperature_schedule_name [string]
- drain_water_heat_exchanger_type [string] (Default: None)
- drain_water_heat_exchanger_destination [string] (Default: Plant)
- drain_water_heat_exchanger_u_factor_times_area [number]
- connections [Array of {water_use_equipment_name}]

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.

Fields
- water_quality_subcategory [string]
- maximum_capacity [number]
- initial_volume [number]
- design_in_flow_rate [number]
- design_out_flow_rate [number]
- overflow_destination [string]
- type_of_supply_controlled_by_float_valve [string]
- float_valve_on_capacity [number]
- float_valve_off_capacity [number]
- backup_mains_capacity [number]
- other_tank_name [string]
- water_thermal_mode [string]
- water_temperature_schedule_name [string]
- ambient_temperature_indicator [string]
- ambient_temperature_schedule_name [string]
- zone_name [string]
- tank_surface_area [number]
- tank_u_value [number]
- tank_outside_surface_material_name [string]

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.

Fields
- storage_tank_name [string]
- pump_depth [number]
- pump_rated_flow_rate [number]
- pump_rated_head [number]
- pump_rated_power_consumption [number]
- pump_efficiency [number]
- well_recovery_rate [number]
- nominal_well_storage_volume [number]
- water_table_depth_mode [string]
- water_table_depth [number]
- water_table_depth_schedule_name [string]

WaterUse:RainCollector¶

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

Fields
- storage_tank_name [string]
- loss_factor_mode [string]
- collection_loss_factor [number]
- collection_loss_factor_schedule_name [string]
- maximum_collection_rate [number]
- surfaces [Array of {collection_surface_name}]

Operational Faults¶

FaultModel:TemperatureSensorOffset:OutdoorAir¶

This object describes outdoor air temperature sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- controller_object_type [string]
- controller_object_name [string]
- temperature_sensor_offset [number] (Default: 0.0)

FaultModel:HumiditySensorOffset:OutdoorAir¶

This object describes outdoor air humidity sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- controller_object_type [string]
- controller_object_name [string]
- humidity_sensor_offset [number] (Default: 0.0)

FaultModel:EnthalpySensorOffset:OutdoorAir¶

This object describes outdoor air enthalpy sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- controller_object_type [string]
- controller_object_name [string]
- enthalpy_sensor_offset [number] (Default: 0.0)

FaultModel:TemperatureSensorOffset:ReturnAir¶

This object describes return air temperature sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- controller_object_type [string]
- controller_object_name [string]
- temperature_sensor_offset [number] (Default: 0.0)

FaultModel:EnthalpySensorOffset:ReturnAir¶

This object describes return air enthalpy sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- controller_object_type [string]
- controller_object_name [string]
- enthalpy_sensor_offset [number] (Default: 0.0)

FaultModel:TemperatureSensorOffset:ChillerSupplyWater¶

This object describes fault of chiller supply water temperature sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- chiller_object_type [string]
- chiller_object_name [string]
- reference_sensor_offset [number] (Default: 0.0)

FaultModel:TemperatureSensorOffset:CoilSupplyAir¶

This object describes fault of coil supply air temperature sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- coil_object_type [string]
- coil_object_name [string]
- water_coil_controller_name [string]
- reference_sensor_offset [number] (Default: 0.0)

FaultModel:TemperatureSensorOffset:CondenserSupplyWater¶

This object describes fault of condenser supply water temperature sensor offset

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- cooling_tower_object_type [string]
- cooling_tower_object_name [string]
- reference_sensor_offset [number] (Default: 0.0)

FaultModel:ThermostatOffset¶

This object describes fault of thermostat offset

Fields
- thermostat_name [string]
- availability_schedule_name [string]
- severity_schedule_name [string]
- reference_thermostat_offset [number] (Default: 2.0)

FaultModel:HumidistatOffset¶

This object describes fault of humidistat offset

Fields
- humidistat_name [string]
- humidistat_offset_type [string] (Default: ThermostatOffsetIndependent)
- availability_schedule_name [string]
- severity_schedule_name [string]
- reference_humidistat_offset [number] (Default: 5.0)
- related_thermostat_offset_fault_name [string]

FaultModel:Fouling:AirFilter¶

This object describes fault of dirty air filters

Fields
- fan_object_type [string]
- fan_name [string]
- availability_schedule_name [string]
- pressure_fraction_schedule_name [string]
- fan_curve_name [string]

FaultModel:Fouling:Boiler¶

This object describes the fouling fault of boilers with water-based heat exchangers

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- boiler_object_type [string]
- boiler_object_name [string]
- fouling_factor [number] (Default: 1.0)

FaultModel:Fouling:EvaporativeCooler¶

This object describes the fouling fault of the wetted coil evaporative cooler

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- evaporative_cooler_object_type [string]
- evaporative_cooler_object_name [string]
- fouling_factor [number] (Default: 1.0)

FaultModel:Fouling:Chiller¶

This object describes the fouling fault of chillers with water-cooled condensers

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- chiller_object_type [string]
- chiller_object_name [string]
- fouling_factor [number] (Default: 1.0)

FaultModel:Fouling:CoolingTower¶

This object describes the fault of fouling cooling towers

Fields
- availability_schedule_name [string]
- severity_schedule_name [string]
- cooling_tower_object_type [string]
- cooling_tower_object_name [string]
- reference_ua_reduction_factor [number]

FaultModel:Fouling:Coil¶

This object describes fouling water heating or cooling coils

Fields
- coil_name [string]
- availability_schedule_name [string]
- severity_schedule_name [string]
- fouling_input_method [string] (Default: FouledUARated)
- uafouled [number]
- water_side_fouling_factor [number] (Default: 0.0)
- air_side_fouling_factor [number] (Default: 0.0)
- outside_coil_surface_area [number]
- inside_to_outside_coil_surface_area_ratio [number] (Default: 0.07)

General Data Entry¶

Matrix:TwoDimension¶

matrix data in row-major order list each row keeping the columns in order number of values must equal N1 x N2

Fields
- number_of_rows [integer]
- number_of_columns [integer]
- values [Array of {value}]

Hybrid Model¶

HybridModel:Zone¶

Zones with measured air temperature data and a range of dates. If the range of temperature measurement dates includes a leap day, the weather data should include a leap day.

Fields
- zone_name [string]
- calculate_zone_internal_thermal_mass [string] (Default: No)
- calculate_zone_air_infiltration_rate [string] (Default: No)
- calculate_zone_people_count [string] (Default: No)
- zone_measured_air_temperature_schedule_name [string]
- zone_measured_air_humidity_ratio_schedule_name [string]
- zone_measured_air_co2_concentration_schedule_name [string]
- zone_input_people_activity_schedule_name [string]
- zone_input_people_sensible_heat_fraction_schedule_name [string]
- zone_input_people_radiant_heat_fraction_schedule_name [string]
- zone_input_people_co2_generation_rate_schedule_name [string]
- zone_input_supply_air_temperature_schedule_name [string]
- zone_input_supply_air_mass_flow_rate_schedule_name [string]
- zone_input_supply_air_humidity_ratio_schedule_name [string]
- zone_input_supply_air_co2_concentration_schedule_name [string]
- begin_month [integer]
- begin_day_of_month [integer]
- end_month [integer]
- end_day_of_month [integer]

Performance Curves¶

Curve:Linear¶

Linear curve with one independent variable. Input for the linear curve consists of a curve name, the two coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:QuadLinear¶

Linear curve with four independent variables. Input for the linear curve consists of a curve name, the two coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*w + C3*x + C4*y + C5*z

Fields
- coefficient1_constant [number]
- coefficient2_w [number]
- coefficient3_x [number]
- coefficient4_y [number]
- coefficient5_z [number]
- minimum_value_of_w [number]
- maximum_value_of_w [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_value_of_z [number]
- maximum_value_of_z [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_w [string] (Default: Dimensionless)
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- input_unit_type_for_z [string] (Default: Dimensionless)

Curve:QuintLinear¶

Linear curve with five independent variables. Input for the linear curve consists of a curve name, the two coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*v + C3*w + C4*x + C5*y + C6*z

Fields
- coefficient1_constant [number]
- coefficient2_v [number]
- coefficient3_w [number]
- coefficient4_x [number]
- coefficient5_y [number]
- coefficient6_z [number]
- minimum_value_of_v [number]
- maximum_value_of_v [number]
- minimum_value_of_w [number]
- maximum_value_of_w [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_value_of_z [number]
- maximum_value_of_z [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_v [string] (Default: Dimensionless)
- input_unit_type_for_w [string] (Default: Dimensionless)
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- input_unit_type_for_z [string] (Default: Dimensionless)

Curve:Quadratic¶

Quadratic curve with one independent variable. Input for a quadratic curve consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Cubic¶

Cubic curve with one independent variable. Input for a cubic curve consists of the curve name, the 4 coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*x**3

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- coefficient4_x_3 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Quartic¶

Quartic (fourth order polynomial) curve with one independent variable. Input for a Quartic curve consists of the curve name, the five coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*x**3 + C5*x**4

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- coefficient4_x_3 [number]
- coefficient5_x_4 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Exponent¶

Exponent curve with one independent variable. Input for a exponent curve consists of the curve name, the 3 coefficients, and the maximum and minimum valid independent variable values. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x**C3 The independent variable x is raised to the C3 power, multiplied by C2, and C1 is added to the result.

Fields
- coefficient1_constant [number]
- coefficient2_constant [number]
- coefficient3_constant [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Bicubic¶

Cubic curve with two independent variables. Input consists of the curve name, the ten coefficients, and the minimum and maximum values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*y + C5*y**2 + C6*x*y + C7*x**3 + C8*y**3 + C9*x**2*y + C10*x*y**2

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- coefficient4_y [number]
- coefficient5_y_2 [number]
- coefficient6_x_y [number]
- coefficient7_x_3 [number]
- coefficient8_y_3 [number]
- coefficient9_x_2_y [number]
- coefficient10_x_y_2 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Biquadratic¶

Quadratic curve with two independent variables. Input consists of the curve name, the six coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*y + C5*y**2 + C6*x*y

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- coefficient4_y [number]
- coefficient5_y_2 [number]
- coefficient6_x_y [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:QuadraticLinear¶

Quadratic-linear curve with two independent variables. Input consists of the curve name, the six coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = (C1 + C2*x + C3*x**2) + (C4 + C5*x + C6*x**2)*y

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- coefficient4_y [number]
- coefficient5_x_y [number]
- coefficient6_x_2_y [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:CubicLinear¶

Cubic-linear curve with two independent variables. Input consists of the curve name, the six coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = (C1 + C2*x + C3*x**2 + C4*x**3) + (C5 + C6*x)*y

Fields
- coefficient1_constant [number]
- coefficient2_x [number]
- coefficient3_x_2 [number]
- coefficient4_x_3 [number]
- coefficient5_y [number]
- coefficient6_x_y [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Triquadratic¶

Quadratic curve with three independent variables. Input consists of the curve name, the twenty seven coefficients, and min and max values for each of the independent variables. Optional inputs for curve minimum and maximum may be used to limit the output of the performance curve. curve = a0 + a1*x**2 + a2*x + a3*y**2 + a4*y + a5*z**2 + a6*z + a7*x**2*y**2 + a8*x*y + a9*x*y**2 + a10*x**2*y + a11*x**2*z**2 + a12*x*z + a13*x*z**2 + a14*x**2*z + a15*y**2*z**2 + a16*y*z + a17*y*z**2 + a18*y**2*z + a19*x**2*y**2*z**2 + a20*x**2*y**2*z + a21*x**2*y*z**2 + a22*x*y**2*z**2 + a23*x**2*y*z + a24*x*y**2*z + a25*x*y*z**2 +a26*x*y*z

Fields
- coefficient1_constant [number]
- coefficient2_x_2 [number]
- coefficient3_x [number]
- coefficient4_y_2 [number]
- coefficient5_y [number]
- coefficient6_z_2 [number]
- coefficient7_z [number]
- coefficient8_x_2_y_2 [number]
- coefficient9_x_y [number]
- coefficient10_x_y_2 [number]
- coefficient11_x_2_y [number]
- coefficient12_x_2_z_2 [number]
- coefficient13_x_z [number]
- coefficient14_x_z_2 [number]
- coefficient15_x_2_z [number]
- coefficient16_y_2_z_2 [number]
- coefficient17_y_z [number]
- coefficient18_y_z_2 [number]
- coefficient19_y_2_z [number]
- coefficient20_x_2_y_2_z_2 [number]
- coefficient21_x_2_y_2_z [number]
- coefficient22_x_2_y_z_2 [number]
- coefficient23_x_y_2_z_2 [number]
- coefficient24_x_2_y_z [number]
- coefficient25_x_y_2_z [number]
- coefficient26_x_y_z_2 [number]
- coefficient27_x_y_z [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_value_of_z [number]
- maximum_value_of_z [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- input_unit_type_for_z [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Functional:PressureDrop¶

Sets up curve information for minor loss and/or friction calculations in plant pressure simulations Expression: DeltaP = {K + f*(L/D)} * (rho * V^2) / 2

Fields
- diameter [number]
- minor_loss_coefficient [number]
- length [number]
- roughness [number]
- fixed_friction_factor [number]

Curve:FanPressureRise¶

Special curve type with two independent variables. Input for the fan total pressure rise curve consists of the curve name, the four coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1*Qfan**2+C2*Qfan+C3*Qfan*(Psm-Po)**0.5+C4*(Psm-Po) Po assumed to be zero See InputOut Reference for curve details

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- coefficient4_c4 [number]
- minimum_value_of_qfan [number]
- maximum_value_of_qfan [number]
- minimum_value_of_psm [number]
- maximum_value_of_psm [number]
- minimum_curve_output [number]
- maximum_curve_output [number]

Curve:ExponentialSkewNormal¶

Exponential-modified skew normal curve with one independent variable. Input consists of the curve name, the four coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = see Input Output Reference

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- coefficient4_c4 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:Sigmoid¶

Sigmoid curve with one independent variable. Input consists of the curve name, the five coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1+C2/[1+exp((C3-x)/C4)]**C5

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- coefficient4_c4 [number]
- coefficient5_c5 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:RectangularHyperbola1¶

Rectangular hyperbola type 1 curve with one independent variable. Input consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = ((C1*x)/(C2+x))+C3

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:RectangularHyperbola2¶

Rectangular hyperbola type 2 curve with one independent variable. Input consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = ((C1*x)/(C2+x))+(C3*x)

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:ExponentialDecay¶

Exponential decay curve with one independent variable. Input consists of the curve name, the three coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1+C2*exp(C3*x)

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:DoubleExponentialDecay¶

Double exponential decay curve with one independent variable. Input consists of the curve name, the five coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1+C2*exp(C3*x)+C4*exp(C5*x)

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- coefficient4_c4 [number]
- coefficient5_c5 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Curve:ChillerPartLoadWithLift¶

This chiller part-load performance curve has three independent variables. Input consists of the curve name, the twelve coefficients, and the maximum and minimum valid independent variable values. Optional inputs for the curve minimum and maximum may be used to limit the output of the performance curve. curve = C1 + C2*x + C3*x**2 + C4*y + C5*y**2 + C6*x*y + C7*x**3 + C8*y**3 + C9*x**2*y + C10*x*y**2 + C11*x**2*y**2 + C12*z*y**3 x = dT* = normalized fractional Lift = dT / dTref y = PLR = part load ratio (cooling load/steady state capacity) z = Tdev* = normalized Tdev = Tdev / dTref Where: dT = Lift = Leaving Condenser Water Temperature - Leaving Chilled Water Temperature dTref = dT at the reference condition Tdev = Leaving Chilled Water Temperature - Reference Chilled Water Temperature

Fields
- coefficient1_c1 [number]
- coefficient2_c2 [number]
- coefficient3_c3 [number]
- coefficient4_c4 [number]
- coefficient5_c5 [number]
- coefficient6_c6 [number]
- coefficient7_c7 [number]
- coefficient8_c8 [number]
- coefficient9_c9 [number]
- coefficient10_c10 [number]
- coefficient11_c11 [number]
- coefficient12_c12 [number]
- minimum_value_of_x [number]
- maximum_value_of_x [number]
- minimum_value_of_y [number]
- maximum_value_of_y [number]
- minimum_value_of_z [number]
- maximum_value_of_z [number]
- minimum_curve_output [number]
- maximum_curve_output [number]
- input_unit_type_for_x [string] (Default: Dimensionless)
- input_unit_type_for_y [string] (Default: Dimensionless)
- input_unit_type_for_z [string] (Default: Dimensionless)
- output_unit_type [string] (Default: Dimensionless)

Performance Tables¶

Table:IndependentVariable¶

An independent variable representing a single dimension of a Table:Lookup object.

Fields
- interpolation_method [string] (Default: Linear)
- extrapolation_method [string] (Default: Constant)
- minimum_value [number]
- maximum_value [number]
- normalization_reference_value [number]
- unit_type [string] (Default: Dimensionless)
- external_file_name [string]
- external_file_column_number [integer]
- external_file_starting_row_number [integer]
- values [Array of {value}]

Table:IndependentVariableList¶

A sorted list of independent variables used by one or more Table:Lookup objects.

Fields
- independent_variables [Array of {independent_variable_name}]

Table:Lookup¶

Lookup tables are used in place of curves and can represent any number of independent variables (defined as Table:IndependentVariable objects in a Table:IndependentVariableList). Output values are interpolated within the bounds defined by each independent variable and extrapolated beyond the bounds according to the interpolation/extrapolation methods defined by each independent variable.

Fields
- independent_variable_list_name [string]
- normalization_method [string] (Default: None)
- normalization_divisor [number] (Default: 1.0)
- minimum_output [number]
- maximum_output [number]
- output_unit_type [string] (Default: Dimensionless)
- external_file_name [string]
- external_file_column_number [integer]
- external_file_starting_row_number [integer]
- values [Array of {output_value}]

Fluid Properties¶

FluidProperties:Name¶

potential fluid name/type in the input file repeat this object for each fluid

Fields
- fluid_name [string]
- fluid_type [string]

FluidProperties:GlycolConcentration¶

glycol and what concentration it is

Fields
- glycol_type [string]
- user_defined_glycol_name [string]
- glycol_concentration [number]

FluidProperties:Temperatures¶

property values for fluid properties list of up to 250 temperatures, note that number of property values must match the number of properties in other words, there must be a one-to-one correspondence between the property values in this list and the actual properties list in other syntax degrees C (for all temperature inputs)

Fields
- temperature_1 [number]
- temperature_2 [number]
- temperature_3 [number]
- temperature_4 [number]
- temperature_5 [number]
- temperature_6 [number]
- temperature_7 [number]
- temperature_8 [number]
- temperature_9 [number]
- temperature_10 [number]
- temperature_11 [number]
- temperature_12 [number]
- temperature_13 [number]
- temperature_14 [number]
- temperature_15 [number]
- temperature_16 [number]
- temperature_17 [number]
- temperature_18 [number]
- temperature_19 [number]
- temperature_20 [number]
- temperature_21 [number]
- temperature_22 [number]
- temperature_23 [number]
- temperature_24 [number]
- temperature_25 [number]
- temperature_26 [number]
- temperature_27 [number]
- temperature_28 [number]
- temperature_29 [number]
- temperature_30 [number]
- temperature_31 [number]
- temperature_32 [number]
- temperature_33 [number]
- temperature_34 [number]
- temperature_35 [number]
- temperature_36 [number]
- temperature_37 [number]
- temperature_38 [number]
- temperature_39 [number]
- temperature_40 [number]
- temperature_41 [number]
- temperature_42 [number]
- temperature_43 [number]
- temperature_44 [number]
- temperature_45 [number]
- temperature_46 [number]
- temperature_47 [number]
- temperature_48 [number]
- temperature_49 [number]
- temperature_50 [number]
- temperature_51 [number]
- temperature_52 [number]
- temperature_53 [number]
- temperature_54 [number]
- temperature_55 [number]
- temperature_56 [number]
- temperature_57 [number]
- temperature_58 [number]
- temperature_59 [number]
- temperature_60 [number]
- temperature_61 [number]
- temperature_62 [number]
- temperature_63 [number]
- temperature_64 [number]
- temperature_65 [number]
- temperature_66 [number]
- temperature_67 [number]
- temperature_68 [number]
- temperature_69 [number]
- temperature_70 [number]
- temperature_71 [number]
- temperature_72 [number]
- temperature_73 [number]
- temperature_74 [number]
- temperature_75 [number]
- temperature_76 [number]
- temperature_77 [number]
- temperature_78 [number]
- temperature_79 [number]
- temperature_80 [number]
- temperature_81 [number]
- temperature_82 [number]
- temperature_83 [number]
- temperature_84 [number]
- temperature_85 [number]
- temperature_86 [number]
- temperature_87 [number]
- temperature_88 [number]
- temperature_89 [number]
- temperature_90 [number]
- temperature_91 [number]
- temperature_92 [number]
- temperature_93 [number]
- temperature_94 [number]
- temperature_95 [number]
- temperature_96 [number]
- temperature_97 [number]
- temperature_98 [number]
- temperature_99 [number]
- temperature_100 [number]
- temperature_101 [number]
- temperature_102 [number]
- temperature_103 [number]
- temperature_104 [number]
- temperature_105 [number]
- temperature_106 [number]
- temperature_107 [number]
- temperature_108 [number]
- temperature_109 [number]
- temperature_110 [number]
- temperature_111 [number]
- temperature_112 [number]
- temperature_113 [number]
- temperature_114 [number]
- temperature_115 [number]
- temperature_116 [number]
- temperature_117 [number]
- temperature_118 [number]
- temperature_119 [number]
- temperature_120 [number]
- temperature_121 [number]
- temperature_122 [number]
- temperature_123 [number]
- temperature_124 [number]
- temperature_125 [number]
- temperature_126 [number]
- temperature_127 [number]
- temperature_128 [number]
- temperature_129 [number]
- temperature_130 [number]
- temperature_131 [number]
- temperature_132 [number]
- temperature_133 [number]
- temperature_134 [number]
- temperature_135 [number]
- temperature_136 [number]
- temperature_137 [number]
- temperature_138 [number]
- temperature_139 [number]
- temperature_140 [number]
- temperature_141 [number]
- temperature_142 [number]
- temperature_143 [number]
- temperature_144 [number]
- temperature_145 [number]
- temperature_146 [number]
- temperature_147 [number]
- temperature_148 [number]
- temperature_149 [number]
- temperature_150 [number]
- temperature_151 [number]
- temperature_152 [number]
- temperature_153 [number]
- temperature_154 [number]
- temperature_155 [number]
- temperature_156 [number]
- temperature_157 [number]
- temperature_158 [number]
- temperature_159 [number]
- temperature_160 [number]
- temperature_161 [number]
- temperature_162 [number]
- temperature_163 [number]
- temperature_164 [number]
- temperature_165 [number]
- temperature_166 [number]
- temperature_167 [number]
- temperature_168 [number]
- temperature_169 [number]
- temperature_170 [number]
- temperature_171 [number]
- temperature_172 [number]
- temperature_173 [number]
- temperature_174 [number]
- temperature_175 [number]
- temperature_176 [number]
- temperature_177 [number]
- temperature_178 [number]
- temperature_179 [number]
- temperature_180 [number]
- temperature_181 [number]
- temperature_182 [number]
- temperature_183 [number]
- temperature_184 [number]
- temperature_185 [number]
- temperature_186 [number]
- temperature_187 [number]
- temperature_188 [number]
- temperature_189 [number]
- temperature_190 [number]
- temperature_191 [number]
- temperature_192 [number]
- temperature_193 [number]
- temperature_194 [number]
- temperature_195 [number]
- temperature_196 [number]
- temperature_197 [number]
- temperature_198 [number]
- temperature_199 [number]
- temperature_200 [number]
- temperature_201 [number]
- temperature_202 [number]
- temperature_203 [number]
- temperature_204 [number]
- temperature_205 [number]
- temperature_206 [number]
- temperature_207 [number]
- temperature_208 [number]
- temperature_209 [number]
- temperature_210 [number]
- temperature_211 [number]
- temperature_212 [number]
- temperature_213 [number]
- temperature_214 [number]
- temperature_215 [number]
- temperature_216 [number]
- temperature_217 [number]
- temperature_218 [number]
- temperature_219 [number]
- temperature_220 [number]
- temperature_221 [number]
- temperature_222 [number]
- temperature_223 [number]
- temperature_224 [number]
- temperature_225 [number]
- temperature_226 [number]
- temperature_227 [number]
- temperature_228 [number]
- temperature_229 [number]
- temperature_230 [number]
- temperature_231 [number]
- temperature_232 [number]
- temperature_233 [number]
- temperature_234 [number]
- temperature_235 [number]
- temperature_236 [number]
- temperature_237 [number]
- temperature_238 [number]
- temperature_239 [number]
- temperature_240 [number]
- temperature_241 [number]
- temperature_242 [number]
- temperature_243 [number]
- temperature_244 [number]
- temperature_245 [number]
- temperature_246 [number]
- temperature_247 [number]
- temperature_248 [number]
- temperature_249 [number]
- temperature_250 [number]

FluidProperties:Saturated¶

fluid properties for the saturated region

Fields
- fluid_name [string]
- fluid_property_type [string]
- fluid_phase [string]
- temperature_values_name [string]
- property_value_1 [number]
- property_value_2 [number]
- property_value_3 [number]
- property_value_4 [number]
- property_value_5 [number]
- property_value_6 [number]
- property_value_7 [number]
- property_value_8 [number]
- property_value_9 [number]
- property_value_10 [number]
- property_value_11 [number]
- property_value_12 [number]
- property_value_13 [number]
- property_value_14 [number]
- property_value_15 [number]
- property_value_16 [number]
- property_value_17 [number]
- property_value_18 [number]
- property_value_19 [number]
- property_value_20 [number]
- property_value_21 [number]
- property_value_22 [number]
- property_value_23 [number]
- property_value_24 [number]
- property_value_25 [number]
- property_value_26 [number]
- property_value_27 [number]
- property_value_28 [number]
- property_value_29 [number]
- property_value_30 [number]
- property_value_31 [number]
- property_value_32 [number]
- property_value_33 [number]
- property_value_34 [number]
- property_value_35 [number]
- property_value_36 [number]
- property_value_37 [number]
- property_value_38 [number]
- property_value_39 [number]
- property_value_40 [number]
- property_value_41 [number]
- property_value_42 [number]
- property_value_43 [number]
- property_value_44 [number]
- property_value_45 [number]
- property_value_46 [number]
- property_value_47 [number]
- property_value_48 [number]
- property_value_49 [number]
- property_value_50 [number]
- property_value_51 [number]
- property_value_52 [number]
- property_value_53 [number]
- property_value_54 [number]
- property_value_55 [number]
- property_value_56 [number]
- property_value_57 [number]
- property_value_58 [number]
- property_value_59 [number]
- property_value_60 [number]
- property_value_61 [number]
- property_value_62 [number]
- property_value_63 [number]
- property_value_64 [number]
- property_value_65 [number]
- property_value_66 [number]
- property_value_67 [number]
- property_value_68 [number]
- property_value_69 [number]
- property_value_70 [number]
- property_value_71 [number]
- property_value_72 [number]
- property_value_73 [number]
- property_value_74 [number]
- property_value_75 [number]
- property_value_76 [number]
- property_value_77 [number]
- property_value_78 [number]
- property_value_79 [number]
- property_value_80 [number]
- property_value_81 [number]
- property_value_82 [number]
- property_value_83 [number]
- property_value_84 [number]
- property_value_85 [number]
- property_value_86 [number]
- property_value_87 [number]
- property_value_88 [number]
- property_value_89 [number]
- property_value_90 [number]
- property_value_91 [number]
- property_value_92 [number]
- property_value_93 [number]
- property_value_94 [number]
- property_value_95 [number]
- property_value_96 [number]
- property_value_97 [number]
- property_value_98 [number]
- property_value_99 [number]
- property_value_100 [number]
- property_value_101 [number]
- property_value_102 [number]
- property_value_103 [number]
- property_value_104 [number]
- property_value_105 [number]
- property_value_106 [number]
- property_value_107 [number]
- property_value_108 [number]
- property_value_109 [number]
- property_value_110 [number]
- property_value_111 [number]
- property_value_112 [number]
- property_value_113 [number]
- property_value_114 [number]
- property_value_115 [number]
- property_value_116 [number]
- property_value_117 [number]
- property_value_118 [number]
- property_value_119 [number]
- property_value_120 [number]
- property_value_121 [number]
- property_value_122 [number]
- property_value_123 [number]
- property_value_124 [number]
- property_value_125 [number]
- property_value_126 [number]
- property_value_127 [number]
- property_value_128 [number]
- property_value_129 [number]
- property_value_130 [number]
- property_value_131 [number]
- property_value_132 [number]
- property_value_133 [number]
- property_value_134 [number]
- property_value_135 [number]
- property_value_136 [number]
- property_value_137 [number]
- property_value_138 [number]
- property_value_139 [number]
- property_value_140 [number]
- property_value_141 [number]
- property_value_142 [number]
- property_value_143 [number]
- property_value_144 [number]
- property_value_145 [number]
- property_value_146 [number]
- property_value_147 [number]
- property_value_148 [number]
- property_value_149 [number]
- property_value_150 [number]
- property_value_151 [number]
- property_value_152 [number]
- property_value_153 [number]
- property_value_154 [number]
- property_value_155 [number]
- property_value_156 [number]
- property_value_157 [number]
- property_value_158 [number]
- property_value_159 [number]
- property_value_160 [number]
- property_value_161 [number]
- property_value_162 [number]
- property_value_163 [number]
- property_value_164 [number]
- property_value_165 [number]
- property_value_166 [number]
- property_value_167 [number]
- property_value_168 [number]
- property_value_169 [number]
- property_value_170 [number]
- property_value_171 [number]
- property_value_172 [number]
- property_value_173 [number]
- property_value_174 [number]
- property_value_175 [number]
- property_value_176 [number]
- property_value_177 [number]
- property_value_178 [number]
- property_value_179 [number]
- property_value_180 [number]
- property_value_181 [number]
- property_value_182 [number]
- property_value_183 [number]
- property_value_184 [number]
- property_value_185 [number]
- property_value_186 [number]
- property_value_187 [number]
- property_value_188 [number]
- property_value_189 [number]
- property_value_190 [number]
- property_value_191 [number]
- property_value_192 [number]
- property_value_193 [number]
- property_value_194 [number]
- property_value_195 [number]
- property_value_196 [number]
- property_value_197 [number]
- property_value_198 [number]
- property_value_199 [number]
- property_value_200 [number]
- property_value_201 [number]
- property_value_202 [number]
- property_value_203 [number]
- property_value_204 [number]
- property_value_205 [number]
- property_value_206 [number]
- property_value_207 [number]
- property_value_208 [number]
- property_value_209 [number]
- property_value_210 [number]
- property_value_211 [number]
- property_value_212 [number]
- property_value_213 [number]
- property_value_214 [number]
- property_value_215 [number]
- property_value_216 [number]
- property_value_217 [number]
- property_value_218 [number]
- property_value_219 [number]
- property_value_220 [number]
- property_value_221 [number]
- property_value_222 [number]
- property_value_223 [number]
- property_value_224 [number]
- property_value_225 [number]
- property_value_226 [number]
- property_value_227 [number]
- property_value_228 [number]
- property_value_229 [number]
- property_value_230 [number]
- property_value_231 [number]
- property_value_232 [number]
- property_value_233 [number]
- property_value_234 [number]
- property_value_235 [number]
- property_value_236 [number]
- property_value_237 [number]
- property_value_238 [number]
- property_value_239 [number]
- property_value_240 [number]
- property_value_241 [number]
- property_value_242 [number]
- property_value_243 [number]
- property_value_244 [number]
- property_value_245 [number]
- property_value_246 [number]
- property_value_247 [number]
- property_value_248 [number]
- property_value_249 [number]
- property_value_250 [number]

FluidProperties:Superheated¶

fluid properties for the superheated region

Fields
- fluid_name [string]
- fluid_property_type [string]
- temperature_values_name [string]
- pressure [number]
- property_value_1 [number]
- property_value_2 [number]
- property_value_3 [number]
- property_value_4 [number]
- property_value_5 [number]
- property_value_6 [number]
- property_value_7 [number]
- property_value_8 [number]
- property_value_9 [number]
- property_value_10 [number]
- property_value_11 [number]
- property_value_12 [number]
- property_value_13 [number]
- property_value_14 [number]
- property_value_15 [number]
- property_value_16 [number]
- property_value_17 [number]
- property_value_18 [number]
- property_value_19 [number]
- property_value_20 [number]
- property_value_21 [number]
- property_value_22 [number]
- property_value_23 [number]
- property_value_24 [number]
- property_value_25 [number]
- property_value_26 [number]
- property_value_27 [number]
- property_value_28 [number]
- property_value_29 [number]
- property_value_30 [number]
- property_value_31 [number]
- property_value_32 [number]
- property_value_33 [number]
- property_value_34 [number]
- property_value_35 [number]
- property_value_36 [number]
- property_value_37 [number]
- property_value_38 [number]
- property_value_39 [number]
- property_value_40 [number]
- property_value_41 [number]
- property_value_42 [number]
- property_value_43 [number]
- property_value_44 [number]
- property_value_45 [number]
- property_value_46 [number]
- property_value_47 [number]
- property_value_48 [number]
- property_value_49 [number]
- property_value_50 [number]
- property_value_51 [number]
- property_value_52 [number]
- property_value_53 [number]
- property_value_54 [number]
- property_value_55 [number]
- property_value_56 [number]
- property_value_57 [number]
- property_value_58 [number]
- property_value_59 [number]
- property_value_60 [number]
- property_value_61 [number]
- property_value_62 [number]
- property_value_63 [number]
- property_value_64 [number]
- property_value_65 [number]
- property_value_66 [number]
- property_value_67 [number]
- property_value_68 [number]
- property_value_69 [number]
- property_value_70 [number]
- property_value_71 [number]
- property_value_72 [number]
- property_value_73 [number]
- property_value_74 [number]
- property_value_75 [number]
- property_value_76 [number]
- property_value_77 [number]
- property_value_78 [number]
- property_value_79 [number]
- property_value_80 [number]
- property_value_81 [number]
- property_value_82 [number]
- property_value_83 [number]
- property_value_84 [number]
- property_value_85 [number]
- property_value_86 [number]
- property_value_87 [number]
- property_value_88 [number]
- property_value_89 [number]
- property_value_90 [number]
- property_value_91 [number]
- property_value_92 [number]
- property_value_93 [number]
- property_value_94 [number]
- property_value_95 [number]
- property_value_96 [number]
- property_value_97 [number]
- property_value_98 [number]
- property_value_99 [number]
- property_value_100 [number]
- property_value_101 [number]
- property_value_102 [number]
- property_value_103 [number]
- property_value_104 [number]
- property_value_105 [number]
- property_value_106 [number]
- property_value_107 [number]
- property_value_108 [number]
- property_value_109 [number]
- property_value_110 [number]
- property_value_111 [number]
- property_value_112 [number]
- property_value_113 [number]
- property_value_114 [number]
- property_value_115 [number]
- property_value_116 [number]
- property_value_117 [number]
- property_value_118 [number]
- property_value_119 [number]
- property_value_120 [number]
- property_value_121 [number]
- property_value_122 [number]
- property_value_123 [number]
- property_value_124 [number]
- property_value_125 [number]
- property_value_126 [number]
- property_value_127 [number]
- property_value_128 [number]
- property_value_129 [number]
- property_value_130 [number]
- property_value_131 [number]
- property_value_132 [number]
- property_value_133 [number]
- property_value_134 [number]
- property_value_135 [number]
- property_value_136 [number]
- property_value_137 [number]
- property_value_138 [number]
- property_value_139 [number]
- property_value_140 [number]
- property_value_141 [number]
- property_value_142 [number]
- property_value_143 [number]
- property_value_144 [number]
- property_value_145 [number]
- property_value_146 [number]
- property_value_147 [number]
- property_value_148 [number]
- property_value_149 [number]
- property_value_150 [number]
- property_value_151 [number]
- property_value_152 [number]
- property_value_153 [number]
- property_value_154 [number]
- property_value_155 [number]
- property_value_156 [number]
- property_value_157 [number]
- property_value_158 [number]
- property_value_159 [number]
- property_value_160 [number]
- property_value_161 [number]
- property_value_162 [number]
- property_value_163 [number]
- property_value_164 [number]
- property_value_165 [number]
- property_value_166 [number]
- property_value_167 [number]
- property_value_168 [number]
- property_value_169 [number]
- property_value_170 [number]
- property_value_171 [number]
- property_value_172 [number]
- property_value_173 [number]
- property_value_174 [number]
- property_value_175 [number]
- property_value_176 [number]
- property_value_177 [number]
- property_value_178 [number]
- property_value_179 [number]
- property_value_180 [number]
- property_value_181 [number]
- property_value_182 [number]
- property_value_183 [number]
- property_value_184 [number]
- property_value_185 [number]
- property_value_186 [number]
- property_value_187 [number]
- property_value_188 [number]
- property_value_189 [number]
- property_value_190 [number]
- property_value_191 [number]
- property_value_192 [number]
- property_value_193 [number]
- property_value_194 [number]
- property_value_195 [number]
- property_value_196 [number]
- property_value_197 [number]
- property_value_198 [number]
- property_value_199 [number]
- property_value_200 [number]
- property_value_201 [number]
- property_value_202 [number]
- property_value_203 [number]
- property_value_204 [number]
- property_value_205 [number]
- property_value_206 [number]
- property_value_207 [number]
- property_value_208 [number]
- property_value_209 [number]
- property_value_210 [number]
- property_value_211 [number]
- property_value_212 [number]
- property_value_213 [number]
- property_value_214 [number]
- property_value_215 [number]
- property_value_216 [number]
- property_value_217 [number]
- property_value_218 [number]
- property_value_219 [number]
- property_value_220 [number]
- property_value_221 [number]
- property_value_222 [number]
- property_value_223 [number]
- property_value_224 [number]
- property_value_225 [number]
- property_value_226 [number]
- property_value_227 [number]
- property_value_228 [number]
- property_value_229 [number]
- property_value_230 [number]
- property_value_231 [number]
- property_value_232 [number]
- property_value_233 [number]
- property_value_234 [number]
- property_value_235 [number]
- property_value_236 [number]
- property_value_237 [number]
- property_value_238 [number]
- property_value_239 [number]
- property_value_240 [number]
- property_value_241 [number]
- property_value_242 [number]
- property_value_243 [number]
- property_value_244 [number]
- property_value_245 [number]
- property_value_246 [number]
- property_value_247 [number]
- property_value_248 [number]
- property_value_249 [number]
- property_value_250 [number]

FluidProperties:Concentration¶

fluid properties for water/other fluid mixtures

Fields
- fluid_name [string]
- fluid_property_type [string]
- temperature_values_name [string]
- concentration [number]
- property_value_1 [number]
- property_value_2 [number]
- property_value_3 [number]
- property_value_4 [number]
- property_value_5 [number]
- property_value_6 [number]
- property_value_7 [number]
- property_value_8 [number]
- property_value_9 [number]
- property_value_10 [number]
- property_value_11 [number]
- property_value_12 [number]
- property_value_13 [number]
- property_value_14 [number]
- property_value_15 [number]
- property_value_16 [number]
- property_value_17 [number]
- property_value_18 [number]
- property_value_19 [number]
- property_value_20 [number]
- property_value_21 [number]
- property_value_22 [number]
- property_value_23 [number]
- property_value_24 [number]
- property_value_25 [number]
- property_value_26 [number]
- property_value_27 [number]
- property_value_28 [number]
- property_value_29 [number]
- property_value_30 [number]
- property_value_31 [number]
- property_value_32 [number]
- property_value_33 [number]
- property_value_34 [number]
- property_value_35 [number]
- property_value_36 [number]
- property_value_37 [number]
- property_value_38 [number]
- property_value_39 [number]
- property_value_40 [number]
- property_value_41 [number]
- property_value_42 [number]
- property_value_43 [number]
- property_value_44 [number]
- property_value_45 [number]
- property_value_46 [number]
- property_value_47 [number]
- property_value_48 [number]
- property_value_49 [number]
- property_value_50 [number]
- property_value_51 [number]
- property_value_52 [number]
- property_value_53 [number]
- property_value_54 [number]
- property_value_55 [number]
- property_value_56 [number]
- property_value_57 [number]
- property_value_58 [number]
- property_value_59 [number]
- property_value_60 [number]
- property_value_61 [number]
- property_value_62 [number]
- property_value_63 [number]
- property_value_64 [number]
- property_value_65 [number]
- property_value_66 [number]
- property_value_67 [number]
- property_value_68 [number]
- property_value_69 [number]
- property_value_70 [number]
- property_value_71 [number]
- property_value_72 [number]
- property_value_73 [number]
- property_value_74 [number]
- property_value_75 [number]
- property_value_76 [number]
- property_value_77 [number]
- property_value_78 [number]
- property_value_79 [number]
- property_value_80 [number]
- property_value_81 [number]
- property_value_82 [number]
- property_value_83 [number]
- property_value_84 [number]
- property_value_85 [number]
- property_value_86 [number]
- property_value_87 [number]
- property_value_88 [number]
- property_value_89 [number]
- property_value_90 [number]
- property_value_91 [number]
- property_value_92 [number]
- property_value_93 [number]
- property_value_94 [number]
- property_value_95 [number]
- property_value_96 [number]
- property_value_97 [number]
- property_value_98 [number]
- property_value_99 [number]
- property_value_100 [number]
- property_value_101 [number]
- property_value_102 [number]
- property_value_103 [number]
- property_value_104 [number]
- property_value_105 [number]
- property_value_106 [number]
- property_value_107 [number]
- property_value_108 [number]
- property_value_109 [number]
- property_value_110 [number]
- property_value_111 [number]
- property_value_112 [number]
- property_value_113 [number]
- property_value_114 [number]
- property_value_115 [number]
- property_value_116 [number]
- property_value_117 [number]
- property_value_118 [number]
- property_value_119 [number]
- property_value_120 [number]
- property_value_121 [number]
- property_value_122 [number]
- property_value_123 [number]
- property_value_124 [number]
- property_value_125 [number]
- property_value_126 [number]
- property_value_127 [number]
- property_value_128 [number]
- property_value_129 [number]
- property_value_130 [number]
- property_value_131 [number]
- property_value_132 [number]
- property_value_133 [number]
- property_value_134 [number]
- property_value_135 [number]
- property_value_136 [number]
- property_value_137 [number]
- property_value_138 [number]
- property_value_139 [number]
- property_value_140 [number]
- property_value_141 [number]
- property_value_142 [number]
- property_value_143 [number]
- property_value_144 [number]
- property_value_145 [number]
- property_value_146 [number]
- property_value_147 [number]
- property_value_148 [number]
- property_value_149 [number]
- property_value_150 [number]
- property_value_151 [number]
- property_value_152 [number]
- property_value_153 [number]
- property_value_154 [number]
- property_value_155 [number]
- property_value_156 [number]
- property_value_157 [number]
- property_value_158 [number]
- property_value_159 [number]
- property_value_160 [number]
- property_value_161 [number]
- property_value_162 [number]
- property_value_163 [number]
- property_value_164 [number]
- property_value_165 [number]
- property_value_166 [number]
- property_value_167 [number]
- property_value_168 [number]
- property_value_169 [number]
- property_value_170 [number]
- property_value_171 [number]
- property_value_172 [number]
- property_value_173 [number]
- property_value_174 [number]
- property_value_175 [number]
- property_value_176 [number]
- property_value_177 [number]
- property_value_178 [number]
- property_value_179 [number]
- property_value_180 [number]
- property_value_181 [number]
- property_value_182 [number]
- property_value_183 [number]
- property_value_184 [number]
- property_value_185 [number]
- property_value_186 [number]
- property_value_187 [number]
- property_value_188 [number]
- property_value_189 [number]
- property_value_190 [number]
- property_value_191 [number]
- property_value_192 [number]
- property_value_193 [number]
- property_value_194 [number]
- property_value_195 [number]
- property_value_196 [number]
- property_value_197 [number]
- property_value_198 [number]
- property_value_199 [number]
- property_value_200 [number]
- property_value_201 [number]
- property_value_202 [number]
- property_value_203 [number]
- property_value_204 [number]
- property_value_205 [number]
- property_value_206 [number]
- property_value_207 [number]
- property_value_208 [number]
- property_value_209 [number]
- property_value_210 [number]
- property_value_211 [number]
- property_value_212 [number]
- property_value_213 [number]
- property_value_214 [number]
- property_value_215 [number]
- property_value_216 [number]
- property_value_217 [number]
- property_value_218 [number]
- property_value_219 [number]
- property_value_220 [number]
- property_value_221 [number]
- property_value_222 [number]
- property_value_223 [number]
- property_value_224 [number]
- property_value_225 [number]
- property_value_226 [number]
- property_value_227 [number]
- property_value_228 [number]
- property_value_229 [number]
- property_value_230 [number]
- property_value_231 [number]
- property_value_232 [number]
- property_value_233 [number]
- property_value_234 [number]
- property_value_235 [number]
- property_value_236 [number]
- property_value_237 [number]
- property_value_238 [number]
- property_value_239 [number]
- property_value_240 [number]
- property_value_241 [number]
- property_value_242 [number]
- property_value_243 [number]
- property_value_244 [number]
- property_value_245 [number]
- property_value_246 [number]
- property_value_247 [number]
- property_value_248 [number]
- property_value_249 [number]
- property_value_250 [number]

Economics¶

CurrencyType¶

If CurrencyType is not specified, it will default to USD and produce $ in the reports.

Fields
- monetary_unit [string]

ComponentCost:Adjustments¶

Used to perform various modifications to the construction costs to arrive at an estimate for total project costs. This object allows extending the line item model so that the overall costs of the project will reflect various profit and fees.

Fields
- miscellaneous_cost_per_conditioned_area [number]
- design_and_engineering_fees [number]
- contractor_fee [number]
- contingency [number]
- permits_bonding_and_insurance [number]
- commissioning_fee [number]
- regional_adjustment_factor [number]

ComponentCost:Reference¶

Used to allow comparing the current cost estimate to the results of a previous estimate for a reference building. This object parallels the ComponentCost:Adjustments object but adds a field for entering the cost line item model result for the reference building. The factors entered in this object are applied to the reference building while the factors listed in the ComponentCost:Adjustments object are applied to the current building model cost estimate.

Fields
- reference_building_line_item_costs [number]
- reference_building_miscellaneous_cost_per_conditioned_area [number]
- reference_building_design_and_engineering_fees [number]
- reference_building_contractor_fee [number]
- reference_building_contingency [number]
- reference_building_permits_bonding_and_insurance [number]
- reference_building_commissioning_fee [number]
- reference_building_regional_adjustment_factor [number]

ComponentCost:LineItem¶

Each instance of this object creates a cost line item and will contribute to the total for a cost estimate.

Fields
- type [string]
- line_item_type [string]
- item_name [string]
- object_end_use_key [string]
- cost_per_each [number]
- cost_per_area [number]
- cost_per_unit_of_output_capacity [number]
- cost_per_unit_of_output_capacity_per_cop [number]
- cost_per_volume [number]
- cost_per_volume_rate [number]
- cost_per_energy_per_temperature_difference [number]
- quantity [number]

UtilityCost:Tariff¶

Defines the name of a utility cost tariff, the type of tariff, and other details about the overall tariff. Each other object that is part of the tariff model references the tariff name. See UtilityCost:Charge:Simple, UtilityCost:Charge:Block, UtilityCost:Ratchet, UtilityCost:Qualify, UtilityCost:Variable and UtilityCost:Computation objects.

Fields
- output_meter_name [string]
- conversion_factor_choice [string]
- energy_conversion_factor [number]
- demand_conversion_factor [number]
- time_of_use_period_schedule_name [string]
- season_schedule_name [string]
- month_schedule_name [string]
- demand_window_length [string]
- monthly_charge_or_variable_name [unknown field type]
- minimum_monthly_charge_or_variable_name [unknown field type]
- real_time_pricing_charge_schedule_name [string]
- customer_baseline_load_schedule_name [string]
- group_name [string]
- buy_or_sell [string] (Default: BuyFromUtility)

UtilityCost:Qualify¶

The qualify object allows only tariffs to be selected based on limits which may apply such as maximum or minimum demand requirements. If the results of the simulation fall outside of the range of qualifications, that tariff is still calculated but the “Qualified” entry will say “No” and the UtilityCost:Qualify that caused its exclusion is shown. Multiple UtilityCost:Qualify objects can appear for the same tariff and they can be based on any variable.

Fields
- utility_cost_qualify_name [string]
- tariff_name [string]
- variable_name [string]
- qualify_type [string] (Default: Maximum)
- threshold_value_or_variable_name [unknown field type]
- season [string]
- threshold_test [string] (Default: Consecutive)
- number_of_months [number]

UtilityCost:Charge:Simple¶

UtilityCost:Charge:Simple is one of the most often used objects for tariff calculation. It is used to compute energy and demand charges that are very simple. It may also be used for taxes, surcharges and any other charges that occur on a utility bill. Multiple UtilityCost:Charge:Simple objects may be defined for a single tariff and they will be added together.

Fields
- utility_cost_charge_simple_name [string]
- tariff_name [string]
- source_variable [string]
- season [string]
- category_variable_name [string]
- cost_per_unit_value_or_variable_name [unknown field type]

UtilityCost:Charge:Block¶

Used to compute energy and demand charges (or any other charges) that are structured in blocks of charges. Multiple UtilityCost:Charge:Block objects may be defined for a single tariff and they will be added together.

Fields
- utility_cost_charge_block_name [string]
- tariff_name [string]
- source_variable [string]
- season [string] (Default: Annual)
- category_variable_name [string]
- remaining_into_variable [string]
- block_size_multiplier_value_or_variable_name [unknown field type]
- block_size_1_value_or_variable_name [unknown field type]
- block_1_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_2_value_or_variable_name [unknown field type]
- block_2_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_3_value_or_variable_name [unknown field type]
- block_3_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_4_value_or_variable_name [unknown field type]
- block_4_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_5_value_or_variable_name [unknown field type]
- block_5_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_6_value_or_variable_name [unknown field type]
- block_6_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_7_value_or_variable_name [unknown field type]
- block_7_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_8_value_or_variable_name [unknown field type]
- block_8_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_9_value_or_variable_name [unknown field type]
- block_9_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_10_value_or_variable_name [unknown field type]
- block_10_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_11_value_or_variable_name [unknown field type]
- block_11_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_12_value_or_variable_name [unknown field type]
- block_12_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_13_value_or_variable_name [unknown field type]
- block_13_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_14_value_or_variable_name [unknown field type]
- block_14_cost_per_unit_value_or_variable_name [unknown field type]
- block_size_15_value_or_variable_name [unknown field type]
- block_15_cost_per_unit_value_or_variable_name [unknown field type]

UtilityCost:Ratchet¶

Allows the modeling of tariffs that include some type of seasonal ratcheting. Ratchets are most common when used with electric demand charges. A ratchet is when a utility requires that the demand charge for a month with a low demand may be increased to be more consistent with a month that set a higher demand charge.

Fields
- tariff_name [string]
- baseline_source_variable [string]
- adjustment_source_variable [string]
- season_from [string]
- season_to [string]
- multiplier_value_or_variable_name [unknown field type]
- offset_value_or_variable_name [unknown field type]

UtilityCost:Variable¶

Allows for the direct entry of monthly values into a utility tariff variable.

Fields
- tariff_name [string]
- variable_type [string] (Default: Dimensionless)
- january_value [number]
- february_value [number]
- march_value [number]
- april_value [number]
- may_value [number]
- june_value [number]
- july_value [number]
- august_value [number]
- september_value [number]
- october_value [number]
- november_value [number]
- december_value [number]

UtilityCost:Computation¶

The object lists a series of computations that are used to perform the utility bill calculation. The object is only used for complex tariffs that cannot be modeled any other way. For most utility tariffs, UtilityCost:Computation is unnecessary and should be avoided. If UtilityCost:Computation is used, it must contain references to all objects involved in the rate in the order that they should be computed.

Fields
- tariff_name [string]
- compute_step_1 [string]
- compute_step_2 [string]
- compute_step_3 [string]
- compute_step_4 [string]
- compute_step_5 [string]
- compute_step_6 [string]
- compute_step_7 [string]
- compute_step_8 [string]
- compute_step_9 [string]
- compute_step_10 [string]
- compute_step_11 [string]
- compute_step_12 [string]
- compute_step_13 [string]
- compute_step_14 [string]
- compute_step_15 [string]
- compute_step_16 [string]
- compute_step_17 [string]
- compute_step_18 [string]
- compute_step_19 [string]
- compute_step_20 [string]
- compute_step_21 [string]
- compute_step_22 [string]
- compute_step_23 [string]
- compute_step_24 [string]
- compute_step_25 [string]
- compute_step_26 [string]
- compute_step_27 [string]
- compute_step_28 [string]
- compute_step_29 [string]
- compute_step_30 [string]

LifeCycleCost:Parameters¶

Provides inputs related to the overall life-cycle analysis. It establishes many of the assumptions used in computing the present value. It is important that when comparing the results of multiple simulations that the fields in the LifeCycleCost:Parameters objects are the same for all the simulations. When this object is present the tabular report file will contain the Life-Cycle Cost Report.

Fields
- discounting_convention [string] (Default: EndOfYear)
- inflation_approach [string] (Default: ConstantDollar)
- real_discount_rate [number]
- nominal_discount_rate [number]
- inflation [number]
- base_date_month [string] (Default: January)
- base_date_year [integer]
- service_date_month [string] (Default: January)
- service_date_year [integer]
- length_of_study_period_in_years [integer]
- tax_rate [number]
- depreciation_method [string] (Default: None)

LifeCycleCost:RecurringCosts¶

Recurring costs are costs that repeat over time on a regular schedule during the study period. If costs associated with equipment do repeat but not on a regular schedule, use LifeCycleCost:NonrecurringCost objects instead.

Fields
- category [string] (Default: Maintenance)
- cost [number]
- start_of_costs [string] (Default: ServicePeriod)
- years_from_start [integer]
- months_from_start [integer]
- repeat_period_years [integer] (Default: 1)
- repeat_period_months [integer] (Default: 0)
- annual_escalation_rate [number]

LifeCycleCost:NonrecurringCost¶

A non-recurring cost happens only once during the study period. For costs that occur more than once during the study period on a regular schedule, use the LifeCycleCost:RecurringCost object.

Fields
- category [string] (Default: Construction)
- cost [number]
- start_of_costs [string] (Default: ServicePeriod)
- years_from_start [integer]
- months_from_start [integer]

LifeCycleCost:UsePriceEscalation¶

Life cycle cost escalation factors. The values for this object may be found in the annual supplement to NIST Handbook 135 in Tables Ca-1 to Ca-5 and are included in an EnergyPlus dataset file.

Fields
- lcc_price_escalation_name [string]
- resource [string]
- escalation_start_year [integer]
- escalation_start_month [string] (Default: January)
- escalations [Array of {year_escalation}]

LifeCycleCost:UseAdjustment¶

Used by advanced users to adjust the energy or water use costs for future years. This should not be used for compensating for inflation but should only be used to increase the costs of energy or water based on assumed changes to the actual usage, such as anticipated changes in the future function of the building. The adjustments begin at the start of the service period.

Fields
- resource [string]
- multipliers [Array of {year_multiplier}]

Parametrics¶

Parametric:SetValueForRun¶

Parametric objects allow a set of multiple simulations to be defined in a single idf file. The parametric preprocessor scans the idf for Parametric:* objects then creates and runs multiple idf files, one for each defined simulation. The core parametric object is Parametric:SetValueForRun which defines the name of a parameter and sets the parameter to different values depending on which run is being simulated.

Fields
- values [Array of {value_for_run}]

Parametric:Logic¶

This object allows some types of objects to be included for some parametric cases and not for others. For example, you might want an overhang on a window in some parametric runs and not others. A single Parametric:Logic object is allowed per file. Consult the Input Output Reference for available commands and syntax.

Fields
- lines [Array of {parametric_logic_line}]

Parametric:RunControl¶

Controls which parametric runs are simulated. This object is optional. If it is not included, then all parametric runs are performed.

Fields
- runs [Array of {perform_run}]

Parametric:FileNameSuffix¶

Defines the suffixes to be appended to the idf and output file names for each parametric run. If this object is omitted, the suffix will default to the run number.

Fields
- suffixes [Array of {suffix_for_file_name_in_run}]

Output Reporting¶

Output:VariableDictionary¶

Produces a list summarizing the output variables and meters that are available for reporting for the model being simulated (rdd output file). The list varies depending on the types of objects present in the idf file. For example, variables related to lights will only appear if a Lights object is present. The IDF option generates complete Output:Variable objects to simplify adding the desired output to the idf file.

Fields
- key_field [string] (Default: regular)
- sort_option [string]

Output:Surfaces:List¶

Produces a report summarizing the details of surfaces in the eio output file.

Fields
- report_type [string]
- report_specifications [string]

Output:Surfaces:Drawing¶

Produces reports/files that are capable of rendering graphically or being imported into other programs. Rendering does not alter the actual inputs/surfaces.

Fields
- report_type [string]
- report_specifications_1 [string] (Default: Triangulate3DFace)
- report_specifications_2 [string]

Output:Schedules¶

Produces a condensed reporting that illustrates the full range of schedule values in the eio output file. In the style of input: DaySchedule, WeekSchedule, and Annual Schedule.

Fields
- key_field [string]

Output:Constructions¶

Adds a report to the eio output file which shows details for each construction, including overall properties, a list of material layers, and calculated results related to conduction transfer functions.

Fields
- details_type_1 [string]
- details_type_2 [string]

Output:EnergyManagementSystem¶

This object is used to control the output produced by the Energy Management System

Fields
- actuator_availability_dictionary_reporting [string] (Default: None)
- internal_variable_availability_dictionary_reporting [string] (Default: None)
- ems_runtime_language_debug_output_level [string] (Default: None)

OutputControl:SurfaceColorScheme¶

This object is used to set colors for reporting on various building elements particularly for the DXF reports. We know the user can enter 0 to 255 and the color map is available in DXF output. Therefore, we are limiting the colors in that range. You can extend by editing the IDD but you do so on your own. Colors not changed in any scheme will remain as the default scheme uses.

Fields
- drawing_element_1_type [string]
- color_for_drawing_element_1 [integer]
- drawing_element_2_type [string]
- color_for_drawing_element_2 [integer]
- drawing_element_3_type [string]
- color_for_drawing_element_3 [integer]
- drawing_element_4_type [string]
- color_for_drawing_element_4 [integer]
- drawing_element_5_type [string]
- color_for_drawing_element_5 [integer]
- drawing_element_6_type [string]
- color_for_drawing_element_6 [integer]
- drawing_element_7_type [string]
- color_for_drawing_element_7 [integer]
- drawing_element_8_type [string]
- color_for_drawing_element_8 [integer]
- drawing_element_9_type [string]
- color_for_drawing_element_9 [integer]
- drawing_element_10_type [string]
- color_for_drawing_element_10 [integer]
- drawing_element_11_type [string]
- color_for_drawing_element_11 [integer]
- drawing_element_12_type [string]
- color_for_drawing_element_12 [integer]
- drawing_element_13_type [string]
- color_for_drawing_element_13 [integer]
- drawing_element_14_type [string]
- color_for_drawing_element_14 [integer]
- drawing_element_15_type [string]
- color_for_drawing_element_15 [integer]

Output:Table:SummaryReports¶

This object allows the user to call report types that are predefined and will appear with the other tabular reports. These predefined reports are sensitive to the OutputControl:Table:Style object and appear in the same files as the tabular reports. The entries for this object is a list of the predefined reports that should appear in the tabular report output file.

Fields
- reports [Array of {report_name}]

Output:Table:TimeBins¶

Produces a bin report in the table output file which shows the amount of time in hours that occurs in different bins for a single specific output variable or meter. Two different types of binning are reported: by month and by hour of the day.

Fields
- key_value [string] (Default: *)
- variable_name [string]
- interval_start [number]
- interval_size [number]
- interval_count [integer]
- schedule_name [string]
- variable_type [string]

Output:Table:Monthly¶

Provides a generic method of setting up tables of monthly results. The report has multiple columns that are each defined using a repeated group of fields for any number of columns. A single Output:Table:Monthly object often produces multiple tables in the output. A table is produced for every instance of a particular output variable. For example, a table defined with zone variables will be produced once for every zone.

Fields
- digits_after_decimal [integer] (Default: 2)
- variable_details [Array of {variable_or_meter_name, aggregation_type_for_variable_or_meter}]

Output:Table:Annual¶

Provides a generic method of setting up tables of annual results with one row per object. The report has multiple columns that are each defined using a repeated group of fields for any number of columns. A single Output:Table:Annual produces a single table in the output.

Fields
- filter [string]
- schedule_name [string]
- variable_details [Array of {variable_or_meter_or_ems_variable_or_field_name, aggregation_type_for_variable_or_meter, digits_after_decimal}]

Output:Table:ReportPeriod¶

This object allows the user to generate the resilience tabular reports over a subset of a run period. When it is defined, a series of reporting-period-specific resilience summary tables will be generated at the end of all tabular reports. Multiple reporting periods may be input.

Fields
- name_ [string]
- report_name_ [string]
- begin_year [integer]
- begin_month [integer]
- begin_day_of_month [integer]
- begin_hour_of_day [integer]
- end_year [integer]
- end_month [integer]
- end_day_of_month [integer]
- end_hour_of_day [integer]

OutputControl:Table:Style¶

default style for the OutputControl:Table:Style is comma – this works well for importing into spreadsheet programs such as Excel(tm) but not so well for word processing programs – there tab may be a better choice. fixed puts spaces between the “columns”. HTML produces tables in HTML. XML produces an XML file. note - if no OutputControl:Table:Style is included, the defaults are comma and None.

Fields
- column_separator [string] (Default: Comma)
- unit_conversion [string] (Default: None)

OutputControl:ReportingTolerances¶

Calculations of the time that setpoints are not met use a tolerance of 0.2C. This object allows changing the tolerance used to determine when setpoints are being met.

Fields
- tolerance_for_time_heating_setpoint_not_met [number] (Default: 0.2)
- tolerance_for_time_cooling_setpoint_not_met [number] (Default: 0.2)

Output:Variable¶

each Output:Variable command picks variables to be put onto the standard output file (.eso) some variables may not be reported for every simulation. a list of variables that can be reported are available after a run on the report dictionary file (.rdd) if the Output:VariableDictionary has been requested.

Fields
- key_value [string] (Default: *)
- variable_name [string]
- reporting_frequency [string] (Default: Hourly)
- schedule_name [string]

Output:Meter¶

Each Output:Meter command picks meters to be put onto the standard output file (.eso) and meter file (.mtr). Not all meters are reported in every simulation. A list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Fields
- key_name [string]
- reporting_frequency [string] (Default: Hourly)

Output:Meter:MeterFileOnly¶

Each Output:Meter:MeterFileOnly command picks meters to be put only onto meter file (.mtr). Not all meters are reported in every simulation. A list of meters that can be reported a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Fields
- key_name [string]
- reporting_frequency [string] (Default: Hourly)

Output:Meter:Cumulative¶

Each Output:Meter:Cumulative command picks meters to be reported cumulatively onto the standard output file (.eso) and meter file (.mtr). Not all meters are reported in every simulation. a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Fields
- key_name [string]
- reporting_frequency [string] (Default: Hourly)

Output:Meter:Cumulative:MeterFileOnly¶

Each Output:Meter:Cumulative:MeterFileOnly command picks meters to be reported cumulatively onto the standard output file (.eso) and meter file (.mtr). Not all meters are reported in every simulation. a list of meters that can be reported are available after a run on the meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

Fields
- key_name [string]
- reporting_frequency [string] (Default: Hourly)

Meter:Custom¶

Used to allow users to combine specific variables and/or meters into “custom” meter configurations. To access these meters by name, one must first run a simulation to generate the RDD/MDD files and names. A Meter:Custom cannot reference another Meter:Custom.

Fields
- resource_type [string]
- variable_details [Array of {key_name, output_variable_or_meter_name}]

Meter:CustomDecrement¶

Fields
- resource_type [string]
- source_meter_name [string]
- variable_details [Array of {key_name, output_variable_or_meter_name}]

OutputControl:Files¶

Conditionally turn on/off output from EnergyPlus.

Fields
- output_csv [string] (Default: No)
- output_mtr [string] (Default: Yes)
- output_eso [string] (Default: Yes)
- output_eio [string] (Default: Yes)
- output_tabular [string] (Default: Yes)
- output_sqlite [string] (Default: Yes)
- output_json [string] (Default: Yes)
- output_audit [string] (Default: Yes)
- output_zone_sizing [string] (Default: Yes)
- output_system_sizing [string] (Default: Yes)
- output_dxf [string] (Default: Yes)
- output_bnd [string] (Default: Yes)
- output_rdd [string] (Default: Yes)
- output_mdd [string] (Default: Yes)
- output_mtd [string] (Default: Yes)
- output_end [string] (Default: Yes)
- output_shd [string] (Default: Yes)
- output_dfs [string] (Default: Yes)
- output_glhe [string] (Default: Yes)
- output_delightin [string] (Default: Yes)
- output_delighteldmp [string] (Default: Yes)
- output_delightdfdmp [string] (Default: Yes)
- output_edd [string] (Default: Yes)
- output_dbg [string] (Default: Yes)
- output_perflog [string] (Default: Yes)
- output_sln [string] (Default: Yes)
- output_sci [string] (Default: Yes)
- output_wrl [string] (Default: Yes)
- output_screen [string] (Default: Yes)
- output_extshd [string] (Default: Yes)
- output_tarcog [string] (Default: Yes)

OutputControl:Timestamp¶

Control timestamp format, currently applies only to JSON and native CSV (not CSV via ReadVars)

Fields
- iso_8601_format [string] (Default: No)
- timestamp_at_beginning_of_interval [string] (Default: No)

Output:JSON¶

Output from EnergyPlus can be written to JSON format files.

Fields
- option_type [string]
- output_json [string] (Default: Yes)
- output_cbor [string] (Default: No)
- output_messagepack [string] (Default: No)

Output:SQLite¶

Output from EnergyPlus can be written to an SQLite format file.

Fields
- option_type [string]
- unit_conversion_for_tabular_data [string] (Default: UseOutputControlTableStyle)

Output:EnvironmentalImpactFactors¶

This is used to Automatically report the facility meters and turn on the Environmental Impact Report calculations for all of the Environmental Factors.

Fields
- reporting_frequency [string]

EnvironmentalImpactFactors¶

Used to help convert district and ideal energy use to a fuel type and provide total carbon equivalent with coefficients Also used in Source=>Site conversions.

Fields
- district_heating_efficiency [number] (Default: 0.3)
- district_cooling_cop [number] (Default: 3.0)
- steam_conversion_efficiency [number] (Default: 0.25)
- total_carbon_equivalent_emission_factor_from_n2o [number] (Default: 80.7272)
- total_carbon_equivalent_emission_factor_from_ch4 [number] (Default: 6.2727)
- total_carbon_equivalent_emission_factor_from_co2 [number] (Default: 0.2727)

FuelFactors¶

Provides Fuel Factors for Emissions as well as Source=>Site conversions. OtherFuel1, OtherFuel2 provide options for users who want to create and use fuels that may not be mainstream (biomass, wood, pellets).

Fields
- existing_fuel_resource_name [string]
- source_energy_factor [number]
- source_energy_schedule_name [string]
- co2_emission_factor [number]
- co2_emission_factor_schedule_name [string]
- co_emission_factor [number]
- co_emission_factor_schedule_name [string]
- ch4_emission_factor [number]
- ch4_emission_factor_schedule_name [string]
- nox_emission_factor [number]
- nox_emission_factor_schedule_name [string]
- n2o_emission_factor [number]
- n2o_emission_factor_schedule_name [string]
- so2_emission_factor [number]
- so2_emission_factor_schedule_name [string]
- pm_emission_factor [number]
- pm_emission_factor_schedule_name [string]
- pm10_emission_factor [number]
- pm10_emission_factor_schedule_name [string]
- pm2_5_emission_factor [number]
- pm2_5_emission_factor_schedule_name [string]
- nh3_emission_factor [number]
- nh3_emission_factor_schedule_name [string]
- nmvoc_emission_factor [number]
- nmvoc_emission_factor_schedule_name [string]
- hg_emission_factor [number]
- hg_emission_factor_schedule_name [string]
- pb_emission_factor [number]
- pb_emission_factor_schedule_name [string]
- water_emission_factor [number]
- water_emission_factor_schedule_name [string]
- nuclear_high_level_emission_factor [number]
- nuclear_high_level_emission_factor_schedule_name [string]
- nuclear_low_level_emission_factor [number]
- nuclear_low_level_emission_factor_schedule_name [string]

Output:Diagnostics¶

Special keys to produce certain warning messages or effect certain simulation characteristics.

Fields
- diagnostics [Array of {key}]

Output:DebuggingData¶

switch eplusout.dbg file on or off

Fields
- report_debugging_data [string] (Default: No)
- report_during_warmup [string] (Default: No)

Output:PreprocessorMessage¶

This object does not come from a user input. This is generated by a pre-processor so that various conditions can be gracefully passed on by the InputProcessor.

Fields
- preprocessor_name [string]
- error_severity [string]
- message_line_1 [string]
- message_line_2 [string]
- message_line_3 [string]
- message_line_4 [string]
- message_line_5 [string]
- message_line_6 [string]
- message_line_7 [string]
- message_line_8 [string]
- message_line_9 [string]
- message_line_10 [string]

Python Plugin System¶

PythonPlugin:SearchPaths¶

Add directories to the search path for Python plugin modules The directory containing the EnergyPlus executable file is automatically added so that the Python interpreter can find the packaged up pyenergyplus Python package. By default, the current working directory and input file directory are also added to the search path. However, this object allows modifying this behavior. With this object, searching these directories can be disabled, and users can add supplemental search paths that point to libraries of plugin scripts.

Fields
- add_current_working_directory_to_search_path [string] (Default: Yes)
- add_input_file_directory_to_search_path [string] (Default: Yes)
- add_epin_environment_variable_to_search_path [string] (Default: Yes)
- py_search_paths [Array of {search_path}]

PythonPlugin:Instance¶

A single plugin to be executed during the simulation, which can contain multiple calling points for the same class instance by overriding multiple calling point methods.

Fields
- run_during_warmup_days [string] (Default: No)
- python_module_name [string]
- plugin_class_name [string]

PythonPlugin:Variables¶

This object defines name identifiers for custom Python Plugin variable data that should be shared among all running Python Plugins.

Fields
- global_py_vars [Array of {variable_name}]

PythonPlugin:TrendVariable¶

This object sets up a Python plugin trend variable from an Python plugin variable A trend variable logs values across timesteps

Fields
- name_of_a_python_plugin_variable [string]
- number_of_timesteps_to_be_logged [integer]

PythonPlugin:OutputVariable¶

This object sets up an EnergyPlus output variable from a Python Plugin variable

Fields
- python_plugin_variable_name [string]
- type_of_data_in_variable [string]
- update_frequency [string]
- units [string]
- resource_type [string]
- group_type [string]
- end_use_category [string]
- end_use_subcategory [string]

EnergyPlus epJSON Input Schema¶

Simulation Parameters¶

Version¶

SimulationControl¶

PerformancePrecisionTradeoffs¶

Building¶

ShadowCalculation¶

SurfaceConvectionAlgorithm:Inside¶

SurfaceConvectionAlgorithm:Outside¶

HeatBalanceAlgorithm¶

HeatBalanceSettings:ConductionFiniteDifference¶

ZoneAirHeatBalanceAlgorithm¶

ZoneAirContaminantBalance¶

ZoneAirMassFlowConservation¶

ZoneCapacitanceMultiplier:ResearchSpecial¶

Timestep¶

ConvergenceLimits¶

HVACSystemRootFindingAlgorithm¶

Compliance Objects¶

Compliance:Building¶

Location and Climate¶

Site:Location¶

Site:VariableLocation¶

SizingPeriod:DesignDay¶

SizingPeriod:WeatherFileDays¶

SizingPeriod:WeatherFileConditionType¶

RunPeriod¶

RunPeriodControl:SpecialDays¶

RunPeriodControl:DaylightSavingTime¶

WeatherProperty:SkyTemperature¶

Site:WeatherStation¶

Site:HeightVariation¶

Site:GroundTemperature:BuildingSurface¶

Site:GroundTemperature:FCfactorMethod¶

Site:GroundTemperature:Shallow¶

Site:GroundTemperature:Deep¶

Site:GroundTemperature:Undisturbed:FiniteDifference¶

Site:GroundTemperature:Undisturbed:KusudaAchenbach¶

Site:GroundTemperature:Undisturbed:Xing¶

Site:GroundDomain:Slab¶

Site:GroundDomain:Basement¶

Site:GroundReflectance¶

Site:GroundReflectance:SnowModifier¶

Site:WaterMainsTemperature¶

Site:Precipitation¶

RoofIrrigation¶

Site:SolarAndVisibleSpectrum¶

Site:SpectrumData¶

Schedules¶

ScheduleTypeLimits¶

Schedule:Day:Hourly¶

Schedule:Day:Interval¶

Schedule:Day:List¶

Schedule:Week:Daily¶

Schedule:Week:Compact¶

Schedule:Year¶

Schedule:Compact¶

Schedule:Constant¶

Schedule:File:Shading¶

Schedule:File¶

Surface Construction Elements¶

Material¶

Material:NoMass¶

Material:InfraredTransparent¶

Material:AirGap¶

Material:RoofVegetation¶

WindowMaterial:SimpleGlazingSystem¶

WindowMaterial:Glazing¶

WindowMaterial:GlazingGroup:Thermochromic¶

WindowMaterial:Glazing:RefractionExtinctionMethod¶

WindowMaterial:Gas¶

WindowGap:SupportPillar¶

WindowGap:DeflectionState¶

WindowMaterial:GasMixture¶

WindowMaterial:Gap¶

WindowMaterial:Shade¶

WindowMaterial:ComplexShade¶

WindowMaterial:Blind¶

WindowMaterial:Screen¶

WindowMaterial:Shade:EquivalentLayer¶