FluidFoam documentation

The fluidfoam package provides Python classes useful to perform some plot with OpenFoam data.

What is this repository for?

  • Openfoam Tools

  • Version : 0.1.6

  • Supported OpenFoam Versions : 2.4.0, 4.1, 5.0, 6.0, v1712+, v1806+

  • Supported Python Versions : 2.7.x, >= 3.4

Deployment instructions

The simplest way to install fluidfoam is by using pip:

pip install fluidfoam

You can get the source code from Bitbucket 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)

To get the status of the files:

hg st

In case of new file(s):

hg add new_file

To commit a revision on the local repository:

hg ci -m "comment on the revision"

To push the revision on the central repository:

hg push

Update instructions (in development mode)

Pull the last revision:

hg pull

Deploy:

hg up

License

fluidfoam is distributed under the CeCILL-B License, a BSD compatible french license.

Modules Reference

Here is presented the general organization of the package and the documentation of the modules, classes and functions.

fluidfoam.readof

Read OpenFoam Files for Python

fluidfoam.processing1d

Write, Read and Plot 1D input files for swak4foam

fluidfoam.readpostpro

Read OpenFoam PostProcessing Files for Python

fluidfoam.meshdesign

Compute mesh grading and cell sizes

Example galleries:

More

Indices and tables