jaheyns / cfdof

Computational Fluid Dynamics (CFD) for FreeCAD based on OpenFOAM solver

CfdOF: A Computational fluid dynamics (CFD) workbench for FreeCAD

This workbench aims to help users set up and run CFD analyses within the FreeCAD modeller, and serves as a front-end (GUI) for the popular OpenFOAM® CFD toolkit (www.openfoam.org, www.openfoam.com). It guides the user in selecting the relevant physics, specifying the material properties, generating a mesh, assigning boundary conditions and choosing the solver settings before running the simulation. Best practices are specified to maximise the stability of the solvers.

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

Features

Current:

Flow physics

• Incompressible, laminar flow (simpleFoam, pimpleFoam)
• Support for various RANS, LES and DES turbulent flow models
• Incompressible free-surface flow (interFoam, multiphaseInterFoam)
• Compressible buoyant flow (buoyantSimpleFoam, buoyantPimpleFoam)
• High-speed compressible flow (HiSA)
• Porous regions and porous baffles
• Basic material database
• Flow initialisation with a potential solver
• Solution of arbitrary passive scalar transport functions

Meshing

• Cut-cell Cartesian meshing with boundary layers (cfMesh)
• Cut-cell Cartesian meshing with baffles (snappyHexMesh)
• Tetrahedral meshing using Gmsh, including conversion to polyhedral dual mesh
• Post-meshing check mesh
• Support for dynamic mesh adaptation for supported solvers

Post-processing and monitoring

• Postprocessing using Paraview
• Basic support for force-based function objects (Forces, Force Coefficients)
• Basic support for probes

Other features

• Runs on Windows 7-11 and Linux
• Unit/regression testing
• Case builder using an extensible template structure
• Macro scripting
• Support for distributed parallel (cluster) runs via mpiexec & --hostfile

Platforms supported

Linux

Any system on which FreeCAD and the prerequisites listed below can be installed.

Windows

Windows 7-11; 64-bit version is required.

macOS

Not widely tested, but success has been reported. See the following forum post for instructions.

Getting started

Prerequisites

The CfdOF workbench depends on the following external software, some of which can be automatically installed (see below for instructions).

• Latest release version of FreeCAD (at least version 0.20.0 / git commit 29177) or latest development version (prerelease)
• OpenFOAM Foundation versions 9-10 or ESI-OpenCFD versions 2006-2306
• Paraview
• cfMesh (customised version updated to compile with latest OpenFOAM versions)
• HiSA (High Speed Aerodynamic Solver)
• Gmsh (version 2.13 or later) - optional, for generating tetrahedral meshes

Setting up the CfdOF workbench

Windows

The latest release or development FreeCAD build can be obtained (64 bit version) and installed by respectively running the installer or extracting the .7z archive to a directory <FreeCAD-directory>. In the latter case, FreeCAD can be run in place (<FreeCAD-directory>\bin\FreeCAD.exe).

CfdOF itself is installed into FreeCAD using the Addon manager:

• Run FreeCAD
• Select Tools | Addon manager ...
• Select CfdOF in the list of workbenches, and click "Install/update"
• Restart FreeCAD
• For installation of dependencies, see below

Note: The CfdOF workbench can be updated at any time through the Addon manager.

Dependency installation

Dependencies can be checked and installed conveniently from the CfdOF Preferences panel in FreeCAD. In the FreeCAD window, select Edit | Preferences ... and choose "CfdOF". The dependencies can be installed as individual components or as part of a docker container (refer to the Docker container install section below).

The OpenFOAM installation is via the OpenCFD MinGW package, and the BlueCFD Core port of OpenFOAM is also supported.

OpenFOAM can be installed manually using the above links, or by clicking the relevant button in the Preferences panel described above. If you experience problems running OpenFOAM in CfdOF, please make sure you have a working installation by following instructions on the relevant websites.

To interface correctly with the OpenFOAM installation, CfdOF needs to be able to write to its install location. Some users experience problems using a location inside C:\Program Files due to restrictions imposed by Windows User Account Control. It is therefore suggested to install to an alternative location, preferably in your home directory.

If OpenFOAM is installed with administrator privileges using the above packages, then Microsoft MPI will also optionally be installed. If not, then it will be necessary to download and install it manually from here. MPI is needed in order to run in parallel.

Set the OpenFOAM install directory in the preferences panel to the install directory ending in the 'vXXXX' subfolder (where XXXX is the version number installed) for the MinGW package, or the BlueCFD install directory. It will be automatically detected in the default install locations.

Any version of ParaView can be installed, by following the above link or clicking the relevant button in the Preferences panel. Set the ParaView install path in the preferences panel to the 'paraview.exe' file in the 'bin' subfolder of the ParaView installation. Common defaults will be detected if it is left blank.

Likewise, cfMesh and HiSA can be installed from the Preferences panel. Do not close it until the 'Install completed' message is received. Note that the OpenFOAM installation must be in a writable location for cfMesh and HiSA to be installed successfully.

Choosing the "Check dependencies" option will verify that all prerequisites have been successfully installed.

Linux

AppImages of the latest release or development versions of FreeCAD can be downloaded and run directly without installation. Note that you will have to enable execution permission on the downloaded file to run it. Otherwise, FreeCAD can be built from the source code at https://github.com/FreeCAD/FreeCAD .

Note:

• Installations of FreeCAD via Linux package managers make use of your local Python installation. Therefore you might need to install additional Python packages to get full functionality. The dependency checker (see below) can help to diagnose this.
• Note that the 'Snap' container installed through some distributions' package managers can be problematic as it does not allow access to system directories, and therefore OpenFOAM has to be installed in the user's home directory to be runnable from FreeCAD.

For the reasons above we recommend the AppImage as the most robust installation option on Linux.

CfdOF itself is installed into FreeCAD using the Addon manager:

• Run FreeCAD
• Select Tools | Addon manager ...
• Select CfdOF in the list of workbenches, and click "Install/update"
• Restart FreeCAD
• For installation of dependencies, see below

Note: The CfdOF workbench can be updated at any time through the Addon manager.

Dependency installation

Dependencies can be checked and some of them installed conveniently from the CFD Preferences panel in FreeCAD. In the FreeCAD window, select Edit | Preferences ... and choose "CfdOF".

The dependencies can be installed manually, or as part of a docker container (refer to Docker container install below). Manual installation may be undertaken for OpenFOAM (OpenCFD or Foundation versions), Paraview and Gmsh (optional) by using the links above or your distribution's package manager. Note, however, that the OpenFOAM packages bundled in some Linux distributions may be out of date or incomplete; for example, the standard Debian and Ubuntu packages do not include the build command 'wmake' and therefore cannot be used with the optional components 'HiSA' and 'cfMesh'. We therefore recommend installation of the packages supplied through the official websites above. Please make sure the install the 'development' package where available (usually named with the suffix '-devel' or '-dev') to be sure that the optional components 'HiSA' and 'cfMesh' can be compiled with 'wmake'.

Set the OpenFOAM install directory in the preferences panel - examples of typical install locations are /usr/lib/openfoam/openfoam2306, /opt/openfoam10 or /home/user/OpenFOAM/OpenFOAM-10.x (it will be automatically detected in common default install locations). Note that if you have loaded the desired OpenFOAM environment already before starting FreeCAD, the install directory should be left blank.

cfMesh and HiSA can be installed using the Preferences panel described above, and can be downloaded and built from their source code inside your OpenFOAM installation if you have not already done so yourself. Note that this is a lengthy process.

Choosing the "Check dependencies" option will verify that all prerequisites have been successfully installed.

Docker container install

Docker containers offer a convenient way of providing pre-compiled program packages for both windows and linux. macOS can also be supported but assistance will be required to setup a container. Please leave a message on the forum.

Docker on Windows

The preferred docker run-time for Windows is via podman as currently this provides fast filesystem integration. Docker Desktop may also be used.

1. Install podman (or docker desktop).
2. If using podman, open a cmd window and issue the following commands:
   • podman machine init
   • podman machine start
   • podman machine set --rootful
3. Edit → Preferences → CfdOF: Press the Install Paraview button.
4. Edit → Preferences → CfdOF: Select Use docker.
5. Press the Install Docker Container button. There is no need to install gmsh, cfmesh and HISA as they are included in the docker image.
6. If using podman, fast WSL file system integration can be enabled:
   • Create a new subdirectory (for example cfdof) in the following firectory created by podman: \\wsl$\podman-machine-default\home\user
   • In the cfdof preference page, set the default output directory as above: \\wsl$\podman-machine-default\home\user\cfdof
7. Press the Run dependency checker button.

Docker on Linux

1. Install docker using these instructions (or similar).
2. Install paraview as per the package installation instructions for your distribution (for example sudo apt-get install paraview on debian).
3. Edit → Preferences → CfdOF: Select Use docker.
4. Press the Install Docker Container button. There is no need to install gmsh, cfmesh and HISA as they are included in the docker image.
5. Press the Run dependency checker button.

Documentation

At present there is no formal documentation for CfdOF apart from this README. However, demonstration cases are provided inside the 'Demos' folder of the CfdOF workbench directory. These aim to provide a basic overview of features and best practices. The examples are run by loading and executing the macro files ending in '.FCMacro' in the various sub-directories in the 'Demos' directory. Where there are several numbered files, these should be run in order and aim to demonstrate step-by-step how the case is set up.

Community assistance may be sought at the CfdOF dedicated FreeCAD forum, and a list of various third-party documentation is available in the following forum post.

FAQ

Q: Do I have to create a watertight geometry?

A: This isn't necessary if using the cartesian mesh generators snappyHexMesh and cfMesh. You can make use of shells and compounds instead of creating solids, as long as the collection of shapes in the compound being meshed blocks off the volume desired. Gaps smaller than the mesh spacing are also allowed.

Feedback

Reporting Bugs

Please discuss issues on the CfdOF FreeCAD forum for community assistance. Bugs can be reported on the Github project site.

Please first read the guidelines for reporting bugs in order to provide sufficient information.

Development

If you would like to get involved in the development of CfdOF, please refer to the Contribution guidelines and Roadmap.

Acknowledgements

Funding

This development was made possible through initial funding from Eskom Holdings SOC Ltd and the Council for Scientific and Industrial Research (South Africa).

Contributors

• Oliver Oxtoby (CSIR, 2016-2018; private 2019-) [email protected]
• Johan Heyns (CSIR, 2016-2018) [email protected]
• Alfred Bogaers (CSIR, 2016-2018) [email protected]
• Jonathan Bergh (2022)
• Qingfeng Xia (2015)
• Thomas Schrader (2017-) [email protected]
• Michael Hindley (2016)
• Mark Mackenzie (CNF, 2022)
• Katy Akmal (2022) [Forum: @KAKM]
• Adrian Insaurralde (2022)
• Klaus Sembritzki (2017)

Dedication

CfdOF is dedicated to the memory of Michael Hindley. It is thanks to his irrepressible enthusiasm for FreeCAD and open source software that this workbench exists. Rest in peace.

cfdof's Issues

Import self-created structured mesh-file

Hello guys,
is it possible to import a self-created structured mesh-file (e.g. .stl-file created in gmsh) to the CfdOF-workbench in FreeCAD?
Best regards
Dominik

FreeCAD 0.18 ?

I just noticed Freecad 0.18 was released. I love the CfdOF addon and thank you very much for making it possible. Will it be updated for Freecad 0.18 ? Thanks

HISA not found even after an installation attempt

Hi,
I am trying to install HISA with the Freecad Preferences assistant and it is not working for me :

When using the Install HISA button, I end up with

Checking dependencies...
HiSA not found
Downloading HiSA, please wait...
Extracting HiSA...
Download completed
Building HiSA. Please wait...
Log file: /home/myusername /OpenFOAM/myusername-6/hisa-master/log.Allwmake
Install completed
Checking dependencies...
HiSA not found

The log.Allwmake yields many errors (see in attachments)
log.Allwmake.txt

I am using Ubuntu 18.04 and Freecad 0.17.

What am I doing wrong ? If you need any other info, feel free to ask.

Thanks

Mesh creation errors

I have a custom workbench that creates convex faces (TopoDS_Face) that represent the shapes of yacht hulls. Unfortunately it's probably not feasible for you to install the workbench or load files it creates at this point. The result looks like this:

I'd now like to simulate this in a stream of water. The water surface should be around half-way up the side of the hull. I want to include surface wave simulation and so I should need two initial regions of fluid, one for the water & one for the air. I've set these up as cubes:

Now I'm trying to generate a mesh for this simulation. It doesn't appear to be possible to create a mesh for multiple objects, as the 'Create a mesh...' button on the toolbar is only enabled when one object is selected. I've tried using the Part workbench's 'Create compound' tool to combine the objects into a single one, but then mesh generation produces this output:

0.0: Preparing meshing ...
0.0: Error: 'NoneType' object has no attribute 'Name'

What's the recommended way forward here?

Meshing with cfMesh with # processes > 1 causes meshing to hang. Zombie processes left after Stop.

When meshing the attached FreeCAD project with cfMesh if number of processes is set to more than 1 and number of threads set to 0, the meshing process will get hung at "Finished renaming boundary patches" with the processors running at 100% load.

If number of processes is set to 1 and number of threads to 0, all the processors still get used but the mesh completes without hanging.

If one kills the mesh process with the "Stop" button, a number of zombie processes get left running, albeit at almost zero load.

hung mesh session.txt

naca2412_BH.zip

Allmesh row 26 and 41

file Allmesh
row 26 and 41
if [ -z $FOAM_API ] && [ $WM_PROJECT_VERSION -ge 9 ]

But version can be not only with digits.
I installed openfoam from https://openfoam.org/download/dev-ubuntu/ and get version "dev".

No module named 'freecad.plot'

Software Context

Freecad was installed via conda: conda create -n freecad freecad -c conda-forge

Freecad about:

OS: Ubuntu 18.10
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.18.14555 (Git shallow)
Build type: Release
Branch: (HEAD detached at 2ea4c6a)
Hash: 2ea4c6a81a6449b6880f8a757d0298dd889e0630
Python version: 3.7.1
Qt version: 5.6.2
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: French/Switzerland (fr_CH)

cfdOF Dependancies

Dependency checker output:

Checking dependencies...
No missing dependencies detected

Bug Occuring

Performing first tutorial (elbow), everythong works fine until Page 22 (Write the case to a directory). Clicking on the "Edit Properties and run solver" green arrow button raises the following stacktrace:

Traceback (most recent call last):
  File "/home/nic/.FreeCAD/Mod/CfdOF/_ViewProviderCfdSolverFoam.py", line 81, in setEdit
    from CfdRunnableFoam import CfdRunnableFoam
  File "/home/nic/.FreeCAD/Mod/CfdOF/CfdRunnableFoam.py", line 44, in <module>
    from CfdResidualPlot import ResidualPlot
  File "/home/nic/.FreeCAD/Mod/CfdOF/CfdResidualPlot.py", line 30, in <module>
    from freecad.plot import Plot
<class 'ModuleNotFoundError'>: No module named 'freecad.plot'

---

[edit] No bug detected using freecad-daily

The Bug does not affect Freecad-daily

OS: Ubuntu 18.10
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.18.16093 (Git)
Build type: Release
Branch: releases/FreeCAD-0-18
Hash: 690774c0effe4fd7b8d2b5e2fb2b8c8d145e21ce
Python version: 2.7.15+
Qt version: 5.11.1
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: French/Switzerland (fr_CH)

FOAM FATAL when mesh is generated

Hi,

I am using freecad 0.18 on openSUSE Leap 15.0 (from the repository science version 0.18.3-lp150.97.1) and openfoam version 1906-lp150.6.1.

I am trying the tutorial 1 and when I try to create the mesh (page 14) I got the message "3.9: Meshing exited with error".

Looking into the output lead me to a "FOAM FATAL
surfaceMeshTriangulate has been superceded by surfaceMeshExtract (DEC-2018)" at the end of the log output. Substituting "runCommand surfaceMeshTriangulate mesh_outside.stl" by "runCommand surfaceMeshExtract mesh_outside.stl" in the Allmesh script resolved the issue.

Please excuse, but I do not know where to look to fix it without introducing additional trouble.

Kind regards

Full LOG:
Part to mesh:
Name: Body, Label: Body, ShapeType: Solid
CharacteristicLengthMax: 800.0
ElementDimension: 3D
No mesh refinements
Populating mesh dictionaries in folder /tmp/freecad/meshCase
Successfully wrote meshCase to folder /tmp/freecad/meshCase
Executing: bash -c cd "/tmp/freecad/meshCase" && ./Allmesh
Raw command: ['bash', '-c', 'cd "/tmp/freecad/meshCase" && ./Allmesh']
Info : Running '/usr/bin/gmsh - gmsh/Body_Geometry.geo' [Gmsh 4.4.1, 1 node, max. 1 thread]
Info : Started on Wed Oct 16 16:24:47 2019
Info : Reading 'gmsh/Body_Geometry.geo'...
Info : Reading '/tmp/freecad/meshCase/gmsh/Body_Geometry.brep'...
Info : Done reading '/tmp/freecad/meshCase/gmsh/Body_Geometry.brep'
Info : Meshing 1D...
Info : Meshing curve 1 (Line)
Info : Meshing curve 2 (Line)
Info : Meshing curve 3 (Line)
Info : Meshing curve 4 (Line)
Info : Meshing curve 5 (Line)
Info : Meshing curve 6 (Line)
Info : Meshing curve 7 (Line)
Info : Meshing curve 8 (Line)
Info : Meshing curve 9 (Line)
Info : Meshing curve 10 (Line)
Info : Meshing curve 11 (Line)
Info : Meshing curve 12 (Circle)
Info : Meshing curve 13 (Circle)
Info : Meshing curve 14 (Line)
Info : Meshing curve 15 (Line)
Info : Meshing curve 16 (Line)
Info : Meshing curve 17 (Line)
Info : Meshing curve 18 (Line)
Info : Meshing curve 19 (Line)
Info : Meshing curve 20 (Line)
Info : Meshing curve 21 (Line)
Info : Meshing curve 22 (Line)
Info : Meshing curve 23 (Line)
Info : Meshing curve 24 (Circle)
Info : Meshing curve 25 (Circle)
Info : Meshing curve 26 (Line)
Info : Meshing curve 27 (Line)
Info : Meshing curve 28 (Line)
Info : Meshing curve 29 (Line)
Info : Meshing curve 30 (Line)
Info : Meshing curve 31 (Line)
Info : Meshing curve 32 (Line)
Info : Meshing curve 33 (Line)
Info : Meshing curve 34 (Line)
Info : Meshing curve 35 (Circle)
Info : Meshing curve 36 (Circle)
Info : Done meshing 1D (0.006575 s)
Info : Meshing 2D...
Info : Meshing surface 1 (Plane, Delaunay)
Info : Meshing surface 2 (Plane, Delaunay)
Info : Meshing surface 3 (Plane, Delaunay)
Info : Meshing surface 4 (Cylinder, Delaunay)
Info : Meshing surface 5 (Plane, Delaunay)
Info : Meshing surface 6 (Plane, Delaunay)
Info : Meshing surface 7 (Plane, Delaunay)
Info : Meshing surface 8 (Cylinder, Delaunay)
Info : Meshing surface 9 (Plane, Delaunay)
Info : Meshing surface 10 (Plane, Delaunay)
Info : Meshing surface 11 (Plane, Delaunay)
Info : Meshing surface 12 (Cylinder, Delaunay)
Info : Meshing surface 13 (Plane, Delaunay)
Info : Meshing surface 14 (Plane, Delaunay)
Info : Done meshing 2D (0.872024 s)
Info : Meshing 3D...
Info : 3D Meshing 1 volumes with 1 connected components
Info : Tetrahedrization of 7532 points in 0.161071 seconds
Info : Reconstructing mesh...
Info : - Creating surface mesh
Info : - Identifying boundary edges
Info : - Recovering boundary
Info : - Added 18 Steiner points
Info : Done reconstructing mesh (0.481506 s)
Info : Found region 1
Info : 0 points created - worst tet radius 1.64878 (points removed 0 0)
Info : 3D point insertion terminated (7574 points created):
Info : - 0 Delaunay cavities modified for star shapeness
Info : - 42 points could not be inserted
Info : - 22562 tetrahedra created in 0.005953 sec. (3790021 tets/s)
Info : Done meshing 3D (0.729099 s)
Info : Optimizing 3D mesh...
Info : Optimizing volume 1
Info : Optimization starts (volume = 1.68261e+12) with worst = 0.0109476 / average = 0.70175:
Info : 0.00 < quality < 0.10 : 217 elements
Info : 0.10 < quality < 0.20 : 160 elements
Info : 0.20 < quality < 0.30 : 141 elements
Info : 0.30 < quality < 0.40 : 166 elements
Info : 0.40 < quality < 0.50 : 301 elements
Info : 0.50 < quality < 0.60 : 1556 elements
Info : 0.60 < quality < 0.70 : 6350 elements
Info : 0.70 < quality < 0.80 : 10825 elements
Info : 0.80 < quality < 0.90 : 2263 elements
Info : 0.90 < quality < 1.00 : 583 elements
Info : 500 edge swaps, 4 node relocations (volume = 1.68261e+12): worst = 0.0134277 / average = 0.714694 (0.015967 s)
Info : 525 edge swaps, 5 node relocations (volume = 1.68261e+12): worst = 0.0134277 / average = 0.715034 (0.020887 s)
Info : 4 ill-shaped tets are still in the mesh
Info : 0.00 < quality < 0.10 : 9 elements
Info : 0.10 < quality < 0.20 : 9 elements
Info : 0.20 < quality < 0.30 : 5 elements
Info : 0.30 < quality < 0.40 : 157 elements
Info : 0.40 < quality < 0.50 : 266 elements
Info : 0.50 < quality < 0.60 : 1424 elements
Info : 0.60 < quality < 0.70 : 6487 elements
Info : 0.70 < quality < 0.80 : 10955 elements
Info : 0.80 < quality < 0.90 : 2212 elements
Info : 0.90 < quality < 1.00 : 578 elements
Info : Done optimizing 3D mesh (0.049231 s)
Info : 7574 vertices 37873 elements
Info : Writing '/tmp/freecad/meshCase/gmsh/Body_Geometry.msh'...
Info : Done writing '/tmp/freecad/meshCase/gmsh/Body_Geometry.msh'
Info : Done reading 'gmsh/Body_Geometry.geo'
Info : Stopped on Wed Oct 16 16:24:49 2019
/---------------------------------------------------------------------------
| ========= | |
| \ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \ / O peration | Version: 1906 |
| \ / A nd | Web: www.OpenFOAM.com |
| \/ M anipulation | |
*---------------------------------------------------------------------------*/
Build : 1906 OPENFOAM=1906 patch=191001
Arch : "LSB;label=32;scalar=64"
Exec : gmshToFoam gmsh/Body_Geometry.msh
Date : Oct 16 2019
Time : 16:24:50
Host : lukas
PID : 17806
I/O : uncollated
Case : /tmp/freecad/meshCase
nProcs : 1
trapFpe: Floating point exception trapping enabled (FOAM_SIGFPE).
fileModificationChecking : Monitoring run-time modified files using timeStampMaster (fileModificationSkew 10)
allowSystemOperations : Allowing user-supplied system call operations

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
Create time

--> FOAM Warning :
From function static Foam::IOstreamOption::compressionType Foam::IOstreamOption::compressionEnum(const Foam::word&)
in file db/IOstreams/IOstreams/IOstreamOption.C at line 86
Unknown compression specifier 'uncompressed', assuming no compression
Starting to read mesh format at line 2
Read format version 2.2 ascii 0

Starting to read physical names at line 5
Physical names:15
Surface 2 face0
Surface 3 face1
Surface 4 face2
Surface 5 face3
Surface 6 face4
Surface 7 face5
Surface 8 face6
Surface 9 face7
Surface 10 face8
Surface 11 face9
Surface 12 face10
Surface 13 face11
Surface 14 face12
Surface 15 face13
Volume 1 Internal

Starting to read points at line 23
Vertices to be read: 7574
Vertices read:7574

Starting to read cells at line 7600
Cells to be read: 37169

Mapping region 2 to Foam patch 0
Mapping region 3 to Foam patch 1
Mapping region 4 to Foam patch 2
Mapping region 5 to Foam patch 3
Mapping region 6 to Foam patch 4
Mapping region 7 to Foam patch 5
Mapping region 8 to Foam patch 6
Mapping region 9 to Foam patch 7
Mapping region 10 to Foam patch 8
Mapping region 11 to Foam patch 9
Mapping region 12 to Foam patch 10
Mapping region 13 to Foam patch 11
Mapping region 14 to Foam patch 12
Mapping region 15 to Foam patch 13
Mapping region 1 to Foam cellZone 0
Cells:
total:22125
hex :0
prism:0
pyr :0
tet :22125

CellZones:
Zone Size
0 22125

Patch 0 gets name face0
Patch 1 gets name face1
Patch 2 gets name face2
Patch 3 gets name face3
Patch 4 gets name face4
Patch 5 gets name face5
Patch 6 gets name face6
Patch 7 gets name face7
Patch 8 gets name face8
Patch 9 gets name face9
Patch 10 gets name face10
Patch 11 gets name face11
Patch 12 gets name face12
Patch 13 gets name face13

--> FOAM Warning :
From function Foam::polyMesh::polyMesh(const Foam::IOobject&, Foam::pointField&&, const cellShapeList&, const faceListList&, const wordList&, const wordList&, const Foam::word&, const Foam::word&, const wordList&, bool)
in file meshes/polyMesh/polyMeshFromShapeMesh.C at line 592
Found 15044 undefined faces in mesh; adding to default patch.
Finding faces of patch 0
Finding faces of patch 1
Finding faces of patch 2
Finding faces of patch 3
Finding faces of patch 4
Finding faces of patch 5
Finding faces of patch 6
Finding faces of patch 7
Finding faces of patch 8
Finding faces of patch 9
Finding faces of patch 10
Finding faces of patch 11
Finding faces of patch 12
Finding faces of patch 13

FaceZones:
Zone Size

Writing zone 0 to cellZone Internal and cellSet
End

/---------------------------------------------------------------------------
| ========= | |
| \ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \ / O peration | Version: 1906 |
| \ / A nd | Web: www.OpenFOAM.com |
| \/ M anipulation | |
*---------------------------------------------------------------------------*/
Build : 1906 OPENFOAM=1906 patch=191001
Arch : "LSB;label=32;scalar=64"
Exec : transformPoints -scale (0.001 0.001 0.001)
Date : Oct 16 2019
Time : 16:24:51
Host : lukas
PID : 17812
I/O : uncollated
Case : /tmp/freecad/meshCase
nProcs : 1
trapFpe: Floating point exception trapping enabled (FOAM_SIGFPE).
fileModificationChecking : Monitoring run-time modified files using timeStampMaster (fileModificationSkew 10)
allowSystemOperations : Allowing user-supplied system call operations

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
Create time

--> FOAM Warning :
From function static Foam::IOstreamOption::compressionType Foam::IOstreamOption::compressionEnum(const Foam::word&)
in file db/IOstreams/IOstreams/IOstreamOption.C at line 86
Unknown compression specifier 'uncompressed', assuming no compression
Scaling points by (0.001 0.001 0.001)
Writing points into directory "/tmp/freecad/meshCase/constant/polyMesh"

End

FOAM FATAL
surfaceMeshTriangulate has been superceded by surfaceMeshExtract (DEC-2018)

Hisa not found after install completed

I am new to freeCAD. Just installed it today, but there is a problem with Hisa. It always says Hisa is not found after install complete.

blueCFD automatic download fails to launch installer

Hi,
If i click install blueCFD-core in the preferences dialog, it downloads a file with no extension instead of .exe and it fails to launch the installer


Translation: There is no association of an application with the specified file for this operation

If i download the file by copying the given url https://github.com/blueCFD/Core/releases/download/blueCFD-Core-2017-2/blueCFD-Core-2017-2-win64-setup.exe in the browser, and then select it with choose existing file, it works fine.

Mesh task dialog is not showing

Hello.

I am trying to do CfdOF elbow tutorial from opensim.
However, the mesh task dialog is not showing so I cannot apply the mesh.
The workbench is installed successfully, along with cfmesh and Hisa.
Is there a workaround for this issue?

System used:
Pop_OS 20.04
OpenFOAM 7 [installed via ppa]
Freecad 18.4 [ubuntu repo via synaptic]

Kind regards,
Iwan

SnappyHexMesh scaling

Hi,
I am running Freecad 0.19 in ubuntu machine. When I mesh with snappyhexmesh a simple model, it is scaling the mesh and the mesh model is almost double (x and y directions) of my model. I have checked for other mesh algorithims working fine. But snappyhexmesh has problem in Allmesh file I have checked thant when I change (play) the rates in command "runCommand surfaceTransformPoints -scale "(1000 1000 1000)" mesh_outside.stl mesh_outside.stl" model is getting similar sizes.

Load issue - missing dependencies

While attempting to load the CfdOF, I get following error message:

During initialization the error "module 'CfdTools' has no attribute 'get_module_path'" occurred in share/Mod/CfdOF/InitGui.py

Note: For security reasons, the patch was truncated

System:

• Debian 10 (64-bit) - Linux
• FreeCAD version: 4.0.0

CFD_Mesh not using multi threaded parameter for mesh case writing surface enumaration

Much as the title.

Essentially, Cfd OF seems to only use the multi threaded parameter in the CFD mesh workbench when calling GMSH/snappyhexmesh or CFmesh, but does not use it when writting the case itself.

This is fine for small meshes (number of faces smaller than 100k) but means that larger cases can take more time to write the mesh case file than actually mesh.

errors from excuting FCMACRO

the solver cannot run when I excute the FCMACRO file. The errors are:

10:14:15 Exception ignored in: <function CfdConsoleProcess.del at 0x000001AE939E6E50>
10:14:15 Traceback (most recent call last):
10:14:15 File "D:\ProgramData\FreeCAD 0.19\Mod\CfdOF\CfdConsoleProcess.py", line 52, in del
10:14:15 self.terminate()
10:14:15 File "D:\ProgramData\FreeCAD 0.19\Mod\CfdOF\CfdConsoleProcess.py", line 75, in terminate
10:14:15 if self.process.state() != self.process.NotRunning:
10:14:15 AttributeError: 'CfdConsoleProcess' object has no attribute 'process'
10:14:15 Traceback (most recent call last):
File "E:/myWorkspace/myAirfoil2/myAirfoil/simulators/finiteTE/computing.FCMacro", line 32, in
solver_process = CfdConsoleProcess.CfdConsoleProcess(stdoutHook=solver_runner.process_output)
<class 'TypeError'>: init() got an unexpected keyword argument 'stdoutHook'

Excessive rounding in data entry fields

Data entry fields seem to round to 2 significant figures and I can't see any way to change this behaviour. For example on Inlet velocity, if I want to set a 10 deg AoA then I need to set the Uy and Uz components to high precision, however if I enter the components to 5 sf:

then they get rounded to just 2 sf:

Which isn't really enough. I have checked and it is not just the display that is being rounded, it's the rounded numbers which are being written into the OpenFOAM case files. So my current workaround is to edit those files with a Text Editor to enter in the numbers at full accuracy.
If I select the Inlet object in the model tree then I can edit the values to full precision in the "Data" tab, however if I then open the GUI for the inlet then it rounds them back to 2sf.

Problem compiling cfMesh-cfdof on Ubuntu 20.04

Hello!

OS: Ubuntu 20.04

Using: OpenFOAM-7 (see https://openfoam.org)
Build: 7-3bcbaf946ae9

FreeCAD 0.18 Revision: 16146 (Git)

I've installed the "Plot" and "CfdOF" workbenches using the Addon Manager.

Clicking the "Install cfMesh" button fails, though. I've attached the log file.

log.Allwmake.txt

I looked at the first error, and it seemed to be looking for a directory that doesn't exist:

wmakeLnIncludeAll: running wmakeLnInclude on dependent libraries:
    wmakeLnInclude error: base directory /opt/openfoam7/src/edgeMesh/ does not exist

It looks like this has been moved to /opt/openfoam7/src/meshTools/edgeMesh/. So I went around to all the options files and removed references to this directory. Allwclean ; Allwmake and I get a different error, seemingly to do with syntax or typing or something. (I don't really know C++.)

utilities/checkMeshDict/checkMeshDict.C:361:69: error: ‘LITERAL’ is not a member of ‘Foam::keyType’
  361 |                     dict.lookupEntry(objectNames[objectI], keyType::LITERAL);
      |                                                                     ^~~~~~~

log2.txt

I don't know if this is a real error that I revealed by resolving the import error, or a new error that I introduced by messing with the imports...

Does anyone have any insights? Thanks

AttributeError: module 'Plot' has no attribute 'figure'

Case write is ok but when I'm running the solver I got this error :
Start to write case to folder /tmp Matching boundary conditions ... Populating createPatchDict to update BC names Successfully wrote case to folder /tmp Traceback (most recent call last): File "/home/fred/.FreeCAD/Mod/CfdOF/_TaskPanelCfdSolverControl.py", line 152, in runSolverProcess cmd = self.solver_runner.get_solver_cmd(solverDirectory) File "/home/fred/.FreeCAD/Mod/CfdOF/CfdRunnableFoam.py", line 93, in get_solver_cmd self.residualPlot = ResidualPlot() File "/home/fred/.FreeCAD/Mod/CfdOF/CfdResidualPlot.py", line 37, in __init__ self.fig = Plot.figure(FreeCAD.ActiveDocument.Name + "Residuals") AttributeError: module 'Plot' has no attribute 'figure'

the same error has been reported here :
https://forum.freecadweb.org/viewtopic.php?f=3&t=37553

When following this plot workbench basic tutorial :
https://www.freecadweb.org/wiki/Plot_Basic_tutorial

I've the same error in the console after this two command :
import Plot
Plot.figure("TrigonometricTest")
Traceback (most recent call last): File "<input>", line 1, in <module> AttributeError: module 'Plot' has no attribute 'figure'

So I post this same issue on freecad.plot repo.
FreeCAD/freecad.plot#8

Hope somebody can help...

config :
Ubuntu 18.04
Freecad 0.18.3
Python 3.6.8

Hisa don't work at OpenFoam 7

Greetings.
I have a problem when I try to use CFD for freecad, I believe that is something similar to the error that ca be find in these link: #12
But the difference is that I am using OpenFoam 7, you could help me.

Installation error (missing component)

I'm getting the following error while trying to install CfdOF in FreeCAD on Ubuntu 20.04 (for FreeCAD details see below):

Some errors were found that prevent to install this workbench: Some errors were found that prevent to install this workbench. Please install the missing components first.

So apparently I'm missing some component, but I'm not sure which one(s)....
I installed cfMesh and HiSA using the links listed in the Getting Started section. The OpenFOAM version I'm using is Foundation version 7, which comes with Paraview 5.6 (installed from source, located under /opt)

The installation instructions say something about dependency checking through FreeCAD preferences, but I can't find this option (Edit | Preferences is there alright, but I can't find any CfdOF there):
Dependencies can be checked and installed conveniently from the CfdOF Preferences panel in FreeCAD. In the FreeCAD window, select Edit | Preferences ... and choose "CfdOF".

As I couldn't find this CfdOF Preferences panel, I was also unable to set the OpenFOAM install directory, so I tried starting FreeCAD after sourcing OpenFOAM, but that didn't work either, got me the same error message.

How can I find out which component I'm missing?

Many thanks,
Sita

FreeCAD details (AppImage, FreeCAD_0.19.3-Linux-Conda_glibc2.12-x86_64.AppImage)
OS: Ubuntu 20.04.4 LTS (ubuntu:GNOME/ubuntu)
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.19.24366 (Git) AppImage
Build type: Release
Branch: (HEAD detached at 0f9259c)
Hash: 0f9259cda103ae1824ac16c68ac9b4a0d54b05fc
Python version: 3.9.7
Qt version: 5.12.9
Coin version: 4.0.0
OCC version: 7.5.3
Locale: English/United States (en_US)

Installation: error while installing cfmesh in new computer

Hi,

I am getting a lot of errors when running the installation of cfmesh using the latest zip file from sourceforge (march 2020). However, it keeps on looking for directories that do not seem to exist, nor could I find them in the ZIP's folder (I also looked for them in another computer with the installation and could not find them).

One Example from the log file:
could not open file UList.H for source file utilities/workflowControls/workflowControls.C
(I couldn't find this directory anywhere).

Here is a screenshot of the panel:

*** Here is the initial portion of the log file ***
wmake libso meshLibrary wmakeLnInclude: linking include files to ./lnInclude Making dependency list for source file workflowControls.C Making dependency list for source file fpmaMesh.C Making dependency list for source file writeMeshFPMA.C Making dependency list for source file voronoiMeshGenerator.C Making dependency list for source file voronoiMeshExtractorCreateMesh.C Making dependency list for source file voronoiMeshExtractorAddressing.C Making dependency list for source file voronoiMeshExtractor.C Making dependency list for source file tetMeshGenerator.C Making dependency list for source file tetMeshExtractorOctree.C Making dependency list for source file cartesian2DMeshGenerator.C Making dependency list for source file cartesianMeshGenerator.C Making dependency list for source file cartesianMeshExtractorDecomposeSplitHexes.C could not open file UList.H for source file utilities/workflowControls/workflowControls.C could not open file foamTime.H for source file utilities/workflowControls/workflowControls.C could not open file Time.H for source file utilities/workflowControls/workflowControls.C could not open file HashSet.H for source file utilities/workflowControls/workflowControls.C could not open file token.H for source file utilities/workflowControls/workflowControls.C could not open file Istream.H for source file utilities/workflowControls/workflowControls.C could not open file SubList.H for source file utilities/workflowControls/workflowControls.C could not open file foamTime.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C could not open file Time.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C could not open file HashSet.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C could not open file token.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C could not open file UList.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C could not open file Istream.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C could not open file SubList.H for source file utilities/dataConversion/foamToFPMA/fpmaMesh.C

---

Thank you very much for this wonderful project.

HiSA and cfMesh install issues

Hi I'm running windows 10 and I was trying to install cdfof on freecad. I used the buttons in the preferences panel to install all the dependencies. I put OpenFoam in a folder on my desktop and it's my understanding that HiSA and cfMesh are installed to the OpenFoam folder? But whenever I hit install it just installs the Zip file to the Temp directory. When running the dependency checker it takes a long time and then says that it couldn't find the HiSA or cfMesh install. Is there something I'm doing wrong? The OpenFoam folder on my desktop should be writeable

Materials error

Hi, I am running FreeCAD from the latest AppImage.

OS: Arch Linux
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.18.16117 (Git) AppImage
Build type: Release
Branch: (HEAD detached at 0.18.2)
Hash: dbb4cc6415bac848a294f03b80f65e888d531742
Python version: 3.6.7
Qt version: 5.6.2
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: English/UnitedStates (en_US)

When I press "Add fluid properties" the following error occurs:

File CardName (SeaWater) is not content CardName (FreeCAD Material card: see https://www.freecadweb.org/wiki/Material)
Running the Python command 'Cfd_Analysis' failed:
Traceback (most recent call last):
  File "/home/me/.FreeCAD/Mod/CfdOF/CfdAnalysis.py", line 94, in Activated
    FreeCADGui.doCommand("analysis.addObject(CfdFluidMaterial.makeCfdFluidMaterial('FluidProperties'))")
  File "<string>", line 1, in <module>
  File "/home/me/.FreeCAD/Mod/CfdOF/CfdFluidMaterial.py", line 39, in makeCfdFluidMaterial
    _CfdMaterial(obj)  # Include default fluid properties
  File "/home/me/.FreeCAD/Mod/CfdOF/CfdFluidMaterial.py", line 91, in __init__
    self.initProperties(obj)
  File "/home/me/.FreeCAD/Mod/CfdOF/CfdFluidMaterial.py", line 104, in initProperties
    mats, name_path_list = CfdTools.importMaterials()
  File "/home/me/.FreeCAD/Mod/CfdOF/CfdTools.py", line 1129, in importMaterials
    material_name_path_list = material_name_path_list + addMatDir(system_mat_dir, materials)
  File "/home/me/.FreeCAD/Mod/CfdOF/CfdTools.py", line 1143, in addMatDir
    materials[a_path] = importFCMat.read(a_path)
  File "/tmp/.mount_FreeCAcAb56k/usr/Mod/Material/importFCMat.py", line 122, in read
    v = line.split(";")[1].strip()  # Line 2

And I cannot select any materials in FreeCAD.

Original materials, produce the error because they are missing a comment in the second line:

; FreeCAD Material card: see https://www.freecadweb.org/wiki/Material

[FCdMat]
Name = Water
Description = Standard distilled water properties at 20 Degrees Celsius and 1 atm
Density = 998 kg/m^3
DynamicViscosity = 1.003e-3 kg/m/s 

Materials with second line comment do not:

; FreeCAD Material card: see https://www.freecadweb.org/wiki/Material
; FreeCAD
[FCdMat]
Name = Water
Description = Standard distilled water properties at 20 Degrees Celsius and 1 atm
Density = 998 kg/m^3
DynamicViscosity = 1.003e-3 kg/m/s 

It seems that missing "; AUTHOR LICENCE STUFF" in the second line was expected by the code in importFCMat.py, which is missing in every material for some reason.

Hope it helps.

Error on run mesher

I am having issues running the mesher on windows and getting the below error. It looks like the mesh case is created fine, but the directory is not accessible in openfoam because it is outside the docker instance.

FreeCAD info:

OS: Windows 10
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.18.4 (GitTag)
Build type: Release
Branch: releases/FreeCAD-0-18
Hash: 980bf9060e28555fecd9e3462f68ca74007b70f8
Python version: 3.6.6
Qt version: 5.6.2
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: English/UnitedStates (en_US)

I have installed openfoam from the preferences. I cannot run the dependency checker though as this hangs for me. That may be a separate bug I am thinking

InitialiseFields break

Hello,
First I would thank you for all your effort in this project.
I'm beginner in Freecad and CFD.
I've try make a very simple case with cube and a cylindre add cfd analysis but when I clic "InitialiseFields" button This error appear :
Traceback (most recent call last): File "/home/fred/.FreeCAD/Mod/CfdOF/CfdInitialiseFlowField.py", line 149, in setEdit self.Object, physics_model, boundaries, material_objs) File "/home/fred/.FreeCAD/Mod/CfdOF/_TaskPanelCfdInitialiseInternalFlowField.py", line 62, in __init__ self.load() File "/home/fred/.FreeCAD/Mod/CfdOF/_TaskPanelCfdInitialiseInternalFlowField.py", line 104, in load self.form.comboInlets.setCurrentIndex(self.form.comboInlets.findData(self.obj.Inlet.Name)) <class 'AttributeError'>: 'NoneType' object has no attribute 'Name'
and the task dialog doesn't show.
Thanks for your help.

HiSa not installed correctly in FreeCAD

I tried to install HISA, and run one of the tutorials to check for any issues. None of the tutorials work because HISA was not found:
--> FOAM Warning :
From function bool Foam::dlLibraryTable::open(const Foam::fileName&, bool)
in file db/dynamicLibrary/dlLibraryTable/dlLibraryTable.C at line 105
could not load "libhisaFiniteVolume.so"

I updated HISA from the preferences tab and according to the depency checker it installed correctly:

However, the output console gives me some errors:
Checking CFD workbench dependencies...
Checking FreeCAD version
Checking for OpenFOAM:
Running echo $WM_PROJECT_VERSION
Raw command: ['C:/Program Files/FreeCAD 0.18/bin\python.exe', '-u', 'C:\Users\MyPC\AppData\Roaming\FreeCAD\Mod\CfdOF\WindowsRunWrapper.py', 'C:/PROGRA1/BLUECF1/OPENFO~1.X\..\msys64\usr\bin\bash', '--login', '-O', 'expand_aliases', '-c', 'echo $WM_PROJECT_VERSION']
Setting environment for OpenFOAM 5.x mingw-w64 Double Precision (of5-64), using MSMPI71 - please wait...
Environment is now ready. Notes:

• You can change between installed versions by running: ofmenu
• You can change to other predefined versions by running: ofmenuNew
  5.x
  Running cartesianMesh -version
  Raw command: ['C:/Program Files/FreeCAD 0.18/bin\python.exe', '-u', 'C:\Users\MyPC\AppData\Roaming\FreeCAD\Mod\CfdOF\WindowsRunWrapper.py', 'C:/PROGRA1/BLUECF1/OPENFO~1.X\..\msys64\usr\bin\bash', '--login', '-O', 'expand_aliases', '-c', 'cartesianMesh -version']
  Setting environment for OpenFOAM 5.x mingw-w64 Double Precision (of5-64), using MSMPI71 - please wait...
  Environment is now ready. Notes:
• You can change between installed versions by running: ofmenu
• You can change to other predefined versions by running: ofmenuNew
  /---------------------------------------------------------------------------
  | ========= | |
  | \ / F ield | OpenFOAM: The Open Source CFD Toolbox |
  | \ / O peration | Version: 5.x |
  | \ / A nd | Web: www.OpenFOAM.org |
  | \/ M anipulation | |
  *---------------------------------------------------------------------------/
  / Windows 32 and 64 bit porting by blueCAPE: http://www.bluecape.com.pt
  | Based on Windows porting (2.0.x v4) by Symscape: http://www.symscape.com |
  *---------------------------------------------------------------------------/
  Build : 5.x-963176928289
  Exec : C:/PROGRA1/BLUECF1/ofuser-of5/platforms/mingw_w64GccDPInt32Opt/bin/cartesianMesh.exe -version
  Date : May 26 2020
  Time : 21:29:13
  Host : "MyPC"
  PID : 6992
  I/O : uncollated
  Case : C:/PROGRA1/BLUECF1/msys64/home/ofuser
  nProcs : 1
  SigFpe : Enabling floating point exception trapping (FOAM_SIGFPE).
  fileModificationChecking : Monitoring run-time modified files using timeStampMaster (fileModificationSkew 10)
  allowSystemOperations : Allowing user-supplied system call operations

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
cfMesh-CfdOF (cfMesh 1.1.2) 1.6
Running hisa -version
Raw command: ['C:/Program Files/FreeCAD 0.18/bin\python.exe', '-u', 'C:\Users\MyPC\AppData\Roaming\FreeCAD\Mod\CfdOF\WindowsRunWrapper.py', 'C:/PROGRA1/BLUECF1/OPENFO~1.X\..\msys64\usr\bin\bash', '--login', '-O', 'expand_aliases', '-c', 'hisa -version']
Setting environment for OpenFOAM 5.x mingw-w64 Double Precision (of5-64), using MSMPI71 - please wait...
Environment is now ready. Notes:

• You can change between installed versions by running: ofmenu
• You can change to other predefined versions by running: ofmenuNew
  /---------------------------------------------------------------------------
  | ========= | |
  | \ / F ield | OpenFOAM: The Open Source CFD Toolbox |
  | \ / O peration | Version: 5.x |
  | \ / A nd | Web: www.OpenFOAM.org |
  | \/ M anipulation | |
  *---------------------------------------------------------------------------/
  / Windows 32 and 64 bit porting by blueCAPE: http://www.bluecape.com.pt
  | Based on Windows porting (2.0.x v4) by Symscape: http://www.symscape.com |
  *---------------------------------------------------------------------------/
  Build : 5.x-963176928289
  Exec : C:/PROGRA1/BLUECF1/ofuser-of5/platforms/mingw_w64GccDPInt32Opt/bin/hisa.exe -version
  Date : May 26 2020
  Time : 21:29:15
  Host : "MyPC"
  PID : 5644
  I/O : uncollated
  Case : C:/PROGRA1/BLUECF1/msys64/home/ofuser
  nProcs : 1
  SigFpe : Enabling floating point exception trapping (FOAM_SIGFPE).
  fileModificationChecking : Monitoring run-time modified files using timeStampMaster (fileModificationSkew 10)
  allowSystemOperations : Allowing user-supplied system call operations

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
--> FOAM Warning :
From function void* Foam::dlOpen(const Foam::fileName&, bool)
in file MSwindows.C at line 1336
LoadLibrary failed. "Error 126: The specified module could not be found.

"
hisa 1.1.3
Checking for paraview:
Checking for Plot workbench:
Checking for gmsh:
Completed CFD dependency check

Any help is welcome!

HISA not found even after multiple installations

Hi,
I'm facing following issue when I run dependency checker in preference menu of FreeCAd, to use CFDOF, I believe that is something similar to the error that ca be find in these link: #12 , I am using OpenFoam 8, I tried installing multiple no of time but same issue, I even cloned hisa repository to Open FOAM8, still the same issue. I need your support in fixing this issue.

Thanks
Lokesha

Support XDG Base Directory Specification

Installation script of cfMesh and HiSA violates XDG Base Directory Specification.
Right now installation path is like this $HOME/OpenFOAM/$USER-v$VERSION/platforms/$OSarch$Gccversion/ that contains bin and lib directories. (In my case $HOME/OpenFOAM/einhander-v2012/platforms/linux64GccDPInt32Opt)
By XDG Specification bin and lib should be located under $HOME/.local/ directory.
But in case of multiple version software like OpenFOAM, I think that cfMesh bin and lib should be placed under $HOME/.local/lib/openfoam/openfoam2012/platforms/linux64GccDPInt32Opt/ like it placed in /usr/ directory in openfoam2012 binary package.

XDG specification with examples https://wiki.archlinux.org/index.php/XDG_Base_Directory

Support debian openfoam installation

Hello, I've installed openfoam via apt install openfoam, but CfdOF can't detect openfoam. In https://develop.openfoam.com/Development/openfoam/-/wikis/precompiled/debian says that "The OpenFOAM applications are located under /usr/bin and configuration files under /usr/share/openfoam/etc", but It can't be detected in /usr/bin nor /usr/share/openfoam/ directory.

Allmesh: line 9: syntax error near unexpected token `>'

Allmesh: line 9: ` "$@" 1> >(tee -a log."$sol") 2> >(tee -a log."$sol" >&2)'

#!/bin/bash

runCommand()
{
if [ "$1" == "mpirun" ]; then sol="$4"; else sol="$1"; fi
sol=$(basename -- "$sol")
sol="${sol%.*}"
if [ -f log."$sol" ]; then rm log."$sol"; fi
"$@" 1> >(tee -a log."$sol") 2> >(tee -a log."$sol" >&2)
err=$?
if [ ! $err -eq 0 ]; then exit $err; fi
}

Extract feature edges

runCommand surfaceFeatureEdges -angle 60 "constant/triSurface/Compound_Geometry.stl" "Compound_Geometry.fms"
runCommand cartesianMesh

if [ ! -z $FOAM_API ] && [ $FOAM_API -ge 1906 ]
then
runCommand surfaceMeshExtract mesh_outside.stl
else
runCommand surfaceMeshTriangulate mesh_outside.stl
fi

runCommand surfaceTransformPoints -scale "(1000 1000 1000)" mesh_outside.stl mesh_outside.stl

Running the Python command 'Cfd_Analysis' failed

Hi,
I'm not able even to create an analysis because.
It seems an error similar to issue #23 but it happens immediately when I create the analysis.
Namely: the container CfdAnalysis is created in the document and has also PhysicsModel inside it Instead FluidProperties is left outside the container, in the document tree, and then the script stops.
I tried to update the addon cfdof but the addon manager returns that it is already up-to-date.
The full error message is:
'''
Running the Python command 'Cfd_Analysis' failed:
Traceback (most recent call last):
File "/home/user/.FreeCAD/Mod/CfdOF/CfdAnalysis.py", line 94, in Activated
FreeCADGui.doCommand("analysis.addObject(CfdFluidMaterial.makeCfdFluidMaterial('FluidProperties'))")
File "", line 1, in
File "/home/user/.FreeCAD/Mod/CfdOF/CfdFluidMaterial.py", line 39, in makeCfdFluidMaterial
_CfdMaterial(obj) # Include default fluid properties
File "/home/user/.FreeCAD/Mod/CfdOF/CfdFluidMaterial.py", line 91, in init
self.initProperties(obj)
File "/home/user/.FreeCAD/Mod/CfdOF/CfdFluidMaterial.py", line 104, in initProperties
mats, name_path_list = CfdTools.importMaterials()
File "/home/user/.FreeCAD/Mod/CfdOF/CfdTools.py", line 1150, in importMaterials
material_name_path_list = material_name_path_list + addMatDir(system_mat_dir, materials)
File "/home/user/.FreeCAD/Mod/CfdOF/CfdTools.py", line 1166, in addMatDir
materials[a_path] = importFCMat.read(a_path)
File "/tmp/.mount_FreeCANAkZYR/usr/Mod/Material/importFCMat.py", line 115, in read
v = line.split(";")[1].strip() # Line 1

list index out of range
'''
I'm running 0.19 dev Appimage but that happens also with 0.18 Appimage and 0.17:
'''
OS: Linux Mint 19.2
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.19.16121 (Git) AppImage
Build type: Release
Branch: master
Hash: a7919b63dea4bb1f1107c80ed44758479eec3d8d
Python version: 3.6.7
Qt version: 5.6.2
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: Italian/Italy (it_IT)
'''
Can you clarify how to get rid of this?

Preference Page is not working

When trying to access the CfdOF Preference page it came up blank, and at the bottom in yellow lettering it says, "Cfd Preference Page is not a preference page"

Problems with cfMesh and HiSA

Hello, I have the same problem with cfMesh and HiSA, I do not know what is the problem, can you help me please?

wmake will be installed if OpenFOAM*-devel is installed.

A person on the FreeCAD CfdOF forums had trouble installing cfmesh and Hisa because wmake wasn't available on his computer. https://forum.freecadweb.org/viewtopic.php?style=5&f=37&t=74015

The poster included the following quote, apparently from the CfdOF ReadMe file:

The dependencies can be installed manually, or as part of a docker container (refer to Docker container install below). Manual installation may be undertaken for OpenFOAM (OpenCFD or Foundation versions), Paraview and Gmsh (optional) by using the links above or your distribution's package manager. Note, however, that the OpenFOAM packages bundled in some Linux distributions may be out of date or incomplete; for example, the standard Debian and Ubuntu packages do not include the build command 'wmake' and therefore cannot be used with the optional components 'HiSA' and 'cfMesh'. We therefore recommend installation of the packages supplied through the official websites above.

It turns out that wmake will get installed if the user installs the openFOAM development package. In my case, on Fedora 37, using the Copr repository, the OpenFOAM development package is openfoam2206-devel.noarch. After installing that package, wmake is present on my computer.

[me@workstation1 ~]$ wmake
wmake error: file 'Make/files' does not exist in /home/me
[me@workstation1 ~]$ which wmake
/usr/lib/openfoam/openfoam2206/wmake/wmake
[me@workstation1 ~]$ wmake -version
2206

I too enountered the wmake package missing prior to installing the OpenFOAM devel package. After installing OpenFOAM devel package, I was able to install cfmesh and Hisa from within CfgOF.

I provide this information for 3 purposes:

1. On Linux machines the OpenFOAM installation might be expanded to include the OpenFOAM devel package.

2. The ReadMe might be modified to add the fact that wmake may be obtained by installing the OpenFOAM devel package.

3. Additional information may be added to the wmake missing message when checking dependencies.

Problem with dependency checker

HI
I have a problem when install and setting up cfdOF in FreeCad. (I have OpenFOME 8). When selecting OpenFOAM install directory witch for me is /opt/openfoam8 i get this message in the output:

Checking dependencies...
Could not find OpenFOAM installation: The directory /opt/openfoam8 is not a recognised OpenFOAM installation
gmsh not found (optional)

So i am wondering what the problem is and if there is a solution?

Error when using PartDesign Boolean

CfdOF/CfdTools.py

Line 242 in 8691c5e

FreeCAD.getDocument(doc_name).getObject(obj.Name).Mode = 'CompSolid'

Hi, this implementation is problematic because it trows errors when there is a PartDesign Boolean (wich doesn't have the Mode property) in the document, a workaround is to manually create a Mode property in the boolean feature.

Here the error:
Traceback (most recent call last): File "C:\Users\usuario\AppData\Roaming\FreeCAD\Mod\CfdOF\CfdMesh.py", line 155, in onChanged CfdTools.setCompSolid(vobj) File "C:\Users\usuario\AppData\Roaming\FreeCAD\Mod\CfdOF\CfdTools.py", line 241, in setCompSolid FreeCAD.getDocument(doc_name).getObject(obj.Name).Mode = 'CompSolid' <class 'AttributeError'>: 'PartDesign.Feature' object has no attribute 'Mode'

And my FreeCAD info in case it's relevant:

OS: Windows 10 (10.0)
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.19.18750 (Git)
Build type: Release
Branch: master
Hash: a3e88a399fb6395a20f4cf5c7e3ed70e61c9e22f
Python version: 3.7.3
Qt version: 5.12.1
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: Spanish/Paraguay (es_PY)

example.zip
Attached a minimal example (change zip to FCStd), double click Sphere_Mesh to get the error

CfdOF - Please create SVG logo for this workbench

It will be added to the new and improved Addon Manager
FreeCAD/FreeCAD-addons#37

Need help installing dependencies

Hi everyone,
I'm trying to install CfdOF in my FreeCAD Addon manager, but it always says that it cannot find the dependencies. I have downloaded the OpenFOAM .deb files from their website and unpacked them into $HOME, so I have $HOME/usr/lib/openfoam/openfoam2112/platforms/linux64GccDPInt32Opt and $HOME/usr/lib/openfoam/openfoam2112/platforms/tools. Also I installed ParaView, also into $HOME so have a big bunch of libraries in `$HOME/usr/lib" and the binaries:

~$ ls usr/bin/
hydra_pmi_proxy  ospray_mpi_worker  paraview.conf  pvbatch       pvdataserver       pvpython       pvrenderserver       pvserver       qt.conf
mpiexec          paraview           paraview-real  pvbatch-real  pvdataserver-real  pvpython-real  pvrenderserver-real  pvserver-real  vrpn_server

I have the FreeCAD AppImage in $HOME, too, and I did no modifications to any of my environment variables. So, what else could be the problem ?

MacOSx

Any plans to put in instructions to get this working with MAC? Can't figure out how to integrate in the Docker container to have openFoam installation available to Freecad on MAC

Paraview launch button not working with appimage due to path

It looks like the paraview button does not work at least with the appimage due to the fact it does not explicitly attempt to launch the script in the default /tmp/meshCase folder

0.0: Preparing meshing ...
0.0: Exporting mesh refinement data ...
0.1: Exporting the part surfaces ...
0.3: Mesh case written to /tmp/meshCase
5.3: Please edit the case input files externally at: /tmp/meshCase
0.0: Running cfMesh ...
0.0: Mesher started
1.9: Meshing completed
Reading mesh ...
Triangulated representation of the surface mesh is shown -
Please view in Paraview for accurate display.
0.0: Running /opt/paraviewopenfoam56/bin/paraview --script=pvScriptMesh.py
0.0: Paraview started

This fails to launch as does from the cli

(base) mike@mike-HP-Pavilion-Laptop-15-cs0xxx:~$ /opt/paraviewopenfoam56/bin/paraview --script=pvScriptMesh.py

explictly changing to
(base) mike@mike-HP-Pavilion-Laptop-15-cs0xxx:~$ /opt/paraviewopenfoam56/bin/paraview --script=/tmp/meshCase/pvScriptMesh.py

works fine.

I also have the same problem launching parview from the solver dialog and can work around it from the cli.

I believe the easy fix for the appimage directory issue is just use the full path instead of expecting it to be in that directory.
Saw you had stated this was a known issue in another thread but here is a workaround.

Thanks for all the work
Mike

OS: Ubuntu 21.04 (ubuntu:GNOME/ubuntu)
Word size of FreeCAD: 64-bit
Version: 0.20.25429 (Git) AppImage
Build type: Release
Branch: master
Hash: acce57a25d82b0408fa07b9452ed31c8a06c7a1b
Python version: 3.9.6
Qt version: 5.12.9
Coin version: 4.0.0
OCC version: 7.5.2
Locale: English/United States (en_US)

"No module name freecad.plot" error persists after pip installing

I pip installed freecad.plot and it is successfully installed. Yet, this issue persists on double-clicking on cfdsolver. Do I need to take additional steps for freecad to recognize the new add-on. I have restarted freecad multiple times already. Thanks in advance!

10:47:13 Traceback (most recent call last):
File "/home/adwaith/.FreeCAD/Mod/CfdOF/CfdSolverFoam.py", line 168, in setEdit
from CfdRunnableFoam import CfdRunnableFoam
File "/home/adwaith/.FreeCAD/Mod/CfdOF/CfdRunnableFoam.py", line 33, in
from CfdResidualPlot import ResidualPlot
File "/home/adwaith/.FreeCAD/Mod/CfdOF/CfdResidualPlot.py", line 31, in
from freecad.plot import Plot
<class 'ModuleNotFoundError'>: No module named 'freecad.plot'

Failed starting paraview

Launch paraview on gui and get this error on console:

Traceback (most recent call last):
  File "/home/edombek/.local/share/FreeCAD/Mod/CfdOF/./CfdOF/Solve/TaskPanelCfdSolverControl.py", line 302, in openParaview
    self.open_paraview = CfdTools.startParaview(case_path, script_name, self.consoleMessage)
  File "/home/edombek/.local/share/FreeCAD/Mod/CfdOF/./CfdOF/CfdTools.py", line 1227, in startParaview
    CfdConsoleProcess.removeAppimageEnvironment(env)
AttributeError: type object 'CfdConsoleProcess' has no attribute 'removeAppimageEnvironment'
Traceback (most recent call last):
  File "/home/edombek/.local/share/FreeCAD/Mod/CfdOF/./CfdOF/Solve/TaskPanelCfdSolverControl.py", line 302, in openParaview
    self.open_paraview = CfdTools.startParaview(case_path, script_name, self.consoleMessage)
  File "/home/edombek/.local/share/FreeCAD/Mod/CfdOF/./CfdOF/CfdTools.py", line 1227, in startParaview
    CfdConsoleProcess.removeAppimageEnvironment(env)
AttributeError: type object 'CfdConsoleProcess' has no attribute 'removeAppimageEnvironment'

paraview 5.10.1
freecad 0.21.0.30252.gaf18a9ea3b
CfdOF latest version

Please update to support OpenFOAM 10

Please

two times plot workbench in freeCAD!

There is a plot workbench in freeCAD 0.94. But it isn't the cfdOF used!

Dependancy checker does not find GMSH

Running FreeCad 0.19 from the Ubuntu PPA,
CfdOF from the manager.
Open foam version 2012
Gmsh latest stable from developer, pre-compiled binary, version 4.8.4

Path to GMSH is exported to bashrc and executable to all users

Platform is PopOS 20.04 with a 5.10.x Kernel

Proposed modifications to CfdOF to utilize a remote computer for meshing and simulation tasks.

I'm thinking of modifying CfdOF so that the user can run meshes and simulations locally or on a remote computer. I'm looking for input before I do anything.

Generating large meshes and simulating them can take considerable time on even the fastest desktop CPU. In some cases hours or even days. Meanwhile the workstation machine is tied up and often not very responsive because the CPU core loads are high and the memory bandwidth is almost entirely consumed. The storage device will also be accessed frequently, further slowing down the local machine.

A better way to handle large meshing and simulation tasks is to off load them to a second (remote) computer, leaving the workstation almost unhindered while they run. Furthermore the remote computer can be optimized to run mesh and simulation loads much faster than a desktop machine might be.

I presently use a remote computer to generate meshes and run OpenFOAM simulations. I do this by editing the mesh and OF case files on my workstation, then copying them to the remote machine, logging into the remote machine with ssh and then running the tasks in the ssh session. I'm doing most of this without CfdOF, manually.

While this approach works, it is cumbersome. One is always moving case files back and forth between the workstation and the remote machine as well as the results from the remote machine back to the workstation. More than once I thought I was looking at a mesh or simulation result that just ran when, in fact, it wasn't the current output. Ugghhh.

I'd like to streamline the use of a remote computer in CfdOF, so that it happens automagically from the CfdOF GUI.

I envision doing this as follows:

1. Add a Remote tab to the CfdOF Preferences GUI for the remote connection parameters and set up. The Remote tab would have a checkbox to allow the use of a remote computer and fields for the remote hostname and username on the remote computer as well as a way to test it the connection. Ie can one successfully invoke an ssh session with the remote computer ?

The Remote tab will also allow setting up OpenFOAM, gmsh, cfmesh and Hisa on the remote machine, just as how it happens on the local computer right now.

I want the remote computer to be set up exactly as the local computer is set up as far as the tools go. That way anything that can be done in a worker thread on the local machine could also be done in a worker thread on the remote machine in a ssh session. With a little tweaking, of course.

For now I will not handle setting up Docker on the remote machine, just because I am not terribly familiar with Docker. I have used virtual environments, but not Docker. I may ask for assistance on this part of the task or leave it unimplemented.

2. In the CFD Mesh GUI I will change the "Write mesh case" button to "Write mesh case locally" and add a "Write mesh case remotely" button. The former will do as it does now. The later will write the mesh case to the working directory on the remote computer.

Likewise the Check Mesh button will also have a local and remote version.

I will also change the "Run mesher" button to "Run mesher locally" and add a "Run mesher remotely" button. The former will do as it does now. The later will mesh the mesh case that has been written on the remote machine and display the progress results in the Status box, just as it does now.

Having local and remote versions of these buttons will allow the user to use CfdOF exactly as it is presently used or with a remote computer as the user decides when working on the project. If the remote machine is busy running a mesh or simulation for another FreeCAD instance, the user may want to run meshes or simulations locally. Having both versions of the buttons allows the user the option of doing either.

Upon completion of the remote meshing task, the results will automatically be copied back to the local machine so they can be viewed (Load surface mesh) just as if they were meshed locally.

3. In the CFD Solver GUI the Write button will have a local and remote version, just as the Mesh GUI did.

I haven't figured out how to eloquently handle Editing the remote files. My best solution so far is to write the local files, allow the user to edit them locally and then have a "Copy to remote" button that will copy the entire (edited) case to the remote machine.

The Run button will have a local and remote version. The results of the remote run will display in the Status box and the Reporting Functions just as they do now.

Upon completion of a remote run the results will be copied back to the local machine, just as if it ran locally. Thus the Paraview button will work exactly as it does now, by using Paraview locally on locally stored results.

The availability of all the remote buttons will be controlled by the "Allow remote computations" checkbox on the Remote tab. If the "Allow remote computations" CB isn't checked, all the remote buttons will be disabled, leaving the user only the local buttons. Thus if the "Allow remote computations" button isn't checked, CfdOF will behave exactly as it does now.

SSH will require a password every time a new session is invoked. I'll ask the local user for the remote user's password the first time a remote operation (via ssh) is needed, but not store it. The ssh session should stay available forever unless something happens to one of the computers, ie gets powered down or goes to sleep (timeout). I'll check that the ssh session is still alive every time before using it. If the ssh session has ended, I'll invoke a new one, in which case I'll have to ask the user for the password again.

I also want to (eventually) handle the case of the workstation going to sleep, or being shut down or the user quitting FreeCAD while a remote task is running. I think I can do this by opening a new ssh connection when CfdOF is restarted and reattaching to the existing task. I'm not sure how I'll handle the data that will be missing while the connection is lost. I may have to buffer it on the remote side and redisplay it on the local side when the connection is resumed.

It seems like a lot of work to allow the workstation FreeCAD session to disconnect and resume, but it allows the user the flexibility to reboot the workstation, shut it off overnight, etc., while a task is running on the remote machine.

I am not calling the local machine a host and the remote machine a server because this isn't a true client/server relationship in the traditional sense. Right now I'm using the terminology of local and remote. I'm open to suggestions on the terminology aspect of it.

Theoretically the remote machine will allow multiple FreeCAD "clients" to connect to it, as long as each FreeCAD connection uses a different directory to store the results in. By allocating each client a subset of the total number of cores, each may have a decent experience, ie realtime but slower compared to having exclusive access to the remote machine. For now the allocation of cores will be done manually by the local user, not automatically.

The highest incarnation of using a remote computer for CfdOF processing would be the use of an AWS server or similar. I'm not saying that the work I would do would achieve this. But I do think it would be a step in the right direction. Right now it is quite cumbersome to use an AWS server for OpenFOAM work, for the same reasons I experienced and mentioned. If the remote functionality of the proposed enhancement were done right it could really streamline working with an AWS server.

Not everyone can afford a dedicated EPYC server beside their desk to run their OpenFOAM tasks. But just about everyone can afford to buy some time on an AWS server or make use of a virtual instance granted to them on a server at their local university. Adding remote processing capabilities to CfdOF would really steamline this workflow.

One of the advantages of using an ssh session to do the work on the remote computer is that just about every OS available already has ssh on it. While we could write a special server to run on the remote computer to interface with CfdOF, it would require special setup on the remote machine and I don't see that it would add a lot of value. If one uses ssh sessions, all one needs to do is ensure that ssh is set up on the remote computer.

I'm hoping to add my code to the existing worker thread routines, adding cases for the remote functionality. The alternative would be to duplicate the existing worker thread routines and create local and remote versions of each. I think there will be a lot of code commonality and having duplicates of each would increase maintenance effort in the future. However, I understand that there is a case for leaving the present routines untouched and developing stand alone remote routines. I await your input on this.

At this point I'm doing this just for me to test the concept. These changes may never be published if I find it too cumbersome in use. I'm asking for input now so that if remote processing does make it to the public that what I'm doing has a good chance of being accepted without making a lot of changes. I'm also looking for better ideas on how it might be done.

Thanks for your attention. Thoughts ? Ideas ? Advice ? Feedback ?

UAV case slicemesh meshrefinement Err

11:12:00 Traceback (most recent call last):
File "C:\Users...\AppData\Roaming\FreeCAD\Mod\cfdOF\CfdMeshRefinement.py", line 133, in execute
obj.Shape = shape
<class 'AttributeError'>: 'FeaturePython' object has no attribute 'Shape'

Add LGTM badge

Per FreeCAD/FreeCAD-addons#163

Would it be OK if we added these badges to the top of the README ? This was discussed in https://www.forum.freecadweb.org/viewtopic.php?f=10&t=40228

[![Total alerts](https://img.shields.io/lgtm/alerts/g/jaheyns/CfdOF.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jaheyns/CfdOF/alerts/)

Example:

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/jaheyns/CfdOF.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jaheyns/CfdOF/context:python)

Example:

OpenFOAM IO error: Cannot find patchField entry for MeshRefinement... file: ../case/0/U.boundaryField from line 28 to line 19.

Somehow, when trying to run a case that has a mesh with a "zero thickness baffle" defined in a surface mesh refinement, I always get the following solver error:

OpenFOAM IO error: Cannot find patchField entry for MeshRefinement... file: ../case/0/U.boundaryField from line 28 to line 19.
(removed path)

This happens pretty consistently whenever I use the baffle option for surface refinement for snappyHexMesh.

Whether I define the baffle surfaces as a no-slip wall or just not define them at all for the solver, I get the same error.

Awesome work. Thank you so much.

Allrun FOAMDIR= set wrong

I'm running FreeCAD 0.18.4 on Ubuntu
Description: Ubuntu 18.04.5 LTS
Release: 18.04
Codename: bionic

I've installed CfdOF successfully and the dependency check is OK. Under the freecad preferences CfdOF the OpenFoam install directory is set to /opt/openfoam6. Meshing works absolutely fine. When I go to the Solver module and write the case out it sets the Allrun FOAMDIR="None" everytime. The work around is just to edit the Allrun in kate and set the FOAMDIR="/opt/openfoam6" and all is well but it would be nice not to have to and will probably confuse new users. It took me a while to figure out the problem being new to OpenFoam