#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     | Website:  https://openfoam.org
#   \\  /    A nd           | Copyright (C) 2021 OpenFOAM Foundation
#    \\/     M anipulation  |
#------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM.
#
#     OpenFOAM is free software: you can redistribute it and/or modify it
#     under the terms of the GNU General Public License as published by
#     the Free Software Foundation, either version 3 of the License, or
#     (at your option) any later version.
#
#     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
#     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
#     for more details.
#
#     You should have received a copy of the GNU General Public License
#     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
#
# Script
#     foamCleanCase
#
# Description
#     Cleans an OpenFOAM case directory, resetting it to its initial state.
#     Executes a local Allclean script if it present, otherwise runs the
#     cleanCase function in bin/tools/CleanFunctions
#
#------------------------------------------------------------------------------

# Source tutorial clean functions
. "$WM_PROJECT_DIR/bin/tools/CleanFunctions"

usage() {
    cat<<USAGE

Usage: ${0##*/} [OPTIONS]
options:
  -case | -c <dir>  specify case directory (default = local dir)
  -help | -h        print the usage

Cleans an OpenFOAM case directory, resetting it to its initial state.
USAGE
}

error() {
    exec 1>&2
    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
    usage
    exit 1
}

# Parse options
while [ "$#" -gt 0 ]
do
    case "$1" in
    -c | -case)
        [ "$#" -ge 2 ] || error "'$1' option requires an argument"
        cd "$2" 2>/dev/null || error "Case directory does not exist: '$2'"
        shift 2
        ;;
    -h | -help)
        usage && exit 0
        ;;
    *)
        break
        ;;
    esac
done

[ $# -eq 0 ] || error "Incorrect arguments specified"

foamListTimes >/dev/null 2>&1 || \
    error "'$PWD' is not a valid case directory"

[ -x Allclean ] && ./Allclean && \
    echo "... using the local Allclean script" && exit 0
cleanCase

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