openfoam/etc
Mark Olesen 65e94fde66 DEFEATURE: remove wmakeScheduler (issue #1178)
- was for parallel compilation across multiple hosts, but less useful
  with modern CPUs with higher number of cores and/or hyperthreading.

  Fragile use and dependent on a 'lockfile' utility that is not often
  installed.
2019-01-23 12:43:41 +01:00
..
caseDicts STYLE: documentation/comment typo 2019-01-02 16:16:45 +01:00
codeTemplates ENH: wmakeRoot for locating the root directory 2019-01-18 10:58:07 +01:00
config.csh DEFEATURE: remove wmakeScheduler (issue #1178) 2019-01-23 12:43:41 +01:00
config.sh DEFEATURE: remove wmakeScheduler (issue #1178) 2019-01-23 12:43:41 +01:00
templates STYLE: Updating version to v1812 2018-12-19 18:07:52 +00:00
thermoData thermophysicalModels: Changed specie thermodynamics from mole to mass basis 2017-02-17 11:22:14 +00:00
bashrc ENH: make use of FOAM_API for environment as well (issue #1158) 2019-01-10 12:21:19 +01:00
cellModels STYLE: Updating version to v1812 2018-12-19 18:07:52 +00:00
controlDict STYLE: Updating version to v1812 2018-12-19 18:07:52 +00:00
cshrc ENH: make use of FOAM_API for environment as well (issue #1158) 2019-01-10 12:21:19 +01:00
mergeHistory ENH: Added mergeHistory doc showing merges from Foundation line 2015-12-22 16:53:39 +00:00
README.md CONFIG: drop config support for deprecated ensight reader library 2019-01-17 10:53:44 +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
  • 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