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) | :: | CoilType | |||
character(len=*), | intent(in) | :: | CoilName | |||
logical, | intent(inout) | :: | ErrorsFound | |||
integer, | intent(in), | optional | :: | CoilIndex |
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.
FUNCTION GetDXCoilAvailSchPtr(CoilType,CoilName,ErrorsFound,CoilIndex) RESULT(SchPtr)
! FUNCTION INFORMATION:
! AUTHOR Richard Raustad
! DATE WRITTEN January 2013
! MODIFIED na
! RE-ENGINEERED na
! PURPOSE OF THIS FUNCTION:
! This function looks up the given coil and returns the availability schedule index. If
! incorrect coil type or name is given, errorsfound is returned as true and schedule index is returned
! as -1.
! METHODOLOGY EMPLOYED:
! na
! REFERENCES:
! na
! USE STATEMENTS:
USE InputProcessor, ONLY: FindItemInList
IMPLICIT NONE ! Enforce explicit typing of all variables in this routine
! FUNCTION ARGUMENT DEFINITIONS:
CHARACTER(len=*), INTENT(IN) :: CoilType ! must match coil types in this module
CHARACTER(len=*), INTENT(IN) :: CoilName ! must match coil names for the coil type
LOGICAL, INTENT(INOUT) :: ErrorsFound ! set to true if problem
INTEGER, INTENT(IN), OPTIONAL :: CoilIndex ! Coil index number
INTEGER :: SchPtr ! returned availabiltiy schedule of matched coil
! FUNCTION PARAMETER DEFINITIONS:
! na
! INTERFACE BLOCK SPECIFICATIONS:
! na
! DERIVED TYPE DEFINITIONS:
! na
! FUNCTION LOCAL VARIABLE DECLARATIONS:
INTEGER :: WhichCoil
! Obtains and Allocates DXCoils
IF (GetCoilsInputFlag) THEN
CALL GetDXCoils
GetCoilsInputFlag = .FALSE.
END IF
If (PRESENT(CoilIndex)) Then
IF(CoilIndex .EQ. 0)THEN
CALL ShowSevereError('GetDXCoilAvailSchPtr: Invalid index passed = 0')
CALL ShowContinueError('... returning DXCoilAvailSchPtr as -1.')
ErrorsFound=.TRUE.
SchPtr=-1
RETURN
ELSE
WhichCoil=CoilIndex
END IF
Else
WhichCoil=FindItemInList(CoilName,DXCoil%Name,NumDXCoils)
End If
IF (WhichCoil /= 0) THEN
SchPtr=DXCoil(WhichCoil)%SchedPtr
ELSE
If (.NOT. PRESENT(CoilIndex)) Then
CALL ShowSevereError('GetDXCoilAvailSch: Could not find Coil, Type="'//TRIM(CoilType)//'" Name="'//TRIM(CoilName)// &
'" when accessing coil availability schedule index.')
End IF
ErrorsFound=.true.
SchPtr=-1
ENDIF
RETURN
END FUNCTION GetDXCoilAvailSchPtr