Bug Reporting
When reporting a bug in OpenFOAM, please provide sufficient detail for us to understand your problem. This should include:
- OpenFOAM version
- Find your OpenFOAM version by running
foamVersion
.
- Find your OpenFOAM version by running
- Operating system, compiler, etc.
- Check your installation by running
foamInstallationTest
. This will return an extended log, from which you can focus on the "Basic setup" and "Software Components" sections. - Find your Linux distribution and version by running
lsb_release -a
.
- Check your installation by running
- The circumstances that provoke the bug, e.g. what application was being run and under what conditions.
- Be as specific as possible and provide extended log parts.
- Where appropriate, please include a small test case.
- Prepare a minimal working example, using a small mesh and just the conditions that trigger the issue, if possible.
- Use an official tutorial to demonstrate the problem, if possible.
- and, if possible, provide a suggested fix.
- You can prepare a patch using git-format-patch. Please use the latest state of the
develop
branch as a starting point. For example, runninggit format-patch origin
will extract all the commits in your local branch but not in the remote repository. - See also the pages Code Development and Coding Style Guide.
- You can prepare a patch using git-format-patch. Please use the latest state of the
Please do not submit issues related to general user support. These will be monitored and closed accordingly.
Feature Requests
We are keen to hear feedback from our users and welcome feature requests!
General guidelines for submitting issues
- Use a title that precisely describes your issue
- Use Markdown to format your message (and especially code snippets)
- Find out more about using the GitLab environment to create issues.