Investigate OpenFOAM tutorials
OpenFOAM provides a lot of "case examples" in a tutorials
directory (env FOAM_TUTORIALS
, path like /opt/openfoam/2206plus/OpenFOAM-v2206/tutorials
at LEGI).
We need to investigate (also programmatically) these example cases to be able to produce a general tool.
-
we can have a script that loop over these tutorials to list all files used in the definition of these cases. -
we can have a script that parse all these files to (i) check our ability to parse these files and (ii) list the used syntax (described in https://www.openfoam.com/documentation/user-guide/2-openfoam-cases/2-2-basic-inputoutput-file-format).
We know that we have usually the same files:
/opt/openfoam/2206plus/OpenFOAM-v2206/tutorials/incompressible/icoFoam/cavity/cavity$ ls *
0:
p U
constant:
transportProperties
system:
blockMeshDict decomposeParDict fvSolution
controlDict fvSchemes PDRblockMeshDict
We want to know for each of these files the regularities and the differences between different cases.
We want to list in our doc the documentation page describing these files (for example for system/blockMeshDict
https://www.openfoam.com/documentation/user-guide/4-mesh-generation-and-conversion/4.3-mesh-generation-with-the-blockmesh-utility, for system/fvSolution
, https://doc.cfd.direct/openfoam/user-guide-v6/fvsolution).
The results should be described in some pages (.md files) in /doc/dev
.