Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Grid), | intent(in) | :: | grid | |||
type(ESMF_StaggerLoc), | intent(in) | :: | staggerloc | |||
integer, | intent(out), | optional | :: | rc |
function ESMF_XGridGeomBaseCreateGrid(grid,staggerloc, rc) ! ! !RETURN VALUE: type(ESMF_XGridGeomBase) :: ESMF_XGridGeomBaseCreateGrid ! ! !ARGUMENTS: type(ESMF_Grid), intent(in) :: grid type(ESMF_StaggerLoc), intent(in) :: staggerloc integer, intent(out), optional :: rc ! ! !DESCRIPTION: ! Create an {\tt ESMF\_XGridGeomBase} object from an {\tt ESMF\_Grid} object. ! This will be overloaded for each type of object a GeomBase can represent. ! ! The arguments are: ! \begin{description} ! \item[grid] ! {\tt ESMF\_Grid} object to create the Grid Base from. ! \item[staggerloc] ! StaggerLoc on the Grid to create the Grid Base object on. ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOPI type(ESMF_XGridGeomBaseClass),pointer :: gbcp integer :: localrc ! local error status ! 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_GridGetInit, grid, rc) ! initialize pointers nullify(gbcp) nullify( ESMF_XGridGeomBaseCreateGrid%gbcp) ! allocate GeomBase type allocate(gbcp, stat=localrc) if (ESMF_LogFoundAllocError(localrc, msg="Allocating GeomBase type object", & ESMF_CONTEXT, rcToReturn=rc)) return ! Set values in GeomBase gbcp%type = ESMF_XGRIDGEOMTYPE_GRID gbcp%grid = grid gbcp%staggerloc = staggerloc ! Set GeomBase Type into GeomBase ESMF_XGridGeomBaseCreateGrid%gbcp=>gbcp ! Add reference to this object into ESMF garbage collection table call c_ESMC_VMAddFObject(ESMF_XGridGeomBaseCreateGrid, ESMF_ID_GEOMBASE%objectID) ! Set init status ESMF_INIT_SET_CREATED(ESMF_XGridGeomBaseCreateGrid) ! Return successfully if (present(rc)) rc = ESMF_SUCCESS end function ESMF_XGridGeomBaseCreateGrid