psmile_neigh_extra_search_dble.F90

Go to the documentation of this file.

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

      subroutine psmile_neigh_extra_search_dble (search, extra_search, &
                                                 nb_extra, ierror)
!
! !USES:
!
      use PRISM_constants
!
      use PSMILe, dummy_interface => PSMILe_Neigh_extra_search_dble

      Implicit none
!
! !INPUT PARAMETERS:
!
      Type (Enddef_search),     Intent (In)    :: search

!     Info's on coordinates to be searched

      Integer,                  Intent (In)    :: nb_extra
!
!     Number of extra points to be searched
!
! !INPUT/OUTPUT PARAMETERS:
!
      Type (Extra_search_info), Intent (InOut) :: extra_search
!
!     Structure containing the data for
!     (*) global search and
!     (*) extra search of location
!         (for example: where required mask values were not "true")
!
! !OUTPUT PARAMETERS:

      Integer,                  Intent (Out)   :: ierror

!     Returns the error code of PSMILE_Neigh_extra_search_dble;
!             ierror = 0 : No error
!             ierror > 0 : Severe error
!
! !DEFINED PARAMETERS:
!
!  lat   = Index of Latitudes  in arrays "sin_values" and "cos_values"
!
      Integer, Parameter              :: lat = 2
!
! !LOCAL VARIABLES
!
      Integer                         :: n_extra
!
!     ... for error handling
!
      Integer, Parameter              :: nerrp = 2
      Integer                         :: ierrp (nerrp)
!
! !DESCRIPTION:
!
! Subroutine "PSMILe_Neigh_extra_search_dble" allocates the vectors
! which are required for the global search of the extra points.
!
!
! !REVISION HISTORY:
!
!   Date      Programmer   Description
! ----------  ----------   -----------
!  9.10.06    H. Ritzdorf  created
!
!EOP
!----------------------------------------------------------------------
!
!  $Id: psmile_neigh_extra_search_dble.F90 2082 2009-10-21 13:31:19Z hanke $
!  $Author: hanke $
!
   Character(len=len_cvs_string), save :: mycvs = 
       '$Id: psmile_neigh_extra_search_dble.F90 2082 2009-10-21 13:31:19Z hanke $'
!
!----------------------------------------------------------------------
!
!  Initialization
!
#ifdef VERBOSE
      print 9990, trim(ch_id)

      call psmile_flushstd
#endif /* VERBOSE */
!
!===> Initialization
!
      ierror  = 0
!
      n_extra = extra_search%n_extra
!
#ifdef PRISM_ASSERTION
      if ( Associated (extra_search%dist_dble)       .or. &
           Associated (extra_search%cos_search_dble) .or. &
           Associated (extra_search%sin_search_dble) .or. &
           Associated (extra_search%z_search_dble)   ) then
!
         call psmile_assert (__FILE__, __LINE__, &
                             "arrays should be not allocated")
      endif
#endif
!
!===> Allocate array for distances of nearest neighbour points
!     found
!
      Allocate (extra_search%dist_dble(n_extra, nb_extra), &
                STAT = ierror)
!
      if ( ierror > 0 ) then
         ierrp (1) = ierror
         ierrp (2) = n_extra * nb_extra

         ierror = PRISM_Error_Alloc
         call psmile_error ( ierror, 'extra_search%dist_dble', &
                             ierrp, 2, __FILE__, __LINE__ )
         return
      endif
!
!===> Allocate arrays for transformed coordinates
!
      Allocate (extra_search%sin_search_dble(n_extra, lat), &
                extra_search%cos_search_dble(n_extra, lat), &
                extra_search%z_search_dble(n_extra), &
                STAT = ierror)
!
      if ( ierror > 0 ) then
         ierrp (1) = ierror
         ierrp (2) = n_extra*lat*2 + n_extra

         ierror = PRISM_Error_Alloc
         call psmile_error ( ierror, 'extra_search%cos_search, ...', &
                             ierrp, 2, __FILE__, __LINE__ )
         return
      endif

!
!===> All done
!
#ifdef VERBOSE
      print 9980, trim(ch_id)

      call psmile_flushstd
#endif /* VERBOSE */
!
!  Formats:
!
9990 format (1x, a, ': psmile_neigh_extra_search_dble:')
9980 format (1x, a, ': psmile_neigh_extra_search_dble: eof')

      end subroutine psmile_neigh_extra_search_dble