ESMF_ContainerGetField Subroutine

private subroutine ESMF_ContainerGetField(container, itemName, keywordEnforcer, item, itemCount, isPresent, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Container), intent(in) :: container
character(len=*), intent(in) :: itemName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Field), intent(out), optional :: item
integer, intent(out), optional :: itemCount
logical, intent(out), optional :: isPresent
integer, intent(out), optional :: rc

Calls

proc~~esmf_containergetfield~~CallsGraph proc~esmf_containergetfield ESMF_ContainerGetField c_esmc_containergetcount c_esmc_containergetcount proc~esmf_containergetfield->c_esmc_containergetcount c_esmc_containergetfield c_esmc_containergetfield proc~esmf_containergetfield->c_esmc_containergetfield c_esmc_containergetispresent c_esmc_containergetispresent proc~esmf_containergetfield->c_esmc_containergetispresent proc~esmf_containergetinit ESMF_ContainerGetInit proc~esmf_containergetfield->proc~esmf_containergetinit proc~esmf_imerr ESMF_IMErr proc~esmf_containergetfield->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_containergetfield->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_containergetfield~~CalledByGraph proc~esmf_containergetfield ESMF_ContainerGetField interface~esmf_containerget~2 ESMF_ContainerGet interface~esmf_containerget~2->proc~esmf_containergetfield proc~esmf_reconcileinitialize ESMF_ReconcileInitialize proc~esmf_reconcileinitialize->interface~esmf_containerget~2 proc~esmf_reconcilezapproxies ESMF_ReconcileZapProxies proc~esmf_reconcileinitialize->proc~esmf_reconcilezapproxies proc~esmf_reconcilezappedproxies ESMF_ReconcileZappedProxies proc~esmf_reconcilezappedproxies->interface~esmf_containerget~2 proc~esmf_reconcilezapproxies->interface~esmf_containerget~2 proc~esmf_statevalidate ESMF_StateValidate proc~esmf_statevalidate->interface~esmf_containerget~2 proc~finalize~10 Finalize proc~finalize~10->interface~esmf_containerget~2 proc~nuopc_drivergetallcplcomp NUOPC_DriverGetAllCplComp proc~nuopc_drivergetallcplcomp->interface~esmf_containerget~2 proc~nuopc_drivergetallgridcomp NUOPC_DriverGetAllGridComp proc~nuopc_drivergetallgridcomp->interface~esmf_containerget~2 proc~nuopc_drivergetcplcomp NUOPC_DriverGetCplComp proc~nuopc_drivergetcplcomp->interface~esmf_containerget~2 proc~nuopc_drivergetgridcomp NUOPC_DriverGetGridComp proc~nuopc_drivergetgridcomp->interface~esmf_containerget~2 proc~nuopc_driverprint NUOPC_DriverPrint proc~nuopc_driverprint->interface~esmf_containerget~2 proc~nuopc_fielddictionaryegestdefaulti NUOPC_FieldDictionaryEgestDefaultI proc~nuopc_fielddictionaryegestdefaulti->interface~esmf_containerget~2 proc~nuopc_fielddictionaryegestyamli NUOPC_FieldDictionaryEgestYAMLI proc~nuopc_fielddictionaryegestyamli->interface~esmf_containerget~2 proc~nuopc_initattributesfield NUOPC_InitAttributesField proc~nuopc_initattributesfield->interface~esmf_containerget~2 program~esmf_containerutest ESMF_ContainerUTest program~esmf_containerutest->interface~esmf_containerget~2 program~esmf_statecreateutest ESMF_StateCreateUTest program~esmf_statecreateutest->interface~esmf_containerget~2 interface~nuopc_drivergetcomp NUOPC_DriverGetComp interface~nuopc_drivergetcomp->proc~nuopc_drivergetallcplcomp interface~nuopc_drivergetcomp->proc~nuopc_drivergetallgridcomp interface~nuopc_drivergetcomp->proc~nuopc_drivergetcplcomp interface~nuopc_drivergetcomp->proc~nuopc_drivergetgridcomp interface~nuopc_initattributes NUOPC_InitAttributes interface~nuopc_initattributes->proc~nuopc_initattributesfield proc~esmf_statereconcile_driver ESMF_StateReconcile_driver proc~esmf_statereconcile_driver->proc~esmf_reconcileinitialize proc~esmf_statereconcile_driver->proc~esmf_reconcilezappedproxies proc~nuopc_driveringestrunsequenceff NUOPC_DriverIngestRunSequenceFF proc~nuopc_driveringestrunsequenceff->proc~nuopc_drivergetcplcomp proc~nuopc_fielddictionaryegesti NUOPC_FieldDictionaryEgestI proc~nuopc_fielddictionaryegesti->proc~nuopc_fielddictionaryegestdefaulti proc~nuopc_fielddictionaryegesti->proc~nuopc_fielddictionaryegestyamli program~esmf_nuopc_utest ESMF_NUOPC_UTest program~esmf_nuopc_utest->proc~nuopc_driverprint program~esmf_statereconcileutest ESMF_StateReconcileUTest program~esmf_statereconcileutest->proc~esmf_statevalidate

Source Code

  subroutine ESMF_ContainerGetField(container, itemName, keywordEnforcer, &
    item, itemCount, isPresent, rc)
!
! !ARGUMENTS:
    type(ESMF_Container), intent(in)            :: container
    character(len=*),     intent(in)            :: itemName
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    type(ESMF_Field),     intent(out), optional :: item
    integer,              intent(out), optional :: itemCount
    logical,              intent(out), optional :: isPresent
    integer,              intent(out), optional :: rc
!         
! !DESCRIPTION:
!   Get items from a {\tt ESMF\_Container} object.
!
!   The arguments are:
!   \begin{description}
!   \item[container]
!     {\tt ESMF\_Container} object to be queried.
!   \item[itemName]
!     The name of the specified item.
!   \item[{[item]}]
!     Returned item.
!   \item [{[itemCount]}]
!     Number of items with {\tt itemName} in {\tt container}.
!   \item [{[isPresent]}]
!     Upon return indicates whether item with {\tt itemName} is contained in 
!     {\tt container}.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                       :: localrc      ! local return code
    type(ESMF_Logical)            :: isPres

    ! Initialize return code; assume failure until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP_SHORT(ESMF_ContainerGetInit, container, rc)
    
    if (present(item)) then
      ! Call into the C++ interface
      call c_ESMC_ContainerGetField(container, trim(itemName), item, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif
    
    if (present(itemCount)) then
      ! Call into the C++ interface
      call c_ESMC_ContainerGetCount(container, trim(itemName), itemCount, &
        localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif

    if (present(isPresent)) then
      ! Call into the C++ interface
      call c_ESMC_ContainerGetIsPresent(container, trim(itemName), &
        isPres, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
      isPresent = isPres
    endif
 
    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS
 
  end subroutine ESMF_ContainerGetField