Subversion Repositories lagranto.um

#!/bin/csh

# Set Lagranto 

set LAGRANTO = ${LAGRANTOBASE}.${MODEL}/

# ---------------------------------------------------------------------

# Usage, parameter settings

# ---------------------------------------------------------------------

# Write usage information

if ( (${#argv} == 0) | (${#argv} < 2) ) then

  echo 

  echo "--------------------------------------------------------------"

  echo " Usage: trace.sh inpfile outfile [flags]        "

  echo 

  echo "        inpfile   : Input trajectory file                     "

  echo "        outfile   : Output trajectory file                    "

  echo "        [ flags ] : Optional list of flags                    "

  echo

  echo " Optional flags                                               "

  echo

  echo "        -i hours     : Time increment for input files in hours"

  echo "        -v filename  : Name of tracing file                   "

  echo "        -f var scale : Trace field <var> with scaling <scale> "

  echo "        -changet     : change times on P,S files before calculation" 

  echo "        -noclean     : do not remove temporary files"

  echo 

  echo " Tracing variables must be available on file <tracevars>, if not"

  echo " provided with "-f" option. The format of the <tracevars> file is"

  echo  

  echo "           varname   scale    compflag[0|1]   prefix[P|S]     "

  echo

  echo " The tracing variables have the following form                "

  echo 

  echo "             varname[:shift] with <shift> as + 100 km[lat]    "

  echo "                                             - 100 km[lon]    "

  echo "                                             + 2 dlon         "

  echo "                                             - 2 dlat         "

  echo "                                             + 50 hPa         "

  echo "                                             - 1 dp           "

  echo "                                             + 6 h            "

  echo "                                             - 180 min        "

  echo

  echo " The following fields can be computed 'online':               "

  echo

  echo " TH, RHO, RH, THE, LHR, DUDX, DVDX, DTDX, DUDY, DVDY, DTDY,    " 

  echo " DUDP, DVDP, DTDP, DTHDP, NSQ, RELVORT, ABSVORT, DIV, DTHDX,"

  echo " DTHDY, PV, RI, TI"

  echo "--------------------------------------------------------------"

  exit 0

endif

# Write title

echo 

echo '========================================================='

echo '       *** START OF PREPROCESSOR TRACE ***              '

echo

# Get the arguments

set inpfile   = $1

set outfile   = $2

# Set base directories (run+prog)

set cdfdir=${PWD}

set tradir=${PWD}

# Set program paths and filenames 

set parfile = ${tradir}/trace.param 

set prog    = ${LAGRANTO}/trace/trace

# Set the prefix of the primary and secondary data files

set charp = 'P'

set chars = 'S'

echo '---- DIRECTORIES AND PROGRAMS ---------------------------'

echo    

echo "CDF directory         : ${cdfdir}"

echo "TRA directory         : ${tradir}"

echo "PROGRAM TRACE         : ${prog}"

echo "PARAMETER file        : ${parfile}"

echo

# ---------------------------------------------------------------------

# Set optional flags

# ---------------------------------------------------------------------

echo '---- OPTIONAL FLAGS -------------------------------------'

echo

# Set some default values ("nil" must be set according to input files)

set flag_i     = "nil"

set flag_v     = "tracevars"

set flag_f     = "nil"

set tvfile     = 'tracevars'

set changet    = 'false'

set noclean    = 'false'

set timecheck  = 'yes' 

# Set flag for consitency

set isok = 1

while ( $#argv > 0 )

  switch ( $argv[1] )

   case -i

     set flag_i=$argv[2]

     echo "Flag '-i'     -> ${flag_i} (user defined)"

     shift;

   breaksw

   case -v

     set flag_v="-v"

     set tvfile=$argv[2]

     echo "Flag '-v'     -> ${tvfile} (user defined)"

     shift;

     if ( $isok == 2 ) set isok = 0

     if ( $isok == 1 ) set isok = 2

   breaksw

   case -f

     set flag_f="-f"

     set tvfile="tracevars.tmp"

     shift;

     set tvar="$argv[1]"

     shift;

     set tscale="$argv[1]"

     echo "Flag '-f'     -> ${tvar} ${tscale} (user defined)"

     if ( $isok == 2 ) set isok = 0

     if ( $isok == 1 ) set isok = 2

   breaksw

   case -changet

     set changet = 'true'

     echo "changet       -> true (user defined)"

   breaksw

   case -noclean

     set noclean = 'true'

     echo "noclean       -> true (user defined)"

   breaksw

   case -notimecheck

     set timecheck = 'no'

     echo "timecheck               -> no (user defined)"

   breaksw

  endsw

  shift;

end

# No change of times necessary if no check requested

if ( "${timecheck}" == "no" ) then

   set  changet = 'false'

endif

# Check consitency of arguments

if ( $isok == 0 ) then

    echo

    echo " ERROR: Use either option '-v' or '-f', but not both..."

    exit 1

endif

# ---------------------------------------------------------------------

# Handle the input trajectory file

# ---------------------------------------------------------------------

echo

echo '---- TIME RANGE -----------------------------------------'

echo

# Check whether the input file can be found

if ( ! -f ${inpfile} ) then

    echo " ERROR : Input file ${inpfile} is missing"

    exit 1

endif

# Get the start, end and reference date for the tracing

set startdate = `${LAGRANTO}/goodies/trainfo.sh ${inpfile} startdate` 

set enddate   = `${LAGRANTO}/goodies/trainfo.sh ${inpfile} enddate` 

set refdate   = `${LAGRANTO}/goodies/trainfo.sh ${inpfile} refdate` 

set ntra      =  `${LAGRANTO}/goodies/trainfo.sh ${inpfile} ntra`

set ntim      =  `${LAGRANTO}/goodies/trainfo.sh ${inpfile} ntim`

set ncol      =  `${LAGRANTO}/goodies/trainfo.sh ${inpfile} ncol`

# Check format of start and end date - must be the same

set ns=`echo $startdate | sed -e 's/_[0-9]*//' | wc -c`

set ne=`echo $enddate   | sed -e 's/_[0-9]*//' | wc -c`

if ( $ns != $ne ) then

  echo " ERROR: start and end date must be in the same format ***"

  exit 1

endif

if ( $ns != 9 ) then

  echo " ERROR: Date format must be yyyymmdd ***"

  exit 1

endif

set ns=`echo $startdate | sed -e 's/[0-9]*_//' | wc -c`

set ne=`echo $enddate   | sed -e 's/[0-9]*_//' | wc -c`

if ( $ns != $ne ) then

  echo " ERROR: start and end date must be in the same format ***"

  exit 1

endif

if ( ( $ns != 5 ) & ( $ns != 3 ) ) then

  echo " ERROR: Time format must be hh(mm) ***"

  exit 1

endif

# Split the start and end date into <yymmdd_hh and mm>

set startdate_ymdh = `echo $startdate | cut -c 1-11`

set startdate_min  = `echo $startdate | cut -c 12-13`

if ( $startdate_min == "" ) set startdate_min = 00

set enddate_ymdh = `echo $enddate | cut -c 1-11`

set enddate_min  = `echo $enddate | cut -c 12-13`

if ( $enddate_min == "" ) set enddate_min = 00

# Get the time difference between <start_ymdh> and <end_ymdh> date

# Decide whether trajectoriesare forward or backward

set timediff_hh = `${LAGRANTO}/goodies/gettidiff ${enddate_ymdh} ${startdate_ymdh}`

if ( $timediff_hh == 0 ) then

  if ( $enddate_min > $startdate_min ) then

    set direction = f

    set idir      = 1

  else

    set direction = b

    set idir      = -1

  endif

else if ( $timediff_hh > 0 ) then

  set direction = f

  set idir      = 1

else

  set direction = b

  set idir      = -1

  @ timediff_hh = $idir * $timediff_hh

endif

# Get also minutes for time difference, if <start_min> or <end_min> != 0

set timediff_mm=

if ( $startdate_min != 00 || $enddate_min != 00 ) then

  @ min = ( $enddate_min - $startdate_min )

  if ( $min == 0 ) then

    set timediff_mm=

  else if ( $min > 0 ) then

    if ( $idir == 1 ) then

      set timediff_mm=$min

    else

      @ timediff_hh --

      @ timediff_mm = 60 - $min

    endif

  else

    if ( $idir == 1 ) then

      @ timediff_hh --

      @ timediff_mm = 60 + $min

    else

      @ timediff_mm = 0 - $min

    endif

  endif

else

  set timediff_mm = 0

endif

# Write status information

echo "Time range      : ${startdate} -> ${enddate}"

if ( ${timediff_mm} != "" ) then

   echo "Time difference : ${timediff_hh} h ${timediff_mm} min"

else

   echo "Time difference : ${timediff_hh} h"

endif

echo "Direction       : ${direction} (${idir})"

# ---------------------------------------------------------------------

# Check availability of input data 

# ---------------------------------------------------------------------

echo

echo '---- INPUT FILES ----------------------------------------'

echo

# Take the time increment from flag list ('nil', if not defined)

set timeinc = ${flag_i}

# Find a first data file (if possible corresponding to start/end date

# If starttime is not a data time, take the first file in the direectory

if ( $direction == "f" ) then

  set file=${charp}${startdate_ymdh}

else

  set file=${charp}${enddate_ymdh}

endif

if ( ! -f $file ) then

  set file=`ls ${charp}[0-9_]*[0-9] | head -1 | sed -e 's/@//'`

endif

# Determine timeinc (the time difference in hours between two data file)

# if not already defined with option -i

if ( ${timeinc} == "nil" ) then

  set date1=`echo $file | cut -c 2-`

  set n=`ls ${charp}[0-9_]*[0-9] | grep -n $date1 | awk -F: '{print $1}'`

  @ n ++

  set date2=`\ls ${charp}[0-9_]*[0-9] | head -$n | tail -1 | cut -c 2-`

  set timeinc=`${LAGRANTO}/goodies/gettidiff $date2 $date1`

endif

if ( $timeinc == 0 ) then

    echo " ERROR: cannot set the time increment between input files ***"

    exit 1

endif

# Decide whether the time increment is smaller than 1 h; if so set the hires

# flag and convert the timeincement into fractional hour

set flag = `echo ${timeinc} | grep -n '\.'`

set hires = 0

if ( "${flag}" != "" ) then

  echo "Input files availability < 1 hour ($timeinc): switch to hires"

  echo "mode. All input files must be of form: P{yyyymmdd_hhmm}"

  set hires = 1

  set timeinc_min = `echo "(${timeinc} * 100 + 0.5)/1" | bc`

  set timeinc     = `echo "scale=8; ${timeinc} * 100 / 60" | bc`

  goto hires

endif

## Search the first file to use: We step through all P files and see whether they are

# good P files. Let's first do the test for the first data file found. If it's ok, we 

# take it; if not, we step through all P files and find the good one  

set flag=0

set td=

set date = `echo $file | cut -c 2-12`

set td1  = `${LAGRANTO}/goodies/gettidiff ${startdate_ymdh} ${date}`

set td2  = `${LAGRANTO}/goodies/gettidiff ${enddate_ymdh}   ${date}`

if (( $td1 < $timeinc || $td2 < $timeinc ) && ( $td1 >= 0 || $td2 >= 0 )) then

   set datfiles=$date

   if ( $td1 < $timeinc    ) set td=$td1

   if ( $td2 < $timeinc    ) set td=$td2

   if ( ( $startdate_min > 0 ) || ( $enddate_min > 0 ) ) @ td ++

   goto label2      

endif

foreach i ( ${charp}????????_?? )

  set date = `echo $i | cut -c 2-12`

  set td1  = `${LAGRANTO}/goodies/gettidiff ${startdate_ymdh} ${date}`

  set td2  = `${LAGRANTO}/goodies/gettidiff ${enddate_ymdh}   ${date}`

  if (( $td1 < $timeinc || $td2 < $timeinc ) && ( $td1 >= 0 || $td2 >= 0 )) then

      set datfiles=$date

      if ( $td1 < $timeinc    ) set td=$td1

      if ( $td2 < $timeinc    ) set td=$td2

      if ( ( $startdate_min > 0 ) || ( $enddate_min > 0 ) ) @ td ++

      goto label2

  endif

end

if ( $td == "" ) then

  echo " ERROR: no data files available for the specified time period"

  exit 1

endif

# If the input files come with time increment < 1 hour, handle it in this

# special section. The aim is not to 'interfere' with the well established

# code handling the standard case with time increment >= 1 hour. In this mode

# we require that the start and end date are available as P files: no start is

# allowed between the model output files

hires:

set flag=0

set td=0

if ( $direction == "f" ) then

  set file=${charp}${startdate}

else 

  set file=${charp}${enddate}

endif

if ( -f $file ) then

  set date     = `echo ${file} | cut -c 2-14`

  set datfiles = $date

  set td       = 0

  goto label2

else

  echo

  echo " ERROR: no data files available for the specified time period"

  exit 1

endif

# Everything is fine so far: proceed

label2:

# Calculate the number of further files; handle hires (timeinc<1 h) and

# standard mode (timeinc >= 1 h) separately

if ( ${hires} == 0 ) then

 @ num = ( $timediff_hh + $td ) / $timeinc + 1

 @ dum1 = ( $num - 1 ) * $timeinc

 @ dum2 = $timediff_hh + $td

 if ( $dum1 != $dum2 ) @ num ++

else

 set num = `echo "( ${timediff_hh}*60 + ${timediff_mm} ) / ( ${timeinc_min} ) + 1" | bc`

endif 

# Get a list of all needed files

set numfiles=$num

set sfiles=1

echo $datfiles

while ( $num > 1 )

  if ( $hires == 0 ) then

     set date=`${LAGRANTO}/goodies/newtime $date $timeinc`

  else

     set date=`${LAGRANTO}/goodies/newtime $date $timeinc_min`

  endif

  if ( ! -f ${charp}${date} ) then

    echo " ERROR: file with primary data is missing for $date"

    exit 1

  else if ( ! -f ${chars}${date} ) then

    set sfiles=0

    set datfiles=`echo $datfiles $date`

  else

    set datfiles=`echo $datfiles $date`

  endif

  @ num --

end

# Calculate the start and the end time relative to the first datfile

if ( $direction == f ) then

  set tstart = `${LAGRANTO}/goodies/gettidiff $startdate $datfiles[1]`

  set tend   = `${LAGRANTO}/goodies/gettidiff $datfiles[$numfiles] $enddate`

else

  set tstart = `${LAGRANTO}/goodies/gettidiff $datfiles[$numfiles] $startdate`

  set tend   = `${LAGRANTO}/goodies/gettidiff $enddate $datfiles[1]`

endif

# Write some status information

echo "Primary file prefix               : ${charp}"

echo "Secondary file prefix             : ${chars}"

if ( ${hires} == 0 ) then

  echo "Time increment for input files    : ${timeinc} h"

else

  echo "Time increment for input files    : ${timeinc_min} min (0$timeinc h) "

endif

echo "# input files                     : ${numfiles}"

echo "First input file                  : $datfiles[1] " 

echo "Last input file                   : $datfiles[$numfiles] " 

echo "${charp} files availability              : 1"  

echo "${chars} files availability              : ${sfiles}"     

if ( $direction == f ) then

echo "Start time relative to first file : $datfiles[1] + ${tstart} "

echo "End time relative to last file    : $datfiles[$numfiles] - ${tend} "  

else

echo "Start time relative to last file  : $datfiles[$numfiles] - ${tstart} "

echo "End time relative to first file   : $datfiles[1] + ${tend} "

endif

echo

echo $datfiles

# ---------------------------------------------------------------------

# Check availability of input data 

# ---------------------------------------------------------------------

echo

echo '---- TRACEVAR FILE --------------------------------------'

echo    

# If "-f" option is used, create a temporary tracevar file

if ( "${flag_f}" == "-f" ) then

#   Preset values for <compfl> and <tprefix>

    set tcompfl=1

    set tprefix='P'

#   Split the variable name into its vectorial components, if necessary

    set tvar0 = `echo ${tvar} | awk -F. '{print $1}' `

    set tvar1 = `echo ${tvar} | awk -F. '{print $2}' `

#   Check availability on P file - only for first vector component

    foreach var ( `${LAGRANTO}/goodies/getvars ${charp}$datfiles[1]` )

       if ( "${var}" == "${tvar0}" ) then

          set tcompfl=0

              set tprefix="P"

       endif

    end

#   Check availability on S file 

    if ( ${sfiles} == 1 ) then

       foreach var ( `${LAGRANTO}/goodies/getvars ${chars}$datfiles[1]` )

         if ( "${var}" == "${tvar0}" ) then

            set tcompfl=0

                set tprefix="S"

         endif

       end

    endif

#   Write the temporary <tracevars> file

    echo "${tvar} ${tscale} ${tcompfl} ${tprefix}" >! ${tvfile}

    echo "Temporary tracervar file <${tvfile}> created"

    echo

endif

# Check if tracevars-file exists

if ( ! -f $tvfile ) then

  echo  " ERROR:  file $tvfile was not found ***"

  exit 1

endif

# check if the variables contained in the tracevars-file are available in the

# data file and check also if there are no empty lines in the tracevars-file

set nlines = `cat $tvfile | wc -l`

set vars   = `cat $tvfile | awk '{print $1}'`

set nvars  = `echo $vars | wc -w`

if ( $nlines != $nvars ) then

  echo " ERROR: tracevars-files must not contain empty lines ***"

  exit 1

endif

set calf=`cat $tvfile | awk '{print $3}'`

set tfil=`cat $tvfile | awk '{print $4}'`

# Write some status information

cat ${tvfile}

echo

echo "# Number of tracing variables : ${nlines}"

echo "Fields are read from following files : ${tfil}"

# Loop over all variables - check availability

foreach v ( $vars )

  if ( $calf[1] == 0 ) then

    set v0 = `echo $v | awk 'BEGIN {FS = ":"}; {print $1}'`

    set flag=`${LAGRANTO}/goodies/getvars $tfil[1]$datfiles[1] | grep " $v0 " | wc -l`

    set iscomment=`echo $v0 | cut -c 1` 

    if ( "${iscomment}" != "#" ) then 

         if ( $flag == 0 ) then

           echo " ERROR: variable $v listed in $tvfile is not on the $tfil[1]-files ***"

           exit 1

         endif

    endif

  endif

  shift calf

  shift tfil

end

set ntrace=${nlines} 

# ---------------------------------------------------------------------

# Prepare input file for trace and run it

# ---------------------------------------------------------------------

# Set times relative to the reference date

if ( "${changet}" == "true" ) then

  echo

  echo '---- CHANGE TIMES ON DATA FILES  ------------------------'

  echo   

  foreach i ( $datfiles )

    ${LAGRANTO}/goodies/changet.sh ${refdate} ${charp}${i}

  end

  if ( ${sfiles} == 1 ) then

    foreach i ( $datfiles )

      ${LAGRANTO}/goodies/changet.sh ${refdate} ${chars}${i}

    end

  endif

endif

# ---------------------------------------------------------------------

# Prepare input file for trace and run it

# ---------------------------------------------------------------------

# Write parameter file

\rm -f ${parfile}

touch ${parfile}

echo $inpfile                                              >> $parfile

echo $outfile                                              >> $parfile    

echo $startdate                                            >> $parfile

echo $enddate                                              >> $parfile

echo $idir                                                 >> $parfile

echo $numfiles                                             >> $parfile

foreach i ( $datfiles )

  echo $i                                                  >> $parfile

end

echo $timeinc                                              >> $parfile

echo $tstart                                               >> $parfile

echo $tend                                                 >> $parfile

echo $ntra                                                 >> $parfile

echo $ntim                                                 >> $parfile

echo $ncol                                                 >> $parfile

echo $ntrace                                               >> $parfile

cat ${tvfile}                                              >> $parfile

${LAGRANTO}/goodies/getvars ${charp}$datfiles[1] | wc -l   >> $parfile

${LAGRANTO}/goodies/getvars ${charp}$datfiles[1]           >> $parfile

if ( $sfiles == 1 ) then

  ${LAGRANTO}/goodies/getvars ${chars}$datfiles[1] | wc -l >> $parfile

  ${LAGRANTO}/goodies/getvars ${chars}$datfiles[1]         >> $parfile

else

  echo 0                                                   >> $parfile

endif

echo \"${timecheck}\"                                      >> $parfile

# Finish the preprocessor

echo 

echo '       *** END OF PREPROCESSOR TRACE ***              '

echo '========================================================='

echo

# Run  trace

${prog}

if ( "${status}" != "0" ) then

  echo "ERROR:  Program <trace> failed"

  exit 1

endif

# ---------------------------------------------------------------------

# Final tasks (make clean)

# ---------------------------------------------------------------------

finish:

if ( "${noclean}" == "false" ) then

  \rm -f ${parfile}

endif

exit 0