ESMF_GridValidate Subroutine

public subroutine ESMF_GridValidate(grid, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Grid), intent(in) :: grid
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Calls

proc~~esmf_gridvalidate~~CallsGraph proc~esmf_gridvalidate ESMF_GridValidate c_esmc_gridvalidate c_esmc_gridvalidate proc~esmf_gridvalidate->c_esmc_gridvalidate proc~esmf_gridgetinit ESMF_GridGetInit proc~esmf_gridvalidate->proc~esmf_gridgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_gridvalidate->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_gridvalidate->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_gridvalidate~~CalledByGraph proc~esmf_gridvalidate ESMF_GridValidate proc~esmf_geomvalidate ESMF_GeomValidate proc~esmf_geomvalidate->proc~esmf_gridvalidate proc~esmf_xgridgeombasevalidate ESMF_XGridGeomBaseValidate proc~esmf_xgridgeombasevalidate->proc~esmf_gridvalidate program~esmf_gridarbitraryutest ESMF_GridArbitraryUTest program~esmf_gridarbitraryutest->proc~esmf_gridvalidate program~esmf_gridcoordutest ESMF_GridCoordUTest program~esmf_gridcoordutest->proc~esmf_gridvalidate program~esmf_gridcreateutest ESMF_GridCreateUTest program~esmf_gridcreateutest->proc~esmf_gridvalidate proc~esmf_fieldvalidate ESMF_FieldValidate proc~esmf_fieldvalidate->proc~esmf_geomvalidate proc~esmf_statevalidate ESMF_StateValidate proc~esmf_statevalidate->proc~esmf_fieldvalidate proc~test7d4_generic test7d4_generic proc~test7d4_generic->proc~esmf_fieldvalidate proc~test_mesh_create_gt_1localde test_mesh_create_gt_1localde proc~test_mesh_create_gt_1localde->proc~esmf_fieldvalidate program~esmf_meshutest ESMF_MeshUTest program~esmf_meshutest->proc~esmf_fieldvalidate program~esmf_meshutest->proc~test_mesh_create_gt_1localde program~esmf_statereconcileutest ESMF_StateReconcileUTest program~esmf_statereconcileutest->proc~esmf_statevalidate

Source Code

  subroutine ESMF_GridValidate(grid, keywordEnforcer, rc)
!
! !ARGUMENTS:
    type(ESMF_Grid), intent(in)              :: grid
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,         intent(out),  optional  :: rc
!
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
!      Validates that the {\tt Grid} is internally consistent.
!      Note that one of the checks that the Grid validate does
!      is the Grid status. Currently, the validate will return
!      an error if the grid is not at least
!      {\tt ESMF\_GRIDSTATUS\_COMPLETE}. This means that
!      if a Grid was created with the {\tt ESMF\_GridEmptyCreate}
!      method, it must also have been finished with
!      {\tt ESMF\_GridEmptyComplete()}
!      to be valid. If a Grid was created with another create
!      call it should automatically have the correct status level
!      to pass the status part of the validate.
!      The Grid validate at this time doesn't check for the presence
!      or consistency of the Grid coordinates.
!      The method returns an error code if problems are found.
!
!     The arguments are:
!     \begin{description}
!     \item[grid]
!          Specified {\tt ESMF\_Grid} object.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

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

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_GridGetInit, grid, rc)

    ! Call into the C++ interface, which will sort out optional arguments.
    call c_ESMC_GridValidate(grid, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_GridValidate