#!/bin/bash

########################## BenchEvalFS2D #########################################
#
# author: Frédéric Darboux <Frederic.Darboux@orleans.inra.fr> (2012-2019)
# version: 1.08.01
# date: 2019-04-05
#
# License Cecill-V2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.html>
#
# (c) CNRS - Universite d'Orleans - INRA (France)
#
# This file is part of FullSWOF_2D software.
# <https://sourcesup.renater.fr/projects/fullswof-2d/>
#
# FullSWOF_2D = Full Shallow-Water equations for Overland Flow,
# in two dimensions of space.
# This software is a computer program whose purpose is to compute
# solutions for 2D Shallow-Water equations.
#
# LICENSE
#
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software. You can use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# <http://www.cecill.info>.
#
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
#
##################################################################################

##################################################################################
# The present script "BenchEvalFS2D" helps in benchmarking the results of
# FullSWOF_2D. It computes absolute and relative differences between
# a reference result and a result to be evaluated.
##################################################################################

# To do
# - treat cases with different resolutions

VERSION="1.08.01, 2019-04-05"

# Define output flux
STDERR=2

#to have . as decimal separator and account for exponential notation ("1e-4")
export LC_ALL=C

if [ $# -ne 4 ]
then
  echo "Usage: BenchEvalFS2D Reference_filename Ref_HeaderLength Eval_filename Eval_HeaderLength" >&$STDERR
  echo "Version $VERSION" >&$STDERR
  exit 1;
fi ;

# Define which command for awk
AWK_CMD=gawk
# Define which command for sort
SORT_CMD=sort
# Define which command for cut
CUT_CMD=cut
# Define which command for paste
PASTE_CMD=paste
# Define which command for mktemp
MKTEMP_CMD=mktemp
# Define which command for rm
RM_CMD=rm

### Check for programs
ALLHERE=0
command -v $AWK_CMD >/dev/null 2>&1 || { echo >&2 "Error: program" $AWK_CMD "required but not installed"; ALLHERE=1; }
command -v $SORT_CMD >/dev/null 2>&1 || { echo >&2 "Error: program" $SORT_CMD "required but not installed"; ALLHERE=1; }
command -v $CUT_CMD >/dev/null 2>&1 || { echo >&2 "Error: program" $CUT_CMD "required but not installed"; ALLHERE=1; }
command -v $PASTE_CMD >/dev/null 2>&1 || { echo >&2 "Error: program" $PASTE_CMD "required but not installed"; ALLHERE=1; }
command -v $MKTEMP_CMD >/dev/null 2>&1 || { echo >&2 "Error: program" $MKTEMP_CMD "required but not installed"; ALLHERE=1; }
command -v $RM_CMD >/dev/null 2>&1 || { echo >&2 "Error: program" $RM_CMD "required but not installed"; ALLHERE=1; }
if [ $ALLHERE -eq 1 ] #at least one program missing...
then
 exit 1 ;
fi

# Below which absolute value to consider a float as equal to zero
FLOATEQUALZERO=1e-300

#Define which input file to use
REF_FILE=$1
REF_HEADERLENGTH=$2
EVAL_FILE=$3
EVAL_HEADERLENGTH=$4

#Create temporary files
Ref1Tempfile=$($MKTEMP_CMD Ref1_XXXXXXXX)
Ref2Tempfile=$($MKTEMP_CMD Ref2_XXXXXXXX)
Eval1Tempfile=$($MKTEMP_CMD Eval1_XXXXXXXX)
Eval2Tempfile=$($MKTEMP_CMD Eval2_XXXXXXXX)
Diff1Tempfile=$($MKTEMP_CMD Diff1_XXXXXXXX)
Diff2Tempfile=$($MKTEMP_CMD Diff2_XXXXXXXX)

##function to remove temporary files
function rmtmp(){
$RM_CMD "$Ref1Tempfile" "$Ref2Tempfile" "$Eval1Tempfile" "$Eval2Tempfile" "$Diff1Tempfile" "$Diff2Tempfile"
return 0
}

##function to compute statistics over diff
function computeStats(){
inputfile=$1
modifiedfile=$($MKTEMP_CMD CMPXXXXXXXX)
#nbdiff=NaN
echo -n "$2" ; $AWK_CMD '$1 == "NaN" {i++} END{printf(" nbdiff==NaN %e\n", i)}' "$inputfile"
#suppress NaN and sort file (sorting will help for min, max and median) for scientific numbers
grep -v 'NaN' "$inputfile" | $SORT_CMD -g > "$modifiedfile"
#nbdiff=0
echo -n "$2" ; $AWK_CMD '$1 == 0 {i++} END{printf(" nbdiff==0 %e\n", i)}' "$modifiedfile"
#nbdiff >0
echo -n "$2" ; $AWK_CMD '$1 > 0 {i++} END{printf(" nbdiff>0 %e\n", i)}' "$modifiedfile"
#nbdiff<0
echo -n "$2" ; $AWK_CMD '$1 < 0 {i++} END{printf(" nbdiff<0 %e\n", i)}' "$modifiedfile"
#min and #max
MINMAX=1
if(test "$(wc -l < "$modifiedfile")" -gt 0); then #at least one line in the file
  MIN=$(head -1 "$modifiedfile")
  echo "$2 min $MIN"
  MAX=$(tail -1 "$modifiedfile")
  echo "$2 max $MAX"
else
  MINMAX=0
  echo "$2 min NaN"
  echo "$2 max NaN"
fi
#mean
echo -n "$2" ; $AWK_CMD '{TOTAL+=$1} END{if(NR>0){printf(" mean %e\n", TOTAL/NR)}else{printf(" mean NaN\n")}}' "$modifiedfile"
#median  (since it is sorted, just take the value at the center)
echo -n "$2" ; $AWK_CMD '{count[NR] = $1} END{if(NR>0){if (NR % 2) {median=count[(NR + 1) / 2];} else {median=(count[(NR / 2)] + count[(NR / 2) + 1]) / 2.0} printf(" median %e\n", median)}else{printf(" median NaN\n")}}' "$modifiedfile"
#Norm L1
echo -n "$2" ; $AWK_CMD '{if ($1 < 0) $1 = -$1; TOTAL+=$1} END{if(NR>0){printf(" L1 %e\n", TOTAL/NR)}else{printf(" L1 NaN\n")}}' "$modifiedfile"
#Norm L2
echo -n "$2" ; $AWK_CMD '{TOTAL+=$1*$1} END{if(NR>0){printf(" L2 %e\n", sqrt(TOTAL/NR))}else{printf(" L2 NaN\n")}}' "$modifiedfile"
#Norm Linfinity
if(test "$MINMAX" -ne 0); then #min and max exists
  echo -n "$2" ; $AWK_CMD 'BEGIN{min='$MIN'; max='$MAX'; if(max<0)max=-max; if(min<0)min=-min; if(min>max)max=min; printf(" Linf %e\n", max)}' "$modifiedfile"
else
  echo "$2 Linf NaN"
fi

$RM_CMD "$modifiedfile"
return 0
}


##Remove unuseful lines
#Remove header from Reference solution
$AWK_CMD 'FNR>HEADERLENGTH' HEADERLENGTH="$REF_HEADERLENGTH" "$REF_FILE" > "$Ref1Tempfile"
#Remove empty lines
$AWK_CMD '/./' "$Ref1Tempfile" > "$Ref2Tempfile"

#Remove header from Evaluated solution
$AWK_CMD 'FNR>HEADERLENGTH' HEADERLENGTH="$EVAL_HEADERLENGTH" "$EVAL_FILE" > "$Eval1Tempfile"
#Remove empty lines
$AWK_CMD '/./' "$Eval1Tempfile" > "$Eval2Tempfile"


#check if same number of lines
if (test "$(wc -l < "$Ref2Tempfile")" -ne "$(wc -l < "$Eval2Tempfile")"); then
	echo "Error: Numbers of lines are different." >&"$STDERR";
	rmtmp;
	exit 1;
fi

#extract relevant columns from Reference File
$CUT_CMD -f1-5,10-11 "$Ref2Tempfile"  > "$Ref1Tempfile"
#extract relevant columns from Evaluated File
$CUT_CMD -f1-5,10-11 "$Eval2Tempfile" > "$Eval1Tempfile"

#create a single file
$PASTE_CMD "$Ref1Tempfile" "$Eval1Tempfile" > "$Diff1Tempfile"

#check if Xs and Ys are identical
$AWK_CMD '{if (($1 != $8)||($2 != $9)) {print "Error: X or Y are different at line", FNR, ":", $0; exit 1}}' "$Diff1Tempfile" >&$STDERR
if (test $? -ne 0); then
	echo "Error: Problem while comparing Xs and Ys in the files"  >&$STDERR
	rmtmp;
	exit 1;
fi

#write header in output file

echo    "##############################################################################"
echo    "# Generated by BenchEvalFS2D version $VERSION"
echo    "# on $(date "+%Y-%m-%d %H:%M:%S") ($(id -un)@$(hostname))"
echo -e "# from reference  file (header = $REF_HEADERLENGTH lines): \t$(pwd)/$REF_FILE"
echo -e "# from evaluation file (header = $EVAL_HEADERLENGTH lines): \t$(pwd)/$EVAL_FILE"
echo    "##############################################################################"

##compute differences and statistics
## for h
#difference in m
$AWK_CMD '{print $10-$3}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" DhSI ;
#difference in %
$AWK_CMD '{if($3<-'$FLOATEQUALZERO' || $3>'$FLOATEQUALZERO'){print 100*($10/$3-1)}else{print "NaN"}}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" Dh% ;

##compute differences and statistics
## for u
#difference in m/s
$AWK_CMD '{print $11-$4}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" DuSI ;
#difference in %
$AWK_CMD '{if($4<-'$FLOATEQUALZERO' || $4>'$FLOATEQUALZERO'){print 100*($11/$4-1)}else{print "NaN"}}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" Du% ;

##compute differences and statistics
## for v
#difference in m/s
$AWK_CMD '{print $12-$5}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" DvSI ;
#difference in %
$AWK_CMD '{if($5<-'$FLOATEQUALZERO' || $5>'$FLOATEQUALZERO'){print 100*($12/$5-1)}else{print "NaN"}}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" Dv% ;

##compute differences and statistics
## for qx
#difference in m2/s
$AWK_CMD '{print $13-$6}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" DqxSI ;
#difference in %
$AWK_CMD '{if($6<-'$FLOATEQUALZERO' || $6>'$FLOATEQUALZERO'){print 100*($13/$6-1)}else{print "NaN"}}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" Dqx% ;

##compute differences and statistics
## for qy
#difference in m2/s
$AWK_CMD '{print $14-$7}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" DqySI ;
#difference in %
$AWK_CMD '{if($7<-'$FLOATEQUALZERO' || $7>'$FLOATEQUALZERO'){print 100*($14/$7-1)}else{print "NaN"}}' "$Diff1Tempfile" > "$Diff2Tempfile"
computeStats "$Diff2Tempfile" Dqy% ;

rmtmp;

exit 0