Difference between revisions of "Contrib/porousMultiphaseFoam"

From OpenFOAMWiki
(Kicked off this page)
 
(foam-extend 3.0 to 3.2: would need fixing for 3.0-ext)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
= Overview =
 +
 
; Source code repository: [https://github.com/phorgue/porousMultiphaseFoam porousMultiphaseFoam at GitHub]
 
; Source code repository: [https://github.com/phorgue/porousMultiphaseFoam porousMultiphaseFoam at GitHub]
  
; Description: A open-source toolbox for multiphase flow in porous media.
+
; Description: An open-source toolbox for multiphase flow in porous media.
  
 
; Support pages:
 
; Support pages:
 
:* Issue/bug tracker: [https://github.com/phorgue/porousMultiphaseFoam/issues porousMultiphaseFoam Issue Tracker]
 
:* Issue/bug tracker: [https://github.com/phorgue/porousMultiphaseFoam/issues porousMultiphaseFoam Issue Tracker]
 
:* Forum support thread: [http://www.cfd-online.com/Forums/openfoam-news-announcements-other/143248-porous-multiphase-toolbox-openfoam.html A porous multiphase toolbox for OpenFOAM]
 
:* Forum support thread: [http://www.cfd-online.com/Forums/openfoam-news-announcements-other/143248-porous-multiphase-toolbox-openfoam.html A porous multiphase toolbox for OpenFOAM]
 +
 +
 +
= Installation steps =
 +
 +
== OpenFOAM 3.0 and newer ==
 +
{{VersionInfo}}{{Version3.0}}
 +
 +
<ol>
 +
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
 +
<bash>mkdir -p $FOAM_RUN
 +
cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"</bash>
 +
</li>
 +
 +
<li>Now, it depends on the mode in which you are able to download the toolbox. Try them in order until you don't get an error message while downloading or unpacking:
 +
 +
<ol>
 +
<li>From the Git repository [https://github.com/phorgue/porousMultiphaseFoam], using the {{tt|git}} command:
 +
<bash>git clone https://github.com/phorgue/porousMultiphaseFoam.git porousMultiphaseFoam</bash>
 +
</li>
 +
 +
<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git repository, either directly in the command line:
 +
<bash>wget "https://github.com/phorgue/porousMultiphaseFoam/archive/master.tar.gz" -O porousMultiphaseFoam.tar.gz
 +
tar -xf porousMultiphaseFoam.tar.gz
 +
mv porousMultiphaseFoam-master porousMultiphaseFoam
 +
</bash>
 +
Or manually:
 +
# Download this file: [https://github.com/phorgue/porousMultiphaseFoam/archive/master.tar.gz master.tar.gz]
 +
# Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-master" into the folder indicated by this command: <bash>pwd</bash>
 +
# Rename the folder: <bash>mv porousMultiphaseFoam-master porousMultiphaseFoam</bash>
 +
</li>
 +
 +
<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
 +
<bash>wget "https://github.com/phorgue/porousMultiphaseFoam/archive/master.zip" -O porousMultiphaseFoam.zip
 +
unzip porousMultiphaseFoam.zip
 +
mv porousMultiphaseFoam-master porousMultiphaseFoam
 +
</bash>
 +
Or manually:
 +
# Download this file: [https://github.com/phorgue/porousMultiphaseFoam/archive/master.zip master.zip]
 +
# Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-master" into the folder indicated by this command: <bash>pwd</bash>
 +
# Rename the folder: <bash>mv porousMultiphaseFoam-master porousMultiphaseFoam</bash>
 +
</li>
 +
</ol>
 +
 +
</li>
 +
 +
 +
<li>Now we can build the toolbox:
 +
<bash>cd porousMultiphaseFoam
 +
./Allwmake > log.make 2>&1</bash>
 +
</li>
 +
 +
<li>Run the script a second time, for getting a summary of the build:
 +
<bash>./Allwmake > log.make 2>&1</bash>
 +
</li>
 +
 +
<li>Look into the content of the log file:
 +
<bash>cat log.make</bash>
 +
If all went well, it should show you something like this:
 +
<bash>+ wmake libso porousBoundaryConditions
 +
'/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/lib/libporousBoundaryConditions.so' is up to date.
 +
+ wmake libso porousModels
 +
'/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/lib/libporousModels.so' is up to date.
 +
+ wmake impesFoam
 +
make: '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/bin/impesFoam' is up to date.
 +
+ wmake anisoImpesFoam
 +
make: '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/bin/anisoImpesFoam' is up to date.
 +
+ wmake groundwaterFoam
 +
make: '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/bin/groundwaterFoam' is up to date.</bash>
 +
</li>
 +
 +
<li>Now for getting started, follow the instructions given in the {{tt|README.md}} file or read it in the project page: [https://github.com/phorgue/porousMultiphaseFoam porousMultiphaseFoam at GitHub]</li>
 +
 +
</ol>
 +
 +
== OpenFOAM 2.2 to 2.4 ==
 +
{{VersionInfo}}{{Version2.2}}{{Version2.3}}{{Version2.4}}
 +
 +
<ol>
 +
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
 +
<bash>mkdir -p $FOAM_RUN
 +
cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"</bash>
 +
</li>
 +
 +
<li>Now, it depends on the mode in which you are able to download the toolbox. Try them in order until you don't get an error message while downloading or unpacking:
 +
 +
<ol>
 +
<li>From the Git repository [https://github.com/phorgue/porousMultiphaseFoam], using the {{tt|git}} command:
 +
<bash>git clone https://github.com/phorgue/porousMultiphaseFoam.git porousMultiphaseFoam
 +
cd porousMultiphaseFoam
 +
git checkout of240
 +
cd ..</bash>
 +
</li>
 +
 +
<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git repository, either directly in the command line:
 +
<bash>wget "https://github.com/phorgue/porousMultiphaseFoam/archive/of240.tar.gz" -O porousMultiphaseFoam.tar.gz
 +
tar -xf porousMultiphaseFoam.tar.gz
 +
mv porousMultiphaseFoam-of240 porousMultiphaseFoam
 +
</bash>
 +
Or manually:
 +
# Download this file: [https://github.com/phorgue/porousMultiphaseFoam/archive/of240.tar.gz of240.tar.gz]
 +
# Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-of240" into the folder indicated by this command: <bash>pwd</bash>
 +
# Rename the folder: <bash>mv porousMultiphaseFoam-of240 porousMultiphaseFoam</bash>
 +
</li>
 +
 +
<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
 +
<bash>wget "https://github.com/phorgue/porousMultiphaseFoam/archive/of240.zip" -O porousMultiphaseFoam.zip
 +
unzip porousMultiphaseFoam.zip
 +
mv porousMultiphaseFoam-of240 porousMultiphaseFoam
 +
</bash>
 +
Or manually:
 +
# Download this file: [https://github.com/phorgue/porousMultiphaseFoam/archive/of240.zip of240.zip]
 +
# Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-of240" into the folder indicated by this command: <bash>pwd</bash>
 +
# Rename the folder: <bash>mv porousMultiphaseFoam-of240 porousMultiphaseFoam</bash>
 +
</li>
 +
</ol>
 +
 +
</li>
 +
 +
 +
<li>Now we can build the toolbox:
 +
<bash>cd porousMultiphaseFoam
 +
./Allwmake > log.make 2>&1</bash>
 +
</li>
 +
 +
<li>Run the script a second time, for getting a summary of the build:
 +
<bash>./Allwmake > log.make 2>&1</bash>
 +
</li>
 +
 +
<li>Look into the content of the log file:
 +
<bash>cat log.make</bash>
 +
If all went well, it should show you something like this:
 +
<bash>+ wmake libso porousBoundaryConditions
 +
'/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/lib/libporousBoundaryConditions.so' is up to date.
 +
+ wmake libso porousModels
 +
'/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/lib/libporousModels.so' is up to date.
 +
+ wmake impesFoam
 +
make: '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/bin/impesFoam' is up to date.
 +
+ wmake anisoImpesFoam
 +
make: '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/bin/anisoImpesFoam' is up to date.
 +
+ wmake groundwaterFoam
 +
make: '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/bin/groundwaterFoam' is up to date.</bash>
 +
</li>
 +
 +
<li>Now for getting started, follow the instructions given in the {{tt|README.md}} file or read it in the project page: [https://github.com/phorgue/porousMultiphaseFoam porousMultiphaseFoam at GitHub]</li>
 +
 +
</ol>
 +
 +
== foam-extend 3.1 to 3.2 ==
 +
{{VersionInfo}}{{Version3.1-ext}}{{Version3.2-ext}}
 +
 +
<ol>
 +
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/foam/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
 +
<bash>mkdir -p $FOAM_RUN
 +
cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"</bash>
 +
</li>
 +
 +
<li>Now, it depends on the mode in which you are able to download the toolbox. Try them in order until you don't get an error message while downloading or unpacking:
 +
 +
<ol>
 +
<li>From the Git repository [https://github.com/phorgue/porousMultiphaseFoam], using the {{tt|git}} command:
 +
<bash>git clone https://github.com/phorgue/porousMultiphaseFoam.git porousMultiphaseFoam
 +
cd porousMultiphaseFoam
 +
git checkout extend-version
 +
cd ..</bash>
 +
</li>
 +
 +
<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git repository, either directly in the command line:
 +
<bash>wget "https://github.com/phorgue/porousMultiphaseFoam/archive/extend-version.tar.gz" -O porousMultiphaseFoam.tar.gz
 +
tar -xf porousMultiphaseFoam.tar.gz
 +
mv porousMultiphaseFoam-extend-version porousMultiphaseFoam
 +
</bash>
 +
Or manually:
 +
# Download this file: [https://github.com/phorgue/porousMultiphaseFoam/archive/extend-version.tar.gz extend-version.tar.gz]
 +
# Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-extend-version" into the folder indicated by this command: <bash>pwd</bash>
 +
# Rename the folder: <bash>mv porousMultiphaseFoam-extend-version porousMultiphaseFoam</bash>
 +
</li>
 +
 +
<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
 +
<bash>wget "https://github.com/phorgue/porousMultiphaseFoam/archive/extend-version.zip" -O porousMultiphaseFoam.zip
 +
unzip porousMultiphaseFoam.zip
 +
mv porousMultiphaseFoam-extend-version porousMultiphaseFoam
 +
</bash>
 +
Or manually:
 +
# Download this file: [https://github.com/phorgue/porousMultiphaseFoam/archive/extend-version.zip extend-version.zip]
 +
# Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-extend-version" into the folder indicated by this command: <bash>pwd</bash>
 +
# Rename the folder: <bash>mv porousMultiphaseFoam-extend-version porousMultiphaseFoam</bash>
 +
</li>
 +
</ol>
 +
 +
</li>
 +
 +
 +
<li>Now we can build the toolbox:
 +
<bash>cd porousMultiphaseFoam
 +
./Allwmake > log.make 2>&1</bash>
 +
</li>
 +
 +
<li>Run the script a second time, for getting a summary of the build:
 +
<bash>./Allwmake > log.make 2>&1</bash>
 +
</li>
 +
 +
<li>Look into the content of the log file:
 +
<bash>cat log.make</bash>
 +
If all went well, it should show you something like this:
 +
<bash>+ wmake libso porousBoundaryConditions
 +
'/home/ofuser/foam/ofuser-3.2/lib/linux64GccDPOpt/libporousBoundaryConditions.so' is up to date.
 +
+ wmake libso porousModels
 +
'/home/ofuser/foam/ofuser-3.2/lib/linux64GccDPOpt/libporousModels.so' is up to date.
 +
+ wmake impesFoam
 +
make: '/home/ofuser/foam/ofuser-3.2/applications/bin/linux64GccDPOpt/impesFoam' is up to date.
 +
+ wmake anisoImpesFoam
 +
make: '/home/ofuser/foam/ofuser-3.2/applications/bin/linux64GccDPOpt/anisoImpesFoam' is up to date.</bash>
 +
</li>
 +
 +
<li>Now for getting started, follow the instructions given in the {{tt|README.md}} file or read it in the project page: [https://github.com/phorgue/porousMultiphaseFoam porousMultiphaseFoam at GitHub]</li>
 +
 +
</ol>

Latest revision as of 14:07, 29 December 2015

1 Overview

Source code repository
porousMultiphaseFoam at GitHub
Description
An open-source toolbox for multiphase flow in porous media.
Support pages


2 Installation steps

2.1 OpenFOAM 3.0 and newer

Valid versions: OF Version 30.png

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it depends on the mode in which you are able to download the toolbox. Try them in order until you don't get an error message while downloading or unpacking:
    1. From the Git repository [1], using the git command:
      git clone https://github.com/phorgue/porousMultiphaseFoam.git porousMultiphaseFoam
    2. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git repository, either directly in the command line:
      wget "https://github.com/phorgue/porousMultiphaseFoam/archive/master.tar.gz" -O porousMultiphaseFoam.tar.gz
      tar -xf porousMultiphaseFoam.tar.gz
      mv porousMultiphaseFoam-master porousMultiphaseFoam

      Or manually:

      1. Download this file: master.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv porousMultiphaseFoam-master porousMultiphaseFoam
    3. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/phorgue/porousMultiphaseFoam/archive/master.zip" -O porousMultiphaseFoam.zip
      unzip porousMultiphaseFoam.zip
      mv porousMultiphaseFoam-master porousMultiphaseFoam

      Or manually:

      1. Download this file: master.zip
      2. Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv porousMultiphaseFoam-master porousMultiphaseFoam

  3. Now we can build the toolbox:
    cd porousMultiphaseFoam
    ./Allwmake > log.make 2>&1
  4. Run the script a second time, for getting a summary of the build:
    ./Allwmake > log.make 2>&1
  5. Look into the content of the log file:
    cat log.make

    If all went well, it should show you something like this:

    + wmake libso porousBoundaryConditions
    '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/lib/libporousBoundaryConditions.so' is up to date.
    + wmake libso porousModels
    '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/lib/libporousModels.so' is up to date.
    + wmake impesFoam
    make: '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/bin/impesFoam' is up to date.
    + wmake anisoImpesFoam
    make: '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/bin/anisoImpesFoam' is up to date.
    + wmake groundwaterFoam
    make: '/home/ofuser/OpenFOAM/ofuser-3.0.x/platforms/linux64GccDPInt32Opt/bin/groundwaterFoam' is up to date.
  6. Now for getting started, follow the instructions given in the README.md file or read it in the project page: porousMultiphaseFoam at GitHub

2.2 OpenFOAM 2.2 to 2.4

Valid versions: OF Version 22.png OF Version 23.png OF Version 24.png

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it depends on the mode in which you are able to download the toolbox. Try them in order until you don't get an error message while downloading or unpacking:
    1. From the Git repository [2], using the git command:
      git clone https://github.com/phorgue/porousMultiphaseFoam.git porousMultiphaseFoam
      cd porousMultiphaseFoam
      git checkout of240
      cd ..
    2. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git repository, either directly in the command line:
      wget "https://github.com/phorgue/porousMultiphaseFoam/archive/of240.tar.gz" -O porousMultiphaseFoam.tar.gz
      tar -xf porousMultiphaseFoam.tar.gz
      mv porousMultiphaseFoam-of240 porousMultiphaseFoam

      Or manually:

      1. Download this file: of240.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-of240" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv porousMultiphaseFoam-of240 porousMultiphaseFoam
    3. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/phorgue/porousMultiphaseFoam/archive/of240.zip" -O porousMultiphaseFoam.zip
      unzip porousMultiphaseFoam.zip
      mv porousMultiphaseFoam-of240 porousMultiphaseFoam

      Or manually:

      1. Download this file: of240.zip
      2. Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-of240" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv porousMultiphaseFoam-of240 porousMultiphaseFoam

  3. Now we can build the toolbox:
    cd porousMultiphaseFoam
    ./Allwmake > log.make 2>&1
  4. Run the script a second time, for getting a summary of the build:
    ./Allwmake > log.make 2>&1
  5. Look into the content of the log file:
    cat log.make

    If all went well, it should show you something like this:

    + wmake libso porousBoundaryConditions
    '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/lib/libporousBoundaryConditions.so' is up to date.
    + wmake libso porousModels
    '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/lib/libporousModels.so' is up to date.
    + wmake impesFoam
    make: '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/bin/impesFoam' is up to date.
    + wmake anisoImpesFoam
    make: '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/bin/anisoImpesFoam' is up to date.
    + wmake groundwaterFoam
    make: '/home/ofuser/OpenFOAM/ofuser-2.4.x/platforms/linux64GccDPOpt/bin/groundwaterFoam' is up to date.
  6. Now for getting started, follow the instructions given in the README.md file or read it in the project page: porousMultiphaseFoam at GitHub

2.3 foam-extend 3.1 to 3.2

Valid versions: OF Version 31ext.png OF Version 32ext.png

  1. First, go into a good working folder. For example, to go to the folder $HOME/foam/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"
  2. Now, it depends on the mode in which you are able to download the toolbox. Try them in order until you don't get an error message while downloading or unpacking:
    1. From the Git repository [3], using the git command:
      git clone https://github.com/phorgue/porousMultiphaseFoam.git porousMultiphaseFoam
      cd porousMultiphaseFoam
      git checkout extend-version
      cd ..
    2. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git repository, either directly in the command line:
      wget "https://github.com/phorgue/porousMultiphaseFoam/archive/extend-version.tar.gz" -O porousMultiphaseFoam.tar.gz
      tar -xf porousMultiphaseFoam.tar.gz
      mv porousMultiphaseFoam-extend-version porousMultiphaseFoam

      Or manually:

      1. Download this file: extend-version.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-extend-version" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv porousMultiphaseFoam-extend-version porousMultiphaseFoam
    3. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/phorgue/porousMultiphaseFoam/archive/extend-version.zip" -O porousMultiphaseFoam.zip
      unzip porousMultiphaseFoam.zip
      mv porousMultiphaseFoam-extend-version porousMultiphaseFoam

      Or manually:

      1. Download this file: extend-version.zip
      2. Unpack the downloaded file and move the unpacked folder "porousMultiphaseFoam-extend-version" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv porousMultiphaseFoam-extend-version porousMultiphaseFoam

  3. Now we can build the toolbox:
    cd porousMultiphaseFoam
    ./Allwmake > log.make 2>&1
  4. Run the script a second time, for getting a summary of the build:
    ./Allwmake > log.make 2>&1
  5. Look into the content of the log file:
    cat log.make

    If all went well, it should show you something like this:

    + wmake libso porousBoundaryConditions
    '/home/ofuser/foam/ofuser-3.2/lib/linux64GccDPOpt/libporousBoundaryConditions.so' is up to date.
    + wmake libso porousModels
    '/home/ofuser/foam/ofuser-3.2/lib/linux64GccDPOpt/libporousModels.so' is up to date.
    + wmake impesFoam
    make: '/home/ofuser/foam/ofuser-3.2/applications/bin/linux64GccDPOpt/impesFoam' is up to date.
    + wmake anisoImpesFoam
    make: '/home/ofuser/foam/ofuser-3.2/applications/bin/linux64GccDPOpt/anisoImpesFoam' is up to date.
  6. Now for getting started, follow the instructions given in the README.md file or read it in the project page: porousMultiphaseFoam at GitHub