ESMF_DistGridSetInitCreated Subroutine

public subroutine ESMF_DistGridSetInitCreated(distgrid, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_DistGrid), intent(inout) :: distgrid
integer, intent(out), optional :: rc

Called by

proc~~esmf_distgridsetinitcreated~~CalledByGraph proc~esmf_distgridsetinitcreated ESMF_DistGridSetInitCreated proc~esmf_gridgetdefault ESMF_GridGetDefault proc~esmf_gridgetdefault->proc~esmf_distgridsetinitcreated proc~esmf_gridgetpsloc ESMF_GridGetPSloc proc~esmf_gridgetpsloc->proc~esmf_distgridsetinitcreated proc~esmf_locstreamdeserialize ESMF_LocStreamDeserialize proc~esmf_locstreamdeserialize->proc~esmf_distgridsetinitcreated proc~esmf_meshcreateredist ESMF_MeshCreateRedist proc~esmf_meshcreateredist->proc~esmf_distgridsetinitcreated proc~esmf_meshget ESMF_MeshGet proc~esmf_meshget->proc~esmf_distgridsetinitcreated proc~esmf_meshmatch ESMF_MeshMatch proc~esmf_meshmatch->proc~esmf_distgridsetinitcreated

Source Code

  subroutine ESMF_DistGridSetInitCreated(distgrid, rc)
!
! !ARGUMENTS:
    type(ESMF_DistGrid),  intent(inout)           :: distgrid
    integer,              intent(out),  optional  :: rc  
!
! !DESCRIPTION:
!      Set init code in DistGrid object to "CREATED".
!
!     The arguments are:
!     \begin{description}
!     \item[distgrid] 
!          Specified {\tt ESMF\_DistGrid} object.
!     \item[{[rc]}] 
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------

    ! initialize return code; assume routine not implemented
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
    ! Set init code
    ESMF_INIT_SET_CREATED(distgrid)

    ! Return success
    if (present(rc)) rc = ESMF_SUCCESS
    
  end subroutine ESMF_DistGridSetInitCreated