zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
00cbf5564bc8b4918a2ec57cb239cfdb53a6075b
openfoam/etc
History
Mark Olesen bef508dedc ENH: make use of FOAM_API for environment as well (issue #1158) 
- was WM_PROJECT_API in the environment and FOAM_API in dictionaries.

  Make these both consistently FOAM_API.
  This is a non-breaking change, since the value of WM_PROJECT_API
  (added in 1812) and/or FOAM_API is purely informative.
  For the current correct values, always use

    * foamEtcFile -show-api
    * wmakeBuildInfo -show-api
2019-01-10 12:21:19 +01:00
..
caseDicts
STYLE: documentation/comment typo
2019-01-02 16:16:45 +01:00
codeTemplates
ENH: use dictionary::get<> instead of pTraits (#762)
2018-11-20 10:10:39 +01:00
config.csh
ENH: make use of FOAM_API for environment as well (issue #1158)
2019-01-10 12:21:19 +01:00
config.sh
ENH: make use of FOAM_API for environment as well (issue #1158)
2019-01-10 12:21:19 +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
ENH: update handling of versioning and make control (issue #1010)
2018-12-02 18:25:57 +01:00

README.md

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