48fcb7f6d1
*** Note that this commit depends on a corresponding change in
ThirdParty-dev. Ensure that both repositories are up to date before
re-building OpenFOAM.
New environment variables have been added to explicitly control the
installation type of the thirdparty decomposition libraries and of the
ParaView visualiation software. These are set in the etc/bashrc and can
be overridden in a ~/.OpenFOAM/<version>/prefs.sh file or similar.
The variables relating to the decomposition libraries are SCOTCH_TYPE,
METIS_TYPE, PARMETIS_TYPE and ZOLTAN_TYPE, and they can take values of
none, system, or ThirdParty. In the case of ThirdParty, a
<library>_VERSION variable can also be specified. If the version is not
specified then the configuration will search for a source directory, and
if multiple such directories are found then the one with the highest
version number will be used.
The variable relating to ParaView is ParaView_TYPE, and this can be
similarly be set to none, system, or ThirdParty, and ParaView_VERSION
can also be specified when the type is ThirdParty. If the version is not
specified then the installation with the highest version number will be
used.
An example ~/.OpenFOAM/dev/prefs.sh file, in which all decomposition
libraries are enabled, and the Scotch and ParaView versions are
explicitly set, is as follows:
export SCOTCH_TYPE=ThirdParty
export SCOTCH_VERSION=7.0.3
export METIS_TYPE=ThirdParty
export PARMETIS_TYPE=ThirdParty
export ZOLTAN_TYPE=ThirdParty
export ParaView_TYPE=ThirdParty
export ParaView_VERSION=5.11.2
*** Note that if version numbers are not set then the configuration will
search for a decomposition source directory, but it will search for a
ParaView installation directory. This is because decomposition libraries
are built as part of OpenFOAM's ./Allwmake, but ParaView is not. This
distinction remains. If a local compilation of ParaView is needed, then
'./makeParaView -version X.XX.X' should be called explicitly in the
third party directory prior to building OpenFOAM.
The name of the third party directory can now also be independently set.
This simplifies some packaging processes in that it permits third party
to be located within the OpenFOAM installation directory and therefore
bundled into the same binary package.
321 lines
9.5 KiB
Bash
321 lines
9.5 KiB
Bash
#----------------------------------*-sh-*--------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration | Website: https://openfoam.org
|
|
# \\ / A nd | Copyright (C) 2011-2024 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/>.
|
|
#
|
|
# File
|
|
# etc/config.sh/settings
|
|
#
|
|
# Description
|
|
# Startup file for OpenFOAM
|
|
# Sourced from OpenFOAM-<VERSION>/etc/bashrc
|
|
#
|
|
#------------------------------------------------------------------------------
|
|
|
|
# Set environment variables according to system type
|
|
export WM_ARCH=`uname -s`
|
|
|
|
# Define compilation flags for the system type
|
|
case "$WM_ARCH" in
|
|
Linux)
|
|
WM_ARCH=linux
|
|
|
|
# Compiler specifics
|
|
case `uname -m` in
|
|
i686)
|
|
export WM_ARCH_OPTION=32
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-fPIC'
|
|
export WM_CXXFLAGS='-fPIC -std=c++0x'
|
|
export WM_LDFLAGS=
|
|
;;
|
|
|
|
x86_64)
|
|
case "$WM_ARCH_OPTION" in
|
|
32)
|
|
export WM_COMPILER_ARCH=64
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-m32 -fPIC'
|
|
export WM_CXXFLAGS='-m32 -fPIC -std=c++0x'
|
|
export WM_LDFLAGS='-m32'
|
|
;;
|
|
|
|
64)
|
|
WM_ARCH=linux64
|
|
export WM_COMPILER_LIB_ARCH=64
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-m64 -fPIC'
|
|
export WM_CXXFLAGS='-m64 -fPIC -std=c++0x'
|
|
export WM_LDFLAGS='-m64'
|
|
;;
|
|
|
|
*)
|
|
echo "Unknown WM_ARCH_OPTION '$WM_ARCH_OPTION', should be 32 or 64" 1>&2
|
|
;;
|
|
|
|
esac
|
|
;;
|
|
|
|
aarch64)
|
|
WM_ARCH=linuxArm64
|
|
export WM_COMPILER_LIB_ARCH=64
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-fPIC'
|
|
export WM_CXXFLAGS='-fPIC -std=c++0x'
|
|
export WM_LDFLAGS=
|
|
;;
|
|
|
|
armv7l)
|
|
WM_ARCH=linuxARM7
|
|
export WM_ARCH_OPTION=32
|
|
export WM_COMPILER_LIB_ARCH=32
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-fPIC'
|
|
export WM_CXXFLAGS='-fPIC -std=c++0x'
|
|
export WM_LDFLAGS=
|
|
;;
|
|
|
|
ppc64)
|
|
WM_ARCH=linuxPPC64
|
|
export WM_COMPILER_LIB_ARCH=64
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-m64 -fPIC'
|
|
export WM_CXXFLAGS='-m64 -fPIC -std=c++0x'
|
|
export WM_LDFLAGS='-m64'
|
|
;;
|
|
|
|
ppc64le)
|
|
WM_ARCH=linuxPPC64le
|
|
export WM_COMPILER_LIB_ARCH=64
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-m64 -fPIC'
|
|
export WM_CXXFLAGS='-m64 -fPIC -std=c++0x'
|
|
export WM_LDFLAGS='-m64'
|
|
;;
|
|
|
|
*)
|
|
echo Unknown processor type `uname -m` for Linux 1>&2
|
|
;;
|
|
esac
|
|
;;
|
|
|
|
SunOS)
|
|
WM_ARCH=SunOS64
|
|
WM_MPLIB=FJMPI
|
|
export WM_COMPILER_LIB_ARCH=64
|
|
export WM_CC='gcc'
|
|
export WM_CXX='g++'
|
|
export WM_CFLAGS='-mabi=64 -fPIC'
|
|
export WM_CXXFLAGS='-mabi=64 -fPIC -std=c++0x'
|
|
export WM_LDFLAGS='-mabi=64 -G0'
|
|
;;
|
|
|
|
*) # An unsupported operating system
|
|
/bin/cat <<USAGE 1>&2
|
|
|
|
Your "$WM_ARCH" operating system is not supported by this release
|
|
of OpenFOAM. For further assistance, please contact https://openfoam.org
|
|
|
|
USAGE
|
|
;;
|
|
esac
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
|
|
# Location of the jobControl directory
|
|
export FOAM_JOB_DIR=$WM_PROJECT_INST_DIR/jobControl
|
|
|
|
# wmake configuration
|
|
export WM_DIR=$WM_PROJECT_DIR/wmake
|
|
export WM_LINK_LANGUAGE=c++
|
|
export WM_LABEL_OPTION=Int$WM_LABEL_SIZE
|
|
export WM_OPTIONS=$WM_ARCH$WM_COMPILER$WM_PRECISION_OPTION$WM_LABEL_OPTION$WM_COMPILE_OPTION
|
|
|
|
# Base executables/libraries
|
|
export FOAM_APPBIN=$WM_PROJECT_DIR/platforms/$WM_OPTIONS/bin
|
|
export FOAM_LIBBIN=$WM_PROJECT_DIR/platforms/$WM_OPTIONS/lib
|
|
|
|
# External (ThirdParty) libraries
|
|
export FOAM_EXT_LIBBIN=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER$WM_PRECISION_OPTION$WM_LABEL_OPTION/lib
|
|
|
|
# Site-specific directory
|
|
siteDir="${WM_PROJECT_SITE:-$WM_PROJECT_INST_DIR/site}"
|
|
|
|
# Shared site executables/libraries
|
|
# Similar naming convention as ~OpenFOAM expansion
|
|
export FOAM_SITE_APPBIN=$siteDir/$WM_PROJECT_VERSION/platforms/$WM_OPTIONS/bin
|
|
export FOAM_SITE_LIBBIN=$siteDir/$WM_PROJECT_VERSION/platforms/$WM_OPTIONS/lib
|
|
|
|
# User executables/libraries
|
|
export FOAM_USER_APPBIN=$WM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/bin
|
|
export FOAM_USER_LIBBIN=$WM_PROJECT_USER_DIR/platforms/$WM_OPTIONS/lib
|
|
|
|
# DynamicCode templates
|
|
# - default location is the "~OpenFOAM/codeTemplates/dynamicCode" expansion
|
|
# export FOAM_CODE_TEMPLATES=$WM_PROJECT_DIR/etc/codeTemplates/dynamicCode
|
|
|
|
# Convenience
|
|
export FOAM_ETC=$WM_PROJECT_DIR/etc
|
|
export FOAM_APP=$WM_PROJECT_DIR/applications
|
|
export FOAM_SRC=$WM_PROJECT_DIR/src
|
|
export FOAM_TUTORIALS=$WM_PROJECT_DIR/tutorials
|
|
export FOAM_UTILITIES=$FOAM_APP/utilities
|
|
export FOAM_SOLVERS=$FOAM_APP/solvers
|
|
export FOAM_MODULES=$FOAM_APP/modules
|
|
export FOAM_RUN=$WM_PROJECT_USER_DIR/run
|
|
|
|
# Add application bins to the path
|
|
_foamAddPath $FOAM_USER_APPBIN:$FOAM_SITE_APPBIN:$FOAM_APPBIN
|
|
|
|
# Add wmake scripts to the path - not required for runtime-only environment
|
|
[ -d "$WM_DIR" ] && PATH=$WM_DIR:$PATH
|
|
|
|
# Add OpenFOAM scripts to the path
|
|
export PATH=$WM_PROJECT_DIR/bin:$PATH
|
|
|
|
# Add site-specific scripts to path - only if they exist
|
|
if [ -d "$siteDir/bin" ] # Generic
|
|
then
|
|
_foamAddPath "$siteDir/bin"
|
|
fi
|
|
if [ -d "$siteDir/$WM_PROJECT_VERSION/bin" ] # Version-specific
|
|
then
|
|
_foamAddPath "$siteDir/$WM_PROJECT_VERSION/bin"
|
|
fi
|
|
unset siteDir
|
|
|
|
# Make sure to pick up dummy versions of external libraries last
|
|
_foamAddLib $FOAM_USER_LIBBIN:$FOAM_SITE_LIBBIN:$FOAM_LIBBIN:$FOAM_EXT_LIBBIN:$FOAM_LIBBIN/dummy
|
|
|
|
# Compiler settings
|
|
# ~~~~~~~~~~~~~~~~~
|
|
unset gcc_version gmp_version mpfr_version mpc_version
|
|
unset MPFR_ARCH_PATH GMP_ARCH_PATH
|
|
|
|
# Location of compiler installation
|
|
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
if [ -z "$WM_COMPILER_TYPE" ]
|
|
then
|
|
WM_COMPILER_TYPE=system
|
|
/bin/cat <<USAGE 1>&2
|
|
Warning in $WM_PROJECT_DIR/etc/config.sh/settings:
|
|
WM_COMPILER_TYPE not set, using '$WM_COMPILER_TYPE'
|
|
USAGE
|
|
fi
|
|
|
|
# Load configured compiler versions, regardless of the compiler type
|
|
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
_foamSource `$WM_PROJECT_DIR/bin/foamEtcFile config.sh/compiler`
|
|
|
|
case "$WM_COMPILER_TYPE" in
|
|
OpenFOAM | ThirdParty)
|
|
|
|
if [ -n "$gcc_version" ]
|
|
then
|
|
gccDir=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER_ARCH/$gcc_version
|
|
gmpDir=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER_ARCH/$gmp_version
|
|
mpfrDir=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER_ARCH/$mpfr_version
|
|
if [ -n "$mpc_version" ]
|
|
then
|
|
mpcDir=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER_ARCH/$mpc_version
|
|
fi
|
|
|
|
# Check that the compiler directory can be found
|
|
if [ ! -d "$gccDir" ]
|
|
then
|
|
/bin/cat <<USAGE 1>&2
|
|
|
|
Warning in $WM_PROJECT_DIR/etc/config.sh/settings:
|
|
Cannot find $gccDir installation.
|
|
Please install this compiler version or if you wish to use the system compiler,
|
|
change the 'WM_COMPILER_TYPE' setting to 'system'
|
|
|
|
USAGE
|
|
fi
|
|
|
|
_foamAddMan $gccDir/man
|
|
_foamAddPath $gccDir/bin
|
|
|
|
# Add compiler libraries to run-time environment
|
|
_foamAddLib $gccDir/lib$WM_COMPILER_LIB_ARCH
|
|
|
|
# Add gmp/mpfr libraries to run-time environment
|
|
_foamAddLib $gmpDir/lib$WM_COMPILER_LIB_ARCH
|
|
_foamAddLib $mpfrDir/lib$WM_COMPILER_LIB_ARCH
|
|
|
|
# Add mpc libraries (not need for older gcc) to run-time environment
|
|
if [ -n "$mpc_version" ]
|
|
then
|
|
_foamAddLib $mpcDir/lib$WM_COMPILER_LIB_ARCH
|
|
fi
|
|
fi
|
|
unset gcc_version gccDir
|
|
unset gmp_version gmpDir mpfr_version mpfrDir mpc_version mpcDir
|
|
|
|
if [ -n "$clang_version" ]
|
|
then
|
|
clangDir=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER_ARCH/$clang_version
|
|
|
|
# Check that the compiler directory can be found
|
|
if [ ! -d "$clangDir" ]
|
|
then
|
|
/bin/cat <<USAGE 1>&2
|
|
|
|
Warning in $WM_PROJECT_DIR/etc/config.sh/settings:
|
|
Cannot find $clangDir installation.
|
|
Please install this compiler version or if you wish to use the system compiler,
|
|
change the 'WM_COMPILER_TYPE' setting to 'system'
|
|
|
|
USAGE
|
|
fi
|
|
|
|
_foamAddMan $clangDir/share/man
|
|
_foamAddPath $clangDir/bin
|
|
fi
|
|
unset clang_version clangDir
|
|
;;
|
|
|
|
system)
|
|
# Use system compiler
|
|
;;
|
|
|
|
*)
|
|
/bin/cat <<USAGE 1>&2
|
|
Warn: WM_COMPILER_TYPE='$WM_COMPILER_TYPE' is unsupported
|
|
treating as 'system' instead
|
|
USAGE
|
|
;;
|
|
esac
|
|
|
|
# Cleanup environment:
|
|
# ~~~~~~~~~~~~~~~~~~~~
|
|
unset WM_COMPILER_TYPE
|
|
|
|
#------------------------------------------------------------------------------
|