OpenFOAM-5.x/etc
Chris Greenshields 90f39e0d89 Added Bash [TAB] completion to all OpenFOAM applications
When typing OpenFOAM commands, the bash completion system will
complete option names, e.g. -help, -parallel, etc.  After typing an
option that includes an argument, e.g. -case <dir>, completion will
adjust to the type of argument, e.g. present directories if the
argument is a directory.  Similarly, for applications with mandarory
file arguments, file (and directory) names will appear on the
completion list.
2017-05-14 10:53:27 +01:00
..
caseDicts flowRateFaceZone: faceZone configuration for the surfaceFieldValue functionObject 2017-05-05 18:29:14 +01:00
codeTemplates codeTemplates: The copyright year is now set automatically 2017-04-18 11:01:41 +01:00
config.csh Upgraded to OpenMPI-2.0.2 2017-03-10 17:08:16 +00:00
config.sh Added Bash [TAB] completion to all OpenFOAM applications 2017-05-14 10:53:27 +01:00
templates template cases: added minor comment to blockMeshDict files 2017-04-04 12:36:50 +01:00
thermoData thermophysicalModels: Changed specie thermodynamics from mole to mass basis 2017-02-17 11:22:14 +00:00
bashrc Added Bash [TAB] completion to all OpenFOAM applications 2017-05-14 10:53:27 +01:00
cellModels Add the OpenFOAM source tree 2014-12-10 22:40:10 +00:00
controlDict Reinstated operation of "-doc" and "-srcDoc" 2017-05-12 18:35:50 +01:00
cshrc etc/bashrc,cshrc: Added FJMPI and INTELMPI 2016-12-01 19:53:08 +00:00
README.org etc/README.org: Added mpi 2016-02-10 20:49:04 +00:00

OpenFOAM Configuration

The main OpenFOAM settings are located in the parent etc/ directory. The bash and csh shells are supported and to configure OpenFOAM source etc/bashrc or etc/cshrc respectively which source the following files in the config.sh or config.csh respectively:

  • 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 5

The config.*/example directories contains various 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