openfoam/etc
Mark Olesen b6cb62a53f ENH: handle odd c-shell sourcing patterns
- the result of lsof, which is used in the etc/cshrc to locate the
  installation, may contain trailing information about host and mount
  point.

  There is also a moderate concern with people sourcing the
  file indirectly with their own version in the same directory.
  For example, a 'etc/cshrc-site' that actually sources 'etc/cshrc'.
  This leads to multiple matches in the lsof output, so we only take
  the first one, stop there and hope they didn't do something even
  trickier.
2018-12-10 10:34:11 +01:00
..
caseDicts ENH: Added new AMIWeights function object 2018-12-07 17:24:13 +00:00
codeTemplates ENH: use dictionary::get<> instead of pTraits (#762) 2018-11-20 10:10:39 +01:00
config.csh BUG: command-args overload ignored for etc/config.csh/paraview 2018-12-10 09:50:46 +01:00
config.sh Merge branch 'feature-config' into 'develop' 2018-12-06 08:37:48 +00:00
templates ENH: Updated config for release v1806 2018-06-28 12:56:00 +01:00
thermoData thermophysicalModels: Changed specie thermodynamics from mole to mass basis 2017-02-17 11:22:14 +00:00
bashrc CONFIG: adjustments to environment 2018-12-03 09:50:48 +01:00
cellModels ENH: Updated config for release v1806 2018-06-28 12:56:00 +01:00
controlDict CONFIG: default to using logical value for cwd() 2018-10-18 08:05:44 +02:00
cshrc ENH: handle odd c-shell sourcing patterns 2018-12-10 10:34:11 +01:00
mergeHistory ENH: Added mergeHistory doc showing merges from Foundation line 2015-12-22 16:53:39 +00:00
README.md ENH: update handling of versioning and make control (issue #1010) 2018-12-02 18:25:57 +01:00

OpenFOAM Configuration

The main OpenFOAM settings are located in the parent etc/ directory. Both POSIX (bash, dash,...) and csh shells are supported. To configure OpenFOAM, source either the etc/bashrc or the etc/cshrc file, as appropriate for your shell.

These source the following files in the config.sh/ or config.csh/ directories:

  • setup : finalize setup of OpenFOAM environment (called by bashrc,cshrc)
  • settings : core settings
  • aliases : aliases for interactive shells
  • unset : sourced to clear as many OpenFOAM environment settings as possible
  • mpi : MPI communications library settings
  • ensight : application settings for EnSight
  • paraview : application settings for ParaView
  • scotch : application settings for compiling against scotch
  • metis : application settings for compiling against metis

The config.*/example directories contain additional example configuration files for the corresponding shell:

  • compiler : an example of fine tuning ThirdParty compiler settings
  • openmpi : an example of fine tuning openmpi settings for OpenFOAM
  • paraview : an example of chaining to the standard config/paraview with a different ParaView_VERSION
  • prefs: an example of supplying alternative site-defined settings