Nodes of different colours represent the following:
Solid arrows point from a parent (sub)module to the submodule which is descended from it. Dashed arrows point from a module being used to the module or program unit using it. Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| character(len=*), | intent(in) | :: | FreqString | |||
| integer, | intent(out) | :: | ReportFreq |
Nodes of different colours represent the following:
Solid arrows point from a procedure to one which it calls. Dashed arrows point from an interface to procedures which implement that interface. This could include the module procedures in a generic interface or the implementation in a submodule of an interface in a parent module. Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.
Nodes of different colours represent the following:
Solid arrows point from a procedure to one which it calls. Dashed arrows point from an interface to procedures which implement that interface. This could include the module procedures in a generic interface or the implementation in a submodule of an interface in a parent module. Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.
SUBROUTINE DetermineFrequency(FreqString,ReportFreq)
! SUBROUTINE INFORMATION:
! AUTHOR Linda K. Lawrie
! DATE WRITTEN December 1998
! MODIFIED na
! RE-ENGINEERED na
! PURPOSE OF THIS SUBROUTINE:
! This subroutine looks at the passed in report frequency string and
! determines the reporting frequency.
! METHODOLOGY EMPLOYED:
! na
! REFERENCES:
! \field Reporting Frequency
! \type choice
! \key Detailed
! \note Detailed lists every instance (i.e. HVAC variable timesteps)
! \key Timestep
! \note Timestep refers to the zone Timestep/Number of Timesteps in hour value
! \note RunPeriod, Environment, and Annual are the same
! \key Hourly
! \key Daily
! \key Monthly
! \key RunPeriod
! \key Environment
! \key Annual
! \default Hourly
! \note RunPeriod, Environment, and Annual are synonymous
! USE STATEMENTS:
USE InputProcessor, ONLY: SameString
USE DataSystemVariables, ONLY: MinReportFrequency
IMPLICIT NONE ! Enforce explicit typing of all variables in this routine
! SUBROUTINE ARGUMENT DEFINITIONS:
CHARACTER(len=*),INTENT(IN) :: FreqString !
INTEGER, INTENT(OUT) :: ReportFreq
! SUBROUTINE PARAMETER DEFINITIONS:
CHARACTER(len=4), PARAMETER, DIMENSION(-1:6) :: PossibleFreq =(/'deta','time','hour','dail','mont','runp','envi','annu'/)
!=(/'detail','Timestep','Hourly','Daily','Monthly','RunPeriod','Environment','Annual'/)
CHARACTER(len=*), PARAMETER, DIMENSION(-1:6) :: ExactFreqString = &
(/'Detailed ', &
'Timestep ', &
'Hourly ', &
'Daily ', &
'Monthly ', &
'RunPeriod ', &
'Environment', &
'Annual '/)
INTEGER, PARAMETER, DIMENSION(-1:6) :: FreqValues=(/-1,0,1,2,3,4,4,4/)
! note: runperiod, environment, and annual are synonomous
! INTERFACE BLOCK SPECIFICATIONS:
! na
! DERIVED TYPE DEFINITIONS:
! na
! SUBROUTINE LOCAL VARIABLE DECLARATIONS:
INTEGER Loop
INTEGER LenString
ReportFreq=ReportHourly !Default
LenString=LEN(FreqString)
LenString=MIN(LenString,4)
DO Loop=-1,6
IF (.not. SameString(FreqString(1:LenString),PossibleFreq(Loop)(1:4))) CYCLE
IF (.not. SameString(FreqString,ExactFreqString(Loop))) THEN
CALL ShowWarningError('DetermineFrequency: Entered frequency="'//trim(FreqString)// &
'" is not an exact match to key strings.')
CALL ShowContinueError('Frequency='//trim(ExactFreqString(Loop))//' will be used.')
ENDIF
ReportFreq=MAX(FreqValues(Loop),MinReportFrequency)
EXIT
ENDDO
RETURN
END SUBROUTINE DetermineFrequency