Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_StaggerLoc), | intent(in) | :: | staggerloc | |||
character(len=*), | intent(out) | :: | string | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_StaggerLocString(staggerloc, string, & keywordEnforcer, rc) ! ! ! !ARGUMENTS: type(ESMF_StaggerLoc), intent(in) :: staggerloc character (len = *), intent(out) :: string type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, optional, intent(out) :: rc ! ! !STATUS: ! \begin{itemize} ! \item\apiStatusCompatibleVersion{5.2.0r} ! \end{itemize} ! ! !DESCRIPTION: ! Return an {\tt ESMF\_StaggerLoc} as a printable string. ! ! The arguments are: ! \begin{description} ! \item [staggerloc] ! The {\tt ESMF\_StaggerLoc} to be turned into a string. ! \item [string] ! Return string. ! \item [{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! ! !EOP ! Initialize return code; assume routine not implemented if (present(rc)) rc = ESMF_RC_NOT_IMPL ! translate staggerloc to string ! (Strings should be appropriate for 2D and 3D) if (staggerloc < ESMF_STAGGERLOC_CENTER) string="No String For This StaggerLoc" if (staggerloc == ESMF_STAGGERLOC_CENTER) string="Center" if (staggerloc == ESMF_STAGGERLOC_CORNER) string="Corner of Dim. 1 and Dim. 2" if (staggerloc == ESMF_STAGGERLOC_EDGE1) string="Middle of Face Offset in Dim. 1" if (staggerloc == ESMF_STAGGERLOC_EDGE2) string="Middle of Face Offset in Dim. 2" if (staggerloc == ESMF_STAGGERLOC_CENTER_VFACE) string="Middle of Face Offset in Dim. 3" if (staggerloc == ESMF_STAGGERLOC_EDGE1_VFACE) string="Middle of Edge Offset in Dim. 1 and Dim. 3" if (staggerloc == ESMF_STAGGERLOC_EDGE2_VFACE) string="Middle of Edge Offset in Dim. 2 and Dim. 3" if (staggerloc == ESMF_STAGGERLOC_CORNER_VFACE) string="Corner of Dim. 1, Dim. 2, and Dim. 3" if (staggerloc > ESMF_STAGGERLOC_CORNER_VFACE) string="No String For This StaggerLoc" if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_StaggerLocString