Files
OpenFOAM-12/etc/config.csh/functions
Will Bainbridge 48fcb7f6d1 etc: Explicit control of decomposition and ParaView installation type
*** 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.
2024-06-06 15:20:19 +01:00

104 lines
3.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.csh/functions
#
# Description
# Initialisation script functions for the cshrc environment
# Sourced from OpenFOAM-<VERSION>/etc/cshrc
#
#------------------------------------------------------------------------------
if ( ! $?WM_CSH_FUNCTIONS ) then
# Temporary environment variable for automatically (un)loading functions
set WM_CSH_FUNCTIONS loaded
# Source files, possibly with some verbosity
alias _foamSource 'if ($?FOAM_VERBOSE && $?prompt) echo "Sourcing: \!*"; if (\!* != "") source \!*'
# Evaluate command-line parameters
alias _foamParams 'foreach arg (\!*)\
switch ($arg)\
case -*:\
# stray option (not meant for us here) -> get out\
break\
breaksw\
case *=:\
# name= -> unsetenv name\
if ($?FOAM_VERBOSE && $?prompt) echo "unsetenv $arg:s/=//"\
eval "unsetenv $arg:s/=//"\
breaksw\
case *=*:\
# name=value -> setenv name value\
if ($?FOAM_VERBOSE && $?prompt) echo "setenv $arg:s/=/ /"\
eval "setenv $arg:s/=/ /"\
breaksw\
default:\
# ignore non-parameter arguments, e.g. filenames\
break\
breaksw\
endsw\
end'
# Prefix to PATH
alias _foamAddPath 'setenv PATH \!*\:${PATH}'
# Prefix to LD_LIBRARY_PATH
alias _foamAddLib 'setenv LD_LIBRARY_PATH \!*\:${LD_LIBRARY_PATH}'
# Prefix to MANPATH
alias _foamAddMan 'setenv MANPATH \!*\:${MANPATH}'
# Find the most recent of a list of versioned directories
alias _foamMostRecentDir 'foreach dir (\!* /dev/nul[l])\
if ( -d "$dir" ) then\
if ( $?_mostRecentDir ) then\
$WM_PROJECT_DIR/bin/tools/foamVersionCompare $_mostRecentDir lt $dir\
if ( $status == 0 ) then\
set _mostRecentDir=$dir\
endif\
else\
set _mostRecentDir=$dir\
endif\
endif\
end\
if ( $?_mostRecentDir ) then\
echo $_mostRecentDir\
endif\
unset _mostRecentDir'
else
# Cleanup environment:
# ~~~~~~~~~~~~~~~~~~~~
unset WM_CSH_FUNCTIONS
unset _foamSource
unset _foamAddPath _foamAddLib _foamAddMan
endif
#------------------------------------------------------------------------------