ESMF_PointListCreateFrmInput Function

private function ESMF_PointListCreateFrmInput(maxpts, numdims, origCoordDim, origCoordSys, rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: maxpts
integer, intent(in) :: numdims
integer, intent(in), optional :: origCoordDim
type(ESMF_CoordSys_Flag), intent(in), optional :: origCoordSys
integer, intent(out), optional :: rc

Return Value type(ESMF_PointList)


Calls

proc~~esmf_pointlistcreatefrminput~~CallsGraph proc~esmf_pointlistcreatefrminput ESMF_PointListCreateFrmInput c_esmc_pointlistcreatefrminput c_esmc_pointlistcreatefrminput proc~esmf_pointlistcreatefrminput->c_esmc_pointlistcreatefrminput proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_pointlistcreatefrminput->proc~esmf_logfounderror 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_pointlistcreatefrminput~~CalledByGraph proc~esmf_pointlistcreatefrminput ESMF_PointListCreateFrmInput interface~esmf_pointlistcreate ESMF_PointListCreate interface~esmf_pointlistcreate->proc~esmf_pointlistcreatefrminput proc~esmf_pointlistcreatefrmlocstream ESMF_PointListCreateFrmLocStream interface~esmf_pointlistcreate->proc~esmf_pointlistcreatefrmlocstream proc~esmf_pointlistcreatefrmlocstream->interface~esmf_pointlistcreate proc~getpointlistonfieldloc getPointListOnFieldLoc proc~getpointlistonfieldloc->interface~esmf_pointlistcreate proc~test_pointlist_from_grid_nomask test_pointlist_from_grid_nomask proc~test_pointlist_from_grid_nomask->interface~esmf_pointlistcreate proc~test_pointlist_from_grid_wmask test_pointlist_from_grid_wmask proc~test_pointlist_from_grid_wmask->interface~esmf_pointlistcreate proc~test_pointlist_from_inputs test_pointlist_from_inputs proc~test_pointlist_from_inputs->interface~esmf_pointlistcreate proc~test_pointlist_from_locstream_nomask test_pointlist_from_locStream_nomask proc~test_pointlist_from_locstream_nomask->interface~esmf_pointlistcreate proc~test_pointlist_from_locstream_wmask test_pointlist_from_locStream_wmask proc~test_pointlist_from_locstream_wmask->interface~esmf_pointlistcreate proc~test_pointlist_from_mesh_elems_nomask test_pointlist_from_mesh_elems_nomask proc~test_pointlist_from_mesh_elems_nomask->interface~esmf_pointlistcreate proc~test_pointlist_from_mesh_elems_wmask test_pointlist_from_mesh_elems_wmask proc~test_pointlist_from_mesh_elems_wmask->interface~esmf_pointlistcreate proc~test_pointlist_from_mesh_nodes_nomask test_pointlist_from_mesh_nodes_nomask proc~test_pointlist_from_mesh_nodes_nomask->interface~esmf_pointlistcreate proc~test_pointlist_from_mesh_nodes_nomask_empty_proc test_pointlist_from_mesh_nodes_nomask_empty_proc proc~test_pointlist_from_mesh_nodes_nomask_empty_proc->interface~esmf_pointlistcreate proc~test_pointlist_from_mesh_nodes_wmask test_pointlist_from_mesh_nodes_wmask proc~test_pointlist_from_mesh_nodes_wmask->interface~esmf_pointlistcreate proc~esmf_fieldregridstorenx ESMF_FieldRegridStoreNX proc~esmf_fieldregridstorenx->proc~getpointlistonfieldloc 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_nomask_empty_proc program~esmf_pointlistutest->proc~test_pointlist_from_mesh_nodes_wmask interface~esmf_fieldregridstore ESMF_FieldRegridStore interface~esmf_fieldregridstore->proc~esmf_fieldregridstorenx

Source Code

  function ESMF_PointListCreateFrmInput(maxpts, numdims, &
       origCoordDim, origCoordSys, rc)
!
! !RETURN VALUE:
    type(ESMF_PointList) :: ESMF_PointListCreateFrmInput
!
! !ARGUMENTS:
    integer, intent(in)                            :: maxpts, numdims
    integer, intent(in), optional                  :: origCoordDim
    type(ESMF_CoordSys_Flag), intent(in), optional :: origCoordSys
    integer, intent(out), optional                 :: rc
!
! !DESCRIPTION:
!   Allocates memory for a new {\tt ESMF\_PointList} object and
!   constructs its internals from test input
!
!   The arguments are:
!   \begin{description}
!   \item[{maxpts}]
!     The maximum number of points to hold in the PointList.
!   \item[{numdims}]
!     The number of dimensions for points in the PointList.
!   \item[{[origCoordDim]}]
!     The number of dimensions for original (i.e. before conversion to Cart.) coords
!     If not specified or specified to 0, then no original coordinates are stored.     
!   \item[{[origCoordSys]}]
!    The coordinate system of the original coordinates.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer             :: localrc      ! local return code
    type(ESMF_PointList)  :: pointlist

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

    ! Call C++ create code
    call c_ESMC_PointListCreateFrmInput(maxpts, numdims, pointlist, &
         origCoordDim, origCoordSys, localrc)

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

    ! Set return values
    ESMF_PointListCreateFrmInput = pointlist

    ESMF_INIT_SET_CREATED(ESMF_PointListCreateFrmInput)

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

  end function ESMF_PointListCreateFrmInput