openfoam example and short explanation in documentation
You can write some example and documentation about how to use the openfoam stuff
-
add complete example in examples/openfoam/*.py -
move this all of this example from https://github.com/dpkn31/Yade-OpenFOAM-coupling to examples/openfoam/ -
make sure that once openfoam6 is installed and configured properly and the icoFoamYade.C is compiled, then the command mpiexec -n 1 python scriptYade.py : -n 2 icoFoamYade -parallel
works correctly inside examples/openfoam dir -
better not duplicate this example inside Yade-OpenFOAM-coupling/example_icoFoamYade dir, this will cause troubles later, so maybe just delete it from Yade-OpenFOAM-coupling/example_icoFoamYade -
fix the example to use from yadeimport import *
instead oflibyade.py
, as per convention established in https://yade-dev.gitlab.io/trunk/user.html#importing-yade-in-other-python-applications -
inside this example write more detailed comments with bash commands showing necessary steps to run this example, e.g. as in !85 (comment 154456619)
-
-
add the example to examples/list_of_examples.txt (as it is not automatically generated yet, #54 ) -
write a short section in documentation about how to use openfoam, maybe something similar to https://yade-dev.gitlab.io/trunk/FEMxDEM.html -
be sure to mention what packages must be installed to make it all work -
use ":ysrc:`examples/openfoam/`" in documentation to link to examples directory ;) -
use ":yref:`yadeFoamCoupling`" or something like ":yref:`open foam coupling <yadeFoamCoupling>`" in documentation to link to class reference in documentation -
maybe use scripts/list_of_examples_make_videos.sh or just invoke recordmydesktop -x 0 -y 0 --width 1024 --height 768 -o openfoam_example_1.ogv --no-sound
to make a (cool) video ? -
add link to this video in doc/sphinx/FoamCoupling.rst like it is done in doc/sphinx/tutorial-data-mining.rst lines 271-275
-
-
Update of install section of documentation, where the new dependencies are listed, file doc/sphinx/installation.rst -
decide between ENABLE_FOAMCOUPLING and ENABLE_OPENMPI (or something else), then update it in three places: -
https://gitlab.com/yade-dev/trunk/blob/3a25b7d2a9512fd439347d23bf30581f77a267a4/CMakeLists.txt#L23 -
https://gitlab.com/yade-dev/trunk/blob/3a25b7d2a9512fd439347d23bf30581f77a267a4/CMakeLists.txt#L153 -
https://gitlab.com/yade-dev/trunk/blob/3a25b7d2a9512fd439347d23bf30581f77a267a4/doc/sphinx/installation.rst#L247
-
-
-
disable it by default because of two reasons. 1. It is experimental 2. It is a bad idea to force all users to install new dependencies -
Please remove so many empty lines -
improve doc/sphinx/FoamCoupling.rst by writing short answers to following questions. Just few short sentences and links to relevant places in openfoam manual or elsewehre: -
It is just fluid acting on point-sized (infinitely small) masses? -
How the pressure (or is it the fluid velocity?) is applied on the spheres from the grid element onto the sphere. (is it applied to the sphere center? is it applied around the sphere surface using the sphere radius?) -
Is the mesh in OpenFOAM constant? Or is there some remeshing inside OpenFOAM happening? -
What happens with a sphere that goes through the boundary of the mesh. Clarify what are the boundary assumptions in such case when half (a bit more, or a bit less) of the sphere is inside/outside the mesh. If it this is ill-posed then please write this. -
Please mention the mesh generation method: is it default OpenFOAM meshing, or some other (maybe internal yade+CGAL, or other external) meshing method is used? -
Elaborate a little bit more in the Usage section https://yade-dev.gitlab.io/-/trunk/-/jobs/183890384/artifacts/install/share/doc/yade-ci/html/FoamCoupling.html#usage use some more :yref:`………` references to class reference (you will have to test locally if :yref: are correct links until we fix #64 (closed))
-
You can click on the boxes as they are completed along the way ;)
Edited by Janek Kozicki