OutputProcessor Module

module~~outputprocessor~~UsesGraph module~outputprocessor OutputProcessor module~dataglobals DataGlobals module~dataglobals->module~outputprocessor module~dataenvironment DataEnvironment module~dataglobals->module~dataenvironment module~dataenvironment->module~outputprocessor module~dataglobalconstants DataGlobalConstants module~dataglobalconstants->module~outputprocessor module~datainterfaces DataInterfaces module~datainterfaces->module~outputprocessor module~dataprecisionglobals DataPrecisionGlobals module~dataprecisionglobals->module~outputprocessor module~dataprecisionglobals->module~dataglobals module~dataprecisionglobals->module~dataenvironment module~dataprecisionglobals->module~datainterfaces
Help

PUBLIC SetReportNow

Used By

module~~outputprocessor~~UsedByGraph module~outputprocessor OutputProcessor proc~writesourceenergyendusesummary WriteSourceEnergyEndUseSummary module~outputprocessor->proc~writesourceenergyendusesummary proc~initpollutionmeterreporting InitPollutionMeterReporting module~outputprocessor->proc~initpollutionmeterreporting proc~producerddmdd ProduceRDDMDD module~outputprocessor->proc~producerddmdd proc~manageems ManageEMS module~outputprocessor->proc~manageems proc~getinputeconomicstariff GetInputEconomicsTariff module~outputprocessor->proc~getinputeconomicstariff proc~getinputtabularpredefined GetInputTabularPredefined module~outputprocessor->proc~getinputtabularpredefined proc~getruntimelanguageuserinput GetRuntimeLanguageUserInput module~outputprocessor->proc~getruntimelanguageuserinput proc~getnummeteredvariables GetNumMeteredVariables module~outputprocessor->proc~getnummeteredvariables proc~incrementinstmetercache IncrementInstMeterCache module~outputprocessor->proc~incrementinstmetercache proc~getmeteredvariables GetMeteredVariables module~outputprocessor->proc~getmeteredvariables proc~getinternalvariablevalueexternalinterface GetInternalVariableValueExternalInterface module~outputprocessor->proc~getinternalvariablevalueexternalinterface proc~reportoutputfileheaders ReportOutputFileHeaders module~outputprocessor->proc~reportoutputfileheaders proc~setuprealoutputvariable SetupRealOutputVariable module~outputprocessor->proc~setuprealoutputvariable proc~managesimulation ManageSimulation module~outputprocessor->proc~managesimulation proc~getvariablekeycountandtype GetVariableKeyCountandType module~outputprocessor->proc~getvariablekeycountandtype proc~reportingthisvariable ReportingThisVariable module~outputprocessor->proc~reportingthisvariable proc~updatemeterreporting UpdateMeterReporting module~outputprocessor->proc~updatemeterreporting proc~closeoutputfiles CloseOutputFiles module~outputprocessor->proc~closeoutputfiles proc~setinitialmeterreportingandoutputnames SetInitialMeterReportingAndOutputNames module~outputprocessor->proc~setinitialmeterreportingandoutputnames proc~setupintegeroutputvariable SetupIntegerOutputVariable module~outputprocessor->proc~setupintegeroutputvariable proc~getdemandmanagerlistinput GetDemandManagerListInput module~outputprocessor->proc~getdemandmanagerlistinput proc~selecttariff selectTariff module~outputprocessor->proc~selecttariff proc~gatherbepsresultsfortimestep GatherBEPSResultsForTimestep module~outputprocessor->proc~gatherbepsresultsfortimestep proc~updatedataandreport UpdateDataandReport module~outputprocessor->proc~updatedataandreport proc~getvariablekeys GetVariableKeys module~outputprocessor->proc~getvariablekeys proc~genoutputvariablesauditreport GenOutputVariablesAuditReport module~outputprocessor->proc~genoutputvariablesauditreport proc~writebepstable WriteBEPSTable module~outputprocessor->proc~writebepstable proc~addtooutputvariablelist AddToOutputVariableList module~outputprocessor->proc~addtooutputvariablelist proc~gathersourceenergyenduseresultsfortimestep GatherSourceEnergyEndUseResultsForTimestep module~outputprocessor->proc~gathersourceenergyenduseresultsfortimestep proc~gatherpeakdemandfortimestep GatherPeakDemandForTimestep module~outputprocessor->proc~gatherpeakdemandfortimestep proc~writedemandendusesummary WriteDemandEndUseSummary module~outputprocessor->proc~writedemandendusesummary proc~getmeterindex GetMeterIndex module~outputprocessor->proc~getmeterindex proc~getmeterresourcetype GetMeterResourceType module~outputprocessor->proc~getmeterresourcetype proc~getinternalvariablevalue GetInternalVariableValue module~outputprocessor->proc~getinternalvariablevalue proc~beginenvrninitializeruntimelanguage BeginEnvrnInitializeRuntimeLanguage module~outputprocessor->proc~beginenvrninitializeruntimelanguage proc~getcurrentmetervalue GetCurrentMeterValue module~outputprocessor->proc~getcurrentmetervalue proc~calcmorenodeinfo CalcMoreNodeInfo module~outputprocessor->proc~calcmorenodeinfo proc~getinstantmetervalue GetInstantMeterValue module~outputprocessor->proc~getinstantmetervalue
Help

ReportEach ReportTimeStep ReportHourly ReportDaily ReportMonthly ReportSim ReportVDD_No ReportVDD_Yes ReportVDD_IDF MinSetValue MaxSetValue IMinSetValue IMaxSetValue ZoneVar HVACVar AveragedVar SummedVar VarType_NotFound VarType_Integer VarType_Real VarType_Meter VarType_Schedule MeterType_Normal MeterType_Custom MeterType_CustomDec MeterType_CustomDiff TimeStampFormat DailyStampFormat MonthlyStampFormat RunPeriodStampFormat fmta DayTypes BlankString UnitsStringLength RVarAllocInc LVarAllocInc IVarAllocInc RT_IPUnits_Electricity RT_IPUnits_Gas RT_IPUnits_Cooling RT_IPUnits_Water RT_IPUnits_OtherKG RT_IPUnits_OtherM3 RT_IPUnits_OtherL RT_IPUnits_OtherJ InstMeterCacheSize InstMeterCacheSizeInc InstMeterCache InstMeterCacheCopy InstMeterCacheLastUsed TimeValue RVariableTypes IVariableTypes DDVariableTypes CurrentReportNumber NumVariablesForOutput MaxVariablesForOutput NumOfRVariable_Setup NumTotalRVariable NumOfRVariable_Sum NumOfRVariable_Meter NumOfRVariable MaxRVariable NumOfIVariable_Setup NumTotalIVariable NumOfIVariable_Sum NumOfIVariable MaxIVariable OutputInitialized ProduceReportVDD OutputFileRVDD OutputFileMVDD OutputFileMeterDetails NumHoursinDay NumHoursinMonth NumHoursinSim ReportList NumReportList NumExtraVars RVariable IVariable RVar IVar FreqNotice ReqRepVars NumOfReqVariables VarMeterArrays NumVarMeterArrays EnergyMeters NumEnergyMeters MeterValue TimeStepStampReportNbr TimeStepStampReportChr TrackingHourlyVariables DailyStampReportNbr DailyStampReportChr TrackingDailyVariables MonthlyStampReportNbr MonthlyStampReportChr TrackingMonthlyVariables RunPeriodStampReportNbr RunPeriodStampReportChr TrackingRunPeriodVariables SecondsPerTimeStep ErrorsLogged ProduceVariableDictionary EndUseCategory MaxNumSubcategories

Variables

TypeVisibility AttributesNameInitial
integer, public, parameter:: ReportEach =-1
integer, public, parameter:: ReportTimeStep =0
integer, public, parameter:: ReportHourly =1
integer, public, parameter:: ReportDaily =2
integer, public, parameter:: ReportMonthly =3
integer, public, parameter:: ReportSim =4
integer, public, parameter:: ReportVDD_No =0
integer, public, parameter:: ReportVDD_Yes =1
integer, public, parameter:: ReportVDD_IDF =2
real(kind=r64), public, parameter:: MinSetValue =99999999999999.d0
real(kind=r64), public, parameter:: MaxSetValue =-99999999999999.d0
integer, public, parameter:: IMinSetValue =999999
integer, public, parameter:: IMaxSetValue =-999999
integer, public, parameter:: ZoneVar =1
integer, public, parameter:: HVACVar =2
integer, public, parameter:: AveragedVar =1
integer, public, parameter:: SummedVar =2
integer, public, parameter:: VarType_NotFound =0
integer, public, parameter:: VarType_Integer =1
integer, public, parameter:: VarType_Real =2
integer, public, parameter:: VarType_Meter =3
integer, public, parameter:: VarType_Schedule =4
integer, public, parameter:: MeterType_Normal =0
integer, public, parameter:: MeterType_Custom =1
integer, public, parameter:: MeterType_CustomDec =2
integer, public, parameter:: MeterType_CustomDiff =3
character(len=*), public, parameter:: TimeStampFormat ="(A,',',A,',',i2,',',i2,',',i2,',',i2,',',f5.2,',',f5.2,',',A)"
character(len=*), public, parameter:: DailyStampFormat ="(A,',',A,',',i2,',',i2,',',i2,',',A)"
character(len=*), public, parameter:: MonthlyStampFormat ="(A,',',A,',',i2)"
character(len=*), public, parameter:: RunPeriodStampFormat ="(A,',',A)"
character(len=*), public, parameter:: fmta ="(A)"
character(len=*), public, parameter, DIMENSION(12):: DayTypes =(/"Sunday         ", "Monday         ", "Tuesday        ", "Wednesday      ", "Thursday       ", "Friday         ", "Saturday       ", "Holiday        ", "SummerDesignDay", "WinterDesignDay", "CustomDay1     ", "CustomDay2     "/)
character(len=*), public, parameter:: BlankString =' '
integer, public, parameter:: UnitsStringLength =16
integer, public, parameter:: RVarAllocInc =1000
integer, public, parameter:: LVarAllocInc =1000
integer, public, parameter:: IVarAllocInc =10
integer, public, parameter:: RT_IPUnits_Electricity =1
integer, public, parameter:: RT_IPUnits_Gas =2
integer, public, parameter:: RT_IPUnits_Cooling =3
integer, public, parameter:: RT_IPUnits_Water =4
integer, public, parameter:: RT_IPUnits_OtherKG =5
integer, public, parameter:: RT_IPUnits_OtherM3 =6
integer, public, parameter:: RT_IPUnits_OtherL =7
integer, public, parameter:: RT_IPUnits_OtherJ =0
integer, public :: InstMeterCacheSize =1000
integer, public :: InstMeterCacheSizeInc =1000
integer, public, ALLOCATABLE, DIMENSION(:):: InstMeterCache
integer, public, ALLOCATABLE, DIMENSION(:):: InstMeterCacheCopy
integer, public :: InstMeterCacheLastUsed =0
type(TimeSteps), public, DIMENSION(2):: TimeValue
type(RealVariableType), public, DIMENSION(:), ALLOCATABLE:: RVariableTypes
type(IntegerVariableType), public, DIMENSION(:), ALLOCATABLE:: IVariableTypes
type(VariableTypeForDDOutput), public, DIMENSION(:), ALLOCATABLE:: DDVariableTypes
integer, public :: CurrentReportNumber =0
integer, public :: NumVariablesForOutput =0
integer, public :: MaxVariablesForOutput =0
integer, public :: NumOfRVariable_Setup =0
integer, public :: NumTotalRVariable =0
integer, public :: NumOfRVariable_Sum =0
integer, public :: NumOfRVariable_Meter =0
integer, public :: NumOfRVariable =0
integer, public :: MaxRVariable =0
integer, public :: NumOfIVariable_Setup =0
integer, public :: NumTotalIVariable =0
integer, public :: NumOfIVariable_Sum =0
integer, public :: NumOfIVariable =0
integer, public :: MaxIVariable =0
logical, public :: OutputInitialized =.false.
integer, public :: ProduceReportVDD =ReportVDD_No
integer, public :: OutputFileRVDD =0
integer, public :: OutputFileMVDD =0
integer, public :: OutputFileMeterDetails =0
integer, public :: NumHoursinDay =24
integer, public :: NumHoursinMonth =0
integer, public :: NumHoursinSim =0
integer, public, DIMENSION(:), ALLOCATABLE:: ReportList
integer, public :: NumReportList =0
integer, public :: NumExtraVars =0
type(RealVariables), public, POINTER:: RVariable
type(IntegerVariables), public, POINTER:: IVariable
type(RealVariables), public, POINTER:: RVar
type(IntegerVariables), public, POINTER:: IVar
character(len=80), public, DIMENSION(-1:4,1:2):: FreqNotice
type(ReqReportVariables), public, DIMENSION(:), ALLOCATABLE:: ReqRepVars
integer, public :: NumOfReqVariables =0
type(MeterArrayType), public, DIMENSION(:), ALLOCATABLE:: VarMeterArrays
integer, public :: NumVarMeterArrays =0
type(MeterType), public, DIMENSION(:), ALLOCATABLE:: EnergyMeters
integer, public :: NumEnergyMeters =0
real(kind=r64), public, DIMENSION(:), ALLOCATABLE:: MeterValue
integer, public :: TimeStepStampReportNbr
character(len=3), public :: TimeStepStampReportChr
logical, public :: TrackingHourlyVariables =.false.
integer, public :: DailyStampReportNbr
character(len=3), public :: DailyStampReportChr
logical, public :: TrackingDailyVariables =.false.
integer, public :: MonthlyStampReportNbr
character(len=3), public :: MonthlyStampReportChr
logical, public :: TrackingMonthlyVariables =.false.
integer, public :: RunPeriodStampReportNbr
character(len=3), public :: RunPeriodStampReportChr
logical, public :: TrackingRunPeriodVariables =.false.
real(kind=r64), public :: SecondsPerTimeStep
logical, public :: ErrorsLogged =.false.
logical, public :: ProduceVariableDictionary =.false.
type(EndUseCategoryType), public, ALLOCATABLE, DIMENSION(:):: EndUseCategory
integer, public :: MaxNumSubcategories =1

Derived Types

type, public :: TimeSteps

Components

TypeVisibility AttributesNameInitial
real(kind=r64), public, POINTER:: TimeStep
real(kind=r64), public :: CurMinute

type, public :: RealVariables

Components

TypeVisibility AttributesNameInitial
real(kind=r64), public, POINTER:: Which
real(kind=r64), public :: Value =0.0d0
real(kind=r64), public :: TSValue =0.0d0
real(kind=r64), public :: EITSValue =0.0d0
real(kind=r64), public :: StoreValue =0.0d0
real(kind=r64), public :: NumStored =0.0d0
integer, public :: StoreType =0
logical, public :: Stored =.false.
logical, public :: Report =.false.
logical, public :: tsStored =.false.
logical, public :: thistsStored =.false.
integer, public :: thisTScount =0
integer, public :: ReportFreq =0
real(kind=r64), public :: MaxValue =-9999.d0
integer, public :: MaxValueDate =0
real(kind=r64), public :: MinValue =9999.d0
integer, public :: MinValueDate =0
integer, public :: ReportID =0
character(len=16), public :: ReportIDChr =BlankString
integer, public :: SchedPtr =0
integer, public :: MeterArrayPtr =0
integer, public :: ZoneMult =1
integer, public :: ZoneListMult =1

type, public :: IntegerVariables

Components

TypeVisibility AttributesNameInitial
integer, public, POINTER:: Which
real(kind=r64), public :: Value =0.0d0
real(kind=r64), public :: TSValue =0.0d0
real(kind=r64), public :: EITSValue =0.0d0
real(kind=r64), public :: StoreValue =0.0d0
real(kind=r64), public :: NumStored =0.0d0
integer, public :: StoreType =0
logical, public :: Stored =.false.
logical, public :: Report =.false.
logical, public :: tsStored =.false.
logical, public :: thistsStored =.false.
integer, public :: thisTScount =0
integer, public :: ReportFreq =0
integer, public :: MaxValue =-9999
integer, public :: MaxValueDate =0
integer, public :: MinValue =9999
integer, public :: MinValueDate =0
integer, public :: ReportID =0
character(len=16), public :: ReportIDChr =BlankString
integer, public :: SchedPtr =0

type, public :: VariableTypeForDDOutput

Components

TypeVisibility AttributesNameInitial
integer, public :: IndexType =0
integer, public :: StoreType =0
integer, public :: VariableType =VarType_NotFound
integer, public :: Next
logical, public :: ReportedOnDDFile =.false.
character(len=MaxNameLength), public :: VarNameOnly =BlankString
character(len=UnitsStringLength), public :: UnitsString =BlankString

type, public :: RealVariableType

Components

TypeVisibility AttributesNameInitial
integer, public :: IndexType =0
integer, public :: StoreType =0
integer, public :: ReportID =0
character(len=MaxNameLength*2+1), public :: VarName =BlankString
character(len=MaxNameLength*2+1), public :: VarNameUC =BlankString
character(len=MaxNameLength), public :: VarNameOnly =BlankString
character(len=MaxNameLength), public :: VarNameOnlyUC =BlankString
character(len=MaxNameLength), public :: KeyNameOnlyUC =BlankString
character(len=UnitsStringLength), public :: UnitsString =BlankString
type(RealVariables), public, POINTER:: VarPtr

type, public :: IntegerVariableType

Components

TypeVisibility AttributesNameInitial
integer, public :: IndexType =0
integer, public :: StoreType =0
integer, public :: ReportID =0
character(len=MaxNameLength*2+1), public :: VarName =BlankString
character(len=MaxNameLength*2+1), public :: VarNameUC =BlankString
character(len=MaxNameLength), public :: VarNameOnly =BlankString
character(len=UnitsStringLength), public :: UnitsString =BlankString
type(IntegerVariables), public, POINTER:: VarPtr

type, public :: ReqReportVariables

Components

TypeVisibility AttributesNameInitial
character(len=MaxNameLength), public :: Key =BlankString
character(len=MaxNameLength), public :: VarName =BlankString
integer, public :: ReportFreq =0
integer, public :: SchedPtr =0
character(len=MaxNameLength), public :: SchedName =BlankString
logical, public :: Used =.false.

type, public :: MeterArrayType

Components

TypeVisibility AttributesNameInitial
integer, public :: NumOnMeters =0
integer, public :: RepVariable =0
integer, public, DIMENSION(6):: OnMeters =0
integer, public :: NumOnCustomMeters =0
integer, public, ALLOCATABLE, DIMENSION(:):: OnCustomMeters

type, public :: MeterType

Components

TypeVisibility AttributesNameInitial
character(len=MaxNameLength*2), public :: Name =BlankString
character(len=MaxNameLength), public :: ResourceType =BlankString
character(len=MaxNameLength), public :: EndUse =BlankString
character(len=MaxNameLength), public :: EndUseSub =BlankString
character(len=MaxNameLength), public :: Group =BlankString
character(len=UnitsStringLength), public :: Units =BlankString
integer, public :: RT_forIPUnits =0
integer, public :: TypeOfMeter =MeterType_Normal
integer, public :: SourceMeter =0
real(kind=r64), public :: TSValue =0.0d0
real(kind=r64), public :: CurTSValue =0.0d0
logical, public :: RptTS =.false.
logical, public :: RptTSFO =.false.
integer, public :: TSRptNum =0
character(len=16), public :: TSRptNumChr =BlankString
real(kind=r64), public :: HRValue =0.0d0
logical, public :: RptHR =.false.
logical, public :: RptHRFO =.false.
real(kind=r64), public :: HRMaxVal =-99999.d0
integer, public :: HRMaxValDate =0
real(kind=r64), public :: HRMinVal =99999.d0
integer, public :: HRMinValDate =0
integer, public :: HRRptNum =0
character(len=16), public :: HRRptNumChr =BlankString
real(kind=r64), public :: DYValue =0.0d0
logical, public :: RptDY =.false.
logical, public :: RptDYFO =.false.
real(kind=r64), public :: DYMaxVal =-99999.d0
integer, public :: DYMaxValDate =0
real(kind=r64), public :: DYMinVal =99999.d0
integer, public :: DYMinValDate =0
integer, public :: DYRptNum =0
character(len=16), public :: DYRptNumChr =BlankString
real(kind=r64), public :: MNValue =0.0d0
logical, public :: RptMN =.false.
logical, public :: RptMNFO =.false.
real(kind=r64), public :: MNMaxVal =-99999.d0
integer, public :: MNMaxValDate =0
real(kind=r64), public :: MNMinVal =99999.d0
integer, public :: MNMinValDate =0
integer, public :: MNRptNum =0
character(len=16), public :: MNRptNumChr =BlankString
real(kind=r64), public :: SMValue =0.0d0
logical, public :: RptSM =.false.
logical, public :: RptSMFO =.false.
real(kind=r64), public :: SMMaxVal =-99999.d0
integer, public :: SMMaxValDate =0
real(kind=r64), public :: SMMinVal =99999.d0
integer, public :: SMMinValDate =0
integer, public :: SMRptNum =0
character(len=16), public :: SMRptNumChr =BlankString
real(kind=r64), public :: LastSMValue =0.0d0
real(kind=r64), public :: LastSMMaxVal =-99999.d0
integer, public :: LastSMMaxValDate =0
real(kind=r64), public :: LastSMMinVal =99999.d0
integer, public :: LastSMMinValDate =0
logical, public :: RptAccTS =.false.
logical, public :: RptAccTSFO =.false.
logical, public :: RptAccHR =.false.
logical, public :: RptAccHRFO =.false.
logical, public :: RptAccDY =.false.
logical, public :: RptAccDYFO =.false.
logical, public :: RptAccMN =.false.
logical, public :: RptAccMNFO =.false.
logical, public :: RptAccSM =.false.
logical, public :: RptAccSMFO =.false.
integer, public :: TSAccRptNum =0
integer, public :: HRAccRptNum =0
integer, public :: DYAccRptNum =0
integer, public :: MNAccRptNum =0
integer, public :: SMAccRptNum =0
integer, public :: InstMeterCacheStart =0
integer, public :: InstMeterCacheEnd =0

type, public :: EndUseCategoryType

Components

TypeVisibility AttributesNameInitial
character(len=MaxNameLength), public :: Name =BlankString
character(len=MaxNameLength), public :: DisplayName =BlankString
integer, public :: NumSubcategories =0
character(len=MaxNameLength), public, ALLOCATABLE, DIMENSION(:):: SubcategoryName

Functions

public function ValidateIndexType(IndexTypeKey, CalledFrom)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: IndexTypeKey
character(len=*), intent(in) :: CalledFrom

Return Value integer

public function StandardIndexTypeKey(IndexType)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: IndexType

Return Value character(len=4)

public function ValidateVariableType(VariableTypeKey)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: VariableTypeKey

Return Value integer

public function StandardVariableTypeKey(VariableType)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: VariableType

Return Value character(len=9)

public function GetVariableUnitsString(VariableName) result(ThisUnitsString)

! Errors here are fatal because should only be encountered during development.

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: VariableName

Return Value character(len=UnitsStringLength)

public function DateToStringWithMonth(codedDate) result(stringOut)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: codedDate

Return Value character(len=12)

public function WriteTimeStampFormatData(unitNumber, reportingInterval, reportID, reportIDString, DayOfSim, DayOfSimChr, Month, DayOfMonth, Hour, EndMinute, StartMinute, DST, DayType)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: unitNumber
integer, intent(in) :: reportingInterval
integer, intent(in) :: reportID
character(len=*), intent(in) :: reportIDString
integer, intent(in) :: DayOfSim
character(len=*), intent(in) :: DayOfSimChr
integer, intent(in), optional :: Month
integer, intent(in), optional :: DayOfMonth
integer, intent(in), optional :: Hour
real(kind=r64), intent(in), optional :: EndMinute
real(kind=r64), intent(in), optional :: StartMinute
integer, intent(in), optional :: DST
character(len=*), intent(in), optional :: DayType

Return Value integer

public function DetermineIndexGroupKeyFromMeterName(meterName)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: meterName

Return Value integer

public function DetermineIndexGroupFromMeterGroup(meter) result(indexGroup)

Arguments

Type IntentOptional AttributesName
type(MeterType), intent(in) :: meter

Return Value character(len=MaxNameLength)


Subroutines

public subroutine InitializeOutput()

Arguments

None

public subroutine SetupTimePointers(IndexKey, TimeStep)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: IndexKey
real(kind=r64), intent(in), TARGET:: TimeStep

public subroutine CheckReportVariable(KeyedValue, VarName)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: KeyedValue
character(len=*), intent(in) :: VarName

private subroutine BuildKeyVarList(KeyedValue, VariableName, MinIndx, MaxIndx)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: KeyedValue
character(len=*), intent(in) :: VariableName
integer, intent(in) :: MinIndx
integer, intent(in) :: MaxIndx

private subroutine AddBlankKeys(VariableName, MinIndx, MaxIndx)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: VariableName
integer, intent(in) :: MinIndx
integer, intent(in) :: MaxIndx

private subroutine GetReportVariableInput()

Arguments

None

public subroutine DetermineFrequency(FreqString, ReportFreq)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: FreqString
integer, intent(out) :: ReportFreq

public subroutine ProduceMinMaxString(String, DateValue, ReportFreq)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(inout) :: String
integer, intent(in) :: DateValue
integer, intent(in) :: ReportFreq

public subroutine ProduceMinMaxStringWStartMinute(String, DateValue, ReportFreq)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(inout) :: String
integer, intent(in) :: DateValue
integer, intent(in) :: ReportFreq

public subroutine ReallocateIntegerArray(Array, ArrayMax, ArrayInc)

Arguments

Type IntentOptional AttributesName
integer, intent(inout), ALLOCATABLE, DIMENSION(:):: Array
integer, intent(inout) :: ArrayMax
integer, intent(in) :: ArrayInc

public subroutine ReallocateRVar()

Arguments

None

public subroutine ReallocateIVar()

Arguments

None

private subroutine InitializeMeters()

Arguments

None

public subroutine GetCustomMeterInput(ErrorsFound)

Arguments

Type IntentOptional AttributesName
logical, intent(inout) :: ErrorsFound

public subroutine GetStandardMeterResourceType(OutResourceType, UserInputResourceType, ErrorsFound)

!! Basic ResourceType for Meters

Arguments

Type IntentOptional AttributesName
character(len=*), intent(out) :: OutResourceType
character(len=*), intent(in) :: UserInputResourceType
logical, intent(out) :: ErrorsFound

private subroutine AddMeter(Name, MtrUnits, ResourceType, EndUse, EndUseSub, Group)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: Name
character(len=*), intent(in) :: MtrUnits
character(len=*), intent(in) :: ResourceType
character(len=*), intent(in) :: EndUse
character(len=*), intent(in) :: EndUseSub
character(len=*), intent(in) :: Group

public subroutine AttachMeters(MtrUnits, ResourceType, EndUse, EndUseSub, Group, ZoneName, RepVarNum, MeterArrayPtr, ErrorsFound)

! Following if EndUse is by ResourceType

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: MtrUnits
character(len=*), intent(inout) :: ResourceType
character(len=*), intent(inout) :: EndUse
character(len=*), intent(inout) :: EndUseSub
character(len=*), intent(inout) :: Group
character(len=*), intent(in) :: ZoneName
integer, intent(in) :: RepVarNum
integer, intent(out) :: MeterArrayPtr
logical, intent(inout) :: ErrorsFound

public subroutine AttachCustomMeters(MtrUnits, RepVarNum, MeterArrayPtr, MeterIndex, ErrorsFound)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: MtrUnits
integer, intent(in) :: RepVarNum
integer, intent(inout) :: MeterArrayPtr
integer, intent(in) :: MeterIndex
logical, intent(inout) :: ErrorsFound

private subroutine ValidateNStandardizeMeterTitles(MtrUnits, ResourceType, EndUse, EndUseSub, Group, ErrorsFound, ZoneName)

!! Basic ResourceType Meters !! Group Meters !! EndUse Meters ! Following if we do EndUse by ResourceType

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: MtrUnits
character(len=*), intent(inout) :: ResourceType
character(len=*), intent(inout) :: EndUse
character(len=*), intent(inout) :: EndUseSub
character(len=*), intent(inout) :: Group
logical, intent(inout) :: ErrorsFound
character(len=*), intent(in), optional :: ZoneName

private subroutine DetermineMeterIPUnits(CodeForIPUnits, ResourceType, MtrUnits, ErrorsFound)

Arguments

Type IntentOptional AttributesName
integer, intent(inout) :: CodeForIPUnits
character(len=*), intent(in) :: ResourceType
character(len=*), intent(in) :: MtrUnits
logical, intent(inout) :: ErrorsFound

public subroutine UpdateMeterValues(TimeStepValue, NumOnMeters, OnMeters, NumOnCustomMeters, OnCustomMeters)

Arguments

Type IntentOptional AttributesName
real(kind=r64), intent(in) :: TimeStepValue
integer, intent(in) :: NumOnMeters
integer, intent(in), DIMENSION(:):: OnMeters
integer, intent(in), optional :: NumOnCustomMeters
integer, intent(in), optional DIMENSION(:):: OnCustomMeters

public subroutine UpdateMeters(TimeStamp)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: TimeStamp

public subroutine SetMinMax(TestValue, TimeStamp, CurMaxValue, CurMaxValDate, CurMinValue, CurMinValDate)

Arguments

Type IntentOptional AttributesName
real(kind=r64), intent(in) :: TestValue
integer, intent(in) :: TimeStamp
real(kind=r64), intent(inout) :: CurMaxValue
integer, intent(inout) :: CurMaxValDate
real(kind=r64), intent(inout) :: CurMinValue
integer, intent(inout) :: CurMinValDate

public subroutine ReportTSMeters(StartMinute, EndMinute, PrintESOTimeStamp)

Arguments

Type IntentOptional AttributesName
real(kind=r64), intent(in) :: StartMinute
real(kind=r64), intent(in) :: EndMinute
logical, intent(inout) :: PrintESOTimeStamp

public subroutine ReportHRMeters()

Arguments

None

public subroutine ReportDYMeters()

Arguments

None

public subroutine ReportMNMeters()

Arguments

None

public subroutine ReportSMMeters()

Arguments

None

public subroutine ReportForTabularReports()

Arguments

None

public subroutine ReportMeterDetails()

Arguments

None

public subroutine AddEndUseSubcategory(ResourceName, EndUseName, EndUseSubName)

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: ResourceName
character(len=*), intent(in) :: EndUseName
character(len=*), intent(in) :: EndUseSubName

public subroutine WriteReportVariableDictionaryItem(reportingInterval, storeType, reportID, indexGroupKey, indexGroup, reportIDChr, keyedValue, variableName, indexType, unitsString, scheduleName)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportingInterval
integer, intent(in) :: storeType
integer, intent(in) :: reportID
integer, intent(in) :: indexGroupKey
character(len=*), intent(in) :: indexGroup
character(len=*), intent(in) :: reportIDChr
character(len=*), intent(in) :: keyedValue
character(len=*), intent(in) :: variableName
integer, intent(in) :: indexType
character(len=*), intent(in) :: unitsString
character(len=*), intent(in), optional :: scheduleName

public subroutine WriteMeterDictionaryItem(reportingInterval, storeType, reportID, indexGroupKey, indexGroup, reportIDChr, meterName, unitsString, cumulativeMeterFlag, meterFileOnlyFlag)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportingInterval
integer, intent(in) :: storeType
integer, intent(in) :: reportID
integer, intent(in) :: indexGroupKey
character(len=*), intent(in) :: indexGroup
character(len=*), intent(in) :: reportIDChr
character(len=*), intent(in) :: meterName
character(len=*), intent(in) :: unitsString
logical, intent(in) :: cumulativeMeterFlag
logical, intent(in) :: meterFileOnlyFlag

public subroutine WriteRealVariableOutput(reportType, timeIndex)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportType
integer, intent(in) :: timeIndex

public subroutine WriteReportRealData(reportID, creportID, timeIndex, repValue, storeType, numOfItemsStored, reportingInterval, minValue, minValueDate, maxValue, maxValueDate)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportID
character(len=*), intent(in) :: creportID
integer, intent(in) :: timeIndex
real(kind=r64), intent(in) :: repValue
integer, intent(in) :: storeType
real(kind=r64), intent(in) :: numOfItemsStored
integer, intent(in) :: reportingInterval
real(kind=r64), intent(in) :: minValue
integer, intent(in) :: minValueDate
real(kind=r64), intent(in) :: maxValue
integer, intent(in) :: maxValueDate

public subroutine WriteCumulativeReportMeterData(reportID, creportID, timeIndex, repValue, meterOnlyFlag)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportID
character(len=*), intent(in) :: creportID
integer, intent(in) :: timeIndex
real(kind=r64), intent(in) :: repValue
logical, intent(in) :: meterOnlyFlag

public subroutine WriteReportMeterData(reportID, creportID, timeIndex, repValue, reportingInterval, minValue, minValueDate, maxValue, maxValueDate, meterOnlyFlag)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportID
character(len=*), intent(in) :: creportID
integer, intent(in) :: timeIndex
real(kind=r64), intent(in) :: repValue
integer, intent(in) :: reportingInterval
real(kind=r64), intent(in) :: minValue
integer, intent(in) :: minValueDate
real(kind=r64), intent(in) :: maxValue
integer, intent(in) :: maxValueDate
logical, intent(in) :: meterOnlyFlag

public subroutine WriteRealData(reportID, creportID, timeIndex, repValue)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportID
character(len=*), intent(in) :: creportID
integer, intent(in) :: timeIndex
real(kind=r64), intent(in) :: repValue

public subroutine WriteIntegerVariableOutput(reportType, timeIndex)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportType
integer, intent(in) :: timeIndex

public subroutine WriteReportIntegerData(reportID, reportIDString, timeIndex, repValue, storeType, numOfItemsStored, reportingInterval, minValue, minValueDate, maxValue, maxValueDate)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportID
character(len=*), intent(in) :: reportIDString
integer, intent(in) :: timeIndex
real(kind=r64), intent(in) :: repValue
integer, intent(in) :: storeType
real(kind=r64), intent(in), optional :: numOfItemsStored
integer, intent(in), optional :: reportingInterval
integer, intent(in), optional :: minValue
integer, intent(in), optional :: minValueDate
integer, intent(in), optional :: maxValue
integer, intent(in), optional :: maxValueDate

public subroutine WriteIntegerData(reportID, reportIDString, timeIndex, IntegerValue, RealValue)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: reportID
character(len=*), intent(in) :: reportIDString
integer, intent(in) :: timeIndex
integer, intent(in), optional :: IntegerValue
real(kind=r64), intent(in), optional :: RealValue

public subroutine SetInternalVariableValue(varType, keyVarIndex, SetRealVal, SetIntVal)

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: varType
integer, intent(in) :: keyVarIndex
real(kind=r64), intent(in) :: SetRealVal
integer, intent(in) :: SetIntVal


AirflowNetworkBalanceManager AirflowNetworkSolver BaseboardElectric BaseboardRadiator Boilers BoilerSteam BranchInputManager BranchNodeConnections ChillerAbsorption ChillerElectricEIR ChillerExhaustAbsorption ChillerGasAbsorption ChillerIndirectAbsorption ChillerReformulatedEIR CondenserLoopTowers ConductionTransferFunctionCalc ConvectionCoefficients CoolTower CostEstimateManager CrossVentMgr CTElectricGenerator CurveManager DataAirflowNetwork DataAirLoop DataAirSystems DataBranchAirLoopPlant DataBranchNodeConnections DataBSDFWindow DataComplexFenestration DataContaminantBalance DataConvergParams DataConversions DataCostEstimate DataDaylighting DataDaylightingDevices DataDefineEquip DataDElight DataEnvironment DataErrorTracking DataGenerators DataGlobalConstants DataGlobals DataHeatBalance DataHeatBalFanSys DataHeatBalSurface DataHVACControllers DataHVACGlobals DataInterfaces DataIPShortCuts DataLoopNode DataMoistureBalance DataMoistureBalanceEMPD DataOutputs DataPhotovoltaics DataPlant DataPlantPipingSystems DataPrecisionGlobals DataReportingFlags DataRoomAirModel DataRootFinder DataRuntimeLanguage DataShadowingCombinations DataSizing DataStringGlobals DataSurfaceColors DataSurfaceLists DataSurfaces DataSystemVariables DataTimings DataUCSDSharedData DataVectorTypes DataViewFactorInformation DataWater DataWindowEquivalentLayer DataZoneControls DataZoneEnergyDemands DataZoneEquipment DaylightingDevices DaylightingManager DELIGHTMANAGERF DELIGHTMANAGERF DemandManager DesiccantDehumidifiers DirectAirManager DisplacementVentMgr DualDuct DXCoils DXFEarClipping EarthTube EconomicLifeCycleCost EconomicTariff EcoRoofManager ElectricBaseboardRadiator EMSManager EvaporativeCoolers EvaporativeFluidCoolers ExteriorEnergyUse ExternalInterface FanCoilUnits Fans FaultsManager FluidCoolers FluidProperties FuelCellElectricGenerator Furnaces General GeneratorDynamicsManager GeneratorFuelSupply GlobalNames GroundHeatExchangers HeatBalanceAirManager HeatBalanceHAMTManager HeatBalanceIntRadExchange HeatBalanceManager HeatBalanceMovableInsulation HeatBalanceSurfaceManager HeatBalFiniteDiffManager HeatingCoils HeatPumpWaterToWaterCOOLING HeatPumpWaterToWaterHEATING HeatPumpWaterToWaterSimple HeatRecovery HighTempRadiantSystem Humidifiers HVACControllers HVACCooledBeam HVACDuct HVACDXHeatPumpSystem HVACDXSystem HVACHXAssistedCoolingCoil HVACInterfaceManager HVACManager HVACMultiSpeedHeatPump HVACSingleDuctInduc HVACStandAloneERV HVACUnitaryBypassVAV HVACUnitarySystem HVACVariableRefrigerantFlow HWBaseboardRadiator ICEngineElectricGenerator IceThermalStorage InputProcessor InternalHeatGains ISO_C_FUNCTION_BINDING ISO_C_FUNCTION_BINDING LowTempRadiantSystem ManageElectricPower MatrixDataManager MicroCHPElectricGenerator MicroturbineElectricGenerator MixedAir MixerComponent MoistureBalanceEMPDManager MundtSimMgr NodeInputManager NonZoneEquipmentManager OutAirNodeManager OutdoorAirUnit OutputProcessor OutputReportPredefined OutputReportTabular OutsideEnergySources PackagedTerminalHeatPump PackagedThermalStorageCoil Photovoltaics PhotovoltaicThermalCollectors PipeHeatTransfer Pipes PlantCentralGSHP PlantChillers PlantComponentTemperatureSources PlantCondLoopOperation PlantHeatExchangerFluidToFluid PlantLoadProfile PlantLoopEquip PlantLoopSolver PlantManager PlantPipingSystemsManager PlantPressureSystem PlantUtilities PlantValves PollutionModule PondGroundHeatExchanger PoweredInductionUnits Psychrometrics Pumps PurchasedAirManager RefrigeratedCase ReportSizingManager ReturnAirPathManager RoomAirModelManager RoomAirModelUserTempPattern RootFinder RuntimeLanguageProcessor ScheduleManager SetPointManager SimAirServingZones SimulationManager SingleDuct SizingManager SolarCollectors SolarReflectionManager SolarShading SortAndStringUtilities SplitterComponent SQLiteProcedures SQLiteProcedures StandardRatings SteamBaseboardRadiator SteamCoils SurfaceGeometry SurfaceGroundHeatExchanger SystemAvailabilityManager SystemReports TARCOGArgs TARCOGCommon TARCOGDeflection TARCOGGasses90 TARCOGGassesParams TARCOGMain TARCOGOutput TARCOGParams TarcogShading ThermalChimney ThermalComfort ThermalEN673Calc ThermalISO15099Calc TranspiredCollector UFADManager UnitHeater UnitVentilator UserDefinedComponents VariableSpeedCoils vectors VentilatedSlab WaterCoils WaterManager WaterThermalTanks WatertoAirHeatPump WatertoAirHeatPumpSimple WaterUse WeatherManager WindowAC WindowComplexManager WindowEquivalentLayer WindowManager WindTurbine ZoneAirLoopEquipmentManager ZoneContaminantPredictorCorrector ZoneDehumidifier ZoneEquipmentManager ZonePlenum ZoneTempPredictorCorrector