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

DOC: relocated OpenFOAM etc/README.md to doc/Config.md

Browse Source 
- relocated BuildIssues.txt -> doc/BuildIssues.md
This commit is contained in:
Mark Olesen
2019-06-13 18:43:07 +02:00
committed by Andrew Heather
parent f05ff81722
commit 4e0222f887
8 changed files with 130 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
etc/README.md
View File

@ -1,28 +0,0 @@
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

2
etc/config.csh/vtk
View File

@ -25,7 +25,7 @@
#
# It is recommended to use VTK sources from ParaView (5.0.1 or later)
#
# See BuildIssues.txt about problems that can be encountered when using
# See doc/BuildIssues.md about problems that can be encountered when using
# the 'plain' VTK sources.
#------------------------------------------------------------------------------
# USER EDITABLE PART: Changes made here may be lost with the next upgrade

2
etc/config.sh/vtk
View File

@ -26,7 +26,7 @@
#
# It is recommended to use VTK sources from ParaView (5.0.1 or later)
#
# See BuildIssues.txt about problems that can be encountered when using
# See doc/BuildIssues.md about problems that can be encountered when using
# the 'plain' VTK sources.
#------------------------------------------------------------------------------
# USER EDITABLE PART: Changes made here may be lost with the next upgrade