| #----------------------------------*-sh-*-------------------------------------- |
| # ========= | |
| # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| # \\ / O peration | Website: https: |
| # \\ / A nd | Copyright (C) 2011-2026 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: |
| # |
| # File |
| # etc/cshrc |
| # |
| # Description |
| # Startup file for OpenFOAM |
| # Sourced from ~/.login or ~/.cshrc |
| # |
| #------------------------------------------------------------------------------ |
|
|
| setenv WM_PROJECT OpenFOAM |
| setenv WM_THIRD_PARTY ThirdParty |
| setenv WM_PROJECT_VERSION dev |
|
|
| ################################################################################ |
| # USER EDITABLE PART: Changes made here may be lost with the next upgrade |
| # |
| # FOAM_INST_DIR is the location of the OpenFOAM installation which defaults to |
| # the directory two levels below this file, or $HOME/$WM_PROJECT if that |
| # directory cannot be determined. |
| # |
| set foamInstDir=`lsof +p $$ |& sed -n 's%.* \(/.*\)/[^/]\+/etc/cshrc$%\1%p'` |
| if ( -d "$foamInstDir" ) then |
| setenv FOAM_INST_DIR $foamInstDir |
| else |
| setenv FOAM_INST_DIR $HOME/$WM_PROJECT |
| endif |
| unset foamInstDir |
| # |
| # Please set to the appropriate path if the above default is not correct. E.g., |
| # |
| # setenv FOAM_INST_DIR ~$WM_PROJECT |
| # setenv FOAM_INST_DIR /opt/$WM_PROJECT |
| # setenv FOAM_INST_DIR /usr/local/$WM_PROJECT |
| # |
| # END OF (NORMAL) USER EDITABLE PART |
| ################################################################################ |
|
|
| # The default environment variables below can be overridden in a prefs.csh file |
| # located in ~/.OpenFOAM/$WM_PROJECT_VERSION, ~/.OpenFOAM, |
| # $FOAM_INST_DIR/site/$WM_PROJECT_VERSION or $FOAM_INST_DIR/site |
|
|
| #- Compiler location: |
| # WM_COMPILER_TYPE = system | ThirdParty (OpenFOAM) |
| setenv WM_COMPILER_TYPE system |
|
|
| #- Compiler: |
| # WM_COMPILER = Gcc | Gcc55 ... Gcc121 | Clang | Icx |
| setenv WM_COMPILER Gcc |
| unsetenv WM_COMPILER_ARCH WM_COMPILER_LIB_ARCH |
|
|
| #- Memory addressing: |
| # On a 64bit OS this can be 32bit or 64bit |
| # On a 32bit OS addressing is 32bit and this option is not used |
| # WM_ARCH_OPTION = 32 | 64 |
| setenv WM_ARCH_OPTION 64 |
|
|
| #- Precision: |
| # WM_PRECISION_OPTION = SP | DP | LP |
| setenv WM_PRECISION_OPTION DP |
|
|
| #- Label size: |
| # WM_LABEL_SIZE = 32 | 64 |
| setenv WM_LABEL_SIZE 32 |
|
|
| #- Native, optimised, debug, profiling: |
| # WM_COMPILE_OPTION = Native | Opt | Debug | Prof |
| setenv WM_COMPILE_OPTION Opt |
|
|
| #- MPI implementation: |
| # WM_MPLIB = SYSTEMOPENMPI | OPENMPI | SYSTEMMPI | MPICH | MPICH-GM | HPMPI |
| # | MPI | FJMPI | QSMPI | SGIMPI | INTELMPI |
| setenv WM_MPLIB SYSTEMOPENMPI |
|
|
| #- Operating System: |
| # WM_OSTYPE = POSIX | ??? |
| setenv WM_OSTYPE POSIX |
|
|
| #- Decomposition libraries: |
| # <library>_TYPE = none | system | ThirdParty (OpenFOAM) |
| setenv SCOTCH_TYPE ThirdParty |
| setenv METIS_TYPE none |
| setenv PARMETIS_TYPE none |
| setenv ZOLTAN_TYPE ThirdParty |
|
|
| #- ParaView installation: |
| # ParaView_TYPE = none | system | paraviewopenfoam | ThirdParty (OpenFOAM) |
| setenv ParaView_TYPE system |
|
|
| #- Floating-point signal handling: |
| # set or unset |
| setenv FOAM_SIGFPE |
|
|
| #- Memory initialisation: |
| # set or unset |
| #setenv FOAM_SETNAN |
|
|
|
|
| ################################################################################ |
|
|
| # The old dirs to be cleaned from the environment variables |
| set foamOldDirs= |
| if ( $?WM_PROJECT_DIR ) then |
| set foamOldDirs="$foamOldDirs $WM_PROJECT_DIR" |
| endif |
| if ( $?WM_THIRD_PARTY_DIR ) then |
| set foamOldDirs="$foamOldDirs $WM_THIRD_PARTY_DIR" |
| endif |
| if ( $?WM_PROJECT ) then |
| set foamOldDirs="$foamOldDirs $HOME/$WM_PROJECT/$LOGNAME" |
| endif |
| if ( $?FOAM_SITE_APPBIN ) then |
| set foamOldDirs="$foamOldDirs $FOAM_SITE_APPBIN" |
| endif |
| if ( $?FOAM_SITE_LIBBIN ) then |
| set foamOldDirs="$foamOldDirs $FOAM_SITE_LIBBIN" |
| endif |
|
|
| # Location of installation |
| # ~~~~~~~~~~~~~~~~~~~~~~~~ |
| setenv WM_PROJECT_INST_DIR $FOAM_INST_DIR |
| setenv WM_PROJECT_DIR $WM_PROJECT_INST_DIR/$WM_PROJECT-$WM_PROJECT_VERSION |
|
|
| # Location of site-specific templates etc |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| # unset is equivalent to $WM_PROJECT_INST_DIR/site |
| if ( $?WM_PROJECT_SITE ) then |
| set foamOldDirs="$WM_PROJECT_SITE $foamOldDirs" |
| if ( ! -d "$WM_PROJECT_SITE" ) unsetenv WM_PROJECT_SITE |
| else |
| unsetenv WM_PROJECT_SITE |
| endif |
|
|
| # Location of user files |
| # ~~~~~~~~~~~~~~~~~~~~~~ |
| setenv WM_PROJECT_USER_DIR $HOME/$WM_PROJECT/$LOGNAME-$WM_PROJECT_VERSION |
|
|
| # Source initialisation functions |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| source $WM_PROJECT_DIR/etc/config.csh/functions |
|
|
| # Add in preset user or site preferences: |
| _foamSource `$WM_PROJECT_DIR/bin/foamEtcFile prefs.csh` |
|
|
| # Evaluate command-line parameters of the form "param=keyword" or unset |
| # parameters with "param=" |
| setenv FOAM_SETTINGS "${*}" |
| _foamParams ${*} |
|
|
| # Location of third-party software |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| if ( `echo $WM_PROJECT_DIR | sed 's/.*\///g'` == `echo $WM_THIRD_PARTY | sed 's/\/.*//g'` ) then |
| setenv WM_THIRD_PARTY_DIR $WM_PROJECT_INST_DIR/$WM_THIRD_PARTY |
| else |
| setenv WM_THIRD_PARTY_DIR $WM_PROJECT_INST_DIR/$WM_THIRD_PARTY-$WM_PROJECT_VERSION |
| endif |
|
|
| # Clean standard environment variables (PATH, LD_LIBRARY_PATH, MANPATH) |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| set foamClean=$WM_PROJECT_DIR/bin/foamCleanPath |
|
|
| #- prevent local variables from shadowing setenv variables |
| unset PATH MANPATH LD_LIBRARY_PATH LD_PRELOAD |
|
|
| if (! $?LD_LIBRARY_PATH ) setenv LD_LIBRARY_PATH '' |
| if (! $?MANPATH) setenv MANPATH '' |
|
|
| #- Clean PATH (path) |
| set cleaned=`$foamClean "$PATH" "$foamOldDirs"` |
| if ( $status == 0 ) setenv PATH $cleaned |
|
|
| #- Clean LD_LIBRARY_PATH |
| set cleaned=`$foamClean "$LD_LIBRARY_PATH" "$foamOldDirs"` |
| if ( $status == 0 ) setenv LD_LIBRARY_PATH $cleaned |
|
|
| #- Clean MANPATH |
| set cleaned=`$foamClean "$MANPATH" "$foamOldDirs"` |
| if ( $status == 0 ) setenv MANPATH $cleaned |
|
|
|
|
| # Source project setup files |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| _foamSource $WM_PROJECT_DIR/etc/config.csh/settings |
| _foamSource $WM_PROJECT_DIR/etc/config.csh/aliases |
|
|
| # Source user setup files for optional packages |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| _foamSource `$WM_PROJECT_DIR/bin/foamEtcFile config.csh/mpi` |
| _foamSource `$WM_PROJECT_DIR/bin/foamEtcFile config.csh/paraview` |
| _foamSource `$WM_PROJECT_DIR/bin/foamEtcFile config.csh/ensight` |
|
|
|
|
| # Clean environment paths again. Only remove duplicates |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| #- Clean PATH (path) |
| set cleaned=`$foamClean "$PATH"` |
| if ( $status == 0 ) setenv PATH $cleaned |
|
|
| #- Clean LD_LIBRARY_PATH |
| set cleaned=`$foamClean "$LD_LIBRARY_PATH"` |
| if ( $status == 0 ) setenv LD_LIBRARY_PATH $cleaned |
|
|
| #- Clean MANPATH (trailing ':' to find system pages) |
| set cleaned=`$foamClean "$MANPATH"`: |
| if ( $status == 0 ) setenv MANPATH "$cleaned" |
|
|
| #- Clean LD_PRELOAD |
| if ( $?LD_PRELOAD ) then |
| set cleaned=`$foamClean "$LD_PRELOAD"` |
| if ( $status == 0 ) setenv LD_PRELOAD $cleaned |
| endif |
|
|
|
|
| # Cleanup environment: |
| # ~~~~~~~~~~~~~~~~~~~~ |
| unset cleaned foamClean foamOldDirs |
|
|
| # Unload initialisation functions: |
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| source $WM_PROJECT_DIR/etc/config.csh/functions |
|
|
| #------------------------------------------------------------------------------ |
|
|
