Open DEM Japan

LIGGGHTS

LIGGGHTSとは

各種フォーク

• LIGGGHTS-PUBLIC
• LIGGGHTS-INL
• LIGGGHTS-PFM
• PICI-LIGGGHTS
• LIGGGHTS Flexible Fibers
• LAMMPS

マニュアル

• LIGGGHTS-PUBLIC マニュアル (日本語/English)
• LIGGGHTS-INL マニュアル (English)
• LIGGGHTS-PFM マニュアル (English)
• LIGGGHTS Flexible Fibers Wiki (English)

LIGGGHTS チュートリアル 実行例

LIGGGHTS-PUBLIC/examples/LIGGGHTS/Tutorials_public

メディア	内容
	chute_wear シュート内摩耗をDEMで可視化.
	cohesion 凝集粒子の挙動を解析.
	contactModels 接触モデルの違いを比較.
	conveyor ベルトコンベヤ搬送を粒子レベルで再現.
	heatTransfer_1 粒子間熱伝達のシミュレーション1.
	heatTransfer_2 粒子間熱伝達のシミュレーション2.
	hydrogel_multicontact ハイドロゲル多点接触を解析.
	hysteresis ヒステリシスモデルでオーバーラップを蓄積.
	insert_stream 粉体投入流の形成過程を観察.
	multisphere_stone_restitution 多球で複雑形状の石を表現.
	packing 球を成長させ高密度充填.
	mesh_tet メッシュ内部に粉体を充填. （スナップショット）
	meshGran 固定CAD壁に粉体を連続投入し充填・堆積をシミュレート.
	movingMeshGran 回転するCAD壁と粉体の相互作用を可視化.

LIGGGHTS-PUBLIC/examples/LIGGGHTS/SPH

LIGGGHTS-INL/examples/LIGGGHTS/INL_tutorials

abhishekdbihani/compaction_LIGGGHTS/src

LIGGGHTS-INL/examples/LIGGGHTS/INL

LIGGGHTS-INL/examples/LIGGGHTS/INL_tutorials

engineerdo.com

本文書の読み方

円滑な進行を図るとともに, その内容に遺漏のないようにWindows 上での操作手順を以下に逐一記述しておく.

以後, 本文書では次の表記

を採用するものと約束する.

慣例に従い, 入出力ファイルの文字列をメタ構文変数 “hoge” で代表させることにする.

実行の概要

LIGGGHTS には一般に普及したグラフィカルな FEM ソフトのようなボタン操作だけで解析を行える統合 GUI は用意されていない. 代わりに, 利用者は簡潔なテキストベースの入力スクリプト（拡張子 in.*）を記述し, ターミナル上でコマンドを実行するというインタプリタ型のワークフローを採用する. 計算結果は ParaView などの汎用可視化ツールで後処理・可視化する仕組みであり, 以下の手順が典型例である.

1. 3D CADで壁用のSTLファイルを作成
2. メモ帳でLIGGGHTS 入力ファイル in.hoge を編集
3. liggghts -in in.hoge のように実行し, 粒子情報を hoge.vtkやhoge.dump ファイルとして出力.
   ( LPP などのツールで hoge.dump を hoge.vtk 形式へ変換)
4. ParaView で hoge.vtk を読み込み, 可視化

実行に必要なソフト

本節では, 必要となるソフトウェアの概観を説明します. インストールの詳細は次節以降で扱います. 「専門用語まみれでついていけるかな？」と思っても, まずは読み進めてください. 次節以降で実際に手を動かしながら作業すれば, 自然と腑に落ちてくるはずです. LIGGGHTS と ParaView はクロスプラットフォーム対応で, Windows・macOS・Linux のどれでも動作します. 本サイトではユーザー数の多い Windows 版を例に解説します. 私自身は Mac ユーザーですが, OS ごとに書き分けると冗長になるため, あえて Windows に絞ります. 実行に必要なものは, 次の7点です.

1. 3DCADソフト. STL出力できるものなら何でもいい.
2. テキストエディタ. Visual Studio Code (VS Code)推奨.
3. ターミナル. WSL
4. LIGGGHTS
5. mpi
6. ParaView
7. Python

Windows には標準で「コマンド プロンプト」が備わっていますが, LIGGGHTS を実行する際は, 追加で WSL（Windows Subsystem for Linux）というターミナルをインストールして使います. プログラミングに慣れていて「自分でビルドできる」という方なら, C++ 版の LIGGGHTS をコンパイルして Windows 用の exe をつくることも不可能ではありません. とはいえ, 初心者の方には, まず Linux 向けにビルド済みの実行ファイルを導入する方法をおすすめします. 通常, Linux 用にビルドされたバイナリは Windows では動きませんが, WSL を導入すれば問題なく実行できます. Windows用にビルドされたもの(https://github.com/wuhao1938/LIGGGHTS_IN_WINDOWS_10, https://github.com/wuhao1938/LIGGGHTS_IN_WINDOWS_11)がGithubで配布されていますが, これは並列化計算ができないビルドになっており, 実用的ではありません.

WSL に Ubuntu を導入すると, ターミナルで sudo apt-get install コマンドが使えるようになります. このコマンドで, LIGGGHTS 本体と並列計算に必須の MPICH をまとめてインストールできます. 「並列計算は敷居が高いから, 初心者は後回しでいい」――そんな記事を見かけることもあります. しかし DEM 解析では並列化は must-have-tool です. 使わなければ, 計算時間を際限なく浪費することになります.

ParaView は LIGGGHTS 専用ソフトではなく, 3 次元の科学技術計算全般で広く利用されている可視化ツールです. 無償のオープンソースながら, 商用アプリに引けを取らない性能を備えています. クロスプラットフォーム対応のため, 数年前までは Windows 版で「ボタンが小さい」「GUI が扱いづらい」と感じる場面もありましたが, 近年は改良が進み, Windows 上でも違和感なく操作できるようになりました.

LIGGGHTS では VTK 形式を直接書き出すこともできますが, いったん dump ファイルに出力し, Python スクリプトで VTK へ変換したほうが都合のよい場面も多々あります. VTK にしておけば, ほぼどのバージョンの ParaView でも可視化できます. 「dump をそのまま読めればラクなのに……」という声もありますが, ParaView 用のプラグイン（https://github.com/ooyedeji/LIGGGHTS-Paraview-plugin）は開発がストップしており, 最新の ParaView では動作しません. どうしても使いたい場合は自分でビルドし直すか, 古めの ParaView 5.8.1 をインストールする必要があります.

インストール方法

VS Code

1. VS Code公式サイト(https://azure.microsoft.com/ja-jp/products/visual-studio-code)からインストーラをダウンロードし, 基本的へ[次へ]や[OK]などをクリックしてインストールします.
2. 左列の四角いボタンを押し, 拡張機能の検索欄に"LAMMPS"と記入して, "Lammps Syntax Highlighting"を検索します. [インストール]をクリックしてインストールします. 構文カラーリングができ, 拡張子がin.*の テキストに色がついて識別しやすいようになります.

ターミナル. WSL

1. エクスプローラーでパスはどこでもいいのでツールバーに"cmd"と入力して Enter を押下します.
2. 下記を実行します.
   

   wsl --install

3. しばらくするとwslのUbuntuがインストールできます.
4. 下記のように表示されるのでパスワードを設定します.
   

   
   ダウンロードしています: Ubuntu
   インストールしています: Ubuntu
   ディストリビューションが正常にインストールされました. 'wsl.exe -d Ubuntu' を使用して起動できます
   Ubuntu を起動しています...
   
   Provisioning the new WSL instance Ubuntu
   This might take a while...
   Create a default Unix user account: ユーザー名
   
   New password:"ここにパスワードを入力してください."
   Retype new password:"ここにパスワードを入力してください."
   passwd: password updated successfully
   To run a command as administrator (user "root"), use "sudo ".
   See "man sudo_root" for details.
                   

LIGGGHTS

1. エクスプローラーでパスはどこでもいいのでツールバーに"bash"と入力して Enter を押下します.
2. wsl(bash)上で下記を実行します. パスワードが要求されるので先ほど設定したパスワードを入力してください.

   sudo apt upgrade

3. wsl(bash)上で下記を実行します.

   sudo apt update

4. wsl(bash)上で下記を実行します. Do you want to continue? [Y/n] と聞かれるので "y" と入力します.

   sudo apt-get install liggghts

5. wsl(bash)上で下記を実行します.

    liggghts 

6. 下記のように出力されれば成功です.

    --------------------------------------------------------------------------
   LIGGGHTS (Version LIGGGHTS-PUBLIC 3.8.0, compiled 2024-03-31-20:10:17 by buildd, git commit unknown)
   --------------------------------------------------------------------------

MPI

1. エクスプローラーでパスはどこでもいいのでツールバーに"bash"と入力して Enter を押下します.
2. wsl(bash)上で下記を実行します. パスワードが要求されるので先ほど設定したパスワードを入力してください.

   sudo apt-get install mpich

3. wsl(bash)上で下記を実行します.

    mpirun 

4. 下記のように出力されれば成功です.

    --------------------------------------------------------------------------
    mpirun could not find anything to do.
   
    It is possible that you forgot to specify how many processes to run
    via the "-np" argument.
   --------------------------------------------------------------------------

5. ターミナル上でCtrl + C で強制終了されます.

ParaView

1. Microsoft MPI公式サイト(https://learn.microsoft.com/en-us/message-passing-interface/microsoft-mpi) から Microsoft MPI のインストーラ msmpisetup.exe (Microsoft MPI v10.1.2) をダウンロードします. 新しいとまだ ParaView が対応していないことがあるので, ParaView が正常に動作しなければ古いバージョンをダウンロードします. インストーラの指示に従いインストールします.
2. インストールできたかcmdで下記を実行します.

   mpiexec

3. 下記のように表示されればインストール成功です.

   INL\microstructure_compression$ mpiexec
   Microsoft MPI Startup Program [Version 10.1.12498.18]
   
   Launches an application on multiple hosts.
   
   Usage:
   
       mpiexec [options] executable [args] [ : [options] exe [args] : ... ]
       mpiexec -configfile 
   
   Common options:

4. ParaView公式サイト (https://www.paraview.org/download/) からインストーラ ParaView-5.13.1-MPI-Windows-Python3.10-msvc2017-AMD64.msi をダウンロードします.
5. ParaViewインストーラの指示に従って基本的に[次へ]や[OK]をクリックしてインストールします.

Python

1. Python公式サイト(https://www.python.org/downloads/)からpython-3.8.10-amd64.exeをダウンロードします.
2. インストーラを起動し, インストーラの指示に従ってインストールします.
3. cmd上で下記を実行します.

   py

4. 下記のように表示されればインストール成功です.

   Python 3.8.10 (tags/v3.8.10:3d8993a, May  3 2021, 11:48:03) [MSC v.1928 64 bit (AMD64)] on win32
   Type "help", "copyright", "credits" or "license" for more information.
   >>>

はじめてのLIGGGTHの実行

1. エクスプローラーで "Linux"と入力します.
2. "Ubuntu" > "home" > "ユーザー名" のフォルダを開いていきます.
3. 絶対パスとしては"\\wsl.localhost\Ubuntu\home\ユーザー名"です.
4. 下記のGithubのページからzipファイルをダウンロードします.

   https://github.com/CFDEMproject/LIGGGHTS-PUBLIC

   
5. zipファイルを解凍すると "examples" があります. このフォルダをコピーして"\\wsl.localhost\Ubuntu\home\ユーザー名"にペーストします.
6. このexampleフォルダはLIGGGHTSの様々な実行例が納められたフォルダです.
7. このexampleフォルダの中の"\LIGGGHTS\Tutorials_public\packing"を開きます.
8. このフォルダでツールバーに"bash"と入力してターミナルを開きます.
9. ターミナルで下記のように入力します.

   liggghts -in in.packing 

10. postフォルダが出力されます.
11. ParaViewを立ち上げます.
12. ParaViewの「File > Open」でエクスプローラーを開き, ツールバーに"\\wsl.localhost\Ubuntu\home\ユーザー名\examples\LIGGGHTS\Tutorials_public\packing\post"と入力して [OK] で開きます.
13. 次のように設定します.
14. 再生ボタン [▷] をクリックすると再生されます.

並列化実行

現在のパソコンは複数スレッド主流のため, ほとんどのPCでは並列化計算ができます.
1. ターミナルで下記のように記入します.

    mpirun --display-allocation --report-bindings -np 4 hostname

2. 下記のような出力が得られます.

   
   ======================   ALLOCATED NODES   ======================
   DESKTOP-MS24P8I: flags=0x11 slots=10 max_slots=0 slots_inuse=0 state=UP
   =================================================================
                   

3. slots数が10なので10並列化実行できます.
4. 下記のように実行します.

   mpirun -np 10 liggghts-inl -in in.packing

5. postフォルダが出力されます. この後は前節と同様の手順でParaViewで可視化します.

派生版比較

よくある質問（FAQ）

粒子が壁をすり抜ける

時間刻みが大きすぎる可能性があります. fix check/timestep/gran で推奨 dt を確認し, 十分小さな値を設定してください.

ParaView で粒子が点にしか見えない

Glyph → Sphere か Point Gaussian 表示へ変更し, Scale Array に radius を設定すると実寸表示できます.

非球形粒子を扱いたい

クラスタ（マルチスフィア）や超二次形状（ver.3.8.0 以降）で近似可能です. STL 壁メッシュとして実装する方法も一般的です.

GPU で高速化したい

LIGGGHTS‑PUBLIC には GPU サポートがありません. LAMMPS + KOKKOS 版 DEM またはソース改変による独自 GPU 対応を検討してください.

計算時間が長い

MPI 並列数を増やす / dump 出力頻度を下げる / neighbor 更新間隔を調整するなどの最適化が有効です.

よく使われるコマンドと設定例

以下は LIGGGHTS® で頻繁に用いられる代表コマンドをカテゴリ別に整理した早見表です. 粒子生成・物性付与・境界条件・解析出力まで一通り設定できます.

Tips

• # 以降はコメント. 改行継続 & を使う行ではコメント不可.
• variable でパラメータを一元管理し, ${var} で展開するとスクリプト再利用が楽.