Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_StaggerLoc), | intent(inout) | :: | staggerloc | |||
integer, | intent(in) | :: | dim | |||
integer, | intent(in) | :: | loc | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | optional | :: | rc |
subroutine ESMF_StaggerLocSetDim(staggerloc, dim, loc, & keywordEnforcer, rc) ! ! !ARGUMENTS: type (ESMF_StaggerLoc), intent(inout) :: staggerloc integer, intent(in) :: dim integer, intent(in) :: loc type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, optional :: rc ! !STATUS: ! \begin{itemize} ! \item\apiStatusCompatibleVersion{5.2.0r} ! \end{itemize} ! ! !DESCRIPTION: ! Sets a particular dimension of a custom {\tt staggerloc} to a position in a cell ! by using the variable {\tt loc}. The variable {\tt loc} should only be 0,1. ! If {\tt loc} is 0 it means the position ! should be in the center in that dimension. If {\tt loc} is +1 then ! for the dimension, the position should be on the positive side of the cell. ! Please see Section~\ref{sec:usage:staggerloc:adv} ! for diagrams and further discussion of custom stagger locations. ! ! The arguments are: ! \begin{description} ! \item[staggerloc] ! Stagger location to be initialized ! \item[dim] ! Dimension to be changed (1-7). ! \item[loc] ! Position data should be either 0,1. ! \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 !TODO: error checking here ! Set stagger location value staggerloc%staggerloc=loc*2**(dim-1) ! Set return values. if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_StaggerLocSetDim