psmile_free_grid_handle.F90

Go to the documentation of this file.

!-----------------------------------------------------------------------
! Copyright 2006-2010, NEC Europe Ltd., London, UK.
! All rights reserved. Use is subject to OASIS4 license terms.
!-----------------------------------------------------------------------
!BOP
!
! !ROUTINE: PSMILe_Free_grid_handle
!
! !INTERFACE:

      subroutine psmile_free_grid_handle (grid_id, ierror)
!
! !USES:
!
      use PRISM_constants
!
      use PSMILe, dummy_interface => PSMILe_Free_grid_handle

      implicit none
!
! !INPUT PARAMETERS:
!
      integer,Intent(In)  :: grid_id

!     Handle to the grid information to be released.
!
! !OUTPUT PARAMETERS:
!
!
      integer, Intent (Out)               :: ierror

!     Returns the error code of psmile_free_grid_handle;
!             ierror = 0 : No error
!             ierror > 0 : Severe error
!
! !LOCAL VARIABLES
!
      integer, parameter                  :: nerrp = 2
      integer                             :: ierrp (nerrp)
!
! !DESCRIPTION:
!
! Subroutine "PSMILe_Free_grid_handle" released a grid handle.
!
! !REVISION HISTORY:
!
!   Date      Programmer    Description
! ----------  -----------   -----------
! 01.12.03    H. Ritzdorf   created
!
!EOP
!----------------------------------------------------------------------
!
! $Id: psmile_free_grid_handle.F90 2325 2010-04-21 15:00:07Z valcke $
! $Author: valcke $
!
   Character(len=len_cvs_string), save :: mycvs = 
       '$Id: psmile_free_grid_handle.F90 2325 2010-04-21 15:00:07Z valcke $'
!
!----------------------------------------------------------------------
!
!   Initialization
!
      ierror = 0
!
      if (grid_id > Number_of_Grids_allocated .or. &
          grid_id < 1) then

         ierrp (1) = grid_id
         ierrp (2) = Number_of_Grids_allocated

         ierror = PRISM_Error_Internal
         call psmile_error (ierror, "invalid grid handle", &
                            ierrp, nerrp, __FILE__, __LINE__)
         return
      endif
!
!   Free Index
!
      Grids(grid_id)%status = PSMILe_status_free
!
      end subroutine PSMILe_Free_grid_handle