diff --git a/README.md b/README.md index ca67329a4..e9d5c46e4 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ directory): - sfc_climo_gen - vcoord_gen -The reg_tests directory contains the regression test code. +The reg_tests directory contains the consistency test code. The fix directory is where we set links to directories containing large, static data files used by UFS_UTILS programs. @@ -96,7 +96,7 @@ create a model grid on officially supported HPC platforms. The modulefiles directory contains modules loaded when building UFS_UTILS on supported HPC platforms. They are also loaded at runtime -by utility and regression test scripts. +by utility and consistency test scripts. The docs directory contains the control file for the doxygen documentation build, as well as some markdown files which are part of diff --git a/reg_tests/chgres_cube/README b/reg_tests/chgres_cube/README index bf7ca728d..424accd4b 100644 --- a/reg_tests/chgres_cube/README +++ b/reg_tests/chgres_cube/README @@ -1,9 +1,9 @@ -This series of regression tests must be run before any +This series of consistency tests must be run before any changes to the chgres_cube program are merged to the main line of development. Any test failures must be resolved or explained before merging. -To run the regression tests: +To run the consistency tests: 1) Build chgres_cube program. Go to ./sorc and invoke 'build_all.sh' with no arguments. diff --git a/reg_tests/chgres_cube/driver.hera.sh b/reg_tests/chgres_cube/driver.hera.sh index cbabc7b36..9e8c567a1 100755 --- a/reg_tests/chgres_cube/driver.hera.sh +++ b/reg_tests/chgres_cube/driver.hera.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run the chgres_cube regression tests on Hera. +# Run the chgres_cube consistency tests on Hera. # # Set OUTDIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. To see which projects you are authorized to use, # type "account_params". # # Invoke the script with no arguments. A series of daily-chained -# regression tests will be submitted. To check the queue, type: +# consistency tests will be submitted. To check the queue, type: # "squeue -u USERNAME". # # The run output will be stored in OUTDIR. Log output from the suite @@ -47,7 +47,7 @@ export HOMEufs=$PWD/../.. export HOMEreg=/scratch1/NCEPDEV/da/George.Gayno/noscrub/reg_tests/chgres_cube -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log rm -f $LOG_FILE $SUM_FILE diff --git a/reg_tests/chgres_cube/driver.jet.sh b/reg_tests/chgres_cube/driver.jet.sh index 2d2c5f373..f2a29855b 100755 --- a/reg_tests/chgres_cube/driver.jet.sh +++ b/reg_tests/chgres_cube/driver.jet.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run the chgres_cube regression tests on JET. +# Run the chgres_cube consistency tests on JET. # # Set OUTDIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. To see which projects you are authorized to use, @@ -45,7 +45,7 @@ export HOMEufs=$PWD/../.. export HOMEreg=/lfs4/HFIP/emcda/George.Gayno/reg_tests/chgres_cube -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log rm -f $LOG_FILE $SUM_FILE diff --git a/reg_tests/chgres_cube/driver.orion.sh b/reg_tests/chgres_cube/driver.orion.sh index 67d8e0d78..6bda8fb46 100755 --- a/reg_tests/chgres_cube/driver.orion.sh +++ b/reg_tests/chgres_cube/driver.orion.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run the chgres_cube regression tests on Orion. +# Run the chgres_cube consistency tests on Orion. # # Set OUTDIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. To see which projects you are authorized to use, # type "saccount_params". # # Invoke the script with no arguments. A series of daily-chained -# regression tests will be submitted. To check the queue, type: +# consistency tests will be submitted. To check the queue, type: # "squeue -u $LOGNAME". # # The run output will be stored in OUTDIR. Log output from the suite @@ -47,7 +47,7 @@ export HOMEufs=$PWD/../.. export HOMEreg=/work/noaa/da/ggayno/save/ufs_utils.git/reg_tests/chgres_cube -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log rm -f $LOG_FILE $SUM_FILE diff --git a/reg_tests/chgres_cube/driver.wcoss_cray.sh b/reg_tests/chgres_cube/driver.wcoss_cray.sh index 2042c2d83..e5efc70a1 100755 --- a/reg_tests/chgres_cube/driver.wcoss_cray.sh +++ b/reg_tests/chgres_cube/driver.wcoss_cray.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run the chgres_cube regression tests on WCOSS-Cray. +# Run the chgres_cube consistency tests on WCOSS-Cray. # # Set OUTDIR to your working directory. Set the PROJECT_CODE and QUEUE as # appropriate. @@ -43,7 +43,7 @@ export HOMEufs=$PWD/../.. export HOMEreg=/gpfs/hps3/emc/global/noscrub/George.Gayno/ufs_utils.git/reg_tests/chgres_cube -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log diff --git a/reg_tests/chgres_cube/driver.wcoss_dell_p3.sh b/reg_tests/chgres_cube/driver.wcoss_dell_p3.sh index 3449925bd..8a77c9ac2 100755 --- a/reg_tests/chgres_cube/driver.wcoss_dell_p3.sh +++ b/reg_tests/chgres_cube/driver.wcoss_dell_p3.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run the chgres_cube regression tests on WCOSS-Dell. +# Run the chgres_cube consistency tests on WCOSS-Dell. # # Set OUTDIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. @@ -43,7 +43,7 @@ export HOMEufs=$PWD/../.. export HOMEreg=/gpfs/dell2/emc/modeling/noscrub/George.Gayno/ufs_utils.git/reg_tests/chgres_cube -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log diff --git a/reg_tests/global_cycle/driver.hera.sh b/reg_tests/global_cycle/driver.hera.sh index 1828ad1b2..31b676b1e 100755 --- a/reg_tests/global_cycle/driver.hera.sh +++ b/reg_tests/global_cycle/driver.hera.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run global_cycle regression test on Hera. +# Run global_cycle consistency test on Hera. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline files @@ -21,8 +21,8 @@ #SBATCH -J cycle_reg_test #SBATCH -A fv3-cpu #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --nodes=1 --ntasks-per-node=6 #SBATCH -q debug #SBATCH -t 00:05:00 diff --git a/reg_tests/global_cycle/driver.jet.sh b/reg_tests/global_cycle/driver.jet.sh index e55da2636..6d8147176 100755 --- a/reg_tests/global_cycle/driver.jet.sh +++ b/reg_tests/global_cycle/driver.jet.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run global_cycle regression test on Jet. +# Run global_cycle consistency test on Jet. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline files @@ -21,8 +21,8 @@ #SBATCH -J cycle_reg_test #SBATCH -A emcda #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --nodes=1 --ntasks-per-node=6 #SBATCH --partition=xjet #SBATCH -q windfall diff --git a/reg_tests/global_cycle/driver.orion.sh b/reg_tests/global_cycle/driver.orion.sh index b84abae19..33bdfa463 100755 --- a/reg_tests/global_cycle/driver.orion.sh +++ b/reg_tests/global_cycle/driver.orion.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run global_cycle regression test on Orion. +# Run global_cycle consistency test on Orion. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline files @@ -21,8 +21,8 @@ #SBATCH -J cycle_reg_test #SBATCH -A fv3-cpu #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --nodes=1 --ntasks-per-node=6 #SBATCH -q debug #SBATCH -t 00:05:00 diff --git a/reg_tests/grid_gen/driver.hera.sh b/reg_tests/grid_gen/driver.hera.sh index 5810b40e2..d931f82f9 100755 --- a/reg_tests/grid_gen/driver.hera.sh +++ b/reg_tests/grid_gen/driver.hera.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run grid generation regression tests on Hera. +# Run grid generation consistency tests on Hera. # # Set WORK_DIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. To see which projects you are authorized to use, @@ -39,7 +39,7 @@ PROJECT_CODE="${PROJECT_CODE:-fv3-cpu}" # Should not have to change anything below here. #----------------------------------------------------------------------------- -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log export home_dir=$PWD/../.. export APRUN=time diff --git a/reg_tests/grid_gen/driver.jet.sh b/reg_tests/grid_gen/driver.jet.sh index afae062e5..14d92c3c7 100755 --- a/reg_tests/grid_gen/driver.jet.sh +++ b/reg_tests/grid_gen/driver.jet.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run grid generation regression tests on Jet. +# Run grid generation consistency tests on Jet. # # Set WORK_DIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. To see which projects you are authorized to use, @@ -37,7 +37,7 @@ export WORK_DIR="${WORK_DIR}/reg-tests/grid-gen" # Should not have to change anything below here. #----------------------------------------------------------------------------- -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log export home_dir=$PWD/../.. export APRUN=time diff --git a/reg_tests/grid_gen/driver.orion.sh b/reg_tests/grid_gen/driver.orion.sh index e93ec5ba9..86d37ceb4 100755 --- a/reg_tests/grid_gen/driver.orion.sh +++ b/reg_tests/grid_gen/driver.orion.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run grid generation regression tests on Orion. +# Run grid generation consistency tests on Orion. # # Set WORK_DIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. To see which projects you are authorized to use, @@ -38,7 +38,7 @@ PROJECT_CODE=${PROJECT_CODE:-fv3-cpu} # Should not have to change anything below here. #----------------------------------------------------------------------------- -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log export home_dir=$PWD/../.. export APRUN=time diff --git a/reg_tests/grid_gen/driver.wcoss_cray.sh b/reg_tests/grid_gen/driver.wcoss_cray.sh index 1aaf19f5d..23e4cb09e 100755 --- a/reg_tests/grid_gen/driver.wcoss_cray.sh +++ b/reg_tests/grid_gen/driver.wcoss_cray.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run grid generation regression tests on WCOSS-Cray. +# Run grid generation consistency tests on WCOSS-Cray. # # Set WORK_DIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. @@ -36,7 +36,7 @@ export WORK_DIR="${WORK_DIR}/reg-tests/grid-gen" #----------------------------------------------------------------------------- export home_dir=$PWD/../.. -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log export APRUN="aprun -n 1 -N 1 -j 1 -d 1 -cc depth" export APRUN_SFC="aprun -j 1 -n 24 -N 24" diff --git a/reg_tests/grid_gen/driver.wcoss_dell_p3.sh b/reg_tests/grid_gen/driver.wcoss_dell_p3.sh index 8961c90c5..adc7aeaf7 100755 --- a/reg_tests/grid_gen/driver.wcoss_dell_p3.sh +++ b/reg_tests/grid_gen/driver.wcoss_dell_p3.sh @@ -2,7 +2,7 @@ #----------------------------------------------------------------------------- # -# Run grid generation regression tests on WCOSS-Dell. +# Run grid generation consistency tests on WCOSS-Dell. # # Set WORK_DIR to your working directory. Set the PROJECT_CODE and QUEUE # as appropriate. @@ -35,7 +35,7 @@ export WORK_DIR="${WORK_DIR}/reg-tests/grid-gen" # Should not have to change anything below here. #----------------------------------------------------------------------------- -LOG_FILE=regression.log +LOG_FILE=consistency.log SUM_FILE=summary.log export home_dir=$PWD/../.. export APRUN=time diff --git a/reg_tests/ice_blend/driver.hera.sh b/reg_tests/ice_blend/driver.hera.sh index 0fd03dc47..3b7d9c4da 100755 --- a/reg_tests/ice_blend/driver.hera.sh +++ b/reg_tests/ice_blend/driver.hera.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run ice_blend regression test on Hera. +# Run ice_blend consistency test on Hera. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -21,8 +21,8 @@ #SBATCH -J ice_blend #SBATCH -A fv3-cpu #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --ntasks=1 #SBATCH -q debug #SBATCH -t 00:03:00 diff --git a/reg_tests/ice_blend/driver.jet.sh b/reg_tests/ice_blend/driver.jet.sh index 446df2f14..f11191bfb 100755 --- a/reg_tests/ice_blend/driver.jet.sh +++ b/reg_tests/ice_blend/driver.jet.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run ice_blend regression test on Jet. +# Run ice_blend consistency test on Jet. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -23,8 +23,8 @@ #SBATCH --time 0:01 #SBATCH --account=emcda #SBATCH --job-name=ice_blnd -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log set -x diff --git a/reg_tests/ice_blend/driver.orion.sh b/reg_tests/ice_blend/driver.orion.sh index ddb1459af..73d917ea2 100755 --- a/reg_tests/ice_blend/driver.orion.sh +++ b/reg_tests/ice_blend/driver.orion.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run ice_blend regression test on Orion. +# Run ice_blend consistency test on Orion. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -21,8 +21,8 @@ #SBATCH -J ice_blend #SBATCH -A fv3-cpu #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --ntasks=1 #SBATCH -q debug #SBATCH -t 00:03:00 diff --git a/reg_tests/ice_blend/driver.wcoss_cray.sh b/reg_tests/ice_blend/driver.wcoss_cray.sh index e5ff611e7..7556b9b55 100755 --- a/reg_tests/ice_blend/driver.wcoss_cray.sh +++ b/reg_tests/ice_blend/driver.wcoss_cray.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run ice_blend regression test on WCOSS-Cray. +# Run ice_blend consistency test on WCOSS-Cray. # # Set $DATA to your working directory. Set the project code (BSUB -P) # and queue (BSUB -q) as appropriate. # # Invoke the script as follows: cat $script | bsub # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log. # # The test fails when its output does not match the baseline file @@ -19,8 +19,8 @@ #----------------------------------------------------------------------------- #BSUB -W 0:02 -#BSUB -o regression.log -#BSUB -e regression.log +#BSUB -o consistency.log +#BSUB -e consistency.log #BSUB -J iceb_regt #BSUB -q debug #BSUB -R "rusage[mem=2000]" diff --git a/reg_tests/ice_blend/driver.wcoss_dell_p3.sh b/reg_tests/ice_blend/driver.wcoss_dell_p3.sh index 90b3c3630..2d91a3417 100755 --- a/reg_tests/ice_blend/driver.wcoss_dell_p3.sh +++ b/reg_tests/ice_blend/driver.wcoss_dell_p3.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run ice_blend regression test on WCOSS-Dell. +# Run ice_blend consistency test on WCOSS-Dell. # # Set $DATA to your working directory. Set the project code (BSUB -P) # and queue (BSUB -q) as appropriate. # # Invoke the script as follows: cat $script | bsub # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -19,8 +19,8 @@ #----------------------------------------------------------------------------- #BSUB -W 0:02 -#BSUB -o regression.log -#BSUB -e regression.log +#BSUB -o consistency.log +#BSUB -e consistency.log #BSUB -J iceb_regt #BSUB -q debug #BSUB -R "affinity[core(1)]" diff --git a/reg_tests/ice_blend/ice_blend.sh b/reg_tests/ice_blend/ice_blend.sh index 94c9e846a..b1c193ca3 100755 --- a/reg_tests/ice_blend/ice_blend.sh +++ b/reg_tests/ice_blend/ice_blend.sh @@ -1,7 +1,7 @@ #!/bin/bash #----------------------------------------------------------------------------- -# Run ice_blend regression test. This script called from it machine-specific +# Run ice_blend consistency test. This script called from it machine-specific # driver script. #----------------------------------------------------------------------------- diff --git a/reg_tests/rt.sh b/reg_tests/rt.sh index 342e96cec..2c3eadb43 100755 --- a/reg_tests/rt.sh +++ b/reg_tests/rt.sh @@ -4,7 +4,7 @@ ulimit -s unlimited export MAILTO= -# Directory to download UFS_UTILS to and run the regression tests +# Directory to download UFS_UTILS to and run the consistency tests export WORK_DIR= export PROJECT_CODE= @@ -76,7 +76,7 @@ for dir in chgres_cube grid_gen; do sleep 10 sleep_time=$((sleep_time+10)) if (( sleep_time > TIMEOUT_LIMIT )); then - mail -s "UFS_UTILS Regression Tests timed out on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt + mail -s "UFS_UTILS Consistency Tests timed out on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt exit 1 fi done @@ -104,7 +104,7 @@ for dir in snow2mdl global_cycle ice_blend; do sleep 10 sleep_time=$((sleep_time+10)) if (( sleep_time > TIMEOUT_LIMIT )); then - mail -s "UFS_UTILS Regression Tests timed out on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt + mail -s "UFS_UTILS Consistency Tests timed out on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt exit 1 fi done @@ -119,16 +119,16 @@ for dir in chgres_cube grid_gen global_cycle ice_blend snow2mdl; do success=true if grep -qi "FAILED" ${dir}/summary.log; then success=false - echo "${dir} regression tests FAILED" >> ${WORK_DIR}/reg_test_results.txt + echo "${dir} consistency tests FAILED" >> ${WORK_DIR}/reg_test_results.txt else - echo "${dir} regression tests PASSED" >> ${WORK_DIR}/reg_test_results.txt + echo "${dir} consistency tests PASSED" >> ${WORK_DIR}/reg_test_results.txt fi done if [[ "$success" == true ]]; then - mail -s "UFS_UTILS Regression Tests PASSED on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt + mail -s "UFS_UTILS Consistency Tests PASSED on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt else - mail -s "UFS_UTILS Regression Tests FAILED on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt + mail -s "UFS_UTILS Consistency Tests FAILED on ${target}" ${MAILTO} < ${WORK_DIR}/reg_test_results.txt fi # Save current hash as previous hash for next time diff --git a/reg_tests/snow2mdl/driver.hera.sh b/reg_tests/snow2mdl/driver.hera.sh index f2710a0b8..9885f0ac9 100755 --- a/reg_tests/snow2mdl/driver.hera.sh +++ b/reg_tests/snow2mdl/driver.hera.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run snow2mdl regression test on Hera. +# Run snow2mdl consistency test on Hera. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -21,8 +21,8 @@ #SBATCH -J snow #SBATCH -A fv3-cpu #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --ntasks=1 #SBATCH -q debug #SBATCH -t 00:03:00 diff --git a/reg_tests/snow2mdl/driver.jet.sh b/reg_tests/snow2mdl/driver.jet.sh index 22b867b52..2b8345b97 100755 --- a/reg_tests/snow2mdl/driver.jet.sh +++ b/reg_tests/snow2mdl/driver.jet.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run snow2mdl regression test on Jet. +# Run snow2mdl consistency test on Jet. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -23,8 +23,8 @@ #SBATCH --time 0:01 #SBATCH --account=emcda #SBATCH --job-name=snow2mdl -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log set -x diff --git a/reg_tests/snow2mdl/driver.orion.sh b/reg_tests/snow2mdl/driver.orion.sh index 993d479cf..e4c707eaa 100755 --- a/reg_tests/snow2mdl/driver.orion.sh +++ b/reg_tests/snow2mdl/driver.orion.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run snow2mdl regression test on Orion. +# Run snow2mdl consistency test on Orion. # # Set $DATA to your working directory. Set the project code (SBATCH -A) # and queue (SBATCH -q) as appropriate. # # Invoke the script as follows: sbatch $script # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -21,8 +21,8 @@ #SBATCH -J snow #SBATCH -A fv3-cpu #SBATCH --open-mode=truncate -#SBATCH -o regression.log -#SBATCH -e regression.log +#SBATCH -o consistency.log +#SBATCH -e consistency.log #SBATCH --ntasks=1 #SBATCH -q debug #SBATCH -t 00:03:00 diff --git a/reg_tests/snow2mdl/driver.wcoss_cray.sh b/reg_tests/snow2mdl/driver.wcoss_cray.sh index e62cc6816..197ecb161 100755 --- a/reg_tests/snow2mdl/driver.wcoss_cray.sh +++ b/reg_tests/snow2mdl/driver.wcoss_cray.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run snow2mdl regression test on WCOSS-Cray. +# Run snow2mdl consistency test on WCOSS-Cray. # # Set $DATA to your working directory. Set the project code (BSUB -P) # and queue (BSUB -q) as appropriate. # # Invoke the script as follows: cat $script | bsub # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -19,8 +19,8 @@ #----------------------------------------------------------------------------- #BSUB -W 0:02 -#BSUB -o regression.log -#BSUB -e regression.log +#BSUB -o consistency.log +#BSUB -e consistency.log #BSUB -J s2m_regt #BSUB -q debug #BSUB -R "rusage[mem=2000]" diff --git a/reg_tests/snow2mdl/driver.wcoss_dell_p3.sh b/reg_tests/snow2mdl/driver.wcoss_dell_p3.sh index 1e9f396a7..0f315d391 100755 --- a/reg_tests/snow2mdl/driver.wcoss_dell_p3.sh +++ b/reg_tests/snow2mdl/driver.wcoss_dell_p3.sh @@ -2,14 +2,14 @@ #----------------------------------------------------------------------------- # -# Run snow2mdl regression test on WCOSS-Dell. +# Run snow2mdl consistency test on WCOSS-Dell. # # Set $DATA to your working directory. Set the project code (BSUB -P) # and queue (BSUB -q) as appropriate. # # Invoke the script as follows: cat $script | bsub # -# Log output is placed in regression.log. A summary is +# Log output is placed in consistency.log. A summary is # placed in summary.log # # The test fails when its output does not match the baseline file @@ -19,8 +19,8 @@ #----------------------------------------------------------------------------- #BSUB -W 0:02 -#BSUB -o regression.log -#BSUB -e regression.log +#BSUB -o consistency.log +#BSUB -e consistency.log #BSUB -J s2m_regt #BSUB -q debug #BSUB -R "affinity[core(1)]" diff --git a/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 b/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 index 5bf81b92f..a56d4acb6 100644 --- a/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 +++ b/sorc/grid_tools.fd/filter_topo.fd/filter_topo.F90 @@ -5,7 +5,8 @@ !> This program does ??? !! !! @return 0 for success, error code otherwise. -!! @author GFDL Programmer +!! @author S-J Lin (GFDL) for filtering algorithm(s) +!! @author Zhi Liang (GFDL) who packaged it into a standalone application. program filter_topo diff --git a/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 b/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 index 0bd6c7130..0dceea898 100644 --- a/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 +++ b/sorc/grid_tools.fd/regional_esg_grid.fd/pietc.f90 @@ -53,7 +53,7 @@ module pietc real(dp),parameter:: euler=0.57721566490153286060651209008240243104215933593992359880e0_dp !< Euler-Mascheroni constant. real(dp),parameter:: dtor=pi/180 !< Degrees to radians real(dp),parameter:: rtod=180/pi !< radians to degrees -! Sines of all main fractions of 90 degrees (down to ninths): !< ??? +! Sines of all main fractions of 90 degrees (down to ninths): real(dp),parameter:: s10=.173648177666930348851716626769314796000375677184069387236241e0_dp !< sine(10 deg) real(dp),parameter:: s11=.195090322016128267848284868477022240927691617751954807754502e0_dp !< sine(90/8 deg) real(dp),parameter:: s13=.222520933956314404288902564496794759466355568764544955311987e0_dp !< sine(90/7 deg) diff --git a/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 b/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 index f8ed4293a..e57c4163c 100644 --- a/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 +++ b/sorc/grid_tools.fd/regional_esg_grid.fd/psym2.f90 @@ -26,7 +26,7 @@ module psym2 interface expsym2; module procedure expsym2,expsym2d; end interface interface expsym2d_e; module procedure expsym2d_e; end interface interface expsym2d_t; module procedure expsym2d_t; end interface -interface logsym2; module procedure logsym2,logsym2d; end interface +interface logsym2; module procedure logsym2,logsym2d; end interface interface id2222; module procedure id2222; end interface interface chol2; module procedure chol2; end interface @@ -284,11 +284,11 @@ subroutine expsym2(em,expem)! [expsym2] expem=matmul(vv,matmul(oo,transpose(vv))) end subroutine expsym2 -!> Sub Process for process symmetric 2*2 matrix. +!> Get the exp of a symmetric 2*2 matrix, and its symmetric derivative. !! !! @param[in] x symmetric 2*2 positive-definite matrix -!! @param[out] z ??? -!! @param[out] zd symmetric derivative +!! @param[out] z exp of symmetric 2*2 matrix x +!! @param[out] zd symmetric derivative wrt x of exp of x !! @author R. J. Purser subroutine expsym2d(x,z,zd)! [expsym2] implicit none @@ -306,11 +306,12 @@ subroutine expsym2d(x,z,zd)! [expsym2] z=z*exp(trxh) end subroutine expsym2d -!> Sub Process for process symmetric 2*2 matrix. +!> Get the exponential and its symmetric derivative for a symmetric 2*2 matrix +!! using eigen-decomposition. !! !! @param[in] x symmetric 2*2 positive-definite matrix -!! @param[out] z ??? -!! @param[out] zd symmetric derivative +!! @param[out] z exp of symmetrix matrix x +!! @param[out] zd symmetric derivative of z wrt x !! @author R. J. Purser subroutine expsym2d_e(x,z,zd)! [expsym2d_e] implicit none @@ -429,9 +430,10 @@ subroutine logsym2d(x,z,zd)! [logsym2] zd(:,:,2,1)=zd(:,:,1,2) end subroutine logsym2d -!> General routine for Effective identity. +!> General routine for a symmetrized 4th-rank tensor that acts as +!! an effective identity for operations on symmetric matrices. !! -!! @param[out] em ??? +!! @param[out] em symmetrized effective identity in space of symmetrix matrices. !! @author R. J. Purser subroutine id2222(em)! [id2222] implicit none