CONF: consolidate more files into OpenFOAM etc/config

.gitignore

@@ -60,6 +60,8 @@ doc/[Dd]oxygen/man
 # untracked configuration files
 /etc/prefs.csh
 /etc/prefs.sh
+/etc/config/prefs.csh
+/etc/config/prefs.sh
 
 # source packages - anywhere
 *.tar.bz2

etc/bashrc

@@ -177,7 +177,7 @@ _foamEval()
 _foamSource `$WM_PROJECT_DIR/bin/foamEtcFile prefs.sh`
 
 # Evaluate command-line parameters and record settings for later
-# these can be used to set/unset values, or specify prefs files
+# these can be used to set/unset values, or specify alternative pref files
 export FOAM_SETTINGS="$@"
 _foamEval $@
 
@@ -201,7 +201,7 @@ export PATH LD_LIBRARY_PATH MANPATH
 # Source project setup files
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~
 _foamSource $WM_PROJECT_DIR/etc/settings.sh
-_foamSource $WM_PROJECT_DIR/etc/aliases.sh
+_foamSource $WM_PROJECT_DIR/etc/config/aliases.sh
 
 
 # Source user setup files for optional packages

etc/config/README

@@ -0,0 +1,51 @@
+The main OpenFOAM settings are located in the parent etc/ directory
+
+* bashrc, cshrc
+  entry point for sourcing
+
+* settings.csh, settings.sh
+  core settings
+
+* prefs.csh, prefs.sh
+  these files are untracked and can be used for some site-defined
+  settings
+
+
+The etc/config/ directory contains various configuration files in
+sh/csh variants:
+
+* aliases.csh, aliases.sh
+  aliases for interactive shells
+
+* unset.csh, unset.sh
+  sourced to clear as many OpenFOAM environment settings as possible
+
+
+* ensight.csh, ensight.sh
+  application settings for EnSight
+
+* paraview.csh, paraview.sh
+  application settings for ParaView
+
+* scotch.sh
+  application settings for compiling against scotch
+
+---
+
+The config/example directory contains various example configuration files
+in sh/csh variants
+
+* compiler.csh, compiler.sh
+  an example of fine tuning ThirdParty compiler settings for OpenFOAM
+
+* openmpi.csh, openmpi.sh
+  an example of fine tuning openmpi settings for OpenFOAM
+
+* paraview.csh, paraview.sh
+  an example of chaining to the standard config/paraview.sh with a
+  different ParaView_VERSION
+
+* prefs.csh, prefs.sh
+  an example of supplying alternative site-defined settings
+
+---

etc/config/aliases.csh

@@ -22,7 +22,7 @@
 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 #
 # File
-#     etc/aliases.csh
+#     etc/config/aliases.csh
 #
 # Description
 #     Aliases for working with OpenFOAM
@@ -39,7 +39,7 @@ alias wmSP 'wmSET WM_PRECISION_OPTION=SP'
 alias wmDP 'wmSET WM_PRECISION_OPTION=DP'
 
 # clear env
-alias wmUNSET='source $WM_PROJECT_DIR/etc/unset.csh'
+alias wmUNSET='source $WM_PROJECT_DIR/etc/config/unset.csh'
 
 # Toggle wmakeScheduler on/off
 #  - also need to set WM_HOSTS

etc/config/aliases.sh

@@ -22,7 +22,7 @@
 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 #
 # File
-#     etc/aliases.sh
+#     etc/config/aliases.sh
 #
 # Description
 #     Aliases for working with OpenFOAM
@@ -39,7 +39,7 @@ alias wmSP='wmSET WM_PRECISION_OPTION=SP'
 alias wmDP='wmSET WM_PRECISION_OPTION=DP'
 
 # clear env
-alias wmUNSET='. $WM_PROJECT_DIR/etc/unset.sh'
+alias wmUNSET='. $WM_PROJECT_DIR/etc/config/unset.sh'
 
 # Toggle wmakeScheduler on/off
 #  - also need to set WM_HOSTS

etc/config/ensight.csh

@@ -2,7 +2,7 @@
 # =========                 |
 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
 #  \\    /   O peration     |
-#   \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+#   \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
 #    \\/     M anipulation  |
 #-------------------------------------------------------------------------------
 # License

etc/config/ensight.sh

@@ -2,7 +2,7 @@
 # =========                 |
 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
 #  \\    /   O peration     |
-#   \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+#   \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
 #    \\/     M anipulation  |
 #------------------------------------------------------------------------------
 # License

etc/config/example/prefs.csh

@@ -22,7 +22,7 @@
 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 #
 # File
-#     etc/prefs.csh
+#     config/example/prefs.csh
 #
 # Description
 #     Preset variables for the OpenFOAM configuration - C-Shell shell syntax.

etc/config/example/prefs.sh

@@ -22,7 +22,7 @@
 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 #
 # File
-#     etc/prefs.sh
+#     config/example/prefs.sh
 #
 # Description
 #     Preset variables for the OpenFOAM configuration - POSIX shell syntax.

etc/config/unset.csh

@@ -22,7 +22,7 @@
 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 #
 # File
-#     etc/unset.csh
+#     etc/config/unset.csh
 #
 # Description
 #     Clear as many OpenFOAM environment settings as possible

etc/config/unset.sh

@@ -22,7 +22,7 @@
 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 #
 # File
-#     etc/unset.sh
+#     etc/config/unset.sh
 #
 # Description
 #     Clear as many OpenFOAM environment settings as possible

etc/cshrc

@@ -138,7 +138,7 @@ alias _foamSource 'if ($?FOAM_VERBOSE && $?prompt) echo "Sourcing: \!*"; if (\!*
 _foamSource `$WM_PROJECT_DIR/bin/foamEtcFile prefs.csh`
 
 # Evaluate command-line parameters and record settings for later
-# these can be used to set/unset values, or specify prefs files
+# these can be used to set/unset values, or specify alternative pref files
 setenv FOAM_SETTINGS "${*}"
 while ( $#argv > 0 )
     switch ($argv[1])
@@ -195,7 +195,7 @@ if ( $status == 0 ) setenv MANPATH $cleaned
 # Source project setup files
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~
 _foamSource $WM_PROJECT_DIR/etc/settings.csh
-_foamSource $WM_PROJECT_DIR/etc/aliases.csh
+_foamSource $WM_PROJECT_DIR/etc/config/aliases.csh
 
 # Source user setup files for optional packages
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~