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

STYLE: add TOC tag for easier navigation

Mark Olesen
2020-06-19 15:44:29 +02:00
parent 8ca012a70d
commit 9a11ce8dc6
28 changed files with 81 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Coding-Style-Guide.md

@ -6,6 +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.
[[_TOC_]]
## Code

18
Repository-migration.md

@ -1,6 +1,8 @@
<!-- --- title: Migrating the OpenFOAM repository -->
# Migrating the OpenFOAM repository
[[_TOC_]]
## Migrating the OpenFOAM repository
As of December 2019, the OpenFOAM repository is available as
[openfoam][foam-repo], with an older version available as
@ -8,7 +10,7 @@ As of December 2019, the OpenFOAM repository is available as
The repository change does **not** reflect functional alterations in the
code, but rather git-related _maintenance_ and _structural_ changes.
## Background
### Background
The time-line for the repository revamping was triggered by external
circumstances - one of which being the inordinately long times
@ -32,7 +34,7 @@ commits. So even when file-tree contents are identical, the SHA1 of
two individual commits likely are not.
## Moving Forward
### Moving Forward
To properly delineate the repositories, we have taken the
[`maintenance-v1812`][main-1812] branch as the cut-point. This branch
@ -49,7 +51,7 @@ possibility of duplicate commits or forgotten commits that would
otherwise occur if both repositories covered the same active code
range.
## Migrating your code
### Migrating your code
The file contents of the previous `master` and `develop` branches have been preserved and it should be possible to migrate any user code provided that it can be `rebased`. A mapping from the old-to-new commit hashes is [available here](uploads/89c19da374e3d6e281d14f84a9f34b55/old-to-new.map).
To migrate your code, clone the new repository (shown here using https) and change working directory into it:
@ -80,7 +82,7 @@ git fetch local-repo
At this point you can apply your local change commits to the latest master or develop branches using git-format-patch and git-cherry-pick (see below). Alternatively, if you would like to re-apply your changes to the equivalent starting point in the new repository continue to the next section.
### Recovering an old branching location
#### Recovering an old branching location
Skip this section if you would like to apply your local changes to the latest master/develop branches.
@ -106,7 +108,7 @@ git checkout -b new-base YYYY
Reintroduce your changes, e.g. using git-format-patch or git-cherry-pick (see below). These should apply relatively cleanly - if there are conflicts you will need to perform additional integration updates.
### Using git-format-patch
#### Using git-format-patch
This will extract all your changes into a single text file which can then be 'replayed' onto the new repository. From your current repository (with your own code changes):
@ -120,7 +122,7 @@ Change to new repository - make sure you are on your new-base branch
git am new_patches.patch
```
### Using git-cherry-pick
#### Using git-cherry-pick
This method enables you to introduce your change commits one at a time. This is generally preferable since it is easier to resolve any conflicts one-by-one.
@ -137,7 +139,7 @@ git cherry-pick <oldest-commit>..<newest=commit>
Thank you for your understanding and we hope that you enjoy using the more streamlined repository
### Additional points
#### Additional points
The default _development_ version was previously designated `plus`.
This has now changed to `com`.

2
guides/upgrade/v1612-Developer-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Geometric field access
The following examples show manipulation of `scalar` fields; similar constructs are used for other primitive types, i.e. `vector`, `sphericalTensor`, `symmTensor` and tensor classes.

2
guides/upgrade/v1612-User-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## General input
Dictionary keyword entries including the text "Name" have been shortened, e.g. `pName` becomes `p`, `phiName` becomes `phi` etc.

2
guides/upgrade/v1706-Developer-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## API changes
### Heat transfer

2
guides/upgrade/v1706-User-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Turbulence
The `omegaWallFunction` was updated to replicate v1606+ behaviour via the blended keyword. For more information, see commit ef0361f7

2
guides/upgrade/v1712-Developer-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Strings
The special `operator()` for string classes has been removed as being unnecessary since it only duplicated the standard `substr` method and made the code less clear.

2
guides/upgrade/v1712-User-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Solver
### chtMultiRegion solvers

2
guides/upgrade/v1806-Developer-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## User Input / Interaction
### Dictionary input compatibility

2
guides/upgrade/v1806-User-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Environment
Since OpenFOAM-v1612, `FOAM_INST_DIR` and `foamInstDir` no longer have any

2
guides/upgrade/v1812-Developer-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Coordinate systems
As described in the [release notes][v1812-notes], coordinate systems

2
guides/upgrade/v1906-Developer-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Deprecation and Removal
As part of code evolution, some methods become obsolete or are

2
guides/upgrade/v1906-User-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Configuration / Environment
### Mesa / llvm

1
guides/upgrade/v1912-Developer-Upgrade-Guide.md

@ -3,6 +3,7 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade) or
[Coding Patterns][code-patterns].
[[_TOC_]]
## Deprecation and Removal

2
guides/upgrade/v1912-User-Upgrade-Guide.md

@ -2,6 +2,8 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
[[_TOC_]]
## Configuration / Environment
### Cleaner bashrc/cshrc

3
guides/upgrade/v2006-Developer-Upgrade-Guide.md

@ -3,9 +3,10 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade) or
[Coding Patterns][code-patterns].
## _Preview information, subject to change at any time !!!_
[[_TOC_]]
## Deprecation and Removal
### Deprecated Methods

2
guides/upgrade/v2006-User-Upgrade-Guide.md

@ -4,6 +4,8 @@
## _Preview information, subject to change at any time !!!_
[[_TOC_]]
## Deprecation and Removal
### Removed RANS closure model: `v2f`

4
guides/upgrade/v2012-Developer-Upgrade-Guide.md

@ -3,7 +3,9 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade) or
[Coding Patterns][code-patterns].
## _Preview information, subject to change at any time !!!_
***Preview information, subject to change at any time !!!***
[[_TOC_]]
## Deprecation and Removal

4
guides/upgrade/v2012-User-Upgrade-Guide.md

@ -2,7 +2,9 @@
[Back to Upgrade Guides](/guides/upgrade/upgrade)
## _Preview information, subject to change at any time !!!_
***Preview information, subject to change at any time !!!***
[[_TOC_]]
## Deprecation and Removal

2
home.md

@ -9,6 +9,7 @@ This wiki provides information to users about
to the latest version of [OpenFOAM](http://www.openfoam.com),
including information about [repository migration](Repository-migration).
## Access and build the code
The [develop.openfoam.com site](https://develop.openfoam.com) hosts
@ -41,6 +42,7 @@ select Linux systems:
Please see the [Upgrade Guides](/guides/upgrade/upgrade) when
upgrading your cases and code to a more recent release.
They contain information for users and developers both.

20
page-access-code.md

@ -1,6 +1,8 @@
<!-- --- title: Accessing the code -->
# OpenFOAM repositories
[[_TOC_]]
## OpenFOAM repositories
OpenFOAM repositories are hosted at the https://develop.openfoam.com webpage.
Many are **public-access** and can be downloaded or cloned directly;
@ -16,7 +18,7 @@ _If you have been using the [older OpenFOAM git repository][old-foam-repo] (prio
and have code you need to migrate, you should see the [repository migration](Repository-migration) information._
## Organization of git branches
### Organization of git branches
The OpenFOAM repository follows a
[branching workflow](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows)
@ -39,7 +41,7 @@ Since they will also occasionally be rebased onto the lastest
_develop_, there is ***no*** guarantee of continuity.
## Exploring projects
### Exploring projects
- From the projects menu you can navigate through various projects as shown below.
![GitLab All projects](images/KB-GL-ADV-AllProjects.png)
@ -57,9 +59,9 @@ _develop_, there is ***no*** guarantee of continuity.
![GitLab repository view](images/KB-GL-ADV-OpenFOAM-repository-view.png)
## Terminal mode (cloning)
### Terminal mode (cloning)
### Get a snapshot
#### Get a snapshot
- Cloning allows you to synchronize your local code with the latest developments. The address for cloning is available on the right hand side of "Project->Details" slider of the repository:
@ -87,7 +89,7 @@ git submodule init
contains more information.
#### Shallow cloning
##### Shallow cloning
- Shallow cloning is a clone of the last repository state without its
entire history. This makes for a smaller repository and faster cloning.
@ -105,7 +107,7 @@ git clone --depth=8 https://develop.openfoam.com/Development/openfoam.git
```
### Update existing snapshot
#### Update existing snapshot
- The repositories are updated regularly to include bug fixes and new features. Retrieve the updates using:
```
@ -124,7 +126,7 @@ git fetch
```
## Registration
### Registration
- Go to https://develop.openfoam.com and create a new user account
- A confirmation email will be sent to the registered address (check the spam folder if no emails are received after a few minutes)
@ -133,7 +135,7 @@ git fetch
![GitLab User Registration](images/KB-GL-ADV-Register.png)
### Adding a SSH key
#### Adding a SSH key
If you use SSH for cloning, you can access your profile related
settings from the top-right of the browser page. Follow the steps

2
page-build-code.md

@ -1,5 +1,7 @@
<!-- --- title: Building from source -->
[[_TOC_]]
## Linux, Unix-like systems
|Version | Build |

18
page-code-development.md

@ -1,8 +1,10 @@
<!-- --- title: Code Development -->
# Code Development
[[_TOC_]]
## Repository Structure
## Code Development
### Repository Structure
The main branches:
@ -20,7 +22,7 @@ of interest for the casual user. Note that these branches are subject
to change or removal at any time.
## Prerequisites
### Prerequisites
If not already installed, clone the [OpenFOAM][foam-repo] and [ThirdParty][third-repo] repositories to your local OpenFOAM installation directory:
@ -39,7 +41,7 @@ cd ../ThirdParty-common
git checkout -b develop --track remotes/origin/develop
```
### ***Cautionary Note***
#### ***Cautionary Note***
The ThirdParty repository only contains configuration and build
scripts (and patches) for integrating third-party software.
@ -53,7 +55,7 @@ links near the bottom of its content, where they are readily accessible
with grep/tail etc from the command-line.
## Workflow
### Workflow
All new code/features/bug-fixes should be created on their own branch, e.g. starting from the `develop` branch
```
@ -77,7 +79,7 @@ Add functionality in the usual way, e.g. adding and committing code changes.
during development.
### Submitting for code review
#### Submitting for code review
When ready for review, push the branch upstream
```
@ -86,7 +88,7 @@ git push -u origin feature-ABC
On logging in to this service, you will be able to submit a merge request, and assign a user from the list of developers. Most merge requests will target the `develop` branch, unless e.g. hot-fixes which will target the `master` branch directly.
### Direct addition to the repository
#### Direct addition to the repository
If you have the necessary permissions and no code review is required, the feature branch can be merged in the local repository directly and pushed upstream to the relevant branch, e.g.
```
@ -100,7 +102,7 @@ git branch -d feature-ABC
```
## Code Merging
### Code Merging
The `master` branch should only be updated by features that **do not break backwards compatibility with the latest release** typically comprising bugfixes, and occasional small/modular components that are near *release-ready*.
All new capabilities should reside on their own branch until ready to be merged into the `develop` branch.

4
page-feature-requests.md

@ -1,13 +1,13 @@
<!-- --- title: Feature Requests -->
# Current Feature Requests
## Current Feature Requests
- [ ] Development/openfoam#73 Repository for docker file
- [ ] Development/openfoam#85 Relative Velocity Resistance Formulation
- [ ] Development/openfoam#640 pRefValue not preserved in closed-domain simulation
- [ ] Development/openfoam#641 support direct compatible boundaryData
- [ ] Development/openfoam#650 mergeMesh with same patch name - warning
# Closed Feature Requests
## Closed Feature Requests
- [x] Development/openfoam#53 MD2014 feature request
- [x] Development/openfoam#62 redistributePar to work with sets
- [x] Development/openfoam#72 Add keepPatches as example

2
precompiled.md

@ -1,5 +1,7 @@
<!-- --- title: Precompiled Packages -->
[[_TOC_]]
## Precompiled packages
To make OpenFOAM more readily available to a larger range of users,

2
precompiled/debian.md

@ -1,5 +1,7 @@
<!-- --- title: Precompiled Packages (debian) -->
[[_TOC_]]
## Precompiled packages - debian/ubuntu
For debian/ubuntu, OpenCFD works actively with the

2
precompiled/redhat.md

@ -1,5 +1,7 @@
<!-- --- title: Precompiled Packages -->
[[_TOC_]]
## Precompiled packages - CentOS/RedHat/Fedora
For RedHat-based systems, OpenCFD Ltd. is currently using the

2
precompiled/suse.md

@ -1,5 +1,7 @@
<!-- --- title: Precompiled Packages (openSUSE) -->
[[_TOC_]]
## Precompiled packages - openSUSE
For openSUSE users, OpenCFD Ltd. is a maintainer on the community