2017-04-28 09:19 BST

View Issue Details Jump to Notes ]
IDProjectCategoryView StatusLast Update
0002176OpenFOAMPatchpublic2016-08-02 21:34
Reporterwyldckat 
Assigned Tohenry 
PrioritynormalSeveritymajorReproducibilityalways
StatusresolvedResolutionfixed 
Product Version4.x 
Target VersionFixed in Version4.x 
Summary0002176: Typo in bin/tools/RunFunctions: $SUFFIX when it should have been $LOG_SUFFIX
DescriptionThis one's my typo and I only noticed it when I read the summary via RSS from OpenFOAM+ development line, issue #203.
Many thanks to Mark Olesen for spotting (and fixing it in OpenFOAM+) this one before I did a couple of hours ago :) and my apologies for not spotting this sooner myself :(

After reading the summary, I went looking in the current 4.x repository and indeed there is a typo that I failed to notice back when I proposed the changes in report #2015:

- if [ -f log.$SUFFIX ] && [ "$LOG_IGNORE" = "false" ]
+ if [ -f log.$LOG_SUFFIX ] && [ "$LOG_IGNORE" = "false" ]

Attached is the updated file for replacing "bin/tools/RunFunctions".
TagsNo tags attached.
Attached Files
  • ? file icon RunFunctions (4,516 bytes) 2016-08-02 21:07 -
    #---------------------------------*- sh -*-------------------------------------
    # =========                 |
    # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    #  \\    /   O peration     |
    #   \\  /    A nd           | Copyright (C) 2011-2016 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
    #     RunFunctions
    #
    # Description
    #     Miscellaneous functions for running tutorial cases
    #------------------------------------------------------------------------------
    
    isTest()
    {
        for i in "$@"; do
            if [ "$i" = "-test" ]
            then
                return 0
            fi
        done
        return 1
    }
    
    getNumberOfProcessors()
    {
        foamDictionary -entry numberOfSubdomains -value system/decomposeParDict
    }
    
    getApplication()
    {
        sed -ne 's/^ *application\s*\([a-zA-Z]*\)\s*;.*$/\1/p' system/controlDict
    }
    
    runApplication()
    {
        APP_RUN=
        LOG_IGNORE=false
        LOG_APPEND=false
        LOG_SUFFIX=
    
        # Parse options and executable
        while [ $# -gt 0 ] && [ -z "$APP_RUN" ]; do
            key="$1"
            case "$key" in
                -append|-a)
                    LOG_IGNORE=true
                    LOG_APPEND=true
                    ;;
                -overwrite|-o)
                    LOG_IGNORE=true
                    ;;
                -suffix|-s)
                    LOG_SUFFIX=".$2"
                    shift
                    ;;
                *)
                    APP_RUN="$key"
                    APP_NAME="${key##*/}"
                    LOG_SUFFIX="${APP_NAME}${LOG_SUFFIX}"
                    ;;
            esac
    
            shift
        done
    
        if [ -f log.$LOG_SUFFIX ] && [ "$LOG_IGNORE" = "false" ]
        then
            echo "$APP_NAME already run on $PWD:" \
                 "remove log file 'log.$LOG_SUFFIX' to re-run"
        else
            echo "Running $APP_RUN on $PWD"
            if [ "$LOG_APPEND" = "true" ]; then
                $APP_RUN "$@" >> log.$LOG_SUFFIX 2>&1
            else
                $APP_RUN "$@" > log.$LOG_SUFFIX 2>&1
            fi
        fi
    }
    
    runParallel()
    {
        APP_RUN=
        LOG_IGNORE=false
        LOG_APPEND=false
        LOG_SUFFIX=
        nProcs=$(getNumberOfProcessors)
    
        # Parse options and executable
        while [ $# -gt 0 ] && [ -z "$APP_RUN" ]; do
            key="$1"
            case "$key" in
                -append|-a)
                    LOG_IGNORE=true
                    LOG_APPEND=true
                    ;;
                -overwrite|-o)
                    LOG_IGNORE=true
                    ;;
                -suffix|-s)
                    LOG_SUFFIX=".$2"
                    shift
                    ;;
                -np|-n)
                    nProcs="$2"
                    shift
                    ;;
                *)
                    APP_RUN="$key"
                    APP_NAME="${key##*/}"
                    LOG_SUFFIX="${APP_NAME}${LOG_SUFFIX}"
                    ;;
            esac
    
            shift
        done
    
        if [ -f log.$LOG_SUFFIX ] && [ "$LOG_IGNORE" = "false" ]
        then
            echo "$APP_NAME already run on $PWD:" \
                 "remove log file 'log.$LOG_SUFFIX' to re-run"
        else
            echo "Running $APP_RUN in parallel on $PWD using $nProcs processes"
            if [ "$LOG_APPEND" = "true" ]; then
                ( mpirun -np $nProcs $APP_RUN -parallel "$@" < /dev/null >> log.$LOG_SUFFIX 2>&1 )
            else
                ( mpirun -np $nProcs $APP_RUN -parallel "$@" < /dev/null > log.$LOG_SUFFIX 2>&1 )
            fi
        fi
    }
    
    compileApplication()
    {
        echo "Compiling $1 application"
        wmake $1
    }
    
    cloneCase()
    {
        if [ -d $2 ]
        then
            echo "Case already cloned: remove case directory $2 to clone"
        else
            echo "Cloning $2 case from $1"
            mkdir $2
            cpfiles="0 system constant"
            for f in $cpfiles
            do
                cp -r $1/$f $2
            done
        fi
    }
    
    #------------------------------------------------------------------------------
    
    ? file icon RunFunctions (4,516 bytes) 2016-08-02 21:07 +

-Relationships
+Relationships

-Notes

~0006619

henry (manager)

Resolved in OpenFOAM-dev by commit 1467bf2428ab9b7522fa63807a2a2a4768b08cc0
Resolved in OpenFOAM-4.x by commit 16624b772ab16dd1a1520d2851d1de34deee094d
+Notes

-Issue History
Date Modified Username Field Change
2016-08-02 21:07 wyldckat New Issue
2016-08-02 21:07 wyldckat Status new => assigned
2016-08-02 21:07 wyldckat Assigned To => henry
2016-08-02 21:07 wyldckat File Added: RunFunctions
2016-08-02 21:34 henry Note Added: 0006619
2016-08-02 21:34 henry Status assigned => resolved
2016-08-02 21:34 henry Fixed in Version => 4.x
2016-08-02 21:34 henry Resolution open => fixed
+Issue History