6c68c34e1a
- Use the OPENFOAM define (eg, 1806, 1812), which normally corresponds
to a major release, to define an API level. This remains consistent
within a release cycle and means that it is possible to manage
several sub-versions and continue to have a consistent lookup.
The current API value is updated automatically during the build
and cached as meta data for later use, even when the wmake/ directory
is missing or OpenFOAM has not yet be initialized.
The version information reported on program start or with -help
usage adjusted to reflect this. The build tag from git now also
carries the date as being more meaningful to trace than a hash
value.
- Update etc/bashrc and etc/cshrc to obtain the project directory
directly instead of via its prefix directory. The value obtained
corresponds to an absolute path, from which the prefix directory
can be obtained.
The combination of these changes removes the reliance on any
particular directory naming convention.
For example,
With an 1812 version (API level):
WM_PROJECT_VERSION=myVersion
installed as /some/path/somewhere/openfoam-mySandbox
This makes the -prefix, -foamInstall, -projectVersion, -version
values of foamEtcFiles, and similar entries for foamConfigurePaths
superfluous.
WM_PROJECT_INST_DIR is no longer required or used
ENH: improve handling and discovery of ThirdParty
- improve the flexibility and reusability of ThirdParty packs to cover
various standard use cases:
1. Unpacking initial release tar files with two parallel directories
- OpenFOAM-v1812/
- ThirdParty-v1812/
2. With an adjusted OpenFOAM directory name, for whatever reason
- OpenFOAM-v1812-myCustom/
- openfoam-1812-other-info/
3. Operating with/without ThirdParty directory
To handle these use cases, the following discovery is used.
Note PROJECT = the OpenFOAM directory `$WM_PROJECT_DIR`
PREFIX = the parent directory
VERSION = `$WM_PROJECT_VERSION`
API = `$WM_PROJECT_API`, as per `foamEtcFiles -show-api`
0. PROJECT/ThirdParty
- for single-directory installations
1. PREFIX/ThirdParty-VERSION
- this corresponds to the traditional approach
2. PREFIX/ThirdParty-vAPI
- allows for an updated value of VERSION (eg, v1812-myCustom)
without requiring a renamed ThirdParty. The API value
would still be '1812' and the original ThirdParty-v1812/
would be found.
3. PREFIX/ThirdParty-API
- this is the same as the previous example, but using an unadorned
API value. This also makes sense if the chosen version name also
uses the unadorned API value in its naming
(eg, 1812-patch190131, 1812.19W03)
4. PREFIX/ThirdParty-common
- permits maximum reuse for various versions, but only for
experienced user who are aware of potential version
incompatibilities
Directory existence is checked as is the presence of an Allwmake file
or a platforms/ directory. This reduces the potential of false positive
matches and limits the selection to directories that are either
with sources (has the Allwmake file), or pre-compiled binaries (has
the platforms/ directory).
If none of the explored directories are found to be suitable,
it reverts to using a PROJECT/ThirdParty dummy location since
this is within the project source tree and can be trusted to
have no negative side-effects.
ENH: add csh support to foamConfigurePaths
- this removes the previously experienced inconsistence in config file
contents.
REMOVED: foamExec
- was previously used when switching versions and before the
bashrc/cshrc discovery logic was added. It is now obsolete.
149 lines
4.2 KiB
Bash
Executable File
149 lines
4.2 KiB
Bash
Executable File
#!/bin/sh
|
|
#------------------------------------------------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration |
|
|
# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
# \\/ M anipulation | Copyright (C) 2018 OpenCFD Ltd.
|
|
#------------------------------------------------------------------------------
|
|
# 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
|
|
# foamUpdateCaseFileHeader
|
|
#
|
|
# Description
|
|
# Updates the header of application files.
|
|
# By default, writes current version in the header.
|
|
# The version can alternatively be specified with the -v option.
|
|
# Also removes consecutive blank lines from the file.
|
|
#
|
|
#------------------------------------------------------------------------------
|
|
usage() {
|
|
exec 1>&2
|
|
while [ "$#" -ge 1 ]; do echo "$1"; shift; done
|
|
cat<<USAGE
|
|
|
|
Usage: ${0##*/} [OPTION] <file1> ... <fileN>
|
|
|
|
options:
|
|
-version <ver> specifies the version to be written in the header
|
|
-help print the usage
|
|
|
|
Updates the header of application files and removes consecutive blank lines.
|
|
By default, writes current OpenFOAM API number version in the header.
|
|
An alternative version can be specified with the -version option.
|
|
|
|
USAGE
|
|
exit 1
|
|
}
|
|
|
|
#------------------------------------------------------------------------------
|
|
|
|
# parse options
|
|
while [ "$#" -gt 0 ]
|
|
do
|
|
case "$1" in
|
|
-h | -help*)
|
|
usage
|
|
;;
|
|
-v | -version)
|
|
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
|
|
version="$2"
|
|
shift 2
|
|
;;
|
|
-*)
|
|
usage "unknown option: '$1'"
|
|
;;
|
|
*)
|
|
break
|
|
;;
|
|
esac
|
|
done
|
|
|
|
# Constant width for version - default to WM_PROJECT_API
|
|
|
|
: ${version:=$WM_PROJECT_API}
|
|
: ${version:=$WM_PROJECT_VERSION}
|
|
|
|
version=$(printf %-36s ${version:-OPENFOAM})
|
|
|
|
[ $# -ge 1 ] || usage
|
|
|
|
#------------------------------------------------------------------------------
|
|
|
|
printHeader()
|
|
{
|
|
cat<<HEADER
|
|
/*--------------------------------*- C++ -*----------------------------------*\\
|
|
| ========= | |
|
|
| \\\\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
|
|
| \\\\ / O peration | Version: $version |
|
|
| \\\\ / A nd | Web: www.OpenFOAM.com |
|
|
| \\\\/ M anipulation | |
|
|
\\*---------------------------------------------------------------------------*/
|
|
FoamFile
|
|
{
|
|
version 2.0;
|
|
format $1;
|
|
class $2;
|
|
object $3;
|
|
}
|
|
HEADER
|
|
}
|
|
|
|
|
|
#
|
|
# extract attribute '$1' from file '$2'
|
|
#
|
|
FoamFileAttribute()
|
|
{
|
|
sed -n -e 's/[ ;]*$//' -e "s/^ *$1 *//p" $2
|
|
}
|
|
|
|
|
|
#
|
|
# main
|
|
#
|
|
|
|
tmpFile=FoamFile.tmp$$
|
|
for caseFile
|
|
do
|
|
if grep -q FoamFile $caseFile 2>/dev/null
|
|
then
|
|
echo "Updating case file: $caseFile"
|
|
sed -n '/FoamFile/,/}/p' $caseFile > $tmpFile
|
|
|
|
format=$(FoamFileAttribute format $tmpFile)
|
|
class=$(FoamFileAttribute class $tmpFile)
|
|
object=$(FoamFileAttribute object $tmpFile)
|
|
# extract note? - needs special handling
|
|
unset note
|
|
|
|
printHeader $format $class $object "$note" > $tmpFile
|
|
|
|
sed '1,/}/d' $caseFile | sed '/./,/^$/!d' >> $tmpFile
|
|
|
|
# use cat to avoid removing/replace soft-links
|
|
[ -s $tmpFile ] && cat $tmpFile >| $caseFile
|
|
rm -f $tmpFile 2>/dev/null
|
|
else
|
|
echo "Invalid case file: $caseFile" 1>&2
|
|
fi
|
|
done
|
|
|
|
#------------------------------------------------------------------------------
|