1 #----------------------------------*-sh-*--------------------------------------
3 # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
5 # \\ / A nd | Copyright (C) 1991-2008 OpenCFD Ltd.
7 #------------------------------------------------------------------------------
9 # This file is part of OpenFOAM.
11 # OpenFOAM is free software; you can redistribute it and/or modify it
12 # under the terms of the GNU General Public License as published by the
13 # Free Software Foundation; either version 2 of the License, or (at your
14 # option) any later version.
16 # OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 # You should have received a copy of the GNU General Public License
22 # along with OpenFOAM; if not, write to the Free Software Foundation,
23 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 # Startup file for OpenFOAM
30 # Sourced from ~/.profile or ~/.bashrc
31 # Should be usable by any POSIX-compliant shell (eg, ksh)
33 #------------------------------------------------------------------------------
35 export WM_PROJECT=OpenFOAM
36 #export WM_PROJECT_VERSION=1.5.x
37 : ${WM_PROJECT_VERSION:=dev}; export WM_PROJECT_VERSION
41 # either set $FOAM_INST_DIR before sourcing this file or set
42 # $foamInstall below to where OpenFOAM is installed
44 # Location of FOAM installation
45 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46 foamInstall=$HOME/$WM_PROJECT
47 # foamInstall=~$WM_PROJECT
48 # foamInstall=/usr/local/$WM_PROJECT
49 # foamInstall=/opt/$WM_PROJECT
51 : ${FOAM_INST_DIR:=$foamInstall}; export FOAM_INST_DIR
54 # Location of site/user files
55 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
56 export WM_PROJECT_INST_DIR=$FOAM_INST_DIR
57 export WM_PROJECT_DIR=$WM_PROJECT_INST_DIR/$WM_PROJECT-$WM_PROJECT_VERSION
58 export WM_PROJECT_USER_DIR=$HOME/$WM_PROJECT/$USER-$WM_PROJECT_VERSION
61 # Location of third-party software
62 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63 export WM_THIRD_PARTY_DIR=$WM_PROJECT_INST_DIR/ThirdParty
66 # Operating System/Platform from Unix or MSWindows
67 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68 # WM_OS = Unix | MSWindows
69 : ${WM_OS:=Unix}; export WM_OS
72 # Compiler: set to Gcc, Gcc43 or Icc (for Intel's icc)
73 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74 : ${WM_COMPILER:=Gcc}; export WM_COMPILER
76 export WM_COMPILER_ARCH=
77 export WM_COMPILER_LIB_ARCH=
80 # Compilation options (architecture, precision, optimised, debug or profiling)
81 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82 # WM_ARCH_OPTION = 32 | 64
83 : ${WM_ARCH_OPTION:=64}; export WM_ARCH_OPTION
85 # WM_PRECISION_OPTION = DP | SP
86 : ${WM_PRECISION_OPTION:=DP}; export WM_PRECISION_OPTION
88 # WM_COMPILE_OPTION = Opt | Debug | Prof
89 : ${WM_COMPILE_OPTION:=Opt}; export WM_COMPILE_OPTION
91 # WM_JAVAC_OPTION = Opt | Debug
92 : ${WM_JAVAC_OPTION:=Opt}; export WM_JAVAC_OPTION
94 # WM_MPLIB = | OPENMPI| LAM | MPICH | MPICH-GM | HPMPI | GAMMA | MPI
95 : ${WM_MPLIB:=OPENMPI}; export WM_MPLIB
98 # Run options (floating-point signal handling and memory initialisation)
99 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101 # export FOAM_SETNAN=
104 # Detect system type and set environment variables appropriately
105 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 export WM_ARCH=`uname -s`
118 case $WM_ARCH_OPTION in
120 export WM_COMPILER_ARCH='-64'
123 export WM_CFLAGS='-m32 -fPIC'
124 export WM_CXXFLAGS='-m32 -fPIC'
125 export WM_LDFLAGS='-m32'
129 export WM_COMPILER_LIB_ARCH=64
132 export WM_CFLAGS='-m64 -fPIC'
133 export WM_CXXFLAGS='-m64 -fPIC'
134 export WM_LDFLAGS='-m64'
137 echo Unknown WM_ARCH_OPTION $WM_ARCH_OPTION, should be 32 or 64
143 export WM_COMPILER=I64
146 echo Unknown processor type `uname -m` for Linux
151 *) # an unsupported operating system
154 Your "$WM_ARCH" operating system is not supported by this release
155 of OpenFOAM. For further assistance, please contact www.openfoam.org
162 # Clean standard environment variables (PATH, MANPATH, LD_LIBRARY_PATH)
163 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164 cleanProg=$WM_PROJECT_DIR/bin/foamCleanPath
166 # Remove anything under top-level foam directory
167 wildCards="$WM_PROJECT_INST_DIR $HOME/$WM_PROJECT/$USER"
170 cleanPath=`$cleanProg "$PATH" "$wildCards"` && PATH="$cleanPath"
172 #- Clean LD_LIBRARY_PATH
173 cleanPath=`$cleanProg "$LD_LIBRARY_PATH" "$wildCards"` && LD_LIBRARY_PATH="$cleanPath"
176 cleanPath=`$cleanProg "$MANPATH" "$wildCards"` && MANPATH="$cleanPath"
178 export PATH LD_LIBRARY_PATH MANPATH
180 # Source project setup files
181 # ~~~~~~~~~~~~~~~~~~~~~~~~~~
186 [ "$FOAM_VERBOSE" -a "$PS1" ] && echo "Sourcing: $1"
193 _foamSource $WM_PROJECT_DIR/etc/settings.sh
194 _foamSource $WM_PROJECT_DIR/etc/aliases.sh
197 # Source user setup files for optional packages
198 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199 # _foamSource $WM_PROJECT_DIR/etc/apps/paraview/bashrc
200 _foamSource $WM_PROJECT_DIR/etc/apps/paraview3/bashrc
201 # _foamSource $WM_PROJECT_DIR/etc/apps/ensightFoam/bashrc
202 _foamSource $WM_PROJECT_DIR/etc/apps/cint/bashrc
205 # Again clean environment (path, PATH, MANPATH, LD_LIBRARY_PATH)
206 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
207 #- Clean path/PATH. Only remove duplicates
208 cleanPath=`$cleanProg "$PATH"` && PATH="$cleanPath"
210 #- Clean LD_LIBRARY_PATH
211 cleanPath=`$cleanProg "$LD_LIBRARY_PATH"` && LD_LIBRARY_PATH="$cleanPath"
214 cleanPath=`$cleanProg "$MANPATH"` && MANPATH="$cleanPath"
216 export PATH LD_LIBRARY_PATH MANPATH
219 if [ "$LD_PRELOAD" != "" ]; then
220 cleanPath=`$cleanProg "$LD_PRELOAD"` && LD_PRELOAD="$cleanPath"
225 # cleanup environment:
226 # ~~~~~~~~~~~~~~~~~~~~
227 unset cleanPath cleanProg foamInstall
230 # -----------------------------------------------------------------------------