recordRunPeriod

Record for EnergyPlus RunPeriod

Extends from Modelica.Icons.Record (Icon for records).

Information

Record containing the configuration of the EnergyPlus RunPeriod object.

The parameter startDayOfYear is the day of the week for January 1, regardless of the actual start time of the simulation. For example, if startDayOfYear = Sunday, and the Modelica model is simulated starting at t = 1 day, then the first simulated day is a Monday.

Please note the following points:

  • If startDayOfYear = Sunday, and the Modelica model is simulated starting at t = 1 year, e.g, at t = 365 days, then the first simulated day is a Saturday because 52*7=364, and therefore simulating 365 days shifts the days of the weeks by one.
  • The Modelica parameter startDayOfYear differs from how EnergyPlus, if run natively, processes the idf entry for Day of Week for Start Day.
  • The simulation start and stop time is controlled by Modelica, and therefore all entries in the EnergyPlus input data file for the RunPeriod object are ignored.
  • There is no support for leap years, each year has 365 days, also in multi-year simulations.

Parameters

TypeNameDefaultDescription
Buildings.ThermalZones.EnergyPlus_24_2_0.Types.WeekDaysstartDayOfYearBuildings.ThermalZones.EnergyPlus_24_2_0.Types.WeekDays.SundayWeek day of the first day that is simulated
BooleanapplyWeekEndHolidayRulefalseSet to true to apply week-end holiday rules
Booleanuse_weatherFileDaylightSavingPeriodfalseSet to true to apply the daylight saving period from the weather data file if present
Booleanuse_weatherFileHolidaysAndSpecialDaysfalseSet to true to apply holidays and special days from the weather data file if present
Booleanuse_weatherFileRainIndicatorstrueSet to true to use rain indicators from the weather file
Booleanuse_weatherFileSnowIndicatorstrueSet to true to use rain indicators from the weather file

Revisions

  • September 3, 2024, by Michael Wetter:
    First implementation.
    This is for #2926.