VTKで作った解析用構造格子を自作FDMソルバーに投げて計算結果をParaViewで見てみる

0. はじめに
-------
この記事では、[前回紹介した方法](https://qiita.com/torisan_piyopiyo/items/588e607c578b4b00903a)で作成した解析用構造格子を自作のFDM(有限差分法)ソルバーに投げ込み、最終的な計算結果をParaViewで可視化するまでを書いてみます。
![DxG01QYU0AACis5.jpg large.jpg](https://qiita-image-store.s3.amazonaws.com/0/304390/1625d9a5-c1b1-8856-4a2f-101276a26c0a.jpeg)

なお、FDMの具体的な数値計算手法は他の文献に譲ります。それほど難しくないので興味のある方は勉強されてみるといいかもしれません。

また、一連の処理を行うソースコードはC++で書いています。読みづらいかと思いますが許してください。
あと記事が長くなりすぎないように、メインの処理以外のソースコードは省略しております。

ソースコードが欲しい方は[ここから](https://github.com/tori-takanashi/Qiita/tree/ver.1.1/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject)どうぞ。煮るなり焼くなり好きにしてください。

1. 大まかな処理の流れ
-----
今回開発したプログラムは以下のようなフローで実行されます。
まず閉曲面ポリゴンを構造格子ジェネレーターに入力し、その後解析用の属性をボクセルに付与してソルバーに投げ込んであげると数値計算が始まります。ソルバーでの解析が終わった後はVTKファイルで計算結果が出力されますので、ParaView等で内容を詳しく見ることができます。

また、フロー中における青い部分はモジュール化されてますので、それぞれ単独でも使えるようになっています。
![フロー.png](https://qiita-image-store.s3.amazonaws.com/0/304390/c8027e99-22fe-2d56-0eea-4918967129af.png)

メインの処理を記述したソースコードを以下に示します。

``` main.cpp
#include "vtkVoxelMeshGenerator.h"
#include "vtkSettingAnalyticProperties.h"
#include "FDMSolverForDiffusionEq.h"

#include <iostream>
#include <memory>

#include <vtkGeometryFilter.h>
#include <vtkUnstructuredGrid.h>

// Reader & Writer
#include <vtkDataSetReader.h>
#include <vtkSTLReader.h>
#include <vtkDataSetWriter.h>
#include <vtkXMLDataSetWriter.h>

using namespace std;

int main()
{
  // 閉曲面読み取り
  auto reader = vtkSmartPointer<vtkDataSetReader>::New();
  reader->SetFileName("C:\\test\\bunny.vtk");
  reader->Update();

  // PolyDataに変換
  auto geometry = vtkSmartPointer<vtkGeometryFilter>::New();
  geometry->SetInputData(reader->GetOutput());
  geometry->Update();

  cout << "ボクセルメッシュ作成" << endl;
  const int cellDims[] = { 60, 60, 60 };
  const double *bounds = geometry->GetOutput()->GetBounds();
  const double offsetX = (bounds[1] - bounds[0]) * 0.2;
  const double offsetY = (bounds[3] - bounds[2]) * 0.2;
  const double offsetZ = (bounds[5] - bounds[4]) * 0.2;
  const double offsets[6] = { offsetX, offsetX, offsetY, offsetY, offsetZ, offsetZ };

  // スマートポインタでインスタンスを管理
  shared_ptr<vtkVoxelMeshGenerator> voxelMeshGenerator = make_shared<vtkVoxelMeshGenerator>();
  voxelMeshGenerator->SetInputData(geometry->GetOutput());

  voxelMeshGenerator->SetCellDimensions(cellDims);
  voxelMeshGenerator->SetOffsets(offsets);
  voxelMeshGenerator->Update();

  cout << "ボクセルメッシュに解析属性を付与" << endl;
  shared_ptr<vtkSettingAnalyticProperties> analyticProperties;
  analyticProperties = make_shared<vtkSettingAnalyticProperties>();

  analyticProperties->SetCellDimensions(cellDims);
  analyticProperties->SetInputData(voxelMeshGenerator->GetOutput());
  analyticProperties->Update();

  auto field = vtkSmartPointer<vtkUnstructuredGrid>::New();
  field->DeepCopy(analyticProperties->GetOutput());

  cout << "解析開始" << endl;
  const double alpha = 0.1;
  const double wallXYZBC[3] = { 10.0, 100.0, 40.0 };
  const int endStep = 2000;

  shared_ptr<FDMSolverForDiffusionEq> solver;
  solver = make_shared<FDMSolverForDiffusionEq>();

  solver->SetAlpha(alpha);
  solver->SetWallXYZBC(wallXYZBC);
  solver->SolveHeatEquationForAllStep(field, endStep);

  auto writer = vtkSmartPointer<vtkXMLDataSetWriter>::New();
  writer->SetFileName("C:\\test\\Results.vtu");
  writer->SetInputData(field);
  writer->Update();

  return 0;
}
```

2. 構造格子生成
-----
[前回の記事](https://qiita.com/torisan_piyopiyo/items/588e607c578b4b00903a)で作ったプログラムを拡張して構造格子を生成します。変更点は以下の通りです。

- 3Dモデル(閉曲面ポリゴン内のボクセル)かどうかの情報をボクセル単位で保持し、"Is3DModel" という配列で管理する。
- ボクセルの通し番号をボクセル単位で保持し、"OriginalVoxelId" という配列で管理する。
- ベースの構造格子の境界を拡張できるようにする。

構造格子生成プログラムのソースコードは[こちら](https://github.com/tori-takanashi/Qiita/blob/ver.1.1/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject/vtkVoxelMeshGenerator.cpp)と[こちら](https://github.com/tori-takanashi/Qiita/blob/ver.1.1/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject/vtkVoxelMeshGenerator.h)から読めます。

プログラムによって作成したボクセルメッシュをParaView上で読み込み、コンター図を "Is3DModel" に設定し断面を見ると次のように表示されます。
![ボクセルメッシュ断面図.png](https://qiita-image-store.s3.amazonaws.com/0/304390/c430ce9a-de9b-219b-7950-d08f27ebac96.png)

3. 各ボクセルに解析用の属性を付与
-----
境界条件などを与えるボクセルを簡単に識別するために、ボクセル単位で解析用の属性をつけてあげます。
なお、ソースコード中では "AnalyticProperty" という配列で管理しています。

今回は、以下のような属性をボクセルに付与しています。

- 3Dモデルの表面：周辺のボクセルに定義されている物理量(拡散物質の密度)の平均値をとる。
- 3Dモデルの内側：解析しない。
- 壁面：座標軸の方向別にそれぞれ定数値を定義する。
- 上記以外：偏微分方程式を離散化した式で解析を行う。

ソースコードは[こちら](https://github.com/tori-takanashi/Qiita/blob/ver.1.1/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject/vtkSettingAnalyticProperties.cpp)と[こちら](https://github.com/tori-takanashi/Qiita/blob/ver.1.1/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject/vtkSettingAnalyticProperties.h)になります。

プログラムによって情報を追加したボクセルメッシュをParaView上で読み込み、コンター図を "AnalyticProperpy" に設定し断面を見ると次のように表示されます。
![解析属性付与後のボクセルメッシュ断面図.png](https://qiita-image-store.s3.amazonaws.com/0/304390/2aa811bb-80d3-a6d5-e975-6a8ebb80a64b.png)
壁面、3Dモデル表面・内部、その以外のボクセルに番号が与えられており、それぞれをプログラム中で識別できるようになっています。

4. 解析
-----
生成した解析用メッシュに対し、自作のFDMソルバーで解析します。
なお、今回は取り扱うのは以下のような拡散方程式です。

```math
\frac{\partial u}{\partial t} = \alpha \nabla^2 u

```

初期条件は全領域における拡散物質の密度を0とし、指定した計算ステップまで計算させます。

```math 
u|_{t=0} = 0 
``` 


ソルバーのソースコードは[こちら](https://github.com/tori-takanashi/Qiita/blob/ver.1.1/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject/FDMSolverForDiffusionEq.cpp)と[こちら](https://github.com/tori-takanashi/Qiita/blob/master/VTK%E3%81%A7%E4%BD%9C%E3%81%A3%E3%81%9F%E8%A7%A3%E6%9E%90%E7%94%A8%E6%A7%8B%E9%80%A0%E6%A0%BC%E5%AD%90%E3%82%92%E8%87%AA%E4%BD%9CFDM%E3%82%BD%E3%83%AB%E3%83%90%E3%83%BC%E3%81%AB%E6%8A%95%E3%81%92%E3%81%A6%E8%A8%88%E7%AE%97%E7%B5%90%E6%9E%9C%E3%82%92ParaView%E3%81%A7%E8%A6%8B%E3%81%A6%E3%81%BF%E3%82%8B/SampleProject/SampleProject/FDMSolverForDiffusionEq.h)です。

5. 可視化
-----
解析終了後、ソルバーからVTKのXML形式で解析結果が出力されるので、これをParaViewへドラッグ&ドロップし、[Apply] ボタンを押すと次のように計算結果が表示されます。
![ドラッグ&ドロップ後.png](https://qiita-image-store.s3.amazonaws.com/0/304390/477fa540-89f1-051f-4e62-cdb544d1ffd3.png)

このままだとよくわからないので、[Filter] -> [Alphabetical] -> [threshold] を選択し、[Properties]タブ内の [Scalars] から "Is3DModel" を選択し、[Minimum] と [Maximum] をそれぞれ1にして [Apply] を押します。
![threshold.png](https://qiita-image-store.s3.amazonaws.com/0/304390/7f2c0120-a21a-1f3c-a61b-5956bbbe51a9.png)
ウサギさんが出てきました:rabbit:

次に計算結果を色付きで見るために、コンターの表示を "Results" に変更します。
![コンター変更.png](https://qiita-image-store.s3.amazonaws.com/0/304390/17b61d24-0311-1366-a1f1-523b80062d8b.png)
ウサギさんにちゃんと色がついてますね！

## アニメーション
計算結果を連番で出力しアニメーションにしてみました。
![mcx15-uy2sh.gif](https://qiita-image-store.s3.amazonaws.com/0/304390/991882e4-72bf-d714-46ea-efbba72eb7d5.gif)


6. おわりに
-----
VTKで作った構造格子をソルバーに投げ込んで計算したものをParaViewで可視化してみました。

今回は拡散方程式を解きましたが、これを流体の方程式に置き換え、入力する3Dモデルを障害物として解析してみても面白いかもしれません。

また、ソースコード中での疑問があればコメントを投稿していただければ幸いです。