FluidFoam documentation ¶

pip install fluidfoam --user
You can get the source code from github or from the Python Package Index.
The development mode is often useful. From the root directory, run:
python setup.py develop --user
Committing instructions (in development mode)¶
A good starting point is to follow this forking tutorial.
To clone your fork of fluidfoam repository:
git clone https://github.com/your_username/fluidfoam
To get the status of the repository:
git status
In case of new/modified file(s):
git add new_file
To commit a revision on the local repository:
git commit -m "comment on the revision"
To push the revision on your github fluidfoam repository:
git push
To propose your changes into the main fluidfoam project, follow again the forking tutorial.
Example Usage¶
https://sedfoam.github.io
Core Developers¶
Cyrille.Bonamy@univ-grenoble-alpes.fr
Other Contributors¶
Julien.Chauchat@univ-grenoble-alpes.fr
amathieu@udel.edu
Remi.Chassagne@univ-grenoble-alpes.fr
Quentin.Clemencot@univ-grenoble-alpes.fr
Matthias.Renaud@univ-grenoble-alpes.fr
Alban.Gilletta.De.Saint.Joseph@france-energies-marines.org
Gabriel Goncalves
Emeritus Core Developers¶
Pierre.Augier@legi.cnrs.fr
Emeritus Developers¶
Guillaume.Maurice@univ-grenoble-alpes.fr
Tim.Nagel@legi.cnrs.fr
License¶
fluidfoam is distributed under the GNU General Public License v3 (GPLv3 or newer).
Modules Reference¶
Here is presented the general organization of the package
and the documentation of the modules, classes and
functions.
fluidfoam.readof
Reading OpenFoam Files with Python
This module provides functions to read OpenFoam Files:
fluidfoam.processing1d
Write, Read and Plot 1D input files for swak4foam
This module allows to read OpenFoam output of one dimensional computation
and then write, plot and read input files for Boundary and Initial
Conditions imposition in 3D computation (via swak4foam):
fluidfoam.readpostpro
Read OpenFoam PostProcessing Files for Python
This module provides functions to list and read OpenFoam PostProcessing Files:
fluidfoam.meshdesign
Compute mesh grading and cell sizes
This module provides functions to design OpenFoam mesh using blockMesh:
fluidfoam.meshvisu
Visualisation of 2D OpenFoam Mesh with Python
This module provides functions to read 2D OpenFoam Mesh:
fluidfoam.openfoamsimu
Class to load all data saved at timeStep of an openFoam simulation