ESMF_PointListGetForLoc Subroutine

public subroutine ESMF_PointListGetForLoc(pointlist, loc, id, loc_coords, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_PointList), intent(in) :: pointlist
integer, intent(in) :: loc
integer, intent(out), optional :: id
real(kind=ESMF_KIND_R8), intent(out), optional, dimension(:) :: loc_coords
integer, intent(out), optional :: rc

Calls

proc~~esmf_pointlistgetforloc~~CallsGraph proc~esmf_pointlistgetforloc ESMF_PointListGetForLoc c_esmc_pointlistgetcoords c_esmc_pointlistgetcoords proc~esmf_pointlistgetforloc->c_esmc_pointlistgetcoords c_esmc_pointlistgetid c_esmc_pointlistgetid proc~esmf_pointlistgetforloc->c_esmc_pointlistgetid proc~esmf_imerr ESMF_IMErr proc~esmf_pointlistgetforloc->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_pointlistgetforloc->proc~esmf_logfounderror proc~esmf_pointlistgetinit ESMF_PointListGetInit proc~esmf_pointlistgetforloc->proc~esmf_pointlistgetinit 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_pointlistgetforloc~~CalledByGraph proc~esmf_pointlistgetforloc ESMF_PointListGetForLoc proc~test_pointlist_from_grid_nomask test_pointlist_from_grid_nomask proc~test_pointlist_from_grid_nomask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_grid_wmask test_pointlist_from_grid_wmask proc~test_pointlist_from_grid_wmask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_inputs test_pointlist_from_inputs proc~test_pointlist_from_inputs->proc~esmf_pointlistgetforloc proc~test_pointlist_from_locstream_nomask test_pointlist_from_locStream_nomask proc~test_pointlist_from_locstream_nomask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_locstream_wmask test_pointlist_from_locStream_wmask proc~test_pointlist_from_locstream_wmask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_mesh_elems_nomask test_pointlist_from_mesh_elems_nomask proc~test_pointlist_from_mesh_elems_nomask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_mesh_elems_wmask test_pointlist_from_mesh_elems_wmask proc~test_pointlist_from_mesh_elems_wmask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_mesh_nodes_nomask test_pointlist_from_mesh_nodes_nomask proc~test_pointlist_from_mesh_nodes_nomask->proc~esmf_pointlistgetforloc proc~test_pointlist_from_mesh_nodes_wmask test_pointlist_from_mesh_nodes_wmask proc~test_pointlist_from_mesh_nodes_wmask->proc~esmf_pointlistgetforloc program~esmf_pointlistutest ESMF_PointListUTest program~esmf_pointlistutest->proc~test_pointlist_from_grid_nomask program~esmf_pointlistutest->proc~test_pointlist_from_grid_wmask program~esmf_pointlistutest->proc~test_pointlist_from_inputs program~esmf_pointlistutest->proc~test_pointlist_from_locstream_nomask program~esmf_pointlistutest->proc~test_pointlist_from_locstream_wmask program~esmf_pointlistutest->proc~test_pointlist_from_mesh_elems_nomask program~esmf_pointlistutest->proc~test_pointlist_from_mesh_elems_wmask program~esmf_pointlistutest->proc~test_pointlist_from_mesh_nodes_nomask program~esmf_pointlistutest->proc~test_pointlist_from_mesh_nodes_wmask

Source Code

  subroutine ESMF_PointListGetForLoc(pointlist, loc, id, loc_coords, rc)
!
! !ARGUMENTS:
    type(ESMF_PointList), intent(in)                          :: pointlist
    integer,            intent(in)                          :: loc
    integer,            intent(out), optional               :: id
    real(ESMF_KIND_R8), intent(out), optional, dimension(:) :: loc_coords
    integer,            intent(out), optional               :: rc
!
! !DESCRIPTION:
!     Returns information about an {\tt ESMF\_PointList}.
!
!     The arguments are:
!     \begin{description}
!     \item[pointlist]
!          {\tt ESMF\_PointList} to be queried.
!     \item[loc]
!          Location within Pointlist to be queried. Locations values begin with zero.
!     \item[{[id]}]
!          Returns the id associated with location.
!     \item[{[loc_coords]}]
!          Returns array of coordinates associated with location.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    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

    ESMF_INIT_CHECK_DEEP(ESMF_PointListGetInit,pointlist,rc)

    if (present(id)) then
      call c_ESMC_PointListGetId(pointlist, loc, id, localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif

    if (present(loc_coords)) then
      call c_ESMC_PointListGetCoords(pointlist, loc, loc_coords, localrc)

      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif

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

  end subroutine ESMF_PointListGetForLoc