2. Getting Started¶

2.2.1. Read this first:¶

LIGGGHTS（R）- PUBLICをビルドするのは簡単ではありません。 makefileを編集する必要があるかもしれません、考慮するコンパイラオプションがあり、追加のライブラリ（MPI、FFT、JPEG、PNG）を使うことができ、 LIGGGHTS（R）-PUBLICパッケージをincludeしたりexcludeしたりすることができます。 これらのパッケージの中には、事前ビルドなどが必要な補助ライブラリを使用するものがあります。

このセクションをよくお読みください。あなたがMakefileやUnixプラットフォームのコードを作成したり、 マシン上でMPIジョブを実行したりするのに慣れていない場合は、ローカルの専門家を探して手伝ってもらってくださ い。 多くのコンパイル、リンク、および実行の問題は、LIGGGHTS（R）-PUBLICの問題ではなく、ユーザのシステム、コンパイラ、ライブラリなどに特有の問題です。 そのような質問は、ローカルの専門家が良い答えをくれます。

ビルド問題に対してLIGGGHTS（R）-PUBLICの問題だと確信がある場合は、（例えば、コンパイラが LIGGGHTS（R）-PUBLICソース コードの行について苦情を立てるなど）、LIGGGHTS（R）パブリックフォー ラムに投稿ください。

src / MAKEディレクトリに似たMakefileがない新しい種類のマシンにLIGGGHTS（R）-PUBLICをビルドするのに成功した場合は、それを開発者に送ってくだ さい。LIGGGHTS（R ）-PUBLICディストリビューションにincludeします。特に、私たちはMakefile.autoがうまくいかない場合のために、その性能を向上させることに興 味があり ます。

Building LIGGGHTS(R)-PUBLIC can be non-trivial. You may need to edit a makefile, there are compiler options to consider, additional libraries can be used (MPI, FFT, JPEG, PNG), LIGGGHTS(R)-PUBLIC packages may be included or excluded, some of these packages use auxiliary libraries which need to be pre-built, etc.

Please read this section carefully. If you are not comfortable with makefiles, or building codes on a Unix platform, or running an MPI job on your machine, please find a local expert to help you. Many compiling, linking, and run problems that users have are often not LIGGGHTS(R)-PUBLIC issues - they are peculiar to the user’s system, compilers, libraries, etc. Such questions are better answered by a local expert.

If you have a build problem that you are convinced is a LIGGGHTS(R)-PUBLIC issue (e.g. the compiler complains about a line of LIGGGHTS(R)-PUBLIC source code), then please post a question to the LIGGGHTS(R)-PUBLIC forum.

If you succeed in building LIGGGHTS(R)-PUBLIC on a new kind of machine, for which there isn’t a similar Makefile for in the src/MAKE directory, send it to the developers and we can include it in the LIGGGHTS(R)-PUBLIC distribution. In particular, we are interested in cases where Makefile.auto does not work, so that we can improve its performance.

2.2.2. Steps to build a LIGGGHTS(R)-PUBLIC executable:¶

LIGGGHTSバージョン 3.5.1では、LIGGGHTSのビルドを可能な限りシンプルにするために、うまくいけば、すべて新しい魔法の Makefile.autoを公開しました。 次の手順がうまくいかない場合は、ここで詳細なビルド方法の説明をご覧ください。

ビルドを試みる前に、システムに必要な前提条件がすべてインストールされていることを確認してください。 いくつかの一般的なオペレーティングシステムのしっかりとした強固な基礎を以下に示します。

With LIGGGHTS version 3.5.1 we have rolled out a all new and magic Makefile.auto which hopefully will make building LIGGGHTS as simple as possible. If the following steps do not work for you please see the advanced building description here.

Before attempting a build ensure that your system has all required prerequisites installed. A solid basis for several popular operating systems are listed below:

Ubuntu 16.04LTS:
  sudo apt-get install openmpi-bin libopenmpi-dev libvtk6.2 libvtk6-dev
-----
Ubuntu 17.10:
  sudo apt-get install openmpi-bin libopenmpi-dev libvtk6.3 libvtk6-dev
-----
Fedora 25:
  su -
  dnf install openmpi openmpi-devel paraview-openmpi paraview-openmpi-devel gcc-c++
  exit
  echo "export PATH=$PATH:/usr/lib64/openmpi/bin" >> ~/.bashrc
  echo "export LIBRARY_PATH=$LIBRARY_PATH:/usr/lib64/openmpi/lib:/usr/lib64/openmpi/lib/paraview" >> ~/.bashrc
  echo "export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib64/openmpi/lib:/usr/lib64/openmpi/lib/paraview" >> ~/.bashrc
  echo "export C_INCLUDE_PATH=$C_INCLUDE_PATH:/usr/lib64/openmpi/include/paraview" >> ~/.bashrc
  echo "export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:/usr/lib64/openmpi/include/paraview" >> ~/.bashrc

Step 0

srcディレクトリには、 LIGGGHTS（R）-PUBLICのC ++ソースファイルとヘッダーファイルが含まれています。 また、トップレベルのMakefileと、いくつかのMakefile.*ファイルを持つMAKEサブディレクトリも含まれています。 srcディレクトリから "make"または "gmake"と入力します。 利用可能な選択肢のリストが表示されます。 特に重要なのは、autoオプションです。それは私たちのためにすべての重労働をしなければならないからです。 なので、以下を

The src directory contains the C++ source and header files for LIGGGHTS(R)-PUBLIC. It also contains a top-level Makefile and a MAKE sub-directory with several Makefile.* files for many machines. From within the src directory, type “make” or “gmake”. You should see a list of available choices. Of particular interest is the auto option, as it should do all the heavy lifting for us. So start by typing

make auto

コマンドラインに入力します。 これを初めて実行している場合は、次のメッセージが表示されます。

into the command line. If you are running this for the first time you will see the following message:

>>> WARNING <<<
Created MAKE/Makefile.user for the first time. Please check that the options
in that file are set correctly and run make again.

MAKE / Makefile.userはデフォルトでは存在せず、いくつかのデフォルトオプションが含まれているので、これは完全に正常です。 コンパイルが続行され、あなたが十分に幸運であれば、src /フォルダーにlmp_autoという実行可能ファイルが実際に生成されます。 この場合、すでに完了しており、LIGGGHTS（R）-PUBLICの実行に移行できます。

コンパイルが中断した場合は、エラー メッセージを慎重に検討してください。 次の手順では、make autoのコンパイル変数を設定する方法について説明します。

That is perfectly normal as MAKE/Makefile.user does not exist by default and contains some default options. The compilation will continue and if you are lucky enough it will actually produce an executable called lmp_auto in your src/ folder. If this is the case you are done and can move on to Running LIGGGHTS(R)-PUBLIC

Should the compilation interupt please carefully study the error message. The following procedure will explain how to set compilation variables for make auto.

Step 1

これらのオプションを設定するには、 MAKE / Makefile.userを好みのテキストエディタで開きます。 このファイルには2つのセクションがあります。 最初のオプションは、LIGGGHTS（R）-PUBLICのどのオプションと機能を有効にするかを指定します。 最初の3行はMPIと関連しています：

To configure these options open MAKE/Makefile.user with your favourite text editor. There are two sections in this file. The first one specifies which options and features in LIGGGHTS(R)-PUBLIC you would like to activate. The first three lines are related to MPI and read:

# MPI: "ON" or "OFF"
# Description: Use the message passing interface for parallel execution
USE_MPI = "ON"

最初のコメント行は、 "ON"または "OFF"のいずれかが変数USE_MPIの有効なパラメータであることを示します。 オプションの簡単な説明が続き、最後の行は実際にオプションを "ON"に設定します。 デフォルトのMAKE / Makefile.userには、賢明に設定されたデフォルトがあります。 だから、何も変更する必要はありません。

このファイルの2番目の部分は、デフォルトですべてコメント化され、ユーザーおよびマシン固有のパスを扱います。 USE_VTKが "ON"に設定されていてVTKのインストールがあなたの/ usrパスではなく、/ home / liggghts / vtkにあるとします。 その場合、次の行を見てください：

The first, commented line indicates that either “ON” or “OFF” are valid parameters of the variable called USE_MPI. A short description of the option follows and the last line actually sets the option to “ON”. The default MAKE/Makefile.user comes with some sensibly set defaults. So you might not need to change anything at all.

The second part of this file is by default all commented out and deals with user and machine specific paths. Say that USE_VTK is set to “ON” and your VTK installation is not in your /usr path, but in /home/liggghts/vtk. In that case have a look at the following lines:

# VTK specific variables
#
# Path that contains the includes (vtkVersion.h)
#VTK_INC_USR=-I/path/to/vtk/include
# Path that contains the VTK libraries
#VTK_LIB_USR=-L/path/to/vtk/lib
# Additional VTK libraries to include
#VTK_ADDLIBS_USR=

この場合、VTK_INC_USRと VTK_LIB_USRを変更して、以下のようになります。

In this case you would want to change VTK_INC_USR and VTK_LIB_USR so that they become

# VTK specific variables
#
# Path that contains the includes (vtkVersion.h)
VTK_INC_USR=-I/home/liggghts/vtk/include
# Path that contains the VTK libraries
VTK_LIB_USR=-L/home/liggghts/vtk/lib
# Additional VTK libraries to include
#VTK_ADDLIBS_USR=

2つの行にはコメントがなく、必要に 応じて値が変更されています。 includeパス（通常は変数名にINCが含まれています）に-Iが付いていて、ライブラリパス（LIBを含む）に-Lが付いている必要があります。 標準外のパスがある場合は、設定が少し難しいかもしれませんので、マシンのセットアップを知っているローカルの専門 家に相談してください。

Note that the two lines were uncommented and their values were changed as required. You can also see that include paths (normally containing INC in the variable name) need to be prefixed with -I and library paths (containing LIB) with -L. If you have non-standard paths, this can be a bit tricky to set up, so if you need any help ask a local expert that knows the setup of your machine.

make autoを実行すると、指定したオプションが有効かどうかMakefileが自動的にチェックします。 いくつかのオプションが見つからない場合に役立つエラーメッセージが表示されます。

If you run make auto the Makefile will automatically check if the options you have provided are valid. It will hopefully supply you with helpful error messages in case some options cannot be found.

Step 2

すべてのオプションが満足のいくもの に設定された後、単に実行し

After all options are set to your satisfaction. Simply run

make auto

再びオプションをテストし、 LIGGGHTS（R）-PUBLICをコンパイルします。 コンパイルが完了すると、実行可能ファイル名lmp_autoが取得され、ここから続行できます。

again to test the options and compile LIGGGHTS(R)-PUBLIC. After the compilation is finished you will obtain a executable name lmp_auto and you can continue here.

Step 3 (Advanced usage)

Makefile.autoは1つの 変数をpostfixと呼ばれる追加入力として受け付けます。これは次の入力によって使用できます

Makefile.auto accepts one variable as additional input which is called postfix which can be used by typing

make auto postifx=myString

この場合、 Makefile.autoはMAKE / Makefile.userファイルを探すのではなく、MAKE / Makefile.user_myStringを探します。 存在しなければ、MAKE / Makefile.user（デフォルトテンプレートの代わりに）をクローンします。 結果の実行ファイルは、lmp_auto_myString（lmp_autoではなく）と呼ばれます。

初回は、MAKE / Makefile.user_debugで、USE_DEBUGスイッチが "ON"に切り替えられているのに対して、デフォルトのMAKE / Makefile.userは最適化されたコードをコンパイルします。

In this case Makefile.auto will not look for the MAKE/Makefile.user file, but MAKE/Makefile.user_myString. If it does not exist it will clone MAKE/Makefile.user (instead of a default template). The resulting executable will be called lmp_auto_myString (instead of lmp_auto).

The prime use case would be a MAKE/Makefile.user_debug that has USE_DEBUG switched to “ON”, whereas the default MAKE/Makefile.user compiles the optimized version of the code.

LIGGGHTS（R）- PUBLICの全モデル組み合わせは、バージョン3.7から自動的に利用可能です。 ただし、それらのサブセットのみが最適化された方法でコンパイルされます。 これにより、5〜20％のパフォーマンス低下を招く可能性があります。 最適化されていないモデルの組み合わせを使用している場合は、LIGGGHTS（R）-PUBLICがこれを通知します。 この場合、LIGGGHTS（R）-PUBLIC src /フォルダにstyle_contact_model_user.whitelistというファイルを作成し、次のようなエントリを入力します。

All model combination of LIGGGHTS(R)-PUBLIC are automatically available starting with version 3.7. However, only a subset of them are compiled in an optimized manner. This might give you performance losses between 5 and 20%. In case you are using a model combination that is not optimized, LIGGGHTS(R)-PUBLIC will notify you of this. In this case you can create a file called style_contact_model_user.whitelist in your LIGGGHTS(R)-PUBLIC src/ folder and fill it with entries such as

GRAN_MODEL(HERTZ, TANGENTIAL_OFF, COHESION_OFF, ROLLING_OFF, SURFACE_DEFAULT)
GRAN_MODEL(HERTZ, TANGENTIAL_HISTORY, COHESION_OFF, ROLLING_EPSD, SURFACE_DEFAULT)

適切なエントリを持つファイルを作成 または変更したら、LIGGGHTS（R）-PUBLICを再コンパイルする必要があります。今回は、このファイル で指定された最適化されたモデルの組み合わせでビルドされます。

さらに、LIGGGHTS（R）-PUBLIC入力スクリプト用のファイルまたはフォルダを自動的にスキャンし、使 用されている接触モデルを検索することができます。 このリストでは、ホワイトリストへの追加が自動的に作成されます。 LIGGGHTS（R）-PUBLIC srcディレクトリ内で次のコマンドを実行する

After creating or modifying such a file with the appropriate entries you will need to recompile LIGGGHTS(R)-PUBLIC and this time it will be built with optimized model combinations specified in this file.

In addition you can automatically scan files or folders recursively for LIGGGHTS(R)-PUBLIC input scripts and search them for their used contact model. With this list an addition to the whitelist is automatically created. Running the following commands within the LIGGGHTS(R)-PUBLIC src directory

./genAutoExamplesWhitelist.sh -h
./genAutoExamplesWhitelist.sh ../examples

最初に genAutoExamplesWhitelist.shのヘルプメッセージが表示されます。 2番目は再帰的にLIGGGHTS（R）-PUBLICインストールのexamplesフォルダーを検索し、使用されている接触モデルのすべての.inファイルをスキャ ンします。 また、ホワイトリスト形式で一意に使用されるモデルを含むstyle_contact_model_autoExamples.whitelistファイルも作成されま す。

3番目のホワイトリストは、コンパイル時に自動的に作成され、 style_contact_model.whitelistに保存されます。 このファイルが存在する場合、次のコンパイルはこのファイルを変更しません。 手動で削除してから再作成することができます

The first will display the help message for genAutoExamplesWhitelist.sh. The second will recursively search the examples folder of your LIGGGHTS(R)-PUBLIC installation and scan all in.* files for the used contact models. It will also create the file style_contact_model_autoExamples.whitelist containing the unique used models in the whitelist format.

A third whitelist is automatically created during the compilation and is stored in style_contact_model.whitelist . If this file exists, the next compilation will NOT change this file. You can manually delete it and recreate it with

sh Make.sh models
sh Make.sh models_full

すべてのコンパイル時に、3つのホワ イトリストファイルstyle_contact_model_user.whitelist、 style_contact_model_autoExamples.whitelistおよび style_contact_model.whitelistが自動的にマージされ、ユニークなエントリだけがマー ジされたファイルに保持されます。

During every compilation the three whitelist files style_contact_model_user.whitelist , style_contact_model_autoExamples.whitelist and style_contact_model.whitelist are automatically merged and only unique entries are kept in the merged file.

2.2.3. Advanced building using custom makefiles¶

Step 0

srcディレクトリには、 LIGGGHTS（R）-PUBLICのC ++ソースファイルとヘッダーファイルが含まれています。 また、いくつかの選択されたプラットフォーム用の最下位レベルのMakefileと、下位レベルのMakefile*ファイルを持つMAKEサブディレクトリも含まれてい ます。 srcディレクトリから "make"または "gmake"と入力します。 利用可能な選択肢のリストが表示されます。 そのうちの1つがあなたのマシンとオプションにマッチすれば、次のようなコマンドを入力できます：

The src directory contains the C++ source and header files for LIGGGHTS(R)-PUBLIC. It also contains a top-level Makefile and a MAKE sub-directory with low-level Makefile.* files for a few selected platforms. From within the src directory, type “make” or “gmake”. You should see a list of available choices. If one of those is the machine and options you want, you can type a command like:

make mpi
or
gmake serial

注記　マルチプロセッサまたはマルチ コアのプラットフォームでは、makeコマンドで "-j nprocessors"スイッチを使用すると、LIGGGHTS（R）-PUBLICをより迅速にビルドすることができます。

エラーがなく、lmp_mpiや lmp_serialのような実行可能ファイルが生成された場合は、完了しています。 あなたの幸運な日です。

デフォルトでは、いくつかの LIGGGHTS（R）-PUBLICオプションパッケージのみがインストールされていることに注意してください。 オプションのパッケージを使用してLIGGGHTS（R）-PUBLICをビルドするには、以下のセクションを参照 してください。

NOTE On a multi-processor or multi-core platform you can launch a parallel make, by using the “-j nprocessors” switch with the make command, which will build LIGGGHTS(R)-PUBLIC more quickly.

If you get no errors and an executable like lmp_mpi or lmp_serial is produced, you’re done; it’s your lucky day.

Note that by default only a few of LIGGGHTS(R)-PUBLIC optional packages are installed. To build LIGGGHTS(R)-PUBLIC with optional packages, see this section below.

Step 1

ステップ0がうまくいかなかった場合 は、Makefile.fooのような低レベルのMakefileを作成する必要があります。 既存のsrc / MAKE / Makefile*のコピーを出発点として作成する必要があります。 編集が必要なファイルの最初の行、「comliper/linkerの設定」セクション、および「LIGGGHTS（R）-PUBLIC固有の設定」セクションのみです。

If Step 0 did not work, you will need to create a low-level Makefile for your machine, like Makefile.foo. You should make a copy of an existing src/MAKE/Makefile.* as a starting point. The only portions of the file you need to edit are the first line, the “compiler/linker settings” section, and the “LIGGGHTS(R)-PUBLIC-specific settings” section.

Step 2

src / MAKE / Makefile.fooの最初の行を "＃"の後に単語 "foo"をリストするように変更し、それが設定するその他のオプションを指定します。 これは "make"とタイプすれば表示される行です。

Change the first line of src/MAKE/Makefile.foo to list the word “foo” after the “#”, and whatever other options it will set. This is the line you will see if you just type “make”.

Step 3

「compiler/linker設 定」セクショ ンには、最適化フラグを含むC ++コンパイラのコンパイラおよびリンカーの設定が一覧表示されます。すべてのUnixシステムで利用可能なオープンソースのGNUコンパイラであるg ++を使うことができます。 MPIがあなたのシステムにインストールされている場合には一般的に利用可能なmpiccを使うこともできますが、どの実際のコンパイラがラップするかを確認する必要があ ります。ベンダーのコンパイラは、より高速なコードを生成することがよくあります。インテルのCPUを搭載したボッ クスでは、インテルのコンパイラサイトからダウンロードできる市販のインテルiccコンパイラを使用することをお勧 めします。

マシン上のC ++コードをビルドするために追加のライブラリが必要な場合は、それらをLIB変数の一部としてリストする必要があります。

DEPFLAGS設定は、C ++コンパイラがソースファイルの依存関係リストを作成するようにトリガするものです。ソース（.cpp）またはヘッダー（.h）ファイルを編集すると、再コンパイルが速 くなります。一部のコンパイラは依存ファイルの作成をサポートしていないか、-Dとは別のスイッチを使用することが あります。 GNU g ++は-Dで動作します。コンパイラが依存ファイルを作成できない場合は、Makefile.fooをMakefile.stormの後にパターン化して作成する必要があ ります。これは依存ファイルを含まない別のルールを使用します。新しいプラットフォームで初めて LIGGGHTS（R）-PUBLICをビルドすると、* .dファイルの長いリストが素早く出力されることに注意してください。これはエラーではありません。依存関係の通常の作成を行うのはMakefileです。

The “compiler/linker settings” section lists compiler and linker settings for your C++ compiler, including optimization flags. You can use g++, the open-source GNU compiler, which is available on all Unix systems. You can also use mpicc which will typically be available if MPI is installed on your system, though you should check which actual compiler it wraps. Vendor compilers often produce faster code. On boxes with Intel CPUs, we suggest using the commercial Intel icc compiler, which can be downloaded from Intel’s compiler site.

If building a C++ code on your machine requires additional libraries, then you should list them as part of the LIB variable.

The DEPFLAGS setting is what triggers the C++ compiler to create a dependency list for a source file. This speeds re-compilation when source (.cpp) or header (.h) files are edited. Some compilers do not support dependency file creation, or may use a different switch than -D. GNU g++ works with -D. If your compiler can’t create dependency files, then you’ll need to create a Makefile.foo patterned after Makefile.storm, which uses different rules that do not involve dependency files. Note that when you build LIGGGHTS(R)-PUBLIC for the first time on a new platform, a long list of *.d files will be printed out rapidly. This is not an error; it is the Makefile doing its normal creation of dependencies.

Step 4

「システム固有の設定」セクションに はいくつかの部分があります。 このセクションの-D設定を変更した場合は、 "make clean"（異なるクリーンオプションを記述する）と入力した後、完全に再コンパイルする必要があることに注意してください。

LMP_INC変数は、LIGGGHTS（R）-PUBLICコード内でifdefをオンにするオプションを含める ために使用されます。 現在認識されているオプションは次のとおりです。

The “system-specific settings” section has several parts. Note that if you change any -D setting in this section, you should do a full re-compile, after typing “make clean” (which will describe different clean options).

The LMP_INC variable is used to include options that turn on ifdefs within the LIGGGHTS(R)-PUBLIC code. The options that are currently recogized are:

• -DLAMMPS_GZIP
• -DLAMMPS_JPEG
• -DLAMMPS_PNG
• -DLAMMPS_FFMPEG
• -DLAMMPS_MEMALIGN
• -DLAMMPS_XDR
• -DLAMMPS_SMALLBIG
• -DLAMMPS_BIGBIG
• -DLAMMPS_SMALLSMALL
• -DLAMMPS_LONGLONG_TO_LONG
• -DPACK_ARRAY
• -DPACK_POINTER
• -DPACK_MEMCPY

read_dataコマンドと dumpコマンドは、-DLAMMPS_GZIPでコンパイルした場合、gzipファイルを読み書きします。あなた のマシンは標準のランタイムライブラリの "popen"機能をサポートしている必要があり、gzip実行ファイルは実行中にLIGGGHTS（R）-PUBLICが見つけることができます。

-DLAMMPS_JPEGを使用すると、dump imageコマンドはJPEGイメージファイルを書き出すことができます。 JPEGファイルの場合は、後述のようにLIGGGHTS（R）-PUBLICをJPEGライブラリにリンクする必要があります。 -DLAMMPS_PNGを使用すると、dump imageコマンドはPNGイメージファイルを書き出すことができます。 PNGファイルの場合は、後述のようにLIGGGHTS（R）-PUBLICをPNGライブラリにリンクする必要があります。これら2つの定義のどちらも使用されない場 合、LIGGGHTS（R）-PUBLICは圧縮されていないPPMイメージファイルのみを書き出すことができま す。

-DLAMMPS_FFMPEGを使用すると、dump movieコマンドを使用して、中間イメージファイルを格納する 必要があるレンダリングされたムービーのon-the-fly生成をサポートすることができます。あなたのマシンは標準のラ ンタイムライブラリの "popen"機能をサポートしている必要があり、実行中にLIGGGHTS（R）-PUBLICによってFFmpegの実行ファイルが見つかることが必要です。

-DLAMMPS_MEMALIGN = <bytes>を使用すると、LIGGGHTS（R）-PUBLICによって大きなチャンクまたはメモリが割り当てられているときに、malloc（）の代わ りにposix_memalign（）呼び出しを使用できるようになります。最適な性能を得るためには、動的に割り 当てられたメモリをデフォルトのバイト境界（例えば、x86型プラットフォームでは8バイトではなく16バイト）上 に揃えなければならないので、これは最新のCPUSのベクトル命令をより効率的に使用するのに役立ちます。

-DLAMMPS_XDRを使用する場合は、XDR形式の粒子のダンプを実行するためのXDR互換ファイルが ビルドに含まれます。これは、プラットフォームに独自のXDRファイルがある場合にのみ必要です。詳細については、 dumpコマンドのRestrictionsセクションを参照してください。

多くの場合、-DLAMMPS_SMALLBIG、-DLAMMPS_BIGBIG、-D- DLAMMPS_SMALLSMALLのいずれかの設定を使用します。デフォルトは -DLAMMPS_SMALLBIGです。これらの設定は、src / lmptype.hで指定されているように、LIGGGHTS（R）-PUBLIC内の4バイト（小）対8バイト（大）整数の使用を参照します。 BIGBIG設定を使用する唯一の理由は、20億個以上のatomを持つ巨大分子システムのシミュレーションを可能 にす ること、またはatomを512以上の周期的ボックスに巻き戻すことを可能にすることです。 SMALLSMALL設定を使用する唯一の理由は、マシンが64ビット整数をサポートしていない場合です。詳細については、以下の追加ビルドのヒントのセクションを参照し てください。

システムまたはMPIバージョンが「long long」データ型を認識しない場合は、-DLAMMPS_LONGLONG_TO_LONG設定が必要な場合があります。この場合、「long」データ型は既に64ビッ トで ある可能性があります。この場合、この設定はそのデータ型に変換されます。

-DPACK_ARRAY、-DPACK_POINTER、および-DPACK_MEMCPYのいずれかのオプショ ンを使用すると、一部のプラットフォームで高速な並列FFT（PPPMソルバー内）が可能になります。 -DPACK_ARRAY設定がデフォルトです。 PPPMについては、kspace_styleコマンドを参照してください。 FFTライブラリを使用してLIGGGHTS（R）-PUBLICをビルドする方法については、下記のステップ6を参照してください。

The read_data and dump commands will read/write gzipped files if you compile with -DLAMMPS_GZIP. It requires that your machine supports the “popen” function in the standard runtime library and that a gzip executable can be found by LIGGGHTS(R)-PUBLIC during a run.

If you use -DLAMMPS_JPEG, the dump image command will be able to write out JPEG image files. For JPEG files, you must also link LIGGGHTS(R)-PUBLIC with a JPEG library, as described below. If you use -DLAMMPS_PNG, the dump image command will be able to write out PNG image files. For PNG files, you must also link LIGGGHTS(R)-PUBLIC with a PNG library, as described below. If neither of those two defines are used, LIGGGHTS(R)-PUBLIC will only be able to write out uncompressed PPM image files.

If you use -DLAMMPS_FFMPEG, the dump movie command will be available to support on-the-fly generation of rendered movies the need to store intermediate image files. It requires that your machines supports the “popen” function in the standard runtime library and that an FFmpeg executable can be found by LIGGGHTS(R)-PUBLIC during the run.

Using -DLAMMPS_MEMALIGN=<bytes> enables the use of the posix_memalign() call instead of malloc() when large chunks or memory are allocated by LIGGGHTS(R)-PUBLIC. This can help to make more efficient use of vector instructions of modern CPUS, since dynamically allocated memory has to be aligned on larger than default byte boundaries (e.g. 16 bytes instead of 8 bytes on x86 type platforms) for optimal performance.

If you use -DLAMMPS_XDR, the build will include XDR compatibility files for doing particle dumps in XTC format. This is only necessary if your platform does have its own XDR files available. See the Restrictions section of the dump command for details.

Use at most one of the -DLAMMPS_SMALLBIG, -DLAMMPS_BIGBIG, -D-DLAMMPS_SMALLSMALL settings. The default is -DLAMMPS_SMALLBIG. These settings refer to use of 4-byte (small) vs 8-byte (big) integers within LIGGGHTS(R)-PUBLIC, as specified in src/lmptype.h. The only reason to use the BIGBIG setting is to enable simulation of huge molecular systems with more than 2 billion atoms or to allow moving atoms to wrap back through a periodic box more than 512 times. The only reason to use the SMALLSMALL setting is if your machine does not support 64-bit integers. See the Additional build tips section below for more details.

The -DLAMMPS_LONGLONG_TO_LONG setting may be needed if your system or MPI version does not recognize “long long” data types. In this case a “long” data type is likely already 64-bits, in which case this setting will convert to that data type.

Using one of the -DPACK_ARRAY, -DPACK_POINTER, and -DPACK_MEMCPY options can make for faster parallel FFTs (in the PPPM solver) on some platforms. The -DPACK_ARRAY setting is the default. See the kspace_style command for info about PPPM. See Step 6 below for info about building LIGGGHTS(R)-PUBLIC with an FFT library.

Step 5

3つのMPI変数は、LAMMPSを ビルドするMPIライブラリを指定するために使用されます。

LIGGGHTS（R）-PUBLICを並列実行したい場合は、ご使​​用のプラットフォームにMPIライブラ リーがインストールされている必要があります。 "mpicc"のようなMPIラップコンパイラを使ってLIGGGHTS（R）-PUBLICをビルドする場合は、これら3つの変数を空白のままにしておく必要がありま す。 MPIラッパーは必要なファイルをどこに見つけるかを知っています。そうでない場合、MPIが通常の場所（/ usr / localにあります）にシステムにインストールされている場合、これらの3つの変数を指定する必要もありません。コンパイル/リンク環境に "モジュール"を使用するいくつかの大規模な並列マシンでは、ビルド環境に正しいモジュールを入れるだけでよいで しょう。あるいは、並列マシンにベンダー提供のMPIがあると、コンパイラは問題を見つけることができません。

これに失敗すると、これらの3つの変数を使用して、mpi.hファイル（MPI_INC）とMPIライブラリファイ ル（MPI_PATH）が見つかる場所とライブラリファイル（MPI_LIB）の名前を指定できます。

あなた自身でMPIをインストールする場合は、ArgonneのMPICH2またはOpenMPIをお勧めします。 MPICHはArgonne MPIサイトからダウンロードできます。 OpenMPIは、OpenMPIサイトからダウンロードできます。他のMPIパッケージも動作するはずです。大きな並列プラットフォームで実行している場合は、システム の担当者またはベンダーがMPIのバージョンをインストールしておく必要があります。そのMPIは、MPICHまた は OpenMPIよりも高速なので、ビルドとリンク方法がわかります。 MPICHまたはOpenMPIを使用している場合は、ご使​​用のプラットフォーム用に構成およびビルドする必要があります。 MPI構成スクリプトには、LIGGGHTS（R）-PUBLICビルドで使用しているのと同じコンパイラを使用で きるようにコンパイラオプションが必要です.LIGGGHTS（R）-PUBLICをMPIライブラリにリンクする ときに発生する可能性のある問題を回避できます。

単一のプロセッサ上でLIGGGHTS（R）-PUBLICを実行したいだけなら、あなたのシステムに真のMPIラ イブラリがインストールされている必要はないので、src / STUBSで提供されるダミーMPIライブラリを使うことができます。この場合、3つのMPI変数を指定する方法については、src / MAKE / Makefile.serialファイルを参照してください。また、LIGGGHTS（R）-PUBLIC自体を作成する前に、ご使用のプラットフォーム用のSTUBSラ イブラリーをビルドする必要があります。 srcディレクトリからビルドするには、「make stubs」と入力するか、STUBS dirから「make」と入力します。これにより、LIGGGHTS（R）-PUBLICへのリンクに適したlibmpi_stubs.aファイルが作成されます。ビルド に失敗した場合は、ご使​​用のプラットフォーム用のSTUBS / Makefileを編集する必要があります。

ファイルSTUBS / mpi.cは、gettimeofday（）を呼び出すMPI_Wtime（）と呼ばれるCPUタイマー関数を提供します。システムがgettimeofday（）をサ ポートしていない場合は、別のタイマーを呼び出すコードを挿入する必要があります。 ANSI標準の関数clock（）は1時間ほど後にロールオーバーするため、長いLIGGGHTS（R）-PUBLICシミュレーションのタイミングには不十分です。

The 3 MPI variables are used to specify an MPI library to build LAMMPS with.

If you want LIGGGHTS(R)-PUBLIC to run in parallel, you must have an MPI library installed on your platform. If you use an MPI-wrapped compiler, such as “mpicc” to build LIGGGHTS(R)-PUBLIC, you should be able to leave these 3 variables blank; the MPI wrapper knows where to find the needed files. If not, and MPI is installed on your system in the usual place (under /usr/local), you also may not need to specify these 3 variables. On some large parallel machines which use “modules” for their compile/link environements, you may simply need to include the correct module in your build environment. Or the parallel machine may have a vendor-provided MPI which the compiler has no trouble finding.

Failing this, with these 3 variables you can specify where the mpi.h file (MPI_INC) and the MPI library file (MPI_PATH) are found and the name of the library file (MPI_LIB).

If you are installing MPI yourself, we recommend Argonne’s MPICH2 or OpenMPI. MPICH can be downloaded from the Argonne MPI site. OpenMPI can be downloaded from the OpenMPI site. Other MPI packages should also work. If you are running on a big parallel platform, your system people or the vendor should have already installed a version of MPI, which is likely to be faster than a self-installed MPICH or OpenMPI, so find out how to build and link with it. If you use MPICH or OpenMPI, you will have to configure and build it for your platform. The MPI configure script should have compiler options to enable you to use the same compiler you are using for the LIGGGHTS(R)-PUBLIC build, which can avoid problems that can arise when linking LIGGGHTS(R)-PUBLIC to the MPI library.

If you just want to run LIGGGHTS(R)-PUBLIC on a single processor, you can use the dummy MPI library provided in src/STUBS, since you don’t need a true MPI library installed on your system. See the src/MAKE/Makefile.serial file for how to specify the 3 MPI variables in this case. You will also need to build the STUBS library for your platform before making LIGGGHTS(R)-PUBLIC itself. To build from the src directory, type “make stubs”, or from the STUBS dir, type “make”. This should create a libmpi_stubs.a file suitable for linking to LIGGGHTS(R)-PUBLIC. If the build fails, you will need to edit the STUBS/Makefile for your platform.

The file STUBS/mpi.c provides a CPU timer function called MPI_Wtime() that calls gettimeofday() . If your system doesn’t support gettimeofday() , you’ll need to insert code to call another timer. Note that the ANSI-standard function clock() rolls over after an hour or so, and is therefore insufficient for timing long LIGGGHTS(R)-PUBLIC simulations.

Step 6

3つのFFT変数を使用すると、 kspace_styleコマンドによってLIGGGHTS（R）-PUBLICが（1d FFTを実行するために）長距離クーロンの粒子-粒子、粒子-メッシュ（PPPM）オプションを実行するときに使用するFFTライブラリを指定できます。

LIGGGHTS（R）-PUBLICは、この目的のために、さまざまなオープンソースまたはベンダー提供のFFT ライブラリをサポートしています。これら3つの変数を空白のままにしておくと、LIGGGHTS（R）- PUBLICはLIGGGHTS（R）-PUBLICディストリビューションに含まれるオープンソースのKISS FFTライブラリーを使用します。このライブラリはすべてのプラットフォームに移植可能であり、典型的な LIGGGHTS（R）-PUBLICシミュレーションは、FFTWまたはベンダー最適化ライブラリほど高速です。 KSPACEパッケージをビルドに含めない場合は、3つの変数を空白のままにすることもできます。

それ以外の場合は、-DFFT_XXXという形式のスイッチによって、FFT_INC設定の一部として使用する FFTの種類を選択します。 XXXの推奨値は、MKL、SCSL、FFTW2、およびFFTW3です。従来のオプションは、INTEL、SGI、ACML、およびT3Eです。下位互換性のために、- DFFT_FFTWを使用すると、FFTW2ライブラリが使用されます。 -DFFT_NONEを使用すると、上記のKISSライブラリが使用されます。

また、FFT_INC、FFT_PATH、およびFFT_LIB変数を設定する必要があるため、コンパイラとリン カーは必要なFFTヘッダとライブラリファイルを見つけることができます。コンパイル/リンク環境に "modules"を使用するいくつかの大規模並列マシンでは、ビルド環境に正しいモジュールを含めるだけでよいことに注意してください。あるいは、並列マシンにベンダー 提供のFFTライブラリがあると、コンパイラは問題を見つけることができません。

FFTWは、すべてのプラットフォームで動作する、高速で移植性の高いライブラリです。 www.fftw.orgからダウンロードできます。レガシーバージョン2.1.Xとそれ以降のバージョン3.Xは両方とも-DFFT_FFTW2または -DFFT_FFTW3としてサポートされています。あなたのボックスのFFTWをビルドするに は、./configure;makeと同じくらい簡単にする必要があります。いくつかのプラットフォームでは、 FFTW2があらかじめインストールされており、コンパイルされた精度を示す名前の変更されたファイルが使用されて いることに注意してください。 sfftw.h、またはdfftw.hをfftw.hの代わりに使用します。この場合、-DFFTW_SIZEというFFT_INCの追加定義変数を指定して、正しい includeファイルを選択することができます。この場合、FFT_LIBは正しいライブラリ、つまり -lsfftwまたは-ldfftwも手動で指定する必要があります。

FFT_INC変数では、PPPMで単精度FFTを使用する-DFFT_SINGLE設定も可能です.PPPMを使 用すると、特に並列またはGPUで長距離の計算を高速化できます。フーリエ変換および関連するPPPM演算は、浮動 小数点の切り捨て誤差に幾分敏感であるため、必ずしも倍精度で実行する必要はありません。 -DFFT_SINGLE設定を使用すると、メモリ使用量を減らし、3D FFTデータを転置するための並列通信コストをわずかに上回ります。単精度FFTは、FFTW3、FFTW2、MKL、およびKISS FFTオプションでのみテストされています。

The 3 FFT variables allow you to specify an FFT library which LIGGGHTS(R)-PUBLIC uses (for performing 1d FFTs) when running the particle-particle particle-mesh (PPPM) option for long-range Coulombics via the kspace_style command.

LIGGGHTS(R)-PUBLIC supports various open-source or vendor-supplied FFT libraries for this purpose. If you leave these 3 variables blank, LIGGGHTS(R)-PUBLIC will use the open-source KISS FFT library, which is included in the LIGGGHTS(R)-PUBLIC distribution. This library is portable to all platforms and for typical LIGGGHTS(R)-PUBLIC simulations is almost as fast as FFTW or vendor optimized libraries. If you are not including the KSPACE package in your build, you can also leave the 3 variables blank.

Otherwise, select which kinds of FFTs to use as part of the FFT_INC setting by a switch of the form -DFFT_XXX. Recommended values for XXX are: MKL, SCSL, FFTW2, and FFTW3. Legacy options are: INTEL, SGI, ACML, and T3E. For backward compatability, using -DFFT_FFTW will use the FFTW2 library. Using -DFFT_NONE will use the KISS library described above.

You may also need to set the FFT_INC, FFT_PATH, and FFT_LIB variables, so the compiler and linker can find the needed FFT header and library files. Note that on some large parallel machines which use “modules” for their compile/link environements, you may simply need to include the correct module in your build environment. Or the parallel machine may have a vendor-provided FFT library which the compiler has no trouble finding.

FFTW is a fast, portable library that should also work on any platform. You can download it from www.fftw.org. Both the legacy version 2.1.X and the newer 3.X versions are supported as -DFFT_FFTW2 or -DFFT_FFTW3. Building FFTW for your box should be as simple as ./configure; make. Note that on some platforms FFTW2 has been pre-installed, and uses renamed files indicating the precision it was compiled with, e.g. sfftw.h, or dfftw.h instead of fftw.h. In this case, you can specify an additional define variable for FFT_INC called -DFFTW_SIZE, which will select the correct include file. In this case, for FFT_LIB you must also manually specify the correct library, namely -lsfftw or -ldfftw.

The FFT_INC variable also allows for a -DFFT_SINGLE setting that will use single-precision FFTs with PPPM, which can speed-up long-range calulations, particularly in parallel or on GPUs. Fourier transform and related PPPM operations are somewhat insensitive to floating point truncation errors and thus do not always need to be performed in double precision. Using the -DFFT_SINGLE setting trades off a little accuracy for reduced memory use and parallel communication costs for transposing 3d FFT data. Note that single precision FFTs have only been tested with the FFTW3, FFTW2, MKL, and KISS FFT options.

Step 7

3つのJPG変数を使用すると、 LIGGGHTS（R）-PUBLICがJPEGまたはPNGファイルをdump imageコマンドで書き出すときに使用するJPEGおよび/またはPNGライブラリを指定できます。上記の手順4で説明した-DLAMMPS_JPEGまたは -DLAMMPS_PNGスイッチを使用しないと、空白のままにすることができます。その場合、JPEG / PNG出力は無効になるからです。

標準的なJPEGライブラリは、通常、libjpeg.aまたはlibjpeg.soという名前で運ばれ、関連する ヘッダファイルjpeglib.hを持ちます。プラットフォーム上にあるどのJPEGライブラリであれ、適切な JPG_INC、JPG_PATH、およびJPG_LIB変数を設定して、コンパイラとリンカーがそれを見つけること ができるようにする必要があります。

標準的なPNGライブラリは、通常、libpng.aまたはlibpng.soという名前で運ばれ、関連するヘッダ ファイルpng.hを持ちます。どのプラットフォームのPNGライブラリであれ、適切なJPG_INC、 JPG_PATH、およびJPG_LIB変数を設定して、コンパイラとリンカーがそれを見つけることができるようにす る必要があります。

前述のように、これらのヘッダーファイルとライブラリファイルがマシン上の通常の場所にある場合、これらの変数を設 定する必要はありません。

The 3 JPG variables allow you to specify a JPEG and/or PNG library which LIGGGHTS(R)-PUBLIC uses when writing out JPEG or PNG files via the dump image command. These can be left blank if you do not use the -DLAMMPS_JPEG or -DLAMMPS_PNG switches discussed above in Step 4, since in that case JPEG/PNG output will be disabled.

A standard JPEG library usually goes by the name libjpeg.a or libjpeg.so and has an associated header file jpeglib.h. Whichever JPEG library you have on your platform, you’ll need to set the appropriate JPG_INC, JPG_PATH, and JPG_LIB variables, so that the compiler and linker can find it.

A standard PNG library usually goes by the name libpng.a or libpng.so and has an associated header file png.h. Whichever PNG library you have on your platform, you’ll need to set the appropriate JPG_INC, JPG_PATH, and JPG_LIB variables, so that the compiler and linker can find it.

As before, if these header and library files are in the usual place on your machine, you may not need to set these variables.

Step 8

デフォルトでは、いくつかの LIGGGHTS（R）-PUBLICオプションパッケージのみがインストールされていることに注意してください。 オプションのパッケージを使用してLIGGGHTS（R）-PUBLICをビルドするには、ステップ9に進む前にこ の セクションを参照してください。

Note that by default only a few of LIGGGHTS(R)-PUBLIC optional packages are installed. To build LIGGGHTS(R)-PUBLIC with optional packages, see this section below, before proceeding to Step 9.

Step 9

それでおしまい。 正しいMakefile.fooを取得したら、ビルドに含めるオプションのLIGGGHTS（R）-PUBLICパッケージをインストールし、他の必要なライブラリ（例え ばMPI、FFT、パッケージライブラリ）をすべてプレビルドしておき、srcディレクトリから次のような入力をす るだけでよい。：

That’s it. Once you have a correct Makefile.foo, you have installed the optional LIGGGHTS(R)-PUBLIC packages you want to include in your build, and you have pre-built any other needed libraries (e.g. MPI, FFT, package libraries), all you need to do from the src directory is type something like this:

make foo
or
gmake foo

ビルドが完了すると、実行可能ファイ ルlmp_fooを取得しておく必要があります。

You should get the executable lmp_foo when the build is complete.

2.2.4. Errors that can occur when making LIGGGHTS(R)-PUBLIC:¶

次の2つのエラーが発生する可能性が あります。

（1）makeコマンドが、名前に「*」が付いたファイルが見つからないというエラーが表示され、中断した場合、 合、マシンのネイティブmakeがmakefile内でワイルドカード展開をサポートしていない可能性がありま す。 makeの代わりにgmakeを試してみてください。 それでも動作しない場合は、makeコマンドで-fスイッチを使用して、必要なファイルをすべて明示的にリストする事前生成されたMakefile.listを使用してみ てください。

Here are two non-obvious errors that can occur:

(1) If the make command breaks immediately with errors that indicate it can’t find files with a “*” in their names, this can be because your machine’s native make doesn’t support wildcard expansion in a makefile. Try gmake instead of make. If that doesn’t work, try using a -f switch with your make command to use a pre-generated Makefile.list which explicitly lists all the needed files, e.g.

make makelist
make -f Makefile.list linux
gmake -f Makefile.list mac

最初の "make"コマンドは、現在のMakefile.listをsrcディレクトリ内のすべてのファイル名で作成します。 2番目の "make"コマンド（makeまたはgmake）は、それを使ってLIGGGHTS（R）-PUBLICをビルドします。 "make makelist"コマンドを使用する前に、任意のオプションパッケージをinclude/excludeする必要があることに注意してください。

（2） 'identifier "atoll" is undefined'というエラーを受け取った場合、マシンは "long long"整数をサポートしていません。 上記の手順4で説明した-DLAMMPS_LONGLONG_TO_LONG設定を使用してみてください。

The first “make” command will create a current Makefile.list with all the file names in your src dir. The 2nd “make” command (make or gmake) will use it to build LIGGGHTS(R)-PUBLIC. Note that you should include/exclude any desired optional packages before using the “make makelist” command.

(2) If you get an error that says something like ‘identifier “atoll” is undefined’, then your machine does not support “long long” integers. Try using the -DLAMMPS_LONGLONG_TO_LONG setting described above in Step 4.

2.2.5. Additional build tips:¶

You can make LIGGGHTS(R)-PUBLIC for multiple platforms from the same src directory. Each target creates its own object sub-directory called Obj_target where it stores the system-specific *.o files.

Typing “make clean-all” or “make clean-machine” will delete *.o object files created when LIGGGHTS(R)-PUBLIC is built, for either all builds or for a particular machine.

(3) Changing the LIGGGHTS(R)-PUBLIC size limits via -DLAMMPS_SMALLBIG or -DLAMMPS_BIBIG or -DLAMMPS_SMALLSMALL

As explained above, any of these 3 settings can be specified on the LMP_INC line in your low-level src/MAKE/Makefile.foo.

The default is -DLAMMPS_SMALLBIG which allows for systems with up to 2^63 atoms and timesteps (about 9 billion billion). The atom limit is for atomic systems that do not require atom IDs. For molecular models, which require atom IDs, the limit is 2^31 atoms (about 2 billion). With this setting, image flags are stored in 32-bit integers, which means for 3 dimensions that atoms can only wrap around a periodic box at most 512 times. If atoms move through the periodic box more than this limit, the image flags will “roll over”, e.g. from 511 to -512, which can cause diagnostics like the mean-squared displacement, as calculated by the compute msd command, to be faulty.

To allow for larger molecular systems or larger image flags, compile with -DLAMMPS_BIGBIG. This enables molecular systems with up to 2^63 atoms (about 9 billion billion). And image flags will not “roll over” until they reach 2^20 = 1048576.

システムが8バイト整数をサポートし ていない場合は、-DLAMMPS_SMALLSMALL設定でコンパイルする必要があります。 これにより、atom（atomモデルまたは分子モデルの場合）とタイムステップの合計数が2 ^ 31（約20億）に制限されます。 画像フラグは2 ^ 9 = 512でロールオーバーします。

src / lmptype.hには、atomIDと合計システムサイズを格納する整数に関連するMPIデータ型の設定もあります。 これらは、関連するCデータ型と一致する必要があります。そうしないと、LIGGGHTS（R）-PUBLICがラ ンタイムエラーを生成します。

いずれの場合でも、プロセッサごとに実行できる問題のサイズは、4バイトの整数ストレージによってプロセッサあたり 2 ^ 31のatom（約20億）に制限されます。 このような問題は、neighborリストのためにプロセッサごとに膨大なメモリ占有量があり、CPU秒/タイムステップの観点から非常にゆっくりと実行されるため、通常 は制限さ れません。

If your system does not support 8-byte integers, you will need to compile with the -DLAMMPS_SMALLSMALL setting. This will restrict your total number of atoms (for atomic or molecular models) and timesteps to 2^31 (about 2 billion). Image flags will roll over at 2^9 = 512.

Note that in src/lmptype.h there are also settings for the MPI data types associated with the integers that store atom IDs and total system sizes. These need to be consistent with the associated C data types, or else LIGGGHTS(R)-PUBLIC will generate a run-time error.

In all cases, the size of problem that can be run on a per-processor basis is limited by 4-byte integer storage to 2^31 atoms per processor (about 2 billion). This should not normally be a restriction since such a problem would have a huge per-processor memory footprint due to neighbor lists and would run very slowly in terms of CPU secs/timestep.

2.2.6. Building for a Mac:¶

OS XはBSD Unixなので、うまくいくはずです。 "make auto"を使うか、 "make serial"をフォールバックとして使ってみてください。 これはテストされていませんが、cfdem.comにフィードバックをお寄せください

OS X is BSD Unix, so it should just work. Try using “make auto” or use “make serial” as fallback. This is untested but feel free to give us feedback on cfdem.com

2.2.7. Building for Windows:¶

これを行うための推奨された方法は、 CMakeとVisual Studioを使用することです。 CMakeをインストールし、関連するGUIを起動します。ソースコードの場所を指定し、：src /フォルダーに入力し、buildフォルダーをいくつかのフォルダーに設定してください（推奨：LIGGGHTS（R）-PUBLICベースディレクトリーにbuldフォ ルダー を作成することをお勧めします）。configureを押してシステム設定を取得します。 VTKライブラリをビルドしたフォルダにVTK_DIRオプションを設定する必要があります。これが完了したら、プロジェクトを生成できるようにすべてのエラーが解決され るまでconfigureをもう一度押します。その後、Open Projectを押してLIGGGHTS（R）-PUBLICをビルドできるVisual Studioを開くことができます。

これを行うもう1つの方法は、cygwinをインストールして、標準のLinux makeを使ってLIGGGHTS（R）-PUBLICをビルドすることです。cygwin環境は、cmake、g ++、gcc、openmpi、makeなどのいくつかのパッケージを必要とします。 VTKをコンパイルするときは、OpenGLが利用できないため、すべてのレンダリングに関連するVTKオプションを無効にする必要があることに注意してください。これは 上級ユーザーのみが使用するオプションであることに注意してください。

The recommened way to do this is using CMake and Visual Studio. Install CMake and launch the associated GUI. Point the Where is your source code: input to your src/ folder and set the build folder to some folder (recommended: make a build folder in your LIGGGHTS(R)-PUBLIC-base directory). Press Configure to get your system settings. You will most likely have to set the VTK_DIR option to the folder in which you built the VTK library. Once this is done press Configure again until all errors are reolved so that you can Generate the project. After that you should be able to press Open Project to open Visual Studio where you can build LIGGGHTS(R)-PUBLIC.

The other way to do this is install and use cygwin to build LIGGGHTS(R)-PUBLIC with a standard Linux make, just as you would on any Linux box. Your cygwin environment will need several packages such as cmake, g++, gcc, openmpi, make. Note that when compiling VTK you need to disable all rendering related VTK options as OpenGL won’t be available. Note that this is an option that should only be used by advanced users.

2.5.1. Static library:¶

LIGGGHTS（R）- PUBLICを静的ライブラリ（Linux上の* .aファイル）としてビルドするには、次のように入力します。

To build LIGGGHTS(R)-PUBLIC as a static library (*.a file on Linux), type

make makelib
make -f Makefile.lib foo

ここで、fooはマシン名です（通常 はautoでコンパイルしてからこのオプションを使用します）。 この種のライブラリは通常、ドライバアプリケーションをLIGGGHTS（R）-PUBLICに静的にリンクするために使用されるため、コンパイル時にすべての依存関係が 満たされることが保証されます。 "make makelib"とタイプする前に、任意のオプションのパッケージをincludeまたはexcludeする必要があることに注意してください。 最初の "make"コマンドは、srcディレクトリ内のすべてのファイル名で現在のMakefile.libを作成します。 2番目の "make"コマンドは、src / MAKE / Makefile.fooのARCHIVEとARFLAGS設定を使用して、LIGGGHTS（R）-PUBLICを静的ライブラリとしてビルドするためにこのコマンドを 使 用します。 ビルドによって、liblammps_foo.aというファイルが作成され、別のアプリケーションがリンクすることができます。

Where foo is the machine name (if you normally compile with auto then use this option). This kind of library is typically used to statically link a driver application to LIGGGHTS(R)-PUBLIC, so that you can insure all dependencies are satisfied at compile time. Note that inclusion or exclusion of any desired optional packages should be done before typing “make makelib”. The first “make” command will create a current Makefile.lib with all the file names in your src dir. The second “make” command will use it to build LIGGGHTS(R)-PUBLIC as a static library, using the ARCHIVE and ARFLAGS settings in src/MAKE/Makefile.foo. The build will create the file liblammps_foo.a which another application can link to.

2.5.2. Shared library:¶

例えばPythonから LIGGGHTS（R）-PUBLICを共有ライブラリ（Linux上の* .soファイル）としてビルドするには、以下のように入力します。

To build LIGGGHTS(R)-PUBLIC as a shared library (*.so file on Linux), which can be dynamically loaded, e.g. from Python, type

make makeshlib
make -f Makefile.shlib foo

ここで、fooはマシン名です（通常 はautoでコンパイルしてからこのオプションを使用します）。この種のライブラリは、LIGGGHTS（R）- PUBLICをPythonでラップするときに必要です。詳細はSection_pythonを参照してください。 ここでも、 "make makelib"とタイプする前に任意のオプションのパッケージをincludeまたはexcludeする必要があることに注意してください。最初の "make"コマンドはsrcディレクトリ内のすべてのファイル名で現在のMakefile.shlibを作成しま す。 2番目の "make"コマンドは、src / MAKE / Makefile.fooのSHFLAGSとSHLIBFLAGS設定を使用して、それを使ってLIGGGHTS（R）-PUBLICを共有ライブラリとしてビルドしま す。 ビルドによってファイルliblammps_foo.soが作成され、別のアプリケーションが動的にリンクすること ができます。また、Pythonラッパーがデフォルトで使用するソフトリンクliblammps.soも作成されま す。

呼び出し元のプログラムが共有ライブラリを使用できるようにするには、それが依存するすべての補助ライブラリも共有 ライブラリとして存在する必要があります。これは、src / STUBS内のダミーMPIライブラリやlib / packges内のパッケージライブラリなど、LIGGGHTS（R）-PUBLICに含まれるライブラリの場合に は、常に-fPICスイッチとの共有ライブラリとしてビルドされるためです。しかし、MPIやFFTWのようなライ ブ ラリが共有ライブラリとして存在しない場合、2番目のmakeコマンドはエラーを生成します。つまり、パッケージの 共有ライブラリ版をインストールする必要があります。ライブラリのビルド手順は、これを行う方法を説明するしなけれ ばなりません。

たとえば、Argonne National Labsが配布するMPIの普及しているオープンソースのMPICHライブラリを、デフォルトの/ usr / local / libの共有ライブラリとしてビルドしてインストールする方法を次に示します。

where foo is the machine name (if you normally compile with auto then use this option). This kind of library is required when wrapping LIGGGHTS(R)-PUBLIC with Python; see Section_python for details. Again, note that inclusion or exclusion of any desired optional packages should be done before typing “make makelib”. The first “make” command will create a current Makefile.shlib with all the file names in your src dir. The second “make” command will use it to build LIGGGHTS(R)-PUBLIC as a shared library, using the SHFLAGS and SHLIBFLAGS settings in src/MAKE/Makefile.foo. The build will create the file liblammps_foo.so which another application can link to dyamically. It will also create a soft link liblammps.so, which the Python wrapper uses by default.

Note that for a shared library to be usable by a calling program, all the auxiliary libraries it depends on must also exist as shared libraries. This will be the case for libraries included with LIGGGHTS(R)-PUBLIC, such as the dummy MPI library in src/STUBS or any package libraries in lib/packges, since they are always built as shared libraries with the -fPIC switch. However, if a library like MPI or FFTW does not exist as a shared library, the second make command will generate an error. This means you will need to install a shared library version of the package. The build instructions for the library should tell you how to do this.

As an example, here is how to build and install the MPICH library, a popular open-source version of MPI, distributed by Argonne National Labs, as a shared library in the default /usr/local/lib location:

./configure --enable-shared
make
make install

/ usr / local / libに対する書き込み権限がない場合は、最後の行の代わりに "sudo make install"を使用する必要があります。 最終結果は、/usr/local/lib/libmpich.soファイルでなければなりません。

You may need to use “sudo make install” in place of the last line if you do not have write privileges for /usr/local/lib. The end result should be the file /usr/local/lib/libmpich.so.

2.5.3. Additional requirement for using a shared library:¶

オペレーティングシステムは、環境変 数LD_LIBRARY_PATHを使用して実行時にロードする共有ライブラリを検出します。 src / liblammps.soやsrc / liblammps_g ++。soなどのファイルを/ usr / local / libなどのデフォルトで見つけることができる場所にコピーすることもできます。または LIGGGHTS（R）-PUBLIC srcディレクトリをLD_LIBRARY_PATHに設定して、共有ライブラリの現在のバージョンを常に使用するプログラムで使用できるようにします。

cshまたはtcshシェルの場合、〜/ .cshrcファイルに次のようなものを追加します。

The operating system finds shared libraries to load at run-time using the environment variable LD_LIBRARY_PATH. So you may wish to copy the file src/liblammps.so or src/liblammps_g++.so (for example) to a place the system can find it by default, such as /usr/local/lib, or you may wish to add the LIGGGHTS(R)-PUBLIC src directory to LD_LIBRARY_PATH, so that the current version of the shared library is always available to programs that use it.

For the csh or tcsh shells, you would add something like this to your ~/.cshrc file:

setenv LD_LIBRARY_PATH $*LD_LIBRARY_PATH*:/home/sjplimp/lammps/src

2.5.4. Calling the LIGGGHTS(R)-PUBLIC library:¶

ライブラリの味（staticまた はshared）によって、呼び出しプログラムから1つまたは複数のLIGGGHTS（R）-PUBLICオブ ジェクトをインスタンス化することができます。

C ++プログラムから使用すると、LIGGGHTS（R）-PUBLICはすべてLAMMPS_NS namespaceにラップされます。必要に応じて、呼び出しコード内から任意のク ラスとメソッドを安全に使用できます。

CやFortranプログラムやPythonのようなスクリプト言語から使用された場合、ライブラリはsrc / library.cppとsrc / library.hで提供される単純な関数形式のインタフェースを持っています。

LIGGGHTS（R）-PUBLICを呼び出すC ++およびCおよびFortranのコードの例については、examples / COUPLE / simpleのサンプルコードをライブラリインターフェイスで参照してください。 COUPLEディレクトリには、マニュアルのSection_howto 10で説明している他の例もあります。 LIGGGHTS（R）-PUBLICライブラリー・インターフェースを介して動作するLIGGGHTS（R）- PUBLICで提供されるPythonラッパーについては、マニュアルのSection_pythonを参照してく ださい。

ファイルsrc / library.cppとlibrary.hは、LIGGGHTS（R）-PUBLICをライブラリーとして使用するためのCスタイルAPIを定義しています。インター フェイスの説明と必要に応じて拡張する方法については、マニュアルのSection_howto 19を参照してください。

Either flavor of library (static or shared0 allows one or more LIGGGHTS(R)-PUBLIC objects to be instantiated from the calling program.

When used from a C++ program, all of LIGGGHTS(R)-PUBLIC is wrapped in a LAMMPS_NS namespace; you can safely use any of its classes and methods from within the calling code, as needed.

When used from a C or Fortran program or a scripting language like Python, the library has a simple function-style interface, provided in src/library.cpp and src/library.h.

See the sample codes in examples/COUPLE/simple for examples of C++ and C and Fortran codes that invoke LIGGGHTS(R)-PUBLIC thru its library interface. There are other examples as well in the COUPLE directory which are discussed in Section_howto 10 of the manual. See Section_python of the manual for a description of the Python wrapper provided with LIGGGHTS(R)-PUBLIC that operates through the LIGGGHTS(R)-PUBLIC library interface.

The files src/library.cpp and library.h define the C-style API for using LIGGGHTS(R)-PUBLIC as a library. See Section_howto 19 of the manual for a description of the interface and how to extend it for your needs.