pyFoam インストール手順

事前準備

　OpenFOAMは既にインストールされているとします。

　OSは，Ubuntuだとします。

pythonのバージョン確認

　pyFoamは，プログラミング言語python で書かれたツール集です。実行のためには，システムにpythonがインストールされていることが必要です。

　一般的なLinuxシステムでは，すでにpythonがインストールされているでしょう。

　PyFoamは，Python 2.3 以降のバージョンで動作が確認されているようです。バージョン2のなかで，より新しいバージョンを使う方がよいです。

　　ただし，Python 3 では動かないようです。 最新版のPythonは，バージョン3系です。バージョン2から3で，大きな変更がありました。そのため，バージョン2にしか対応していないものが，たくさん存在します。PyFoamも，その1つです。

　下記コマンドを実行すると，インストールされているpythonのバージョンが表示されます。念のため，そのバージョンが，2.？.？であることを確認してください。（?にはそれぞれ数字が入ります。）

python --version

　万が一，2.?.?でない場合は・・・　　

python関連ライブラリのインストール

　PyFoam は，グラフィカルな表示やその他の仕組みに，ライブラリを利用しています。それらをインストールします。

　ターミナルから，下記コマンドを実行してください。

sudo apt-get update

sudo apt-get install python-numpy python-gnuplot python-qt4 python-vtk python-dev gnuplot-x11

　上記パッケージを使うために必要なモノを含めてインストールするか，確認されます。そのまま実行キーを押してください。インストールが始まります。

インストール作業

　下記サイトを参考にして，インストール作業を行います。ここでは，通常ユーザーとしてインストール ”Installation as a regular user” することとします。

http://openfoamwiki.net/index.php/Contrib_PyFoam#Installation

PyFoamのダウンロード

　下記サイトの12.2 Current version から，最新版をダウンロード。2014年3月4日現在は，0.6.2が最新版。（なお，subversionが使える方は，そちらから最新版を取得してもOKです。）”the tar file with the sources and documentation” というリンクをクリックすると，PyFoam-0.6.2.tar.gz のダウンロードが始まります。好きな場所に保存してください。ここでは，$HOME/Downloads に保存したとします。

http://openfoamwiki.net/index.php/Contrib_PyFoam#Downloads

PyFoamの展開

　　ダウンロードしたファイルは圧縮されています。これを展開します。下記コマンドを順に実行すると，ホームディレクトリにPyFoam-0.6.2というディレクトリが作成されます。ファイルブラウザからダブルクリックしても良いです。

cd

tar xvf ~/Downloads/PyFoam-0.6.2.tar.gz

PyFoamのインストール

　PyFoamをインストールするディレクトリを作成します。ここでは，$HOME/OpenFOAM/PyFoamにインストールするとします。下記コマンドを実行します。

mkdir ~/OpenFOAM/PyFoam

　PyFoamを展開したディレクトリに移動する。下記コマンドを実行する。

cd ~/PyFoam-0.6.2

　PyFoamのインストールスクリプトsetup.pyを実行する。その際，インストール先を指定する。下記のコマンドを実行する。これによって，インストール先ディレクトリの下に，binとlibの2つのディレクトリが作成され，各種ファイルが格納されている。

python setup.py install --prefix=~/OpenFOAM/PyFoam

　ライブラリへのパスを，PYTHONPATH として登録する。スクリプトへのパスも追加しておく。下記コマンドを実行して，テキストエディタを起動して.bashrcファイルを開く。

gedit ~/.bashrc

　テキストエディタで，下記2行を.bashrcファイルの末尾に追記する。

export PYTHONPATH=~/OpenFOAM/PyFoam/lib/python2.7/site-packages/:$PYTHONPATH

export PATH=~/OpenFOAM/PyFoam/bin:$PATH

（注意）上記の lib/python2.7 部分は，pythonのバージョンによって異なります。$HOME/OpenFOAM/PyFoam/libの中にあるディレクトリ名を書いてください。

PyFoamのインストール確認

　新しい端末を起動すれば，PyFoamが利用できる状態になっている。

　下記コマンドが実行できることを確認する。インストールが成功していれば，OpenFOAMとPyFoamに関する情報が表示される。

pyFoamVersion.py

PyFoam 利用例

PyFoamを使って残差を表示しながら計算実行

　pyFoamPlotRunner.py 使う。いつものソルバ実行方法で，ソルバ名の前に pyFoamPlotRunner.py を付ければ良い。

　例えば，シングルプロセッサーで，icoFoamを実行する場合には，下記となる。

pyFoamPlotRunner.py icoFoam

　プロセッサを2つ使った並列計算で，icoFoamを実行する場合には，下記となる。

pyFoamPlotRunner.py --procnr=2 icoFoam

　pyFoamPlotRunner.py の一般的な使用方法は下記となる。

pyFoamPlotRunner.py [options] [foamApplication] [foamOptions]

　オプションや使い方については，--helpオプションを付けて実行することで，ヘルプを見ることができる。

pyFoamPlotRunner.py --help

その他の利用方法など

　春日さんのサイトにいろいろと情報があります。

http://www.geocities.jp/penguinitis2002/study/OpenFOAM/PyFoam/PyFoam_memo.html