getfields.F90

Go to the documentation of this file.

!**********************************************************************
! Copyright 1998,1999,2000,2001,2002,2005,2007,2008,2009,2010         *
! Andreas Stohl, Petra Seibert, A. Frank, Gerhard Wotawa,             *
! Caroline Forster, Sabine Eckhardt, John Burkhart, Harald Sodemann   *
!                                                                     *
! This file is part of FLEXPART.                                      *
!                                                                     *
! FLEXPART is free software: you can redistribute it and/or modify    *
! it under the terms of the GNU General Public License as published by*
! the Free Software Foundation, either version 3 of the License, or   *
! (at your option) any later version.                                 *
!                                                                     *
! FLEXPART is distributed in the hope that it will be useful,         *
! but WITHOUT ANY WARRANTY; without even the implied warranty of      *
! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the       *
! GNU General Public License for more details.                        *
!                                                                     *
! You should have received a copy of the GNU General Public License   *
! along with FLEXPART.  If not, see <http://www.gnu.org/licenses/>.   *
!**********************************************************************

subroutine getfields(itime,nstop,metdata_format)
  !                       i     o
  !*****************************************************************************
  !                                                                            *
  !  This subroutine manages the 3 data fields to be kept in memory.           *
  !  During the first time step of petterssen it has to be fulfilled that the  *
  !  first data field must have |wftime|<itime, i.e. the absolute value of     *
  !  wftime must be smaller than the absolute value of the current time in [s].*
  !  The other 2 fields are the next in time after the first one.              *
  !  Pointers (memind) are used, because otherwise one would have to resort the*
  !  wind fields, which costs a lot of computing time. Here only the pointers  *
  !  are resorted.                                                             *
  !                                                                            *
  !     Author: A. Stohl                                                       *
  !                                                                            *
  !     29 April 1994                                                          *
  !                                                                            *
  !*****************************************************************************
  !  Changes, Bernd C. Krueger, Feb. 2001:
  !   Variables tth,qvh,tthn,qvhn (on eta coordinates) in common block.
  !   Function of nstop extended.
  !*****************************************************************************
 
  !  Changes Arnold, D. and Morton, D. (2015):                                 *
  !   -- description of local and common variables                             *
  !*****************************************************************************


  use par_mod
  use com_mod

  implicit none

  !****************************************************************************
  ! Subroutine Parameters:                                                    *
  !    input                                                                  *
  ! itime [s]            current time since start date of trajectory calcu-   *
  !                      lation                                               *
  ! nstop                > 0, if trajectory has to be terminated              *
  !    output                                                                 *
  ! metdata_format       0 = unknown, 1 = ecmwf, 2 = gfs meteorological data  *
  !  
  integer :: itime, nstop, metdata_format

  !****************************************************************************

  !****************************************************************************
  ! Local variables                                                           *
  !
  ! indj                 indicates the number of the wind field to be read in *
  ! memaux               auxiliary variable to shuffle winds in memory        *
  ! indmin               remembers the number of wind fields already treated  *
  ! uu(0:nxmax,0:nymax,nuvzmax,2)  wind components in x-direction [m/s]       *
  ! vv(0:nxmax,0:nymax,nuvzmax,2)  wind components in y-direction [m/s]       *
  ! ww(0:nxmax,0:nymax,nwzmax,2)   wind components in z-direction [deltaeta/s]*
  ! tt(0:nxmax,0:nymax,nuvzmax,2)  temperature [K]                            *
  ! ps(0:nxmax,0:nymax,2)          surface pressure [Pa]                      *
  !
  integer :: indj,memaux
  real :: uuh(0:nxmax-1,0:nymax-1,nuvzmax)
  real :: vvh(0:nxmax-1,0:nymax-1,nuvzmax)
  real :: pvh(0:nxmax-1,0:nymax-1,nuvzmax)
  real :: wwh(0:nxmax-1,0:nymax-1,nwzmax)
  real :: uuhn(0:nxmaxn-1,0:nymaxn-1,nuvzmax,maxnests)
  real :: vvhn(0:nxmaxn-1,0:nymaxn-1,nuvzmax,maxnests)
  real :: pvhn(0:nxmaxn-1,0:nymaxn-1,nuvzmax,maxnests)
  real :: wwhn(0:nxmaxn-1,0:nymaxn-1,nwzmax,maxnests)
  integer :: indmin = 1
  !****************************************************************************


  !****************************************************************************
  ! Global variables                                                          *
  !     from par_mod and com_mod                                              *
  ! nx,ny,nuvz,nwz       field dimensions in x,y and z direction              *
  ! indmin               remembers the number of wind fields already treated  *
  ! memind(2)            pointer, on which place the wind fields are stored   *
  ! memtime(2) [s]       times of the wind fields, which are kept in memory   *
  ! ndinterval [s]    time difference between the two wind fields read in     *
  ! ldirect                 1 for forward, -1 for backward simulation         * 
  ! numbwf                  actual number of wind fields                      *
  ! wftime(maxwf) [s]       times relative to beginning time of wind fields   *
  !****************************************************************************

#ifdef PERFTIMER 
  INTEGER millisecs_start, millisecs_stop, count_rate, count_max
#endif
!-----------------------------------------------------------------------------


  ! Check, if wind fields are available for the current time step
  !**************************************************************
  nstop=0

  if ((ldirect*wftime(1).gt.ldirect*itime).or. &
       (ldirect*wftime(numbwf).lt.ldirect*itime)) then
    write(*,*) 'FLEXPART WARNING: NO WIND FIELDS ARE AVAILABLE.'
    write(*,*) 'A TRAJECTORY HAS TO BE TERMINATED.'
    nstop=4
    return
  endif


  if ((ldirect*memtime(1).le.ldirect*itime).and. &
       (ldirect*memtime(2).gt.ldirect*itime)) then

  ! The right wind fields are already in memory -> don't do anything
  !*****************************************************************

    continue

  else if ((ldirect*memtime(2).le.ldirect*itime).and. &
       (memtime(2).ne.999999999)) then


  ! Current time is after 2nd wind field
  ! -> Resort wind field pointers, so that current time is between 1st and 2nd
  !***************************************************************************

    memaux=memind(1)
    memind(1)=memind(2)
    memind(2)=memaux
    memtime(1)=memtime(2)


  ! Read a new wind field and store it on place memind(2)
  !******************************************************

    do indj=indmin,numbwf-1
       if (ldirect*wftime(indj+1).gt.ldirect*itime) then

#ifdef PERFTIMER
         CALL system_clock(millisecs_start, count_rate, count_max)
#endif
          if (metdata_format.eq.ecmwf_metdata) then
             call readwind_ecmwf(indj+1,memind(2),uuh,vvh,wwh)
             call readwind_nests(indj+1,memind(2),uuhn,vvhn,wwhn)
             call calcpar_ecmwf(memind(2),uuh,vvh,pvh) 
             call calcpar_nests(memind(2),uuhn,vvhn,pvhn,metdata_format)
             call verttransform_ecmwf(memind(2),uuh,vvh,wwh,pvh)
             call verttransform_nests(memind(2),uuhn,vvhn,wwhn,pvhn)
             memtime(2)=wftime(indj+1)
             nstop = 1
          endif
          if (metdata_format.eq.gfs_metdata) then
             call readwind_gfs(indj+1,memind(2),uuh,vvh,wwh)
             call readwind_nests(indj+1,memind(2),uuhn,vvhn,wwhn)
             call calcpar_gfs(memind(2),uuh,vvh,pvh)
             call calcpar_nests(memind(2),uuhn,vvhn,pvhn,metdata_format)
             call verttransform_gfs(memind(2),uuh,vvh,wwh,pvh)
             call verttransform_nests(memind(2),uuhn,vvhn,wwhn,pvhn)
             memtime(2)=wftime(indj+1)
             nstop = 1
          endif

#ifdef PERFTIMER
         CALL system_clock(millisecs_stop, count_rate, count_max)
         print *, 'Wall time to process: ', trim(wfname(indj+1)), &
                  ': ', (millisecs_stop-millisecs_start)/1000.0, ' seconds'
#endif

          goto 40
       endif
    end do
 40   indmin=indj

  else

  ! No wind fields, which can be used, are currently in memory
  ! -> read both wind fields
  !***********************************************************

     do indj=indmin,numbwf-1
        if ((ldirect*wftime(indj).le.ldirect*itime).and. &
             (ldirect*wftime(indj+1).gt.ldirect*itime)) then
           memind(1)=1
           if (metdata_format.eq.ecmwf_metdata) then
#ifdef PERFTIMER
         CALL system_clock(millisecs_start, count_rate, count_max)
#endif
              call readwind_ecmwf(indj,memind(1),uuh,vvh,wwh)
              call readwind_nests(indj,memind(1),uuhn,vvhn,wwhn)
              call calcpar_ecmwf(memind(1),uuh,vvh,pvh)
              call calcpar_nests(memind(1),uuhn,vvhn,pvhn,metdata_format)
              call verttransform_ecmwf(memind(1),uuh,vvh,wwh,pvh)
              call verttransform_nests(memind(1),uuhn,vvhn,wwhn,pvhn)
              memtime(1)=wftime(indj)
              memind(2)=2
#ifdef PERFTIMER
         CALL system_clock(millisecs_stop, count_rate, count_max)
         print *, 'Wall time to process: ', trim(wfname(indj)), &
                  ': ', (millisecs_stop-millisecs_start)/1000.0, ' seconds'
#endif

#ifdef PERFTIMER
         CALL system_clock(millisecs_start, count_rate, count_max)
#endif
              call readwind_ecmwf(indj+1,memind(2),uuh,vvh,wwh)
              call readwind_nests(indj+1,memind(2),uuhn,vvhn,wwhn)
              call calcpar_ecmwf(memind(2),uuh,vvh,pvh)
              call calcpar_nests(memind(2),uuhn,vvhn,pvhn,metdata_format)
              call verttransform_ecmwf(memind(2),uuh,vvh,wwh,pvh)
              call verttransform_nests(memind(2),uuhn,vvhn,wwhn,pvhn)
              memtime(2)=wftime(indj+1)
              nstop = 1
#ifdef PERFTIMER
         CALL system_clock(millisecs_stop, count_rate, count_max)
         print *, 'Wall time to process: ', trim(wfname(indj+1)), &
                  ': ', (millisecs_stop-millisecs_start)/1000.0, ' seconds'
#endif
           endif
           if (metdata_format.eq.gfs_metdata) then 
#ifdef PERFTIMER
         CALL system_clock(millisecs_start, count_rate, count_max)
#endif
              call readwind_gfs(indj,memind(1),uuh,vvh,wwh)
              call readwind_nests(indj,memind(1),uuhn,vvhn,wwhn)
              call calcpar_gfs(memind(1),uuh,vvh,pvh)
              call calcpar_nests(memind(1),uuhn,vvhn,pvhn,metdata_format)
              call verttransform_gfs(memind(1),uuh,vvh,wwh,pvh)
              call verttransform_nests(memind(1),uuhn,vvhn,wwhn,pvhn)
              memtime(1)=wftime(indj)
              memind(2)=2
#ifdef PERFTIMER
         CALL system_clock(millisecs_stop, count_rate, count_max)
         print *, 'Wall time to process: ', trim(wfname(indj)), &
                  ': ', (millisecs_stop-millisecs_start)/1000.0, ' seconds'
#endif

#ifdef PERFTIMER
         CALL system_clock(millisecs_start, count_rate, count_max)
#endif
              call readwind_gfs(indj+1,memind(2),uuh,vvh,wwh)
              call readwind_nests(indj+1,memind(2),uuhn,vvhn,wwhn)
              call calcpar_gfs(memind(2),uuh,vvh,pvh)
              call calcpar_nests(memind(2),uuhn,vvhn,pvhn,metdata_format)
              call verttransform_gfs(memind(2),uuh,vvh,wwh,pvh)
              call verttransform_nests(memind(2),uuhn,vvhn,wwhn,pvhn)
              memtime(2)=wftime(indj+1)
              nstop = 1
#ifdef PERFTIMER
         CALL system_clock(millisecs_stop, count_rate, count_max)
         print *, 'Wall time to process: ', trim(wfname(indj+1)), &
                  ': ', (millisecs_stop-millisecs_start)/1000.0, ' seconds'
#endif
           endif
           goto 60
        endif
     end do
 60   indmin=indj

  endif

  lwindinterv=abs(memtime(2)-memtime(1))

  if (lwindinterv.gt.idiffmax) nstop=3

end subroutine getfields