ESMF_FieldRegridRelease Subroutine

public subroutine ESMF_FieldRegridRelease(routehandle, keywordEnforcer, noGarbage, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_RouteHandle), intent(inout) :: routehandle
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
logical, intent(in), optional :: noGarbage
integer, intent(out), optional :: rc

Calls

proc~~esmf_fieldregridrelease~~CallsGraph proc~esmf_fieldregridrelease ESMF_FieldRegridRelease proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_fieldregridrelease->proc~esmf_logfounderror proc~esmf_routehandlerelease ESMF_RouteHandleRelease proc~esmf_fieldregridrelease->proc~esmf_routehandlerelease 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 proc~esmf_routehandlerelease->proc~esmf_logfounderror proc~esmf_imerr ESMF_IMErr proc~esmf_routehandlerelease->proc~esmf_imerr proc~esmf_routehandledestroy ESMF_RouteHandleDestroy proc~esmf_routehandlerelease->proc~esmf_routehandledestroy proc~esmf_routehandlegetinit ESMF_RouteHandleGetInit proc~esmf_routehandlerelease->proc~esmf_routehandlegetinit proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep 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_routehandledestroy->proc~esmf_logfounderror proc~esmf_routehandledestroy->proc~esmf_imerr proc~esmf_routehandledestroy->proc~esmf_routehandlegetinit c_esmc_routehandledestroy c_esmc_routehandledestroy proc~esmf_routehandledestroy->c_esmc_routehandledestroy 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

ESMF_FieldRegridExwESMF_FieldRegridRelease
w
ESMF_FieldRegridExw
w
ESMF_FieldSphereRegridExw
w
ESMF_LocStreamExw
w
ESMF_MeshExw
w
ESMF_RegridExw
w
ESMF_RHandleDynamicMaskingExw
w
ESMF_RHandleReusabilityExw
w
ESMF_XGridExw
w
f_esmf_regridreleasew
w
field_redist_testw
w
field_regrid_testw
w
test_3Dcartcsrvregridwmasksw
w
test_bilinear_regrid_csgridw
w
test_bilinear_regrid_csgrid_sph_radw
w
test_bilinear_regrid_csmeshw
w
test_bilinear_regrid_csmosaicw
w
test_cart_bilinear_xgridw
w
test_cartcsrvregridwmasksw
w
test_cartcsrvregridwmasksw
w
test_CartMeshToMesh_2ndw
w
test_conserve_regrid_csgridw
w
test_conserve_regrid_csmeshw
w
test_conserve_regrid_csmosaicw
w
test_CSGridToGridw
w
test_CSGridToGrid_2ndw
w
test_CSGridToGridWMasksw
w
test_csrvregridw
w
test_csrvregridwmasksw
w
test_csrvregridwmasksUserAreaw
w
test_DTOS_3DCartMeshToMeshw
w
test_DTOSGridToGridSph3Dw
w
test_extrap_creep_nrst_dw
w
test_extrap_nrst_dw
w
test_GridToGridw
w
test_MasksAndUserAreaw
w
test_mesh_dual_w_bilinearw
w
test_mesh_extrap_creepw
w
test_MeshEasyElemsw
w
test_MeshToMeshw
w
test_MeshToMesh_2ndw
w
test_MeshToMeshCartw
w
test_MeshToMeshWMasksw
w
test_Nearest2DCartLSToLSw
w
test_Nearest3DCartLSToLSw
w
test_nearest_regrid_csgridw
w
test_nearest_regrid_csmeshw
w
test_patch_regrid_csgridw
w
test_patch_regrid_csmeshw
w
test_PatchMeshToLocStreamMaskw
w
test_PerLocStatusw
w
test_regrid0WidthDEsw
w
test_regrid180vs360w
w
test_regrid2TileDGw
w
test_regrid2TileDGw
w
test_regrid2xg_onlinew
w
test_regrid2xgSphw
w
test_regrid3Dw
w
test_regrid3D_DTOSw
w
test_regrid3D_STODw
w
test_regrid3DCartMeshToMeshw
w
test_regrid_extrap_creepw
w
test_regrid_extrap_near_npntsw
w
test_regrid_extrap_nearstodw
w
test_regrid_gridufrmw
w
test_regrid_nanw
w
test_regrid_snanw
w
test_regrid_store_from_filew
w
test_regrid_transposew
w
test_regrid_w_gtomw
w
test_regridAllDstMaskw
w
test_RegridCart4ConcaveMeshw
w
test_RegridCart4ConcaveMeshw
w
test_regridCnrw
w
test_regridCollapsedQuadsw
w
test_RegridCsrv3DCartMeshw
w
test_RegridCsrvCartMeshw
w
test_RegridCsrvCartMultiPolyw
w
test_RegridCsrvCartPHFracNormw
w
test_RegridCsrvCartPHMeshw
w
test_regridDELOCALw
w
test_regridDGSphw
w
test_regridDisjointw
w
test_regridDisjointSDw
w
test_regridDstMaskw
w
test_regridEdgew
w
test_regridExtraFieldDimw
w
test_regridGridToGMLw
w
test_regridGridToGridSph3Dw
w
test_regridGridToLocStream3dw
w
test_regridGridToLocStreamLocCntw
w
test_regridGridToLocStreamRegDistw
w
test_regridGridToMeshw
w
test_regridIrregw
w
test_regridMeshSph3x3ToGridw
w
test_regridMeshToGridw
w
test_regridMeshToGrid3Dw
w
test_regridMeshToGridSph3Dw
w
test_regridMeshToLocStreamMaskw
w
test_regridMeshToMeshw
w
test_regridMeshToMeshCenterw
w
test_regridMeshToMeshMaskw
w
test_regridMeshToMeshPatchw
w
test_regridMeshToMeshPHw
w
test_regridNearestDTOSMeshToMeshw
w
test_regridNearestLocStream_wClusterToMeshw
w
test_regridNearestLocStreamToGridw
w
test_regridNearestLocStreamToLocStreamw
w
test_regridNearestMeshToMeshw
w
test_regridPartialVMw
w
test_regridPerLocStatusw
w
test_regridPerLocStatusw
w
test_regridPerLocStatusExtrapw
w
test_regridPerLocStatusNSToDw
w
test_regridPHMeshToGridw
w
test_regridR4w
w
test_RegridSph4ConcaveMeshw
w
test_RegridSph4ConcaveMeshw
w
test_regridSphDstMaskw
w
test_regridSphGCw
w
test_regridSphNearestw
w
test_regridSphNearestDToSw
w
test_regridSphPoleAllAvgw
w
test_regridSphPoleNonew
w
test_regridSphPoleNpntAvgw
w
test_regridSphPoleTeethw
w
test_regridSphSrcMaskw
w
test_regridSrcMaskw
w
test_regridSwitchedIndicesw
w
test_regridSwitchedIndicesIIw
w
test_regridTetMeshToGrid3Dw
w
test_SmallNumNbrsw
w
test_sph_bilinear_xgridw
w
test_sph_csrv_w_frac_normw
w
test_sph_vec_blnr_csG_to_llGw
w
test_sph_vec_blnr_csG_to_llG_pw
w
test_sph_vec_blnr_identicalw
w
test_STOD_3DCartMeshToMeshw
w
test_STODGridToGridSph3Dw
w
test_unmappedDstListw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w
user_finalw
w

Source Code

      subroutine ESMF_FieldRegridRelease(routehandle, keywordEnforcer, &
        noGarbage, rc)
!
! !ARGUMENTS:
      type(ESMF_RouteHandle), intent(inout)         :: routehandle
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
      logical,                intent(in),  optional :: noGarbage
      integer,                intent(out), optional :: rc 
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \item\apiStatusModifiedSinceVersion{5.2.0r}
! \begin{description}
! \item[8.0.0] Added argument {\tt noGarbage}.
!   The argument provides a mechanism to override the default garbage collection
!   mechanism when destroying an ESMF object.
! \end{description}
! \end{itemize}
!
! !DESCRIPTION:
!     Release resources associated with a regrid operation. After this call
!     {\tt routehandle} becomes invalid.
!
!     The arguments are:
!     \begin{description}
!     \item [routehandle]
!       Handle to the precomputed Route.
!     \item[{[noGarbage]}]
!     If set to {\tt .TRUE.} the object will be fully destroyed and removed
!     from the ESMF garbage collection system. Note however that under this 
!     condition ESMF cannot protect against accessing the destroyed object 
!     through dangling aliases -- a situation which may lead to hard to debug 
!     application crashes.
! 
!     It is generally recommended to leave the {\tt noGarbage} argument
!     set to {\tt .FALSE.} (the default), and to take advantage of the ESMF 
!     garbage collection system which will prevent problems with dangling
!     aliases or incorrect sequences of destroy calls. However this level of
!     support requires that a small remnant of the object is kept in memory
!     past the destroy call. This can lead to an unexpected increase in memory
!     consumption over the course of execution in applications that use 
!     temporary ESMF objects. For situations where the repeated creation and 
!     destruction of temporary objects leads to memory issues, it is 
!     recommended to call with {\tt noGarbage} set to {\tt .TRUE.}, fully 
!     removing the entire temporary object from memory.
!     \item [{[rc]}]
!           Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
        integer :: localrc

        call ESMF_RouteHandleRelease(routehandle, noGarbage=noGarbage, &
          rc=localrc)
        if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
          ESMF_CONTEXT, rcToReturn=rc)) return

        if(present(rc)) rc = ESMF_SUCCESS

    end subroutine ESMF_FieldRegridRelease