openfoam/etc
Mark Olesen cf8d500f8c ENH: export FOAM_API in dictionary (issue #1158)
- uses the value of foamVersion::api, which should be reliable.
2019-01-07 19:04:50 +01:00
..
caseDicts STYLE: Updating version to v1812 2018-12-19 18:07:52 +00:00
codeTemplates ENH: use dictionary::get<> instead of pTraits (#762) 2018-11-20 10:10:39 +01:00
config.csh ENH: export FOAM_API in dictionary (issue #1158) 2019-01-07 19:04:50 +01:00
config.sh ENH: export FOAM_API in dictionary (issue #1158) 2019-01-07 19:04:50 +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 STYLE: Updating version to v1812 2018-12-19 18:07:52 +00: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 STYLE: Updating version to v1812 2018-12-19 18:07:52 +00: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