/porousMultiphaseFoam

A porous multiphase toolbox for OpenFOAM

Primary LanguageC++OtherNOASSERTION

**************************************************************************
****************** PorousMultiphaseFoam for OpenFOAM *********************
**************************************************************************

* General Informations : 

- The toolbox compatibility list:

  - branch "master": 
    - OpenFOAM 6	v1809
    - OpenFOAM 5.0	v1809
    - OpenFOAM 4.0	v1.4.1
    - OpenFOAM 3.0	v1.2

  - branch "foam-extend":
    - foam-extend 4.0	v1809

  - branch "esi-version":
    - OpenFOAM v1806	v1809
    - OpenFOAM v1712    v1805

  - version no supported:
    - OpenFOAM 2.4 and older
    - foam-extend 3.2 and older
    - OpenFOAM v1706 and older

- This toolbox needs only a standard OpenFOAM installation (see www.openfoam.org)

- Please cite the related paper in the "doc" folder if you are using this toolbox.

- Read the COPYING_OPENFOAM file for information about OpenFOAM and this toolbox Copyrights.

* Installation instructions : 


- First, source the OpenFOAM configuration file, i.e. (example for ubuntu version) : 
   source /opt/openfoam5x/etc/bashrc

- then in the "porousMultiphaseFoam" directory, run :

	./Allwmake

  to install the package.

- Dynamic libraries, "libporousBoundaryConditions.so" and "libporousModels.so"
  are compiled in the standard OpenFOAM user directory : $FOAM_USER_LIBBIN;

- The executable solver "impesFoam" is placed in the standard OpenFOAM user
  directory $FOAM_USER_APPBIN.

- Each tutorial directory contains "run" and "clean" files to test installation
  and validate the solver.

- A python script runTutorials.py can be used to test all components.

- To remove compilation and temporary files, run :

	./Allwclean

- see the ReleaseNotes.txt file for detailed information about the toolbox.

**************************************************************************