DOC: misc updates to doc files
This commit is contained in:
Mark Olesen
parent
c32f59e268
commit
31bbca3c38
@ -1,4 +1,4 @@
|
||||
# META-INFO
|
||||
## META-INFO
|
||||
|
||||
Meta-information is generally for OpenFOAM internal use only.
|
||||
|
||||
@ -12,7 +12,7 @@ will need to be updated accordingly:
|
||||
- etc/openfoam
|
||||
- wmake/scripts/wmake-build-info
|
||||
|
||||
## api-info
|
||||
### api-info
|
||||
|
||||
This file and its contents are to be tracked by git.
|
||||
|
||||
@ -21,7 +21,7 @@ This file and its contents are to be tracked by git.
|
||||
- File content (patch) is manually generated content.
|
||||
|
||||
|
||||
## build-info
|
||||
### build-info
|
||||
|
||||
This file is ***never*** to be tracked by git, but may be present in
|
||||
shipped source archives.
|
||||
@ -30,9 +30,9 @@ shipped source archives.
|
||||
git information and cached from previous wmake (api)
|
||||
|
||||
|
||||
## Content types
|
||||
### Content types
|
||||
|
||||
### api
|
||||
#### api
|
||||
|
||||
Format: `date +%y%m`
|
||||
|
||||
@ -41,7 +41,7 @@ Format: `date +%y%m`
|
||||
Example, `1712` for the Dec-2017 release.
|
||||
|
||||
|
||||
### patch
|
||||
#### patch
|
||||
|
||||
Format: `date +%y%m%d`
|
||||
|
||||
@ -57,7 +57,7 @@ ascribed too much meaning, but will often correspond to the last
|
||||
merge with a *maintenance* (*eg*, `master`) branch.
|
||||
|
||||
|
||||
## Flow of information
|
||||
### Flow of information
|
||||
|
||||
Changes in the build information must be reflected in information
|
||||
available in the final binaries. Conversely, it is necessary for later
|
||||
@ -76,11 +76,11 @@ the saved information needs synchronization. The command
|
||||
`wmake -build-info -update` performs the synchronization.
|
||||
|
||||
|
||||
## Notes
|
||||
### Notes
|
||||
|
||||
The saved information is split into two separate files. The `api-info`
|
||||
contains more permanent information, whereas the `build-info` is more
|
||||
transient in nature.
|
||||
|
||||
----
|
||||
2020-05-05
|
||||
2020-06-23
|
||||
|
||||
16
README.md
16
README.md
@ -1,4 +1,4 @@
|
||||
# About OpenFOAM
|
||||
## About OpenFOAM
|
||||
OpenFOAM is a free, open source CFD software [released and developed by OpenCFD Ltd since 2004](http://www.openfoam.com/history/).
|
||||
It has a large user base across most areas of engineering and science, from both commercial and academic organisations.
|
||||
OpenFOAM has an extensive range of features to solve anything from complex fluid flows involving chemical reactions, turbulence and heat transfer, to acoustics, solid mechanics and electromagnetics.
|
||||
@ -11,7 +11,7 @@ individual and group contributors, integrations
|
||||
[governance guided activities](https://www.openfoam.com/governance/).
|
||||
|
||||
|
||||
# Copyright
|
||||
## Copyright
|
||||
|
||||
OpenFOAM is free software: you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by the
|
||||
@ -22,7 +22,7 @@ description of the GNU General Public License terms under which you
|
||||
may redistribute files.
|
||||
|
||||
|
||||
# OpenFOAM Trademark
|
||||
## OpenFOAM Trademark
|
||||
|
||||
OpenCFD Ltd grants use of its OpenFOAM trademark by Third Parties on a
|
||||
licence basis. ESI Group and OpenFOAM Foundation Ltd are currently
|
||||
@ -35,7 +35,7 @@ any questions on the use of the OpenFOAM trademark.
|
||||
Violations of the Trademark are monitored, and will be duly prosecuted.
|
||||
|
||||
|
||||
# Using OpenFOAM
|
||||
## Using OpenFOAM
|
||||
|
||||
If OpenFOAM has already been compiled on your system, simply source
|
||||
the appropriate `etc/bashrc` or `etc/cshrc` file and get started.
|
||||
@ -44,7 +44,7 @@ For example, for the OpenFOAM-v1912 version:
|
||||
source /installation/path/OpenFOAM-v1912/etc/bashrc
|
||||
```
|
||||
|
||||
# Compiling OpenFOAM
|
||||
## Compiling OpenFOAM
|
||||
|
||||
If you are compiling OpenFOAM from source, please see the relevant
|
||||
guides:
|
||||
@ -55,7 +55,7 @@ guides:
|
||||
| [ThirdParty][repo third] | [readme][link third-readme] | [system requirements][link third-require] | [build][link third-build] |
|
||||
|
||||
|
||||
# How do I know which version I am currently using?
|
||||
## How do I know which version I am currently using?
|
||||
|
||||
The value of the `$WM_PROJECT_DIR` or even `$WM_PROJECT_VERSION` are
|
||||
not guaranteed to have any correspondence to the OpenFOAM release
|
||||
@ -110,7 +110,7 @@ patching changes made within the currently active environment and
|
||||
should be used with caution.
|
||||
|
||||
|
||||
# ThirdParty directory
|
||||
## ThirdParty directory
|
||||
|
||||
OpenFOAM normally ships with a directory of 3rd-party software and
|
||||
build scripts for some 3rd-party software that is either necessary or
|
||||
@ -197,7 +197,7 @@ ThirdParty directory will contain either an `Allwmake` file or a
|
||||
[link third-require]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/Requirements.md
|
||||
|
||||
|
||||
# Useful Links
|
||||
## Useful Links
|
||||
|
||||
- Download [source](https://sourceforge.net/projects/openfoam/files/) and [download and installation instructions](http://www.openfoam.com/download/)
|
||||
- [Documentation](http://www.openfoam.com/documentation)
|
||||
|
||||
@ -139,4 +139,4 @@ More details in the [ThirdParty build guide][link third-build].
|
||||
[link third-require]: https://develop.openfoam.com/Development/ThirdParty-common/blob/develop/Requirements.md
|
||||
|
||||
---
|
||||
Copyright 2019 OpenCFD Ltd
|
||||
Copyright 2019-2020 OpenCFD Ltd
|
||||
|
||||
@ -1,3 +1,14 @@
|
||||
## Known Build Issues (OpenFOAM-v2006)
|
||||
|
||||
### Windows cross-compilation
|
||||
|
||||
The reacting Euler multiphase solvers currently do not build for
|
||||
Windows. Compile with the `-k` option to skip over these applications
|
||||
for now.
|
||||
|
||||
Compilation of kahip and ptscotch do not work.
|
||||
|
||||
|
||||
## Known Build Issues (OpenFOAM-v1912)
|
||||
|
||||
### ParaView, ParaView-Catalyst
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# OpenFOAM Configuration
|
||||
## OpenFOAM Configuration
|
||||
|
||||
The main OpenFOAM settings are located in the parent `etc/` directory
|
||||
with both POSIX (bash, dash,...) and csh shells being supported.
|
||||
@ -28,7 +28,7 @@ configuration files for the corresponding shell:
|
||||
settings
|
||||
|
||||
|
||||
## OpenFOAM configuration layers
|
||||
### OpenFOAM configuration layers
|
||||
|
||||
Before launching into manually adjusting the configuration, it is
|
||||
useful to first understand how OpenFOAM supports different
|
||||
@ -55,7 +55,7 @@ Making configuration changes under the *user* or *group* directories
|
||||
allows you to preserve these across upgrades and makes it easier (if
|
||||
necessary) to revert to the original values.
|
||||
|
||||
## Making changes to the configuration
|
||||
### Making changes to the configuration
|
||||
|
||||
The first encounter with the OpenFOAM configuration files can be
|
||||
somewhat intimidating. There are indeed quite a few different bits of
|
||||
@ -205,7 +205,7 @@ Using this tool has some restrictions:
|
||||
between Gcc48, Gcc82 etc.
|
||||
|
||||
|
||||
## Working in groups
|
||||
### Working in groups
|
||||
|
||||
When an OpenFOAM cluster installation is being used by several
|
||||
different people or interest groups it can be highly interesting to
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
# Notes for cross-compiling with mingw
|
||||
## Notes for cross-compiling with mingw
|
||||
|
||||
## Minimum version
|
||||
### Minimum version
|
||||
|
||||
The mingw cross-compiler should be at least version 8.2.0 (tested) or
|
||||
slightly older. Versions that are much older may have faulty regex
|
||||
implementations.
|
||||
|
||||
## Host setup
|
||||
### Host setup
|
||||
|
||||
On openSUSE use the packages for compilation:
|
||||
```
|
||||
@ -84,7 +84,7 @@ export FFTW_ARCH_PATH=/usr/x86_64-w64-mingw32/sys-root/mingw
|
||||
```
|
||||
|
||||
|
||||
## Run-time setup
|
||||
### Run-time setup
|
||||
|
||||
When using the cross-compiled executables and libraries, the
|
||||
corresponding runtime libraries will be required.
|
||||
@ -101,7 +101,7 @@ When running, the `WM_PROJECT_DIR` environment must be set.
|
||||
OpenFOAM will otherwise not be able to locate its files.
|
||||
|
||||
|
||||
## Known limitations (2020-06-16)
|
||||
### Known limitations (2020-06-16)
|
||||
|
||||
- kahip does not build
|
||||
- ptscotch does not build
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
[[_TOC_]]
|
||||
|
||||
## OpenFOAM Modules
|
||||
|
||||
This directory is a location for additional OpenFOAM components or
|
||||
@ -10,14 +12,21 @@ appropriate `Allwmake` (or `Allwmake.override`) file.
|
||||
|
||||
Any individual _module_ will normally also be able to exist outside of
|
||||
the module directory structure and will typically build into user
|
||||
locations (`$FOAM_USER_APPBIN` and/or `$FOAM_USER_LIBBIN`).
|
||||
locations (`$FOAM_USER_APPBIN`, `$FOAM_USER_LIBBIN`).
|
||||
|
||||
When compiled from the top-level OpenFOAM `Allwmake` or the
|
||||
`modules/Allwmake`, they should build into OpenFOAM project locations
|
||||
(`$FOAM_APPBIN` and/or `$FOAM_LIBBIN`). This can be adjusted by
|
||||
(`$FOAM_APPBIN`, `$FOAM_LIBBIN`). This can be adjusted by
|
||||
supplying an alternative `-prefix=` to the corresponding Allwmake
|
||||
command.
|
||||
|
||||
| Command | Install location |
|
||||
|------------|------------------|
|
||||
| ./Allwmake -prefix=user | `$FOAM_USER_APPBIN`, `$FOAM_USER_LIBBIN` |
|
||||
| ./Allwmake -prefix=group | `$FOAM_SITE_APPBIN`, `$FOAM_SITE_LIBBIN` |
|
||||
| ./Allwmake -prefix=openfoam | `$FOAM_APPBIN`, `$FOAM_LIBBIN` |
|
||||
| ./Allwmake -prefix=/some/pathname | `/some/pathname/bin`, `/some/pathname/lib` |
|
||||
|
||||
|
||||
### Adding additional components
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user