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. Icon Legend: * πŸ… This field, or object, is a required input * Ⓝ Numeric Field (Floating point usually) * β’Ύ Integer Value * β“ˆ String Input * Ⓧ Array Field, which will contain an extensible amount of groups of fields * ⒢Ⓝ Auto-sizable, or Auto-calculable, floating point input field * β’Άβ’Ύ Auto-sizable, or Auto-calculable, integer value .. raw:: html .. rst-class:: special Version ======= Specifies the EnergyPlus version of the IDF file. * :abbr:`β“ˆ (String)` `version_identifier` (Current Version) .. rst-class:: special 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. * :abbr:`β“ˆ (String)` `do_zone_sizing_calculation` (Default: No) * :abbr:`β“ˆ (String)` `do_system_sizing_calculation` (Default: No) * :abbr:`β“ˆ (String)` `do_plant_sizing_calculation` (Default: No) * :abbr:`β“ˆ (String)` `run_simulation_for_sizing_periods` (Default: Yes) * :abbr:`β“ˆ (String)` `run_simulation_for_weather_file_run_periods` (Default: Yes) * :abbr:`β“ˆ (String)` `do_hvac_sizing_simulation_for_sizing_periods` (Default: No) * :abbr:`β’Ύ (Integer)` `maximum_number_of_hvac_sizing_simulation_passes` (Default: 1) .. rst-class:: special PerformancePrecisionTradeoffs ============================= This object enables users to choose certain options that speed up EnergyPlus simulation, but may lead to small decreases in accuracy of results. * :abbr:`β“ˆ (String)` `use_coil_direct_solutions` (Default: No) * :abbr:`β“ˆ (String)` `zone_radiant_exchange_algorithm` (Default: ScriptF) * :abbr:`β“ˆ (String)` `override_mode` (Default: Normal) * :abbr:`Ⓝ (Numeric)` `maxzonetempdiff` (Default: 0.3) * :abbr:`Ⓝ (Numeric)` `maxalloweddeltemp` (Default: 0.002) * :abbr:`β“ˆ (String)` `use_representative_surfaces_for_calculations` (Default: No) .. rst-class:: special :abbr:`πŸ… (Required Object)` 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. * :abbr:`Ⓝ (Numeric)` `north_axis` (Default: 0.0) * :abbr:`β“ˆ (String)` `terrain` (Default: Suburbs) * :abbr:`Ⓝ (Numeric)` `loads_convergence_tolerance_value` (Default: 0.04) * :abbr:`Ⓝ (Numeric)` `temperature_convergence_tolerance_value` (Default: 0.4) * :abbr:`β“ˆ (String)` `solar_distribution` (Default: FullExterior) * :abbr:`β’Ύ (Integer)` `maximum_number_of_warmup_days` (Default: 25) * :abbr:`β’Ύ (Integer)` `minimum_number_of_warmup_days` (Default: 1) .. rst-class:: special ShadowCalculation ================= This object is used to control details of the solar, shading, and daylighting models * :abbr:`β“ˆ (String)` `shading_calculation_method` (Default: PolygonClipping) * :abbr:`β“ˆ (String)` `shading_calculation_update_frequency_method` (Default: Periodic) * :abbr:`β’Ύ (Integer)` `shading_calculation_update_frequency` (Default: 20) * :abbr:`β’Ύ (Integer)` `maximum_figures_in_shadow_overlap_calculations` (Default: 15000) * :abbr:`β“ˆ (String)` `polygon_clipping_algorithm` (Default: SutherlandHodgman) * :abbr:`β’Ύ (Integer)` `pixel_counting_resolution` (Default: 512) * :abbr:`β“ˆ (String)` `sky_diffuse_modeling_algorithm` (Default: SimpleSkyDiffuseModeling) * :abbr:`β“ˆ (String)` `output_external_shading_calculation_results` (Default: No) * :abbr:`β“ˆ (String)` `disable_self_shading_within_shading_zone_groups` (Default: No) * :abbr:`β“ˆ (String)` `disable_self_shading_from_shading_zone_groups_to_other_zones` (Default: No) * Array of {:abbr:`β“ˆ (String)` shading_zone_group_zonelist_name} `shading_zone_groups` .. rst-class:: special SurfaceConvectionAlgorithm:Inside ================================= Default indoor surface heat transfer convection algorithm to be used for all zones * :abbr:`β“ˆ (String)` `algorithm` (Default: TARP) .. rst-class:: special SurfaceConvectionAlgorithm:Outside ================================== Default outside surface heat transfer convection algorithm to be used for all zones * :abbr:`β“ˆ (String)` `algorithm` (Default: DOE-2) .. rst-class:: special 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) * :abbr:`β“ˆ (String)` `algorithm` (Default: ConductionTransferFunction) * :abbr:`Ⓝ (Numeric)` `surface_temperature_upper_limit` (Default: 200.0) * :abbr:`Ⓝ (Numeric)` `minimum_surface_convection_heat_transfer_coefficient_value` (Default: 0.1) * :abbr:`Ⓝ (Numeric)` `maximum_surface_convection_heat_transfer_coefficient_value` (Default: 1000.0) .. rst-class:: special HeatBalanceSettings:ConductionFiniteDifference ============================================== Determines settings for the Conduction Finite Difference algorithm for surface heat transfer modeling. * :abbr:`β“ˆ (String)` `difference_scheme` (Default: FullyImplicitFirstOrder) * :abbr:`Ⓝ (Numeric)` `space_discretization_constant` (Default: 3.0) * :abbr:`Ⓝ (Numeric)` `relaxation_factor` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `inside_face_surface_temperature_convergence_criteria` (Default: 0.002) .. rst-class:: special ZoneAirHeatBalanceAlgorithm =========================== Controls the zone/space air heat balance. * :abbr:`β“ˆ (String)` `algorithm` (Default: ThirdOrderBackwardDifference) * :abbr:`β“ˆ (String)` `do_space_heat_balance_for_sizing` (Default: No) * :abbr:`β“ˆ (String)` `do_space_heat_balance_for_simulation` (Default: No) .. rst-class:: special ZoneAirContaminantBalance ========================= Determines which contaminant concentration will be simulates. * :abbr:`β“ˆ (String)` `carbon_dioxide_concentration` (Default: No) * :abbr:`β“ˆ (String)` `outdoor_carbon_dioxide_schedule_name` * :abbr:`β“ˆ (String)` `generic_contaminant_concentration` (Default: No) * :abbr:`β“ˆ (String)` `outdoor_generic_contaminant_schedule_name` .. rst-class:: special 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. * :abbr:`β“ˆ (String)` `adjust_zone_mixing_and_return_for_air_mass_flow_balance` (Default: None) * :abbr:`β“ˆ (String)` `infiltration_balancing_method` (Default: AddInfiltrationFlow) * :abbr:`β“ˆ (String)` `infiltration_balancing_zones` (Default: MixingSourceZonesOnly) .. rst-class:: special ZoneCapacitanceMultiplier:ResearchSpecial ========================================= Multiplier altering the relative capacitance of the air compared to an empty zone * :abbr:`β“ˆ (String)` `zone_or_zonelist_name` * :abbr:`Ⓝ (Numeric)` `temperature_capacity_multiplier` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `humidity_capacity_multiplier` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `carbon_dioxide_capacity_multiplier` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `generic_contaminant_capacity_multiplier` (Default: 1.0) .. rst-class:: special 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. * :abbr:`β’Ύ (Integer)` `number_of_timesteps_per_hour` (Default: 6) .. rst-class:: special ConvergenceLimits ================= Specifies limits on HVAC system simulation timesteps and iterations. This item is an advanced feature that should be used only with caution. * :abbr:`β’Ύ (Integer)` `minimum_system_timestep` * :abbr:`β’Ύ (Integer)` `maximum_hvac_iterations` (Default: 20) * :abbr:`β’Ύ (Integer)` `minimum_plant_iterations` (Default: 2) * :abbr:`β’Ύ (Integer)` `maximum_plant_iterations` (Default: 8) .. rst-class:: special HVACSystemRootFindingAlgorithm ============================== Specifies a HVAC system solver algorithm to find a root * :abbr:`β“ˆ (String)` `algorithm` (Default: RegulaFalsi) * :abbr:`β’Ύ (Integer)` `number_of_iterations_before_algorithm_switch` (Default: 5) .. rst-class:: special Compliance:Building =================== Building level inputs related to compliance to building standards, building codes, and beyond energy code programs. * :abbr:`Ⓝ (Numeric)` `building_rotation_for_appendix_g` (Default: 0.0) .. rst-class:: special Site:Location ============= Specifies the building's location. Only one location is allowed. Weather data file location, if it exists, will override this object. * :abbr:`Ⓝ (Numeric)` `latitude` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `longitude` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `time_zone` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `elevation` (Default: 0.0) * :abbr:`β“ˆ (String)` `keep_site_location_information` (Default: No) .. rst-class:: special Site:VariableLocation ===================== Captures the scheduling of a moving/reorienting building, or more likely a vessel * :abbr:`β“ˆ (String)` `building_location_latitude_schedule` * :abbr:`β“ˆ (String)` `building_location_longitude_schedule` * :abbr:`β“ˆ (String)` `building_location_orientation_schedule` .. rst-class:: special 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. * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `month` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `day_of_month` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `day_type` * :abbr:`Ⓝ (Numeric)` `maximum_dry_bulb_temperature` * :abbr:`Ⓝ (Numeric)` `daily_dry_bulb_temperature_range` (Default: 0.0) * :abbr:`β“ˆ (String)` `dry_bulb_temperature_range_modifier_type` (Default: DefaultMultipliers) * :abbr:`β“ˆ (String)` `dry_bulb_temperature_range_modifier_day_schedule_name` * :abbr:`β“ˆ (String)` `humidity_condition_type` (Default: WetBulb) * :abbr:`Ⓝ (Numeric)` `wetbulb_or_dewpoint_at_maximum_dry_bulb` * :abbr:`β“ˆ (String)` `humidity_condition_day_schedule_name` * :abbr:`Ⓝ (Numeric)` `humidity_ratio_at_maximum_dry_bulb` * :abbr:`Ⓝ (Numeric)` `enthalpy_at_maximum_dry_bulb` * :abbr:`Ⓝ (Numeric)` `daily_wet_bulb_temperature_range` * :abbr:`Ⓝ (Numeric)` `barometric_pressure` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `wind_speed` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `wind_direction` * :abbr:`β“ˆ (String)` `rain_indicator` (Default: No) * :abbr:`β“ˆ (String)` `snow_indicator` (Default: No) * :abbr:`β“ˆ (String)` `daylight_saving_time_indicator` (Default: No) * :abbr:`β“ˆ (String)` `solar_model_indicator` (Default: ASHRAEClearSky) * :abbr:`β“ˆ (String)` `beam_solar_day_schedule_name` * :abbr:`β“ˆ (String)` `diffuse_solar_day_schedule_name` * :abbr:`Ⓝ (Numeric)` `ashrae_clear_sky_optical_depth_for_beam_irradiance_taub_` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `ashrae_clear_sky_optical_depth_for_diffuse_irradiance_taud_` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `sky_clearness` (Default: 0.0) * :abbr:`β’Ύ (Integer)` `maximum_number_warmup_days` * :abbr:`β“ˆ (String)` `begin_environment_reset_mode` (Default: FullResetAtBeginEnvironment) .. rst-class:: special SizingPeriod:WeatherFileDays ============================ Use a weather file period for design sizing calculations. * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `begin_month` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `begin_day_of_month` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `end_month` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `end_day_of_month` * :abbr:`β“ˆ (String)` `day_of_week_for_start_day` (Default: Monday) * :abbr:`β“ˆ (String)` `use_weather_file_daylight_saving_period` (Default: Yes) * :abbr:`β“ˆ (String)` `use_weather_file_rain_and_snow_indicators` (Default: Yes) .. rst-class:: special 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. * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `period_selection` * :abbr:`β“ˆ (String)` `day_of_week_for_start_day` (Default: Monday) * :abbr:`β“ˆ (String)` `use_weather_file_daylight_saving_period` (Default: Yes) * :abbr:`β“ˆ (String)` `use_weather_file_rain_and_snow_indicators` (Default: Yes) .. rst-class:: special RunPeriod ========= Specify a range of dates and other parameters for a simulation. Multiple run periods may be input, but they may not overlap. * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `begin_month` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `begin_day_of_month` * :abbr:`Ⓝ (Numeric)` `begin_year` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `end_month` * :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` `end_day_of_month` * :abbr:`Ⓝ (Numeric)` `end_year` * :abbr:`β“ˆ (String)` `day_of_week_for_start_day` * :abbr:`β“ˆ (String)` `use_weather_file_holidays_and_special_days` (Default: Yes) * :abbr:`β“ˆ (String)` `use_weather_file_daylight_saving_period` (Default: Yes) * :abbr:`β“ˆ (String)` `apply_weekend_holiday_rule` (Default: No) * :abbr:`β“ˆ (String)` `use_weather_file_rain_indicators` (Default: Yes) * :abbr:`β“ˆ (String)` `use_weather_file_snow_indicators` (Default: Yes) * :abbr:`β“ˆ (String)` `treat_weather_as_actual` (Default: No) * :abbr:`β“ˆ (String)` `first_hour_interpolation_starting_values` (Default: Hour24) .. rst-class:: special 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). * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `start_date` * :abbr:`Ⓝ (Numeric)` `duration` (Default: 1.0) * :abbr:`β“ˆ (String)` `special_day_type` (Default: Holiday) .. rst-class:: special 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. * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `start_date` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `end_date` .. rst-class:: special WeatherProperty:SkyTemperature ============================== This object is used to override internal sky temperature calculations. * :abbr:`β“ˆ (String)` `calculation_type` (Default: ClarkAllen) * :abbr:`β“ˆ (String)` `schedule_name` * :abbr:`β“ˆ (String)` `use_weather_file_horizontal_ir` (Default: Yes) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `wind_sensor_height_above_ground` (Default: 10.0) * :abbr:`Ⓝ (Numeric)` `wind_speed_profile_exponent` (Default: 0.14) * :abbr:`Ⓝ (Numeric)` `wind_speed_profile_boundary_layer_thickness` (Default: 270.0) * :abbr:`Ⓝ (Numeric)` `air_temperature_sensor_height_above_ground` (Default: 1.5) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `wind_speed_profile_exponent` (Default: 0.22) * :abbr:`Ⓝ (Numeric)` `wind_speed_profile_boundary_layer_thickness` (Default: 370.0) * :abbr:`Ⓝ (Numeric)` `air_temperature_gradient_coefficient` (Default: 0.0065) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `january_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `february_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `march_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `april_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `may_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `june_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `july_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `august_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `september_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `october_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `november_ground_temperature` (Default: 18.0) * :abbr:`Ⓝ (Numeric)` `december_ground_temperature` (Default: 18.0) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `january_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `february_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `march_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `april_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `may_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `june_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `july_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `august_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `september_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `october_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `november_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `december_ground_temperature` (Default: 13.0) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `january_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `february_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `march_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `april_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `may_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `june_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `july_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `august_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `september_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `october_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `november_surface_ground_temperature` (Default: 13.0) * :abbr:`Ⓝ (Numeric)` `december_surface_ground_temperature` (Default: 13.0) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `january_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `february_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `march_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `april_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `may_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `june_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `july_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `august_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `september_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `october_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `november_deep_ground_temperature` (Default: 16.0) * :abbr:`Ⓝ (Numeric)` `december_deep_ground_temperature` (Default: 16.0) .. rst-class:: special Site:GroundTemperature:Undisturbed:FiniteDifference =================================================== Undisturbed ground temperature object using a detailed finite difference 1-D model * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_thermal_conductivity` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_density` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_specific_heat` * :abbr:`Ⓝ (Numeric)` `soil_moisture_content_volume_fraction` (Default: 30.0) * :abbr:`Ⓝ (Numeric)` `soil_moisture_content_volume_fraction_at_saturation` (Default: 50.0) * :abbr:`Ⓝ (Numeric)` `evapotranspiration_ground_cover_parameter` (Default: 0.4) .. rst-class:: special Site:GroundTemperature:Undisturbed:KusudaAchenbach ================================================== Undisturbed ground temperature object using the Kusuda-Achenbach 1965 correlation. * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_thermal_conductivity` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_density` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_specific_heat` * :abbr:`Ⓝ (Numeric)` `average_soil_surface_temperature` * :abbr:`Ⓝ (Numeric)` `average_amplitude_of_surface_temperature` * :abbr:`Ⓝ (Numeric)` `phase_shift_of_minimum_surface_temperature` .. rst-class:: special Site:GroundTemperature:Undisturbed:Xing ======================================= Undisturbed ground temperature object using the Xing 2014 2 harmonic parameter model. * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_thermal_conductivity` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_density` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_specific_heat` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `average_soil_surface_temperature` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_surface_temperature_amplitude_1` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `soil_surface_temperature_amplitude_2` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `phase_shift_of_temperature_amplitude_1` * :abbr:`πŸ… (Required Field)` :abbr:`Ⓝ (Numeric)` `phase_shift_of_temperature_amplitude_2` .. rst-class:: special Site:GroundDomain:Slab ====================== Ground-coupled slab model for on-grade and in-grade cases with or without insulation. * :abbr:`Ⓝ (Numeric)` `ground_domain_depth` (Default: 10.0) * :abbr:`Ⓝ (Numeric)` `aspect_ratio` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `perimeter_offset` (Default: 5.0) * :abbr:`Ⓝ (Numeric)` `soil_thermal_conductivity` (Default: 1.5) * :abbr:`Ⓝ (Numeric)` `soil_density` (Default: 2800.0) * :abbr:`Ⓝ (Numeric)` `soil_specific_heat` (Default: 850.0) * :abbr:`Ⓝ (Numeric)` `soil_moisture_content_volume_fraction` (Default: 30.0) * :abbr:`Ⓝ (Numeric)` `soil_moisture_content_volume_fraction_at_saturation` (Default: 50.0) * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `undisturbed_ground_temperature_model_type` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `undisturbed_ground_temperature_model_name` * :abbr:`Ⓝ (Numeric)` `evapotranspiration_ground_cover_parameter` (Default: 0.4) * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `slab_boundary_condition_model_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `slab_location` * :abbr:`β“ˆ (String)` `slab_material_name` * :abbr:`β“ˆ (String)` `horizontal_insulation` (Default: No) * :abbr:`β“ˆ (String)` `horizontal_insulation_material_name` * :abbr:`β“ˆ (String)` `horizontal_insulation_extents` (Default: Full) * :abbr:`Ⓝ (Numeric)` `perimeter_insulation_width` * :abbr:`β“ˆ (String)` `vertical_insulation` (Default: No) * :abbr:`β“ˆ (String)` `vertical_insulation_material_name` * :abbr:`Ⓝ (Numeric)` `vertical_insulation_depth` * :abbr:`β“ˆ (String)` `simulation_timestep` (Default: Hourly) * :abbr:`Ⓝ (Numeric)` `geometric_mesh_coefficient` (Default: 1.6) * :abbr:`β’Ύ (Integer)` `mesh_density_parameter` (Default: 6) .. rst-class:: special Site:GroundDomain:Basement ========================== Ground-coupled basement model for simulating basements or other underground zones. * :abbr:`Ⓝ (Numeric)` `ground_domain_depth` (Default: 10.0) * :abbr:`Ⓝ (Numeric)` `aspect_ratio` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `perimeter_offset` (Default: 5.0) * :abbr:`Ⓝ (Numeric)` `soil_thermal_conductivity` (Default: 1.5) * :abbr:`Ⓝ (Numeric)` `soil_density` (Default: 2800.0) * :abbr:`Ⓝ (Numeric)` `soil_specific_heat` (Default: 850.0) * :abbr:`Ⓝ (Numeric)` `soil_moisture_content_volume_fraction` (Default: 30.0) * :abbr:`Ⓝ (Numeric)` `soil_moisture_content_volume_fraction_at_saturation` (Default: 50.0) * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `undisturbed_ground_temperature_model_type` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `undisturbed_ground_temperature_model_name` * :abbr:`Ⓝ (Numeric)` `evapotranspiration_ground_cover_parameter` (Default: 0.4) * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `basement_floor_boundary_condition_model_name` * :abbr:`β“ˆ (String)` `horizontal_insulation` (Default: No) * :abbr:`β“ˆ (String)` `horizontal_insulation_material_name` * :abbr:`β“ˆ (String)` `horizontal_insulation_extents` (Default: Full) * :abbr:`Ⓝ (Numeric)` `perimeter_horizontal_insulation_width` * :abbr:`Ⓝ (Numeric)` `basement_wall_depth` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `basement_wall_boundary_condition_model_name` * :abbr:`β“ˆ (String)` `vertical_insulation` (Default: No) * :abbr:`β“ˆ (String)` `basement_wall_vertical_insulation_material_name` * :abbr:`Ⓝ (Numeric)` `vertical_insulation_depth` * :abbr:`β“ˆ (String)` `simulation_timestep` (Default: Hourly) * :abbr:`β’Ύ (Integer)` `mesh_density_parameter` (Default: 4) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `january_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `february_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `march_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `april_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `may_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `june_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `july_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `august_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `september_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `october_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `november_ground_reflectance` (Default: 0.2) * :abbr:`Ⓝ (Numeric)` `december_ground_reflectance` (Default: 0.2) .. rst-class:: special 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. * :abbr:`Ⓝ (Numeric)` `ground_reflected_solar_modifier` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `daylighting_ground_reflected_solar_modifier` (Default: 1.0) .. rst-class:: special 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. * :abbr:`β“ˆ (String)` `calculation_method` (Default: CorrelationFromWeatherFile) * :abbr:`β“ˆ (String)` `temperature_schedule_name` * :abbr:`Ⓝ (Numeric)` `annual_average_outdoor_air_temperature` * :abbr:`Ⓝ (Numeric)` `maximum_difference_in_monthly_average_outdoor_air_temperatures` * :abbr:`Ⓝ (Numeric)` `temperature_multiplier` (Default: 1.0) * :abbr:`Ⓝ (Numeric)` `temperature_offset` (Default: 0.0) .. rst-class:: special 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. * :abbr:`β“ˆ (String)` `precipitation_model_type` * :abbr:`Ⓝ (Numeric)` `design_level_for_total_annual_precipitation` * :abbr:`β“ˆ (String)` `precipitation_rates_schedule_name` * :abbr:`Ⓝ (Numeric)` `average_total_annual_precipitation` .. rst-class:: special RoofIrrigation ============== Used to describe the amount of irrigation on the ecoroof surface over the course of the simulation runperiod. * :abbr:`β“ˆ (String)` `irrigation_model_type` * :abbr:`β“ˆ (String)` `irrigation_rate_schedule_name` * :abbr:`Ⓝ (Numeric)` `irrigation_maximum_saturation_threshold` (Default: 40.0) .. rst-class:: special Site:SolarAndVisibleSpectrum ============================ If this object is omitted, the default solar and visible spectrum data will be used. * :abbr:`β“ˆ (String)` `spectrum_data_method` (Default: Default) * :abbr:`β“ˆ (String)` `solar_spectrum_data_object_name` * :abbr:`β“ˆ (String)` `visible_spectrum_data_object_name` .. rst-class:: special 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) * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `spectrum_data_type` * :abbr:`Ⓝ (Numeric)` `wavelength` * :abbr:`Ⓝ (Numeric)` `spectrum` * :abbr:`Ⓝ (Numeric)` `wavelength_1` * :abbr:`Ⓝ (Numeric)` `spectrum_2` * Array of {:abbr:`Ⓝ (Numeric)` wavelength, :abbr:`Ⓝ (Numeric)` spectrum} `extensions` .. rst-class:: special ScheduleTypeLimits ================== ScheduleTypeLimits specifies the data types and limits for the values contained in schedules * :abbr:`Ⓝ (Numeric)` `lower_limit_value` * :abbr:`Ⓝ (Numeric)` `upper_limit_value` * :abbr:`β“ˆ (String)` `numeric_type` * :abbr:`β“ˆ (String)` `unit_type` (Default: Dimensionless) .. rst-class:: special Schedule:Day:Hourly =================== A Schedule:Day:Hourly contains 24 values for each hour of the day. * :abbr:`β“ˆ (String)` `schedule_type_limits_name` * :abbr:`Ⓝ (Numeric)` `hour_1` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_2` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_3` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_4` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_5` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_6` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_7` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_8` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_9` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_10` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_11` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_12` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_13` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_14` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_15` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_16` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_17` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_18` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_19` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_20` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_21` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_22` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_23` (Default: 0.0) * :abbr:`Ⓝ (Numeric)` `hour_24` (Default: 0.0) .. rst-class:: special 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. * :abbr:`β“ˆ (String)` `schedule_type_limits_name` * :abbr:`β“ˆ (String)` `interpolate_to_timestep` (Default: No) * Array of {:abbr:`β“ˆ (String)` time, :abbr:`Ⓝ (Numeric)` value_until_time} `data` .. rst-class:: special Schedule:Day:List ================= Schedule:Day:List will allow the user to list 24 hours worth of values, which can be sub-hourly in nature. * :abbr:`β“ˆ (String)` `schedule_type_limits_name` * :abbr:`β“ˆ (String)` `interpolate_to_timestep` (Default: No) * :abbr:`β’Ύ (Integer)` `minutes_per_item` * Array of {:abbr:`Ⓝ (Numeric)` value} `extensions` .. rst-class:: special Schedule:Week:Daily =================== A Schedule:Week:Daily contains 12 Schedule:Day:Hourly objects, one for each day type. * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `sunday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `monday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `tuesday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `wednesday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `thursday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `friday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `saturday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `holiday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `summerdesignday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `winterdesignday_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `customday1_schedule_day_name` * :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` `customday2_schedule_day_name` .. rst-class:: special Schedule:Week:Compact ===================== Compact definition for Schedule:Day:List * Array of {:abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` daytype_list, :abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` schedule_day_name} `data` .. rst-class:: special Schedule:Year ============= A Schedule:Year contains from 1 to 52 week schedules * :abbr:`β“ˆ (String)` `schedule_type_limits_name` * Array of {:abbr:`πŸ… (Required Field)` :abbr:`β“ˆ (String)` schedule_week_name, :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` start_month, :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` start_day, :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` end_month, :abbr:`πŸ… (Required Field)` :abbr:`β’Ύ (Integer)` end_day} `schedule_weeks` .. rst-class:: special 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: