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

Add page titles (meta-info), absolute paths for Guides (lowercase)

Mark Olesen
2019-06-25 07:05:54 +02:00
parent 185ab9b47c
commit be0cce8497
34 changed files with 126 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Coding-Style-Guide.md

@ -1,4 +1,4 @@
# OpenFOAM C++ Coding Style Guide
<!-- --- title: The OpenFOAM C++ Coding Style Guide -->
This sets out some guidelines for the coding style in the OpenFOAM
code base. As usual, *there are no rules without exceptions*, but
@ -6,7 +6,7 @@ following these guidelines does help people navigating the code and
making changes. It also greatly eases the task of integrating community
code contributions and enhances long-term maintenance.
---
--
## Code
@ -294,7 +294,7 @@ For many more details see the
code;
}
```
Range-base for should have a space surrounding the ':'
Range-based for should have a space surrounding the ':'
```
for (auto i : range)
{
@ -314,7 +314,7 @@ For many more details see the
forAll (
```
In many cases, the new `forAllIters` and `forAllConstIters` macros
provide a good means of cycling through iterators (when a range-base
provide a good means of cycling through iterators (when a range-based
for doesn't apply). These use the C++11 decltype and work without
explicitly specifying the container class:
```

47
Guides/Upgrade/Upgrade.md

@ -1,47 +0,0 @@
|Version | User | Developer | Release notes |
|--------|------|------------|---------------|
|v1906 | [User][v1906-user] | [Developer][v1906-devel] | [release notes][v1906-notes] |
|v1812 | [User][v1812-user] | [Developer][v1812-devel] | [release notes][v1812-notes] |
|v1806 | [User][v1806-user] | [Developer][v1806-devel] | [release notes][v1806-notes] |
|v1712 | [User][v1712-user] | [Developer][v1712-devel] | [release notes][v1712-notes] |
|v1706 | [User][v1706-user] | [Developer][v1706-devel] | [release notes][v1706-notes] |
|v1612+ | [User][v1612-user] | [Developer][v1612-devel] | [release notes][v1612-notes] |
|v1606+ | [User][v1606-user] | [Developer][v1606-devel] | [release notes][v1606-notes] |
|v3.0+ | [User][v1601-user] | [Developer][v1601-devel] | [release notes][v1601-notes] |
## General Reference
* The [postProcess upgrade](Guides/Upgrade/v1612-utility-postProcess); utility and solver option.
[v1906-user]: Guides/Upgrade/v1906-User-Upgrade-Guide
[v1906-devel]: Guides/Upgrade/v1906-Developer-Upgrade-Guide
[v1906-notes]: https://www.openfoam.com/releases/openfoam-v1906/
[v1812-user]: Guides/Upgrade/v1812-User-Upgrade-Guide
[v1812-devel]: Guides/Upgrade/v1812-Developer-Upgrade-Guide
[v1812-notes]: https://www.openfoam.com/releases/openfoam-v1812/
[v1806-user]: Guides/Upgrade/v1806-User-Upgrade-Guide
[v1806-devel]: Guides/Upgrade/v1806-Developer-Upgrade-Guide
[v1806-notes]: https://www.openfoam.com/releases/openfoam-v1806/
[v1712-user]: Guides/Upgrade/v1712-User-Upgrade-Guide
[v1712-devel]: Guides/Upgrade/v1712-Developer-Upgrade-Guide
[v1712-notes]: https://www.openfoam.com/releases/openfoam-v1712/
[v1706-user]: Guides/Upgrade/v1706-User-Upgrade-Guide
[v1706-devel]: Guides/Upgrade/v1706-Developer-Upgrade-Guide
[v1706-notes]: https://www.openfoam.com/releases/openfoam-v1706/
[v1612-user]: Guides/Upgrade/v1612-User-Upgrade-Guide
[v1612-devel]: Guides/Upgrade/v1612-Developer-Upgrade-Guide
[v1612-notes]: https://www.openfoam.com/releases/openfoam-v1612+/
[v1606-user]: Guides/Upgrade/v1606-User-Upgrade-Guide
[v1606-devel]: Guides/Upgrade/v1606-Developer-Upgrade-Guide
[v1606-notes]: https://www.openfoam.com/releases/openfoam-v1606+/
[v1601-user]: Guides/Upgrade/v3-User-Upgrade-Guide
[v1601-devel]: Guides/Upgrade/v3-Developer-Upgrade-Guide
[v1601-notes]: https://www.openfoam.com/releases/openfoam-v3.0+/

1
Guides/Upgrade/v1606-Developer-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

1
Guides/Upgrade/v1606-User-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

1
Guides/Upgrade/v1812-Developer-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

1
Guides/Upgrade/v1812-User-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

1
Guides/Upgrade/v1906-Developer-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

2
Guides/Upgrade/v1906-User-Upgrade-Guide.md

@ -1,2 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

1
Guides/Upgrade/v3-Developer-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

1
Guides/Upgrade/v3-User-Upgrade-Guide.md

@ -1 +0,0 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)

49
guides/upgrade/upgrade.md Normal file

@ -0,0 +1,49 @@
<!-- --- title: Upgrade Guides -->
|Version | User | Developer | Release notes |
|--------|------|------------|---------------|
|v1906 | [User][v1906-user] | [Developer][v1906-devel] | [Release notes][v1906-notes] |
|v1812 | [User][v1812-user] | [Developer][v1812-devel] | [Release notes][v1812-notes] |
|v1806 | [User][v1806-user] | [Developer][v1806-devel] | [Release notes][v1806-notes] |
|v1712 | [User][v1712-user] | [Developer][v1712-devel] | [Release notes][v1712-notes] |
|v1706 | [User][v1706-user] | [Developer][v1706-devel] | [Release notes][v1706-notes] |
|v1612+ | [User][v1612-user] | [Developer][v1612-devel] | [Release notes][v1612-notes] |
|v1606+ | [User][v1606-user] | [Developer][v1606-devel] | [Release notes][v1606-notes] |
|v3.0+ | [User][v1601-user] | [Developer][v1601-devel] | [Release notes][v1601-notes] |
## General Reference
* The [postProcess upgrade](/guides/upgrade/v1612-utility-postProcess); utility and solver option.
[v1906-user]: /guides/upgrade/v1906-User-Upgrade-Guide
[v1906-devel]: /guides/upgrade/v1906-Developer-Upgrade-Guide
[v1906-notes]: https://www.openfoam.com/releases/openfoam-v1906/
[v1812-user]: /guides/upgrade/v1812-User-Upgrade-Guide
[v1812-devel]: /guides/upgrade/v1812-Developer-Upgrade-Guide
[v1812-notes]: https://www.openfoam.com/releases/openfoam-v1812/
[v1806-user]: /guides/upgrade/v1806-User-Upgrade-Guide
[v1806-devel]: /guides/upgrade/v1806-Developer-Upgrade-Guide
[v1806-notes]: https://www.openfoam.com/releases/openfoam-v1806/
[v1712-user]: /guides/upgrade/v1712-User-Upgrade-Guide
[v1712-devel]: /guides/upgrade/v1712-Developer-Upgrade-Guide
[v1712-notes]: https://www.openfoam.com/releases/openfoam-v1712/
[v1706-user]: /guides/upgrade/v1706-User-Upgrade-Guide
[v1706-devel]: /guides/upgrade/v1706-Developer-Upgrade-Guide
[v1706-notes]: https://www.openfoam.com/releases/openfoam-v1706/
[v1612-user]: /guides/upgrade/v1612-User-Upgrade-Guide
[v1612-devel]: /guides/upgrade/v1612-Developer-Upgrade-Guide
[v1612-notes]: https://www.openfoam.com/releases/openfoam-v1612+/
[v1606-user]: /guides/upgrade/v1606-User-Upgrade-Guide
[v1606-devel]: /guides/upgrade/v1606-Developer-Upgrade-Guide
[v1606-notes]: https://www.openfoam.com/releases/openfoam-v1606+/
[v1601-user]: /guides/upgrade/v3-User-Upgrade-Guide
[v1601-devel]: /guides/upgrade/v3-Developer-Upgrade-Guide
[v1601-notes]: https://www.openfoam.com/releases/openfoam-v3.0+/

3
guides/upgrade/v1606-Developer-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1606) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

3
guides/upgrade/v1606-User-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: User Upgrade Guide (OpenFOAM-v1606) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

6
Guides/Upgrade/v1612-Developer-Upgrade-Guide.md → guides/upgrade/v1612-Developer-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1612) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## Geometric field access
@ -81,4 +83,4 @@ volScalarField& non_const_field = tField().ref();
const volScalarField& const_field = tField();
```
### Function objects
The `functionObjectState` class has been renamed `stateFunctionObject`
The `functionObjectState` class has been renamed `stateFunctionObject`

4
Guides/Upgrade/v1612-User-Upgrade-Guide.md → guides/upgrade/v1612-User-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: User Upgrade Guide (OpenFOAM-v1612) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## General input

0
Guides/Upgrade/v1612-utility-postProcess.md → guides/upgrade/v1612-utility-postProcess.md

6
Guides/Upgrade/v1706-Developer-Upgrade-Guide.md → guides/upgrade/v1706-Developer-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1706) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## API changes
@ -87,4 +89,4 @@ Accessing a non-existent entry now returns -1 instead of failing.
## String and regex matching
All classes derived from a string or that can match a string now have a unary predicate operator for string comparison or matching. This makes it easier to write generic matching and filtering code.
All classes derived from a string or that can match a string now have a unary predicate operator for string comparison or matching. This makes it easier to write generic matching and filtering code.

6
Guides/Upgrade/v1706-User-Upgrade-Guide.md → guides/upgrade/v1706-User-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: User Upgrade Guide (OpenFOAM-v1706) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## Turbulence
@ -27,4 +29,4 @@ Inputs in the `$FOAM_CASE/noiseDict` dictionary were updated:
* `inputFile` entry renamed to `file`
* for the `pointNoise` model the `csvFileData` sub-dictionary was removed
See source documentation in $FOAM_SRC/randomProcesses/noise/noiseModels
See source documentation in $FOAM_SRC/randomProcesses/noise/noiseModels

6
Guides/Upgrade/v1712-Developer-Upgrade-Guide.md → guides/upgrade/v1712-Developer-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1712) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## Strings
@ -20,4 +22,4 @@ a = b.substr(10);
The rarely used, special purpose `readList<T>` function has been removed and replaced with more robust solutions.
## Conversion
The `ccm26ToFoam` application has now been removed. If you have access to the underlying libraries, the `ccmToFoam` and `foamToCcm` provide better solutions.
The `ccm26ToFoam` application has now been removed. If you have access to the underlying libraries, the `ccmToFoam` and `foamToCcm` provide better solutions.

6
Guides/Upgrade/v1712-User-Upgrade-Guide.md → guides/upgrade/v1712-User-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: User Upgrade Guide (OpenFOAM-v1712) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## Solver
@ -17,4 +19,4 @@ Writing the turbulence viscosity field nut is now optional via the option -write
Power of 2 data samples constraint was removed
## Function objects
`secondaryWrite` option in the `system/controlDict` superseded by the `writeObject` function object
`secondaryWrite` option in the `system/controlDict` superseded by the `writeObject` function object.

4
Guides/Upgrade/v1806-Developer-Upgrade-Guide.md → guides/upgrade/v1806-Developer-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1806) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## User Input / Interaction

4
Guides/Upgrade/v1806-User-Upgrade-Guide.md → guides/upgrade/v1806-User-Upgrade-Guide.md

@ -1,4 +1,6 @@
[Back to Upgrade Guides](Guides/Upgrade/Upgrade)
<!-- --- title: User Upgrade Guide (OpenFOAM-v1806) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## Input dictionaries

3
guides/upgrade/v1812-Developer-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1812) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

3
guides/upgrade/v1812-User-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: User Upgrade Guide (OpenFOAM-v1812) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

3
guides/upgrade/v1906-Developer-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v1906) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

4
guides/upgrade/v1906-User-Upgrade-Guide.md Normal file

@ -0,0 +1,4 @@
<!-- --- title: User Upgrade Guide (OpenFOAM-v1906) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

3
guides/upgrade/v3-Developer-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: Developer Upgrade Guide (OpenFOAM-v3.0+) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

3
guides/upgrade/v3-User-Upgrade-Guide.md Normal file

@ -0,0 +1,3 @@
<!-- --- title: User Upgrade Guide (OpenFOAM-v3.0+) -->
[Back to Upgrade Guides](/guides/upgrade/upgrade)

4
home.md

@ -1,3 +1,5 @@
<!-- --- title: OpenFOAM -->
# About This Site
This site provides users with access to the latest version of OpenFOAM and a platform to submit feedback, e.g. bug reports and feature requests. Please note that this is not a forum for general user support. For information related to our latest service offerings, please visit www.openfoam.com/services/.
@ -17,4 +19,4 @@ and [Coding Style](Coding-Style-Guide)
For details of current feature requests, please see the page [Feature Requests](page-feature-requests)
# Version Upgrade Guides
Looking to upgrade your cases and code to a more recent release? Please see the page [Upgrade Guides](guides/upgrade/upgrade)
Looking to upgrade your cases and code to a more recent release? Please see the page [Upgrade Guides](/guides/upgrade/upgrade)

4
page-access-code.md

@ -1,3 +1,5 @@
<!-- --- title: Accessing the code -->
# OpenFOAM repositories
OpenFOAM repositories are hosted at the https://develop.openfoam.com webpage.
@ -50,7 +52,7 @@ git clone git@develop.openfoam.com:Development/OpenFOAM-plus.git
```
git clone -b <branch name> <address of git> <name of resulting directory>
```
e.g. to clone the *develop* branch to your local OpenFOAM-plus.develop directory via SSH:
e.g. to clone the *develop* branch to your local OpenFOAM-plus.develop directory via HTTPS:
```
git clone -b develop https://develop.openfoam.com:Development/OpenFOAM-plus.git OpenFOAM-plus.develop
```

13
page-build-code.md

@ -1,6 +1,6 @@
# Building from source
<!-- --- title: Building from source -->
## Linux&reg;, Unix&reg;
## Linux, Unix-like systems
|Version | Build |
|--------|--------|
@ -34,11 +34,10 @@ system, which is often created as a disk image and mounted.
## Windows
Windows source compilation is currently
supported with cross-compilation as of [v1906][v1906-notes]
using the [mingw](http://mingw.org/) compiler on 64bit Linux to
generate a Win64 target. See the version-relevant build information.
Starting with [v1906][v1906-notes], windows source compilation is
supported via cross-compilation using the [mingw](http://mingw.org/)
compiler on 64bit Linux to generate a Win64 target. See the
version-relevant build information.
--

2
page-code-development.md

@ -1,3 +1,5 @@
<!-- --- title: Code Development -->
# Code Development
## Repository Structure

2
page-feature-requests.md

@ -1,3 +1,5 @@
<!-- --- title: Feature Requests -->
# Current Feature Requests
- [ ] Development/OpenFOAM-plus#73 Repository for docker file
- [ ] Development/OpenFOAM-plus#85 Relative Velocity Resistance Formulation

4
page-submitting-issues.md

@ -1,3 +1,5 @@
<!-- --- title: Submitting Issues -->
Please do not submit issues related to general user support. These will be monitored and closed accordingly.
# Bug Reporting
@ -9,4 +11,4 @@ When reporting a bug in OpenFOAM, please provide sufficient detail for us to und
- and, if possible, provide a suggested fix
# Feature Requests
We are keen to hear feedback from our users and welcome feature requests
We are keen to hear feedback from our users and welcome feature requests