ESMF_CplCompGetEPPhaseCount Subroutine

public subroutine ESMF_CplCompGetEPPhaseCount(cplcomp, methodflag, phaseCount, phaseZeroFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(in) :: cplcomp
type(ESMF_Method_Flag), intent(in) :: methodflag
integer, intent(out) :: phaseCount
logical, intent(out), optional :: phaseZeroFlag
integer, intent(out), optional :: rc

Calls

proc~~esmf_cplcompgetepphasecount~~CallsGraph proc~esmf_cplcompgetepphasecount ESMF_CplCompGetEPPhaseCount c_esmc_getentrypointphasecount c_esmc_getentrypointphasecount proc~esmf_cplcompgetepphasecount->c_esmc_getentrypointphasecount proc~esmf_cplcompgetinit ESMF_CplCompGetInit proc~esmf_cplcompgetepphasecount->proc~esmf_cplcompgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_cplcompgetepphasecount->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_cplcompgetepphasecount->proc~esmf_logfounderror proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_cplcompgetepphasecount~~CalledByGraph proc~esmf_cplcompgetepphasecount ESMF_CplCompGetEPPhaseCount proc~nuopc_cplcompsetentrypoint NUOPC_CplCompSetEntryPoint proc~nuopc_cplcompsetentrypoint->proc~esmf_cplcompgetepphasecount proc~registeric~4 registerIC proc~registeric~4->proc~esmf_cplcompgetepphasecount interface~nuopc_compsetentrypoint NUOPC_CompSetEntryPoint interface~nuopc_compsetentrypoint->proc~nuopc_cplcompsetentrypoint proc~nuopc_connector_complianceicr NUOPC_Connector_ComplianceICR proc~nuopc_connector_complianceicr->proc~registeric~4 proc~driversetservices driverSetServices proc~driversetservices->interface~nuopc_compsetentrypoint proc~initializep0~2 InitializeP0 proc~initializep0~2->interface~nuopc_compsetentrypoint proc~setservices SetServices proc~setservices->interface~nuopc_compsetentrypoint proc~setservices~2 SetServices proc~setservices~2->interface~nuopc_compsetentrypoint proc~setservices~20 SetServices proc~setservices~20->interface~nuopc_compsetentrypoint

Source Code

  subroutine ESMF_CplCompGetEPPhaseCount(cplcomp, methodflag, phaseCount, &
    phaseZeroFlag, rc)

! !ARGUMENTS:
    type(ESMF_CplComp),     intent(in)            :: cplcomp
    type(ESMF_Method_Flag), intent(in)            :: methodflag
    integer,                intent(out)           :: phaseCount
    logical,                intent(out), optional :: phaseZeroFlag
    integer,                intent(out), optional :: rc
!
! !DESCRIPTION:
! Get phaseCount
!
! The arguments are:
! \begin{description}
! \item[cplcomp]
!   An {\tt ESMF\_CplComp} object.
! \item[methodflag]
!   \begin{sloppypar}
!   One of a set of predefined Component methods - e.g.
!   {\tt ESMF\_METHOD\_INITIALIZE}, {\tt ESMF\_METHOD\_RUN},
!   {\tt ESMF\_METHOD\_FINALIZE}. See section \ref{const:method}
!   for a complete list of valid method options.
!   \end{sloppypar}
! \item[phaseCount]
!   The number of phases for {\tt methodflag}. The method has 1..phaseCount phases.
! \item[phaseZeroFlag]
!   Return .true. if a "zero" phase was registered for {\tt methodflag}. Otherwise
!   return .false..
! \item[{[rc]}]
!   Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer :: localrc                       ! local error status
    type(ESMF_Logical)::  phaseZeroFlagHelp

    ! initialize return code; assume routine not implemented
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    localrc = ESMF_RC_NOT_IMPL

    ESMF_INIT_CHECK_DEEP(ESMF_CplCompGetInit, cplcomp, rc)

    call c_ESMC_GetEntryPointPhaseCount(cplcomp, methodflag, phaseCount, &
      phaseZeroFlagHelp, localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! translate ESMF_Logical -> logical
    if (present(phaseZeroFlag)) then
      phaseZeroFlag = phaseZeroFlagHelp
    endif

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS
  end subroutine ESMF_CplCompGetEPPhaseCount