mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
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.
209 lines
5.5 KiB
Bash
209 lines
5.5 KiB
Bash
#----------------------------------*-sh-*--------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration |
|
|
# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
# \\/ M anipulation | Copyright (C) 2016-2018 OpenCFD Ltd.
|
|
#------------------------------------------------------------------------------
|
|
# License
|
|
# This file is part of OpenFOAM, licensed under GNU General Public License
|
|
# <http://www.gnu.org/licenses/>.
|
|
#
|
|
# File
|
|
# etc/config.sh/unset
|
|
#
|
|
# Description
|
|
# Clear as many OpenFOAM environment settings as possible
|
|
#
|
|
#------------------------------------------------------------------------------
|
|
|
|
# Clean standard environment variables (PATH, LD_LIBRARY_PATH, MANPATH)
|
|
foamClean=$WM_PROJECT_DIR/bin/foamCleanPath
|
|
[ -f "$foamClean" -a -x "$foamClean" ] || unset foamClean
|
|
|
|
# The old dirs to be cleaned from the environment variables
|
|
foamOldDirs="$WM_PROJECT_DIR $WM_THIRD_PARTY_DIR \
|
|
$HOME/$WM_PROJECT/$USER $FOAM_USER_APPBIN $FOAM_USER_LIBBIN \
|
|
$WM_PROJECT_SITE $FOAM_SITE_APPBIN $FOAM_SITE_LIBBIN $ParaView_DIR"
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset WM_* environment variables
|
|
|
|
unset WM_ARCH
|
|
unset WM_ARCH_OPTION
|
|
unset WM_CC
|
|
unset WM_CFLAGS
|
|
unset WM_COMPILER
|
|
unset WM_COMPILER_TYPE
|
|
unset WM_COMPILER_LIB_ARCH
|
|
unset WM_COMPILE_OPTION
|
|
unset WM_CXX
|
|
unset WM_CXXFLAGS
|
|
unset WM_DIR
|
|
unset WM_HOSTS
|
|
unset WM_LABEL_OPTION
|
|
unset WM_LABEL_SIZE
|
|
unset WM_LDFLAGS
|
|
unset WM_MPLIB
|
|
unset WM_NCOMPPROCS
|
|
unset WM_OPTIONS
|
|
unset WM_OSTYPE
|
|
unset WM_PRECISION_OPTION
|
|
unset WM_PROJECT
|
|
unset WM_PROJECT_API
|
|
unset WM_PROJECT_DIR
|
|
unset WM_PROJECT_INST_DIR
|
|
unset WM_PROJECT_SITE
|
|
unset WM_PROJECT_USER_DIR
|
|
unset WM_PROJECT_VERSION
|
|
unset WM_SCHEDULER
|
|
unset WM_THIRD_PARTY_DIR
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset FOAM_* environment variables
|
|
|
|
unset FOAM_APPBIN
|
|
unset FOAM_APP
|
|
unset FOAM_CODE_TEMPLATES
|
|
unset FOAM_ETC
|
|
unset FOAM_EXT_LIBBIN
|
|
unset FOAM_INST_DIR
|
|
unset FOAM_JOB_DIR
|
|
unset FOAM_LIBBIN
|
|
unset FOAM_MPI
|
|
unset FOAM_RUN
|
|
unset FOAM_SETTINGS
|
|
unset FOAM_SIGFPE
|
|
unset FOAM_SIGNAN
|
|
unset FOAM_SITE_APPBIN
|
|
unset FOAM_SITE_LIBBIN
|
|
unset FOAM_SOLVERS
|
|
unset FOAM_SRC
|
|
unset FOAM_TUTORIALS
|
|
unset FOAM_USER_APPBIN
|
|
unset FOAM_USER_LIBBIN
|
|
unset FOAM_UTILITIES
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset MPI-related environment variables
|
|
|
|
unset MPI_ARCH_PATH
|
|
unset MPI_BUFFER_SIZE
|
|
|
|
# Undefine OPAL_PREFIX if set to one of the paths on foamOldDirs
|
|
if [ -n "$foamClean" ] && [ -z "$($foamClean -env=OPAL_PREFIX $foamOldDirs)" ]
|
|
then
|
|
unset OPAL_PREFIX
|
|
fi
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset Ensight/ParaView-related environment variables
|
|
|
|
unset ENSIGHT9_READER
|
|
unset ParaView_DIR
|
|
unset ParaView_INCLUDE_DIR
|
|
unset ParaView_VERSION
|
|
unset PV_PLUGIN_PATH
|
|
unset VTK_DIR
|
|
|
|
# Undefine Qt5_DIR if set to one of the paths on foamOldDirs
|
|
if [ -n "$foamClean" ] && [ -z "$($foamClean -env=Qt5_DIR $foamOldDirs)" ]
|
|
then
|
|
unset Qt5_DIR
|
|
fi
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset other ThirdParty environment variables
|
|
|
|
unset ADIOS_ARCH_PATH
|
|
unset ADIOS1_ARCH_PATH
|
|
unset ADIOS2_ARCH_PATH
|
|
unset BOOST_ARCH_PATH
|
|
unset CCMIO_ARCH_PATH
|
|
unset CGAL_ARCH_PATH
|
|
unset FFTW_ARCH_PATH
|
|
unset GPERFTOOLS_ARCH_PATH
|
|
unset GMP_ARCH_PATH
|
|
unset MPFR_ARCH_PATH
|
|
unset MESA_ARCH_PATH
|
|
unset KAHIP_ARCH_PATH
|
|
unset METIS_ARCH_PATH
|
|
unset SCOTCH_ARCH_PATH
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Cleanup environment
|
|
# PATH, LD_LIBRARY_PATH, MANPATH
|
|
|
|
if [ -n "$foamClean" ]
|
|
then
|
|
eval "$($foamClean -sh-env=PATH $foamOldDirs)"
|
|
eval "$($foamClean -sh-env=LD_LIBRARY_PATH $foamOldDirs)"
|
|
eval "$($foamClean -sh-env=MANPATH $foamOldDirs)"
|
|
fi
|
|
|
|
[ -n "$LD_LIBRARY_PATH" ] || unset LD_LIBRARY_PATH
|
|
[ -n "$LD_PRELOAD" ] || unset LD_PRELOAD
|
|
[ -n "$MANPATH" ] || unset MANPATH
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Cleanup aliases and functions
|
|
|
|
unalias wmSet 2>/dev/null
|
|
unalias wmInt32 2>/dev/null
|
|
unalias wmInt64 2>/dev/null
|
|
unalias wmSP 2>/dev/null
|
|
unalias wmDP 2>/dev/null
|
|
|
|
unalias wmUnset 2>/dev/null
|
|
|
|
unalias wmSchedOn 2>/dev/null
|
|
unalias wmSchedOff 2>/dev/null
|
|
|
|
unalias foam 2>/dev/null
|
|
|
|
unalias src 2>/dev/null
|
|
unalias lib 2>/dev/null
|
|
unalias app 2>/dev/null
|
|
unalias sol 2>/dev/null
|
|
unalias util 2>/dev/null
|
|
unalias tut 2>/dev/null
|
|
unalias run 2>/dev/null
|
|
|
|
unalias ufoam 2>/dev/null
|
|
unalias uapp 2>/dev/null
|
|
unalias usol 2>/dev/null
|
|
unalias uutil 2>/dev/null
|
|
|
|
unset -f wmRefresh 2>/dev/null
|
|
unset -f foamPwd 2>/dev/null
|
|
unset -f foamVersion 2>/dev/null
|
|
unset -f foamPV 2>/dev/null
|
|
|
|
# NB: no good way to remove foamPwd reference in PS1.
|
|
|
|
|
|
# Remove old completions, which look like
|
|
# "complete ... -F _of_complete_ APPNAME
|
|
# For economy, obtain list first
|
|
foamOldDirs="$(complete 2>/dev/null | sed -ne 's/^.*-F _of_.* \(..*\)$/\1/p')"
|
|
for cleaned in $foamOldDirs
|
|
do
|
|
complete -r "$cleaned" 2>/dev/null
|
|
done
|
|
|
|
# Completion functions
|
|
unset -f foamAddCompletion 2>/dev/null
|
|
unset -f _of_complete_ 2>/dev/null
|
|
|
|
# Completion cache
|
|
unset _of_complete_cache_
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Intermediate variables (do as last for a clean exit code)
|
|
|
|
unset cleaned foamClean foamOldDirs
|
|
|
|
#------------------------------------------------------------------------------
|