psmile_neigh_extra_search_init.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_Neigh_extra_search_init
!
! !INTERFACE:

      subroutine psmile_neigh_extra_search_init (search, grid_id, &
                                                 extra_search, ierror)
!
! !USES:
!
      use PRISM_constants
!
      use PSMILe, dummy_interface => PSMILe_Neigh_extra_search_init

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

!     Info's on coordinates to be searched

      Integer,                  Intent(In)     :: grid_id

!     Id of the associated grid
!
! !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_init;
!             ierror = 0 : No error
!             ierror > 0 : Severe error
!
! !LOCAL VARIABLES
!
!
!     ... for error handling
!
      Integer, Parameter              :: nerrp = 2
      Integer                         :: ierrp (nerrp)
!
!
! !DESCRIPTION:
!
! Subroutine "PSMILe_Neigh_extra_search_init" initializes the vectors
! and varibales for the extra search; i.e for
!
!   (*) global search or
!   (*) extra search (nearest neighbour search).
!
! !REVISION HISTORY:
!
!   Date      Programmer   Description
! ----------  ----------   -----------
! 15.03.06    H. Ritzdorf  created
!
!EOP
!----------------------------------------------------------------------
!
!  $Id: psmile_neigh_extra_search_init.F90 2082 2009-10-21 13:31:19Z hanke $
!  $Author: hanke $
!
   Character(len=len_cvs_string), save :: mycvs = 
       '$Id: psmile_neigh_extra_search_init.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
!
      Allocate (extra_search%len_extra  (search%npart), &
                extra_search%len_req    (search%npart), &
                extra_search%indices_req(search%npart), &
                extra_search%required   (search%npart), &
                STAT = ierror)
!
      if ( ierror > 0 ) then
         ierrp (1) = ierror
         ierrp (2) = search%npart * 4

         ierror = PRISM_Error_Alloc
         call psmile_error ( ierror, 'len_extra, len_req, ...', &
                             ierrp, 2, __FILE__, __LINE__ )
         return
      endif
!
      Nullify (extra_search%indices)
!
!===> Nullify distance arrays for global nearest neighbour search
!
      Nullify (extra_search%dist_dble)
      Nullify (extra_search%cos_search_dble)
      Nullify (extra_search%sin_search_dble)
      Nullify (extra_search%z_search_dble)
!
      Nullify (extra_search%dist_real)
      Nullify (extra_search%cos_search_real)
      Nullify (extra_search%sin_search_real)
      Nullify (extra_search%z_search_real)
!
!===> Initialize number of extra points and
!                number of points which require global search
!
      extra_search%len_extra (:) = 0
      extra_search%len_req   (:) = 0
!
      extra_search%n_extra = 0
      extra_search%n_req = 0
!
      extra_search%global_marker = Grids(grid_id)%grid_shape(1,1) - 4
!
!===> All done
!
#ifdef VERBOSE
      print 9980, trim(ch_id)

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

      end subroutine psmile_neigh_extra_search_init