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.
202 lines
5.1 KiB
Bash
202 lines
5.1 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-2017 OpenCFD Ltd.
|
|
#------------------------------------------------------------------------------
|
|
# License
|
|
# This file is part of OpenFOAM, licensed under GNU General Public License
|
|
# <http://www.gnu.org/licenses/>.
|
|
#
|
|
# File
|
|
# etc/config.csh/unset
|
|
#
|
|
# Description
|
|
# Clear as many OpenFOAM environment settings as possible
|
|
#
|
|
#------------------------------------------------------------------------------
|
|
|
|
# Clean standard environment variables (PATH, LD_LIBRARY_PATH, MANPATH)
|
|
|
|
unset foamClean
|
|
if ( $?WM_PROJECT_DIR ) then
|
|
set foamClean=$WM_PROJECT_DIR/bin/foamCleanPath
|
|
if ( ! -f "$foamClean" || ! -x "$foamClean" ) unset foamClean
|
|
endif
|
|
|
|
# The old dirs to be cleaned from the environment variables
|
|
set foamOldDirs="$WM_PROJECT_DIR $WM_THIRD_PARTY_DIR $HOME/$WM_PROJECT/$LOGNAME $FOAM_SITE_APPBIN $FOAM_SITE_LIBBIN"
|
|
if ( $?WM_PROJECT_SITE ) then
|
|
set foamOldDirs="$foamOldDirs $WM_PROJECT_SITE"
|
|
endif
|
|
if ( $?ParaView_DIR ) then
|
|
set foamOldDirs="$foamOldDirs $ParaView_DIR"
|
|
endif
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset WM_* environment variables
|
|
|
|
unsetenv WM_ARCH
|
|
unsetenv WM_ARCH_OPTION
|
|
unsetenv WM_CC
|
|
unsetenv WM_CFLAGS
|
|
unsetenv WM_COMPILER
|
|
unsetenv WM_COMPILER_TYPE
|
|
unsetenv WM_COMPILER_LIB_ARCH
|
|
unsetenv WM_COMPILE_OPTION
|
|
unsetenv WM_CXX
|
|
unsetenv WM_CXXFLAGS
|
|
unsetenv WM_DIR
|
|
unsetenv WM_HOSTS
|
|
unsetenv WM_LABEL_OPTION
|
|
unsetenv WM_LABEL_SIZE
|
|
unsetenv WM_LDFLAGS
|
|
unsetenv WM_MPLIB
|
|
unsetenv WM_NCOMPPROCS
|
|
unsetenv WM_OPTIONS
|
|
unsetenv WM_OSTYPE
|
|
unsetenv WM_PRECISION_OPTION
|
|
unsetenv WM_PROJECT
|
|
unsetenv WM_PROJECT_API
|
|
unsetenv WM_PROJECT_DIR
|
|
unsetenv WM_PROJECT_INST_DIR
|
|
unsetenv WM_PROJECT_SITE
|
|
unsetenv WM_PROJECT_USER_DIR
|
|
unsetenv WM_PROJECT_VERSION
|
|
unsetenv WM_SCHEDULER
|
|
unsetenv WM_THIRD_PARTY_DIR
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset FOAM_* environment variables
|
|
|
|
unsetenv FOAM_APPBIN
|
|
unsetenv FOAM_APP
|
|
unsetenv FOAM_CODE_TEMPLATES
|
|
unsetenv FOAM_ETC
|
|
unsetenv FOAM_EXT_LIBBIN
|
|
unsetenv FOAM_INST_DIR
|
|
unsetenv FOAM_JOB_DIR
|
|
unsetenv FOAM_LIBBIN
|
|
unsetenv FOAM_MPI
|
|
unsetenv FOAM_RUN
|
|
unsetenv FOAM_SETTINGS
|
|
unsetenv FOAM_SIGFPE
|
|
unsetenv FOAM_SIGNAN
|
|
unsetenv FOAM_SITE_APPBIN
|
|
unsetenv FOAM_SITE_LIBBIN
|
|
unsetenv FOAM_SOLVERS
|
|
unsetenv FOAM_SRC
|
|
unsetenv FOAM_TUTORIALS
|
|
unsetenv FOAM_USER_APPBIN
|
|
unsetenv FOAM_USER_LIBBIN
|
|
unsetenv FOAM_UTILITIES
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset MPI-related environment variables
|
|
|
|
unsetenv MPI_ARCH_PATH
|
|
unsetenv MPI_BUFFER_SIZE
|
|
unsetenv OPAL_PREFIX
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset Ensight/ParaView-related environment variables
|
|
|
|
unsetenv ENSIGHT9_READER
|
|
unsetenv ParaView_DIR
|
|
unsetenv ParaView_INCLUDE_DIR
|
|
unsetenv ParaView_VERSION
|
|
unsetenv PV_PLUGIN_PATH
|
|
unsetenv VTK_DIR
|
|
unsetenv Qt5_DIR # Perhaps only unset if it is in WM_THIRD_PARTY_DIR?
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Unset other ThirdParty environment variables
|
|
|
|
unsetenv ADIOS_ARCH_PATH
|
|
unsetenv ADIOS1_ARCH_PATH
|
|
unsetenv ADIOS2_ARCH_PATH
|
|
unsetenv BOOST_ARCH_PATH
|
|
unsetenv CCMIO_ARCH_PATH
|
|
unsetenv CGAL_ARCH_PATH
|
|
unsetenv FFTW_ARCH_PATH
|
|
unsetenv GPERFTOOLS_ARCH_PATH
|
|
unsetenv GMP_ARCH_PATH
|
|
unsetenv MPFR_ARCH_PATH
|
|
unsetenv MESA_ARCH_PATH
|
|
unsetenv METIS_ARCH_PATH
|
|
unsetenv SCOTCH_ARCH_PATH
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Cleanup environment
|
|
# PATH, LD_LIBRARY_PATH, MANPATH
|
|
|
|
if ( $?foamClean ) then
|
|
|
|
eval `$foamClean -csh-env=PATH "$foamOldDirs"`
|
|
|
|
if ($?LD_LIBRARY_PATH) then
|
|
eval `$foamClean -csh-env=LD_LIBRARY_PATH "$foamOldDirs"`
|
|
if ( ${%LD_LIBRARY_PATH} == 0 ) unsetenv LD_LIBRARY_PATH
|
|
endif
|
|
|
|
if ($?MANPATH) then
|
|
eval `$foamClean -csh-env=MANPATH "$foamOldDirs"`
|
|
if ( ${%MANPATH} == 0 ) unsetenv MANPATH
|
|
endif
|
|
|
|
endif
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Cleanup aliases
|
|
|
|
unalias wmSet
|
|
unalias wmInt32
|
|
unalias wmInt64
|
|
unalias wmSP
|
|
unalias wmDP
|
|
|
|
unalias wmUnset
|
|
|
|
unalias wmSchedOn
|
|
unalias wmSchedOff
|
|
|
|
unalias foam
|
|
|
|
unalias src
|
|
unalias lib
|
|
unalias app
|
|
unalias sol
|
|
unalias util
|
|
unalias tut
|
|
unalias run
|
|
|
|
unalias ufoam
|
|
unalias uapp
|
|
unalias usol
|
|
unalias uutil
|
|
|
|
unalias wmRefresh
|
|
unalias foamVersion
|
|
unalias foamPV
|
|
|
|
# Remove old completions, which look like:
|
|
# complete APPNAME 'p,*,`bash $WM_PROJECT_DIR/etc/ ...
|
|
if ($?prompt && $?tcsh) then # Interactive tcsh only
|
|
foreach cleaned (`complete | sed -ne '/WM_PROJECT/s/\t.*$//p'`)
|
|
uncomplete $cleaned
|
|
end
|
|
endif
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Intermediate variables (do as last for a clean exit code)
|
|
|
|
unset cleaned foamClean foamOldDirs
|
|
|
|
#------------------------------------------------------------------------------
|