#!/bin/bash
#
# svn $Id: build.bash 474 2010-06-25 20:19:44Z arango $
#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
# Copyright (c) 2002-2010 The ROMS/TOMS Group                           :::
#   Licensed under a MIT/X style license                                :::
#   See License_ROMS.txt                                                :::
#::::::::::::::::::::::::::::::::::::::::::::::::::::: Hernan G. Arango :::
#                                                                       :::
# ROMS/TOMS Compiling Script                                            :::
#                                                                       :::
# Script to compile an user application where the application-specific  :::
# files are kept separate from the ROMS source code.                    :::
#                                                                       :::
# Q: How/why does this script work?                                     :::
#                                                                       :::
# A: The ROMS makefile configures user-defined options with a set of    :::
#    flags such as ROMS_APPLICATION. Browse the makefile to see these.  :::
#    If an option in the makefile uses the syntax ?= in setting the     :::
#    default, this means that make will check whether an environment    :::
#    variable by that name is set in the shell that calls make. If so   :::
#    the environment variable value overrides the default (and the      :::
#    user need not maintain separate makefiles, or frequently edit      :::
#    the makefile, to run separate applications).                       :::
#                                                                       :::
# Usage:                                                                :::
#                                                                       :::
#    ./build.bash [options]                                             :::
#                                                                       :::
# Options:                                                              :::
#                                                                       :::
#    -j [N]      Compile in parallel using N CPUs                       :::
#                  omit argument for all available CPUs                 :::
#    -noclean    Do not clean already compiled objects                  :::
#                                                                       :::
# Notice that sometimes the parallel compilation fail to find MPI       :::
# include file "mpif.h".                                                :::
#                                                                       :::
#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
# 08/01/2014: Big rewrite by nilsmk@met.no to make build-script more general
set -x

if [ $# -lt 1 ]
  then
  echo "Usage: $0 modelname -j 4"
  echo "Or specify more kernels than 4 for compilation if you have them available"
  exit
fi

#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
# Users can/should/must change things between here...
#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
#
# Setting up things, like compilers etc:
export ROMS_APPLICATION=$1
#export roms_ver="roms-3.6"
export roms_ver="roms-trunk820"

export USE_MPI=on
export USE_MPIF90=on
export USE_OpenMP=
#export USE_LARGE=on
#export USE_DEBUG=on
export USE_NETCDF4=on
#export USE_PARALLEL_IO=on
export which_MPI=mpich2        # compile with MPICH2 library
export USE_CICE=on

if [ "${METROMS_MYHOST}" == "metlocal" ]; then
    export FORT=gfortran
elif [ "${METROMS_MYHOST}" == "vilje" ] ; then
    export FORT=ifort
elif [ "${METROMS_MYHOST}" == "fram" ] ; then
    export FORT=ifort
    export I_MPI_F90=ifort
elif [ "${METROMS_MYHOST}" == "met_ppi" ] ; then
    export FORT=ifort
    export USE_MPI=on
    export USE_MPIF90=on
    export which_MPI=openmpi
else
  echo " Computer not defined set environment variable METROMS_MYHOST= metlocal, vilje ... "
  echo " Did you perhaps forgot 'source ./myenv.bash' ? "
  exit
fi

#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
# ... and here.
#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

if [ ! -d ${METROMS_TMPDIR} ] ; then
    echo "METROMS_TMPDIR not defined, set environment variable METROMS_TMPDIR"
    exit 
fi
if [ ! -d ${METROMS_BLDDIR} ] ; then
    echo "METROMS_BLDDIR not defined, set environment variable METROMS_BLDDIR"
    exit
fi
if [ ! -d ${METROMS_BASEDIR} ] ; then
    echo "METROMS_BASEDIR not defined, set environment variable METROMS_TMPDIR"
    exit 
fi

export MY_ROMS_SRC=${METROMS_BLDDIR}/roms_src
mkdir -p ${MY_ROMS_SRC}
cd ${MY_ROMS_SRC}
tar -xf ${METROMS_BASEDIR}/static_libs/${roms_ver}.tar.gz
rm -rf User

# JD : Added temporary to have place for a new file
touch $MY_ROMS_SRC/ROMS/Nonlinear/frazil_ice_prod_mod.F
# JD end

#SM: Same here, added temporary for new file
touch $MY_ROMS_SRC/ROMS/Modules/mod_ice.F

# Set path of the directory containing makefile configuration (*.mk) files.
# The user has the option to specify a customized version of these files
# in a different directory than the one distributed with the source code,
# ${MY_ROMS_SCR}/Compilers. If this is the case, the you need to keep
# these configurations files up-to-date.

export COMPILERS=${MY_ROMS_SRC}/Compilers

cd ${METROMS_APPDIR}

parallel=1
clean=1

while [ $# -gt 1 ]
do
  case "$2" in
    -j )
shift
parallel=1
test=`echo $2 | grep -P '^\d+$'`
if [ "$test" != "" ]; then
  NCPUS="-j $2"
  shift
else
  NCPUS="-j"
fi
;;
esac
done

cd ${ROMS_APPLICATION}

# Set number of nested/composed/mosaic grids.  Currently, only one grid
# is supported.

export NestedGrids=1

export MY_ROOT_DIR=${METROMS_APPDIR}/${ROMS_APPLICATION}/
export MY_PROJECT_DIR=${METROMS_APPDIR}/${ROMS_APPLICATION}/
export SCRATCH_DIR=${METROMS_BLDDIR}/build

cd ${MY_PROJECT_DIR}

# # NMK - 20151030
# # Check if we have any common modified source files
export MODIFIED_SRC_FOLDER=${METROMS_BASEDIR}/apps/common/modified_src/${roms_ver}
if [ -s $MODIFIED_SRC_FOLDER ]; then
  cd $MODIFIED_SRC_FOLDER
  gotModifiedSourceCOMMON=`ls *.F *.h *.mk *.in`
  cd ${MY_PROJECT_DIR}
fi

# # KHC - 20110209
# # Check if we have any modified source files
if [ -s modified_src ]; then
  cd modified_src
  gotModifiedSourceAPP=`ls *.F *.h *.mk *.in`
  cd ..
fi

# Replace the original files with the modifications
if [ "$gotModifiedSourceAPP" != "" ] || [ "$gotModifiedSourceCOMMON" != "" ]; then

  echo "!!!!!!!!!!!!Found modified src...!!!!!!!!!!!!!!!!!!!!!"

    # Copy common modified source to ROMS app-directory
    for ModSrc in $gotModifiedSourceCOMMON; do

        # Check where original resides
        origFile=`find ${MY_ROMS_SRC} -name $ModSrc`
	
        if [ -f "$origFile" ]; then
	    
            # Moving original and copying user-modifed source code
            # first checking if the original already exists with
            # the .orig extension
            if [ ! -f "$origFile.orig" ]; then
		mv $origFile $origFile.orig
		echo "Moving $origFile to $origFile.orig"
            fi
	    
            # Copying from local source directory to repository
            cp $MODIFIED_SRC_FOLDER/$ModSrc $origFile
            echo "Copying modified_src/$ModSrc to $origFile"
	    
            if [ ! -f USER_MODIFIED_CODE ]; then
		
                # Touch file to notify that user modified code has been
                # placed in the repository
                touch USER_MODIFIED_CODE
		
            fi
        else
	    
            # No such file in repository, quit script
            echo "No source code file $ModSrc in repository, exiting."
            exit 3
	    
        fi
    done
    # Copy locally modified source to main ROMS directory
    for ModSrc in $gotModifiedSourceAPP; do

        # Check where original resides
        origFile=`find ${MY_ROMS_SRC} -name $ModSrc`
	
        if [ -f "$origFile" ]; then
	    
            # Moving original and copying user-modifed source code
            # first checking if the original already exists with
            # the .orig extension
            if [ ! -f "$origFile.orig" ]; then
		mv $origFile $origFile.orig
		echo "Moving $origFile to $origFile.orig"
            fi
	    
            # Copying from local source directory to repository
            cp modified_src/$ModSrc $origFile
            echo "Copying modified_src/$ModSrc to $origFile"
	    
            if [ ! -f USER_MODIFIED_CODE ]; then
		
                # Touch file to notify that user modified code has been
                # placed in the repository
                touch USER_MODIFIED_CODE
		
            fi
        else
	    
            # No such file in repository, quit script
            echo "No source code file $ModSrc in repository, exiting."
            exit 3
	    
        fi
    done
fi

# Removing user modified source code in repository
# KHC - 20110209
# NMK - 2013
rollback() {
    cd $MY_ROOT_DIR
    
    if [ -f USER_MODIFIED_CODE ]; then
	
    # Find source code files with ".orig"-ending and
    # remove ending
    filelist=`find "$MY_ROMS_SRC" -name *.orig`

    if [ "$filelist" != "" ]; then

      for oldFileName in $filelist; do

      # extract basename
      newFileName=`basename $oldFileName .orig`
      fileDirectory=`dirname $oldFileName`
      mv $oldFileName  $fileDirectory/$newFileName

      echo "Moved $oldFileName  to $fileDirectory/$newFileName"

    done

  else # Empty filelist, no such files in repository

    echo "Did not find any .orig-files in the repository, empty file deleted"

  fi
  
    # Remove empty file
    rm -f USER_MODIFIED_CODE

  fi
}
trap 'rollback; exit 99' 0

# 
if [ -n "${USE_CICE:+1}" ]; then
	export USE_MCT=on
	export MY_CPP_FLAGS="${MY_CPP_FLAGS} -DNO_LBC_ATT -DMODEL_COUPLING -DUSE_MCT -DMCT_COUPLING -DMCT_LIB -DCICE_COUPLING -DCICE_OCEAN"
fi

if [ -n "${USE_NETCDF4:+1}" ]; then
 export USE_DAP=on
 export PATH=/usr/bin:$PATH
fi

export MY_HEADER_DIR=${MY_PROJECT_DIR}/include
export MY_ANALYTICAL_DIR=${MY_HEADER_DIR}

# Build ROMS
# Put the binary to execute in the following directory.
export BINDIR=${METROMS_TMPDIR}/${ROMS_APPLICATION}
mkdir -p $BINDIR

cd ${MY_ROMS_SRC}
if [ $clean -eq 1 ]; then
  make clean
fi

# Compile (the binary will go to BINDIR set above).
if [ $parallel -eq 1 ]; then
  make $NCPUS
else
  make
fi

if [ -n "${USE_CICE:+1}" ]; then
	cp ${MODIFIED_SRC_FOLDER}/coupling.dat $BINDIR/
fi

# Clean up unpacked static code:
cd  ${MY_PROJECT_DIR}
#rm -rf ${MY_ROMS_SRC}

set +x