1. Introduction

This section provides an overview of what LIGGGHTS(R)-PUBLIC can do, describes what it means for LIGGGHTS(R)-PUBLIC to be an open-source code, and acknowledges the funding and people who have contributed to LIGGGHTS(R)-PUBLIC over the years.

1.1 What is LIGGGHTS(R)-PUBLIC
1.2 LIGGGHTS(R)-PUBLIC features
1.3 Open source distribution
1.4 Acknowledgments and citations

1.1. What is LIGGGHTS(R)-PUBLIC

LIGGGHTS（R）- PUBLICは、オープンソース離散要素法粒子シミュレーションソフトウェアである。

コア開発者と主な著 者：Christoph Kloss、christoph.kloss@dcs-computing.com

LIGGGHTS（R）-PUBLIC は、オーストリアのLinzにあるDCS Computing GmbHによって配布されるオープンソースの離散要素法粒子シミュレーションソフトウェアです。 LIGGGHTS（R）ソフトウェアおよびCFDEM（R）ソフトウェアの製造元であるDCS Computing GmbHの登録商標です。http://www.cfdem.com/terms-trademark- 詳細についてはポリシーをご覧ください。

LIGGGHTS（R）は、一般的な粉粒 体および粉粒体熱伝達シミュレーションの用にLAMMPSを改良したもので す。 LAMMPSは古典的な分子動力学シミュレータです。分子動力学の分野で広く使用されています。物理的およびアルゴリズム的なアナロジーのおかげで、LAMMPSはDEM シミュレーションの為に基本的な機能を提供しています。 LIGGGHTS（R）は、産業用アプリケーションに適用できるようにすることを目標に機能を改善することを目指しています。 LIGGGHTS®は現在、世界中のさまざまな研究機関によって使用されています。化学、消費財、製薬、農業工学、食品 製造、鉄鋼生産、鉱業、プラスチック生産の分野の多くの一流企業は、生産プロセスの改善のために LIGGGHTS（R）を使用しています。 LIGGGHTS（R）-PUBLICは、シングルプロセッサのデスクトップまたはラップトップコンピュータで効率的に動作しますが、並列コンピュータ用に設計されていま す。 C ++をコンパイルし、MPIメッセージ・パッシング・ライブラリをサポートする任意の並列マシン上で実行されます。これには、分散型または共有メモリ型並列マシンが含まれ ます。 LIGGGHTS（登録商標）は、わずか数百万または数十億の粒子を有するシステムをモデル化することができる。 LIGGGHTS（R）は、新しい力の場、atomタイプ、境界条件、または診断などの新しい機能で簡単に変更または拡張できるように設計されています。詳細は Section_modifyを参照してください。

LIGGGHTS（R）-PUBLICは 自由に利用できるオープンソースコードであり、GNU Public Licenseの条項の下で配布されています。つまり、あなたが望むようにコードを使用したり修正したりすることができます。 オープンソースの考え方の簡単な説明については、このセクションを参照してください。

LIGGGHTS(R)-PUBLIC is an Open Source Discrete Element Method Particle Simulation Software.

Core developer and main author: Christoph Kloss, christoph.kloss@dcs-computing.com

LIGGGHTS(R)-PUBLIC is an Open Source Discrete Element Method Particle Simulation Software, distributed by DCS Computing GmbH, Linz, Austria. LIGGGHTS (R) and CFDEM(R) are registered trade marks of DCS Computing GmbH, the producer of the LIGGGHTS (R) software and the CFDEM(R)coupling software See http://www.cfdem.com/terms-trademark-policy for details.

LIGGGHTS (R) stands for LAMMPS improved for general granular and granular heat transfer simulations. LAMMPS is a classical molecular dynamics simulator. It is widely used in the field of Molecular Dynamics. Thanks to physical and algorithmic analogies, LAMMPS offers basic functionalities for DEM simulations. LIGGGHTS (R) aims to improve those capability with the goal to apply it to industrial applications. LIGGGHTS® is currently used by a variety of research institutions world-wide. A number of Blue Chip companies in the fields of chemical, consumer goods, pharmaceutical, agricultural engineering, food production, steel production, mining, plastics production use LIGGGHTS (R) for improvement of production processes. LIGGGHTS(R)-PUBLIC runs efficiently on single-processor desktop or laptop machines, but is designed for parallel computers. It will run on any parallel machine that compiles C++ and supports the MPI message-passing library. This includes distributed- or shared-memory parallel machines. LIGGGHTS (R) can model systems with only a few particles up to millions or billions. LIGGGHTS (R) is designed to be easy to modify or extend with new capabilities, such as new force fields, atom types, boundary conditions, or diagnostics. See Section_modify for more details.

LIGGGHTS(R)-PUBLIC is a freely-available open-source code, distributed under the terms of the GNU Public License, which means you can use or modify the code however you wish. See this section for a brief discussion of the open-source philosophy.

1.2. LIGGGHTS-PUBLIC VS. LIGGGHTS-PREMIUM

LIGGGHTSの2つの味があります。 このドキュメントでは、LIGGGHTSをLIGGGHTS-PUBLICまたはLIGGGHTS-PREMIUMとし て参照しています。PREMIUMは、あなたの会社または機関の名前です

LIGGGHTS-PUBLICは LIGGGHTSのバージョンであり、ここで公開ダウンロードされ利用可能になっています。 研究者がシミュレーションを行うために必要なすべてのものを提供しています。大規模なモデルポートフォリオ、パフォーマンス、そして使いやすく、新機能で拡張できます。 定期的に更新され、コミュニティからのすべての貢献が含まれます。 LIGGGHTS-PREMIUMは、LIGGGHTS（R）-PUBLICの開発に数百万ユーロを費やした世界中のCFDEM（R）プロジェクトの産業パートナー企業が 利用できる、大規模な産業用アプリケーションの追加機能を備えたバージョンです。 プレミアムバージョンは、CFDEM（R）プロジェクトのモデルポートフォリオをさらに強化するための開発プロジェクトを含む長期的な協力の一環として、産業パートナーお よび顧客に提供されます。

There are 2 flavors of LIGGGHTS. This documentation may refer to LIGGGHTS as LIGGGHTS-PUBLIC or as LIGGGHTS-PREMIUM, where PREMIUM is the name of your company or institution

LIGGGHTS-PUBLIC is the version of LIGGGHTS which is available for public download at this cite. It offers everything a researcher needs to do simulations: A large model portfolio, performance, and it is easy to understand and extend with new capabilities. It is periodically updated, and includes all the contributions from the community. LIGGGHTS-PREMIUM is a version with additional features for large-scale industrial application, available for industrial partner companies of CFDEM(R)project from all around the world, who have spent several million Euros for developing LIGGGHTS(R)-PUBLIC. The Premium version is made available to industrial partners and customers as part of a long-term collaboration involving development projects to further strengthen the model porfolio of CFDEM(R)project.

1.3. History

sanmeが示唆するように、 LIGGGHTS（R）-PUBLICの一部はLAMMPSに基づいています。 LAMMPSは、パラレルコンピュータで効率的に動作するように設計された古典的分子動力学シミュレーションコードです。 これは、米国エネルギー省の施設であるSandia National Laboratoriesで開発され、DOEからの資金援助を受けています。 オープンソースコードであり、GNU Public License（GPL）の条項の下で自由に配布されています。 LAMMPSの主な開発者は、Steve Plimpton、Aidan Thompson、Paul Crozierです。 http://lammps.sandia.govにあるLAMMPSのWWWサイトには、LAMMPSに関するさらに詳しい情報があります。 LAMMPSは当初、2つのDOEラボと3つの企業との間で、米国エネルギー省CRADA（協同研究開発協定）のもとで 開発されました。

As the sanme implies, some parts of LIGGGHTS(R)-PUBLIC are based on LAMMPS. LAMMPS is a classical molecular dynamics simulation code designed to run efficiently on parallel computers. It was developed at Sandia National Laboratories, a US Department of Energy facility, with funding from the DOE. It is an open-source code, distributed freely under the terms of the GNU Public License (GPL). The primary developers of LAMMPS are Steve Plimpton, Aidan Thompson, and Paul Crozier. The LAMMPS WWW Site at http://lammps.sandia.gov has more information about LAMMPS. LAMMPS was originally developed under a US Department of Energy CRADA (Cooperative Research and Development Agreement) between two DOE labs and 3 companies.

1.4. LIGGGHTS(R)-PUBLIC features

最も一般的な意味では、 LIGGGHTS（R）-PUBLICは、短距離または長距離の力を介して様々な初期条件および/または境界条件 と相互作用するatom、分子またはマクロ粒子の収集のための運動のニュートン方程式を統合する。 計算効率のために、LIGGGHTS（R）-PUBLICは隣接リストを使用して近くの粒子を追跡します。 このリストは、短距離で反発する粒子を有するシステムに対して最適化されているので、粒子の局所密度は決して大きくなりすぎることはない。 並列計算機では、LIGGGHTS（R）-PUBLICは空間分解技術を使用して、シミュレーションドメインを小さな 3Dサブドメインに分割します。その1つは各プロセッサに割り当てられます。 プロセッサは、サブドメインに隣接する「ゴースト」atomによりatomの情報を伝達して格納します。

In the most general sense, LIGGGHTS(R)-PUBLIC integrates Newton’s equations of motion for collections of atoms, molecules, or macroscopic particles that interact via short- or long-range forces with a variety of initial and/or boundary conditions. For computational efficiency LIGGGHTS(R)-PUBLIC uses neighbor lists to keep track of nearby particles. The lists are optimized for systems with particles that are repulsive at short distances, so that the local density of particles never becomes too large. On parallel machines, LIGGGHTS(R)-PUBLIC uses spatial-decomposition techniques to partition the simulation domain into small 3d sub-domains, one of which is assigned to each processor. Processors communicate and store “ghost” atom information for atoms that border their sub-domain.

1.5. LIGGGHTS(R)-PUBLIC General features

  • 単一のプロセッサ上で、または並列 上で実行される
  • 分散メモリ並列 計算（MPI）
  • 並列化のためのシミュレーション領 域の空間分解
  • オープンソース配布
  • 非常にポータブルなC ++
  • オプションのライブラリ：MPI
  • 新しい特徴と機能を簡単に拡張でき る
  • 入力スクリプトから実行されます
  • 変数と式を定義して使用するための 構文
  • 実行時のループとループの中断のた めの構文
  • 1つのスクリプトから同時に（並列 に）1つまたは複数のシミュレーションを実行する
  • 広く使用されているオープンソース のVTKデータフォーマットへの出力
  • ライブラリとしてビルドし、ライブ ラリインタフェースを介してLIGGGHTS（R）-PUBLICを呼び出すか、Pythonラッパーを提供する
  • 他のコードとの連 成：LIGGGHTS（R）- PUBLICは他のコードを呼び出し、他のコードはLIGGGHTS（R）-PUBLICを呼び出し、傘のコードは 両方を呼び出します
  • 連成シミュレーションのための仲間 のシミュレーションエンジンの強力なエコシステム、効率的かつ緊密にMPIを介して結合されています。
  • LIGGGHTS（R）- PUBLICは、一般的にCFD-DEMシミュレーションおよびラグランジュ - オイラー連成のため、CFDEM（R）に結合することができる
    • LIGGGHTS（R）- PUBLICは、粒子内輸送プロセスのモデリングのためにシミュレーションエンジンParScaleに結合する ことができます　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 　
  • runs on a single processor or in parallel
  • distributed-memory message-passing parallelism (MPI)
  • spatial-decomposition of simulation domain for parallelism
  • open-source distribution
  • highly portable C++
  • optional libraries used: MPI
  • easy to extend with new features and functionality
  • runs from an input script
  • syntax for defining and using variables and formulas
  • syntax for looping over runs and breaking out of loops
  • run one or multiple simulations simultaneously (in parallel) from one script
  • output to the widely used, open source VTK data format
  • build as library, invoke LIGGGHTS(R)-PUBLIC thru library interface or provided Python wrapper
  • couple with other codes: LIGGGHTS(R)-PUBLIC calls other code, other code calls LIGGGHTS(R)-PUBLIC, umbrella code calls both
  • a strong eco-system of fellow simulation engines for co-simulation, efficienty and tightly coupled via MPI.
  • LIGGGHTS(R)-PUBLIC can be coupled to CFDEM(R)coupling for CFD-DEM simulations and Lagrange-Euler coupling in general
  • LIGGGHTS(R)-PUBLIC can be coupled to the simulation engine ParScale for the modelling of intra-particle transport processes

1.6. LIGGGHTS(R)-PUBLIC Model features: LIGGGHTS-PUBLIC features

  • 複雑な形状のインポートと操 作：STL壁とVTK tetボリュームメッシュ
  • モーションスキームのバリエーショ ンとコンベアベルトのモデルを備えた移動メッシュ機能
  • 応 力制御壁をもちいたメッシュ上での力およ び摩耗解析
  • 接線履歴、非精細性および凝集性の モデルを含むさまざまな粒子 - 粒子接触の実装
  • 拡張されたコンタクトの実装を容易 にするた めのインタフェース
  • 粒子間の熱伝導
  • 事前に定義された体積、メッシュ、 粒子の流れ、粒子の成長と収縮に基づく粒子の挿入
  • 粒子分布の柔軟な定義
  • SPH流体 モデル

  • import and handling of complex geometries: STL walls and VTK tet volume meshes
  • moving mesh feature with a varierty of motion schemes and a model for conveyor belts
  • force and wear analysis on meshes as well as stress-controlled walls
  • a variety of particle-particle contact implementations, including models for tangential history, non-spericity and cohesion
  • interface to easily extend contact implementations
  • heat conduction between particles
  • particle insertion based on pre-defined volumes, meshes and particle streams from faces as well as particle growth and shrinkage
  • flexible definition of particle distributions
  • smoothed Particle Hydrodynamics (SPH) fluid models

1.7. LIGGGHTS(R)-PUBLIC Model features: Additional features for LIGGGHTS(R)-PUBLIC

LIGGGHTS-PUBLIC以外の LIGGGHTSのバージョンには追加の機能があります。これらの機能はすべて、さまざまなコマンドのdocページに記 載されています。

LIGGGHTS versions other than LIGGGHTS-PUBLIC have additional functionalities, which are all described in the doc pages for the different commands.

1.8. Open source distribution

LIGGGHTS（R）-PUBLICは いかなる種類の保証も付いていません。 各ソースファイルのヘッダには、GNU Public License（GPL）の条項の下で無償で配布される著作権で保護されたコードが記載されています。 これはしばしばオープンソース配布と呼ばれます。詳細はwww.gnu.orgまたはwww.opensource.orgを参照してください。 GPLの法的テキストは、LIGGGHTS（R）-PUBLICディストリビューションに含まれるLICENSEファイ ルにあります。

以下は、GPLが LIGGGHTS（R）-PUBLICユーザーにとって何を意味するのかをまとめたものです：

（1）LIGGGHTS（R）- PUBLICは商業目的を問わず、誰でも自由に使用、改変、拡張することができます。

（2）LIGGGHTS（R）-PUBLICの修正版を配布する場合は、オープンソースのままでなければなりません。つ まり、GPLの条件に基づいて配布します。 そのようなコードにLIGGGHTS（R）-PUBLICの派生バージョンとして明確に注釈を付ける必要があります。

（3）LIGGGHTS（R）-PUBLICソースコードを含むコードをリリースした場合は、オープンソースでなければ なりません。つまり、GPLの条件に基づいて配布しなければなりません。

（4）LIGGGHTS（R）-PUBLICファイルを他人に与える場合、GPLライセンスファイルとソースファイル ヘッダ（著作権とGPL通知を含む）はコードの一部として残す必要があります。

オープンソースコードの精神で、これらはLIGGGHTS（R）-PUBLICの改善に貢献するさまざまな方法です。 このマニュアルやコードに誤り、省略、バグがある場合は、弊社のWebサイトを参照してください。

  • LIGGGHTS（R）- PUBLICの 結果を使用して論文を発表する場合は、弊社のウェブサイトの出版物、写真、ムービーのページに引用を追加して、リンクと帰属を示して下さい。

LIGGGHTS(R)-PUBLIC comes with no warranty of any kind. As each source file states in its header, it is a copyrighted code that is distributed free-of- charge, under the terms of the GNU Public License (GPL). This is often referred to as open-source distribution - see www.gnu.org or www.opensource.org for more details. The legal text of the GPL is in the LICENSE file that is included in the LIGGGHTS(R)-PUBLIC distribution.

Here is a summary of what the GPL means for LIGGGHTS(R)-PUBLIC users:

(1) Anyone is free to use, modify, or extend LIGGGHTS(R)-PUBLIC in any way they choose, including for commercial purposes.

(2) If you distribute a modified version of LIGGGHTS(R)-PUBLIC, it must remain open-source, meaning you distribute it under the terms of the GPL. You must clearly annotate such a code as a derivative version of LIGGGHTS(R)-PUBLIC.

(3) If you release any code that includes LIGGGHTS(R)-PUBLIC source code, then it must also be open-sourced, meaning you distribute it under the terms of the GPL.

(4) If you give LIGGGHTS(R)-PUBLIC files to someone else, the GPL LICENSE file and source file headers (including the copyright and GPL notices) must remain part of the code.

In the spirit of an open-source code, these are various ways you can contribute to making LIGGGHTS(R)-PUBLIC better. If you find an error, omission or bug in this manual or in the code, please see our website for more info on how to get involved

  • If you publish a paper using LIGGGHTS(R)-PUBLIC results, send the citation (and any cool pictures or movies if you like) to add to the Publications, Pictures, and Movies pages of the our website, with links and attributions back to you.

1.9. Acknowledgments and citations

LIGGGHTS（R）-PUBLIC開 発は、様々な情報源によって資金提供されています。

  • DCSコンピューティングでは、資 金調 達の大部分が、バイラテラルプロジェクトの参加企業によって寄贈されています
  • EU FP7による、NanoSimおよびT-MAPPP
  • Austrimの資金提供機関 FWF、www.fwf.at
  • Austrialの資金提供機関 FFG、www.ffg.at

LIGGGHTS（R）-PUBLIC開発の初期段階では、

  • Christian Doppler Forschungsgesellschaft、www.cdg.at
  • JKU Linzの産 業パートナーである粒子流動モデルのCD研究所

LIGGGHTS（R）-PUBLICは LAMMPSに基づいているため、LAMMPSの作成に役立った資金調達も認めています。 LAMMPSの開発は、CRADA、LDRD、ASCI、Genomes-to-Lifeプログラム、OASCRおよびOBERオフィスを通じて、米国エネルギー省 （DOE）の資金提供を受けています。 また、米国エネルギー省のゲノミクス：GTLプログラム（www.doegenomestolife.org）のプロジェクト「Synechococcus Spにおける炭素隔離：分子機械から階層的モデリングまで」プロジェクトの資金もあった。

以下の論文では、 LIGGGHTS（R）-PUBLICで使用される基本的な並列アルゴリズムについて説明します。LIGGGHTS（R）-PUBLICの結果を使用した論文を出版する場 合は、この論文を引用し、http://www.cfdem.comサイトへのポインタを含めて ください

LIGGGHTS(R)-PUBLIC development has been funded by a variety of sources:

  • The by far largest part of funding has been contributed by a variety of companies in bi-laterial projects with DCS Computing
  • The EU FP7 programmes NanoSim and T-MAPPP
  • The Austrial funding agency FWF, www.fwf.at
  • The Austrial funding agency FFG, www.ffg.at
  • The early days of LIGGGHTS(R)-PUBLIC development have been funded by:
  • Christian Doppler Forschungsgesellschaft, www.cdg.at
  • Industrial partner of the CD Lab of Particulate Flow Modelling, JKU Linz

As LIGGGHTS(R)-PUBLIC is based on LAMMPS, we also acknowledge the funding that helped creating LAMMPS. LAMMPS development has been funded by the US Department of Energy (DOE), through its CRADA, LDRD, ASCI, and Genomes-to-Life programs and its OASCR and OBER offices. Also there was funding by the US Department of Energy’s Genomics:GTL program (www.doegenomestolife.org) under the project, “Carbon Sequestration in Synechococcus Sp.: From Molecular Machines to Hierarchical Modeling”.

The following paper describe the basic parallel algorithms used in LIGGGHTS(R)-PUBLIC. If you use LIGGGHTS(R)-PUBLIC results in your published work, please cite this paper and include a pointer to the http://www.cfdem.com site