songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: adjust wording and version information

Browse Source
This commit is contained in:
Mark Olesen 2019-11-19 16:15:01 +01:00 committed by Andrew Heather
parent 9e6683f7bc
commit a3d399a550
3 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/foamInstallationTest
View File

@ -35,7 +35,7 @@
#------------------------------------------------------------------------------
# Base settings
MIN_VERSION_GCC=4.8.0
MIN_VERSION_GCC=4.8.5
# General
WIDTH=20

14
doc/Config.md
View File

@ -17,14 +17,15 @@ These source the following files in the `config.sh/` or
* `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:
The `config.{csh,sh}/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
* `prefs.csh`, `prefs.sh`: examples of supplying alternative site-defined
settings
## OpenFOAM configuration layers
@ -95,8 +96,11 @@ variants as well.
some general OpenFOAM-specific settings, which you can use for
guidance but in general you should note the following:
* Changes made to this `bashrc` file will be lost with the next upgrade.
* Should override via a `prefs.sh` file instead of editing this file.
* Changes made to this `etc/bashrc` file ___will be lost___ with
the next upgrade.
* Overrides should defined in the `etc/prefs.sh` instead.
See the comments section of the `etc/bashrc` file for more details.
2. The `etc/bashrc` file (our entry point) passes control to the
`etc/config.sh/setup` file, which dispatches the rest of the

23
doc/Requirements.md
View File

@ -4,7 +4,7 @@ OpenFOAM requires a functioning C++11 compiler and `make` build toolchain.
### Minimum recommended versions
- gcc: 4.8.5
- gcc : 4.8.5
- cmake: 3.3 (required for ParaView and CGAL build)
- boost: 1.48 (required for CGAL build and some functionality)
- fftw: 3.3.7 (recommended - required for FFT-related functionality)
@ -20,6 +20,7 @@ To check the installed versions
|---------------|-----------------------|
| gcc | gcc --version |
| icc | icc --version |
| openmpi | orterun --version |
| cmake | cmake --version |
| openmpi | orterun --version |
@ -27,8 +28,9 @@ To check the installed versions
### Additional utilities
- flex
- QT: 5.9 (optional - for ParaView build)
- flex : **not 2.6.2, 2.6.3** (fails for building scotch)
- m4 : no known minimum level
- QT : 5.9 (optional - for ParaView build)
### Ubuntu (eg, 19.04)
@ -74,11 +76,13 @@ sudo apt-cache show fftw3-dev
| openmpi | 19.04 | 3.1.3 |
| cmake | 19.04 | 3.13.4 |
| flex | 19.04 | 2.6.4 |
| m4 | 15.1 | 1.4.18 |
### openSUSE (eg, Leap-15.0)
### openSUSE (eg, Leap-15.1)
Install the dependencies by copying and pasting the following lines to the command line:
Install the dependencies by copying and pasting the following lines to
the command line:
```
sudo zypper install -t pattern devel_C_C++
@ -89,10 +93,11 @@ This installs
| Program | openSUSE | Program version |
|-----------|-----------|-----------------|
| gcc | 15.0 | 7.4.3 |
| openmpi | 15.0 | 1.10.7 |
| cmake | 15.0 | 3.10.2 |
| flex | 15.0 | 2.6.4 |
| gcc | 15.1 | 7.4.3 |
| openmpi | 15.1 | 1.10.7 |
| cmake | 15.1 | 3.10.2 |
| flex | 15.1 | 2.6.4 |
| m4 | 15.1 | 1.4.18 |
#### OpenMPI