exglobal_enkf_sfc.sh

#! /usr/bin/env bash

################################################################################
####  UNIX Script Documentation Block
#                      .                                             .
# Script name:         exgdas_enkf_sfc.sh
# Script description:  generate ensemble surface analyses on tiles
#
# Author:        Rahul Mahajan      Org: NCEP/EMC     Date: 2017-03-02
#
# Abstract: This script generates ensemble surface analyses on tiles
#
# $Id$
#
# Attributes:
#   Language: POSIX shell
#
################################################################################

# Directories.
pwd=$(pwd)

# Base variables
DONST=${DONST:-"NO"}
DO_GSISOILDA=${DO_GSISOILDA:-"NO"}
DOSFCANL_ENKF=${DOSFCANL_ENKF:-"YES"}
export CASE=${CASE:-384}
ntiles=${ntiles:-6}

# Utilities
NCLEN=${NCLEN:-${USHgfs}/getncdimlen}

# Scripts

# Executables.

# Files.
OPREFIX=${OPREFIX:-""}
OSUFFIX=${OSUFFIX:-""}
APREFIX=${APREFIX:-""}
APREFIX_ENS=${APREFIX_ENS:-${APREFIX}}
GPREFIX=${GPREFIX:-""}
GPREFIX_ENS=${GPREFIX_ENS:-${GPREFIX}}

# Variables
NMEM_ENS_MAX=${NMEM_ENS:-80}
if [[ "${RUN}" == "enkfgfs" ]]; then
    NMEM_ENS=${NMEM_ENS_GFS:-30}
    ec_offset=${NMEM_ENS_GFS_OFFSET:-20}
    mem_offset=$((ec_offset * cyc / 6))
else
    NMEM_ENS=${NMEM_ENS:-80}
    mem_offset=0
fi
DOIAU=${DOIAU_ENKF:-"NO"}

# Global_cycle stuff
CYCLESH=${CYCLESH:-${USHgfs}/global_cycle.sh}
REGRIDSH=${REGRIDSH:-"${USHgfs}/regrid_gsiSfcIncr_to_tile.sh"}
export CYCLEXEC=${CYCLEXEC:-${EXECgfs}/global_cycle}
APRUN_CYCLE=${APRUN_CYCLE:-${APRUN:-""}}
NTHREADS_CYCLE=${NTHREADS_CYCLE:-${NTHREADS:-1}}
export CYCLVARS=${CYCLVARS:-"FSNOL=-2.,FSNOS=99999.,"}
export FHOUR=${FHOUR:-0}
export DELTSFC=${DELTSFC:-6}
export COUPLED=${COUPLED:-".false."}

APRUN_ESFC=${APRUN_ESFC:-${APRUN:-""}}
NTHREADS_ESFC=${NTHREADS_ESFC:-${NTHREADS:-1}}

################################################################################
# Update surface fields in the FV3 restart's using global_cycle.

# Ignore possible spelling error (nothing is misspelled)
# shellcheck disable=SC2153
BDATE=$(date --utc +%Y%m%d%H -d "${PDY} ${cyc} - 3 hours")
bPDY=${BDATE:0:8}
bcyc=${BDATE:8:2}

# Get dimension information based on CASE
res=${CASE:1}
JCAP_CASE=$((res * 2 - 2))
LATB_CASE=$((res * 2))
LONB_CASE=$((res * 4))

# Global cycle requires these files
export FNTSFA=${FNTSFA:-'                  '}
export FNACNA=${FNACNA:-${COMIN_OBS}/${OPREFIX}seaice.5min.blend.grb}
export FNSNOA=${FNSNOA:-${COMIN_OBS}/${OPREFIX}snogrb_t${JCAP_CASE}.${LONB_CASE}.${LATB_CASE}}
# Check if resolution specific FNSNOA exists, if not use t1534 version
if [[ ! -f "${FNSNOA}" ]]; then
    export FNSNOA="${COMIN_OBS}/${OPREFIX}snogrb_t1534.3072.1536"
fi
if [[ ! -f "${FNSNOA}" ]]; then
    echo "WARNING: Current cycle snow file ${FNSNOA} is missing. Snow coverage will not be updated."
else
    echo "INFO: Current cycle snow file is ${FNSNOA}"
fi
export FNSNOG=${FNSNOG:-${COMIN_OBS_PREV}/${GPREFIX}snogrb_t${JCAP_CASE}.${LONB_CASE}.${LATB_CASE}}
# Check if resolution specific FNSNOG exists, if not use t1534 version
if [[ ! -f "${FNSNOG}" ]]; then
    export FNSNOG="${COMIN_OBS_PREV}/${GPREFIX}snogrb_t1534.3072.1536"
fi
if [[ ! -f "${FNSNOG}" ]]; then
    echo "WARNING: Previous cycle snow file ${FNSNOG} is missing. Snow coverage will not be updated."
else
    echo "INFO: Previous cycle snow file is ${FNSNOG}"
fi

# If any snow files are missing, don't apply snow in the global_cycle step.
if [[ ! -f "${FNSNOA}" || ! -f "${FNSNOG}" ]]; then
    export FNSNOA=" "
    export CYCLVARS="FSNOL=99999.,FSNOS=99999.,"
else
    # Set CYCLVARS by checking grib date of current snogrb vs that of prev cycle
    snoa_count=$("${WGRIB}" -4yr "${FNSNOA}" 2> /dev/null | grep -i snowc | awk -F: '{print $3}' | awk -F= '{print $2}')
    snog_count=$("${WGRIB}" -4yr "${FNSNOG}" 2> /dev/null | grep -i snowc | awk -F: '{print $3}' | awk -F= '{print $2}')
    if [[ ${snoa_count} -le ${snog_count} ]]; then
        export FNSNOA=" "
        export CYCLVARS="FSNOL=99999.,FSNOS=99999.,"
    else
        export SNOW_NUDGE_COEFF=${SNOW_NUDGE_COEFF:-0.}
        export CYCLVARS="FSNOL=${SNOW_NUDGE_COEFF},${CYCLVARS}"
    fi
fi

if [[ "${DONST}" == "YES" ]]; then
    export NST_FILE=${NST_FILE:-${COMIN_ATMOS_ANALYSIS_DET}/${APREFIX}increment.dtf.i006.nc}
else
    export NST_FILE="NULL"
fi

# regrid the surface increment files
if [[ "${DO_GSISOILDA}" == "YES" ]]; then

    export CASE_IN=${CASE_ENS}
    export CASE_OUT=${CASE_ENS}
    export OCNRES_OUT=${OCNRES}
    export NMEM_REGRID=${NMEM_ENS}
    if [[ "${DOIAU}" == "YES" ]]; then
        export LFHR=3 # match BDATE
    else              # DOSFCANL_ENKF
        export LFHR=6 # PDYcyc
    fi

    "${REGRIDSH}" && true
    export err=$?
    if [[ ${err} -ne 0 ]]; then
        err_exit "Failed to regrid the surface inrement file!"
    fi

fi

export APRUNCY=${APRUN_CYCLE:-${APRUN_ESFC}}
export OMP_NUM_THREADS_CY=${NTHREADS_CYCLE:-${NTHREADS_ESFC}}
export MAX_TASKS_CY=${NMEM_ENS}

if [[ "${DOIAU}" == "YES" ]]; then
    # Update surface restarts at beginning of window when IAU is ON
    # For now assume/hold increment.dtf.nc is valid at beginning of window.

    for n in $(seq 1 "${ntiles}"); do

        export TILE_NUM=${n}

        # Copy inputs from COMIN to DATA
        for imem in $(seq 1 "${NMEM_ENS}"); do
            smem=$((imem + mem_offset))
            if ((smem > NMEM_ENS_MAX)); then
                smem=$((smem - NMEM_ENS_MAX))
            fi
            gmemchar="mem"$(printf %03i "${smem}")
            cmem=$(printf %03i "${imem}")
            memchar="mem${cmem}"

            declare -x COMOUT_ATMOS_RESTART_MEM=${ROTDIR}/${RUN}.${PDY}/${cyc}/${memchar}/model/atmos/restart

            declare -x COMIN_ATMOS_RESTART_MEM_PREV=${ROTDIR}/${GDUMP_ENS}.${gPDY}/${gcyc}/${gmemchar}/model/atmos/restart

            declare -x COMIN_ATMOS_ANALYSIS_MEM=${ROTDIR}/${RUN}.${PDY}/${cyc}/${memchar}/analysis/atmos

            declare -x COMIN_SNOW_ANALYSIS_MEM=${ROTDIR}/${RUN}.${PDY}/${cyc}/${memchar}/analysis/snow

            # determine where the input snow restart files come from
            snow_prefix=""
            if [[ "${DO_JEDISNOWDA:-}" == "YES" ]]; then
                sfcdata_dir="${COMIN_SNOW_ANALYSIS_MEM}"
                snow_prefix="snow_analysis."
            else
                sfcdata_dir="${COMIN_ATMOS_RESTART_MEM_PREV}"
            fi

            if [[ ${TILE_NUM} -eq 1 ]]; then
                mkdir -p "${COMOUT_ATMOS_RESTART_MEM}"
            fi
            cpreq "${sfcdata_dir}/${bPDY}.${bcyc}0000.${snow_prefix}sfc_data.tile${n}.nc" \
                "${DATA}/fnbgsi.${cmem}"
            cpreq "${DATA}/fnbgsi.${cmem}" "${DATA}/fnbgso.${cmem}"
            cpreq "${FIXgfs}/orog/${CASE}/${CASE}_grid.tile${n}.nc" "${DATA}/fngrid.${cmem}"
            cpreq "${FIXgfs}/orog/${CASE}/${CASE}.mx${OCNRES}_oro_data.tile${n}.nc" "${DATA}/fnorog.${cmem}"

            if [[ "${DO_GSISOILDA}" == "YES" ]] && [[ "${GCYCLE_DO_SOILINCR}" == ".true." ]]; then
                cpreq "${COMIN_ATMOS_ANALYSIS_MEM}/increment.sfc.i00${LFHR}.tile${n}.nc" \
                    "${DATA}/soil_xainc.${cmem}"
            fi

        done # ensembles

        export gcycle_date="${bPDY}${bcyc}"

        "${CYCLESH}" && true
        export err=$?
        if [[ ${err} -ne 0 ]]; then
            err_exit "Failed to update surface fields!"
        fi

        # Copy outputs from DATA to COMOUT
        for imem in $(seq 1 "${NMEM_ENS}"); do
            smem=$((imem + mem_offset))
            if ((smem > NMEM_ENS_MAX)); then
                smem=$((smem - NMEM_ENS_MAX))
            fi
            gmemchar="mem"$(printf %03i "${smem}")
            cmem=$(printf %03i "${imem}")
            memchar="mem${cmem}"

            declare -x COMOUT_ATMOS_RESTART_MEM=${ROTDIR}/${RUN}.${PDY}/${cyc}/${memchar}/model/atmos/restart

            if [[ ${TILE_NUM} -eq 1 ]]; then
                mkdir -p "${COMOUT_ATMOS_RESTART_MEM}"
            fi

            cpfs "${DATA}/fnbgso.${cmem}" "${COMOUT_ATMOS_RESTART_MEM}/${bPDY}.${bcyc}0000.sfcanl_data.tile${n}.nc"

        done # ensembles

    done

fi

if [[ "${DOSFCANL_ENKF}" == "YES" ]]; then
    for n in $(seq 1 "${ntiles}"); do

        export TILE_NUM=${n}

        # Copy inputs from COMIN to DATA
        for imem in $(seq 1 "${NMEM_ENS}"); do
            smem=$((imem + mem_offset))
            if ((smem > NMEM_ENS_MAX)); then
                smem=$((smem - NMEM_ENS_MAX))
            fi
            gmemchar="mem"$(printf %03i "${smem}")
            cmem=$(printf %03i "${imem}")
            memchar="mem${cmem}"

            declare -x COMIN_SNOW_ANALYSIS_MEM=${ROTDIR}/${GDUMP_ENS}.${PDY}/${cyc}/${gmemchar}/analysis/snow

            declare -x COMIN_ATMOS_RESTART_MEM_PREV=${ROTDIR}/${GDUMP_ENS}.${gPDY}/${gcyc}/${gmemchar}/model/atmos/restart

            declare -x COMIN_ATMOS_ANALYSIS_MEM=${ROTDIR}/${RUN}.${PDY}/${cyc}/${memchar}/analysis/atmos

            # determine where the input snow restart files come from
            snow_prefix=""
            if [[ "${DO_JEDISNOWDA:-}" == "YES" ]]; then
                sfcdata_dir="${COMIN_SNOW_ANALYSIS_MEM}"
                snow_prefix="snow_analysis."
            else
                sfcdata_dir="${COMIN_ATMOS_RESTART_MEM_PREV}"
            fi

            cpreq "${sfcdata_dir}/${PDY}.${cyc}0000.${snow_prefix}sfc_data.tile${n}.nc" \
                "${DATA}/fnbgsi.${cmem}"
            cpreq "${DATA}/fnbgsi.${cmem}" "${DATA}/fnbgso.${cmem}"
            cpreq "${FIXgfs}/orog/${CASE}/${CASE}_grid.tile${n}.nc" "${DATA}/fngrid.${cmem}"
            cpreq "${FIXgfs}/orog/${CASE}/${CASE}.mx${OCNRES}_oro_data.tile${n}.nc" "${DATA}/fnorog.${cmem}"

            if [[ "${DO_GSISOILDA}" == "YES" ]] && [[ "${GCYCLE_DO_SOILINCR}" == ".true." ]]; then
                cpreq "${COMIN_ATMOS_ANALYSIS_MEM}/${APREFIX}increment.sfc.i00${LFHR}.tile${n}.nc" \
                    "${DATA}/soil_xainc.${cmem}"
            fi
        done

        export gcycle_date="${PDY}${cyc}"

        "${CYCLESH}" && true
        export err=$?
        if [[ ${err} -ne 0 ]]; then
            err_exit "Failed to update surface increment!"
        fi

        # Copy outputs from DATA to COMOUT
        for imem in $(seq 1 "${NMEM_ENS}"); do
            smem=$((imem + mem_offset))
            if ((smem > NMEM_ENS_MAX)); then
                smem=$((smem - NMEM_ENS_MAX))
            fi
            gmemchar="mem"$(printf %03i "${smem}")
            cmem=$(printf %03i "${imem}")
            memchar="mem${cmem}"

            declare -x COMOUT_ATMOS_RESTART_MEM=${ROTDIR}/${RUN}.${PDY}/${cyc}/${memchar}/model/atmos/restart

            if [[ ! -d "${COMOUT_ATMOS_RESTART_MEM}" ]]; then
                mkdir -p "${COMOUT_ATMOS_RESTART_MEM}"
            fi

            cpfs "${DATA}/fnbgso.${cmem}" "${COMOUT_ATMOS_RESTART_MEM}/${PDY}.${cyc}0000.sfcanl_data.tile${n}.nc"

        done

    done
fi

################################################################################

################################################################################
# Postprocessing
cd "${pwd}" || exit 1

exit "${err}"