CfdOF workbench information: Please read this first

A subforum specific to the development of the OpenFoam-based workbenches ( Cfd https://github.com/qingfengxia/Cfd and CfdOF https://github.com/jaheyns/CfdOF )

Moderator: oliveroxtoby

User avatar
oliveroxtoby
Posts: 300
Joined: Fri Dec 23, 2016 9:43 am
Location: South Africa

CfdOF workbench information: Please read this first

Postby oliveroxtoby » Tue Jan 15, 2019 8:51 pm

Introduction

The CfdOF workbench aims to help users set up and run CFD analyses using the OpenFOAM® solver (www.openfoam.org, www.openfoam.com).

Please see the Readme file for information on installing the workbench and its dependencies.

Disclaimer:
This offering is not approved or endorsed by OpenCFD Limited, producer and distributor of the OpenFOAM software via www.openfoam.com, and owner of the OPENFOAM® and OpenCFD® trade marks

Reporting problems

When asking for help or reporting a problem, please note the following:
  • Developers likely only have time to respond to clearly demonstrated bugs. Of course, you are free to ask for help from community members, but it is unlikely that an issue with the workbench will be looked into unless you have taken time to demonstrate that there is a fault with the software rather than with the installation or problem setup.
  • Please make sure you have read and followed the instructions in the Readme file, particularly for installation issues.
  • Make sure that that all dependencies are up to date by going to Edit | Preferences | CFD | Run dependency checker
  • There is an infinite variety of ways in which a CFD simulation can go wrong. If a simulation crashes with no specific error message, it is likely because of numerical divergence; this usually means that some aspect of the setup is not right for the solver. Unfortunately, providing the final error code or error message is generally of no use in determining the cause in these cases. Some training in CFD may be required to debug the problem, but the best remedy is usually to start with the simplest possible form of the problem (or a known working tutorial problem) and build up complexity slowly. Again, you are welcome to ask for help from the community but developers will not have the time to provide general training in CFD.
  • If at all possible please attach a saved .FCstd file and instructions for reproducing your problem from the saved state. This will greatly increase the chances of the issue being looked at by someone.
  • Provide all possible output for debugging purposes:
    • In FreeCAD, go to Edit | Preferences | Output window
      and tick all five tick boxes on that panel (Record log messages, Record warnings, Record error messages, Redirect internal Python errors, Redirect internal Python output), and click OK.
    • Then, click View | Panels and tick Report View as well as Python Console.
    • Now re-create the error and copy any output and error messages which appear on either the report view or the python console, not just the last line or error. A screenshot is OK if all the relevant output is shown.
  • Go to Help | About FreeCAD and click "Copy to Clipboard" and paste this information into your message.
  • Preferably report confirmed bugs at the project github page. The present forum is intended for community assistance and may not always be monitored by developers. Of course, we'll be grateful if you are able to fix the bug yourself and issue a pull request at https://github.com/jaheyns/CfdOF
Training material

The following is a list of known training material:
  • http://opensim.co.za/training.html
    Example test problems. The starting geometry is provided as well as the FreeCAD macros which reproduce the steps to set up the examples. Slides are provided to walk you through the set-up process. Note that these are based on earlier versions of the workbench, so some adaptation is required.
  • https://youtu.be/8A9GewANqh8
    A nice beginner's walk-through video created by @makkemal