Merge branch 'develop' into release-2.1

Author: yomichi

docs/sphinx/en/source/inputfiles/parameter_config.rst

@@ -79,9 +79,28 @@ In the case of ``solver.type != "potts"``
        The name of structure file (e.g., POSCAR, cif) to be used as the initial structure.
        If not specified, the initial structure is generated randomly based on ``[[config.base_structure]]`` and ``[[config.defect_structure]]``.
 
+    -  ``constraint_module``
+
+       **Format :** bool ("true" or "false")
+
+       **Description :**
+       Whether to apply a constraint condition to configurations. The default value is ``false``.
+
+       When it is set to ``true``, the constraint condition is given as a user-defined function with the name ``constraint_func`` in ``constraint_module.py``. This function takes structure data of pymatgen.core.Structure type, and returns a boolean value. The module may also contain a function named ``constraint_energy`` that evaluates energy from the structure data in the ``shuffle`` operation.
+
+     -  ``constraint``
+
+	**Format :** str
+
+	**Description :**
+	The name of the user-defined function used for a constraint condition to configurations. If it is not specified, no constraint is applied. The default is unspecified.
+
+	The constraint condition is given as a function that takes structure data of pymatgen.core.Structure type and returns a boolean value. The parameter ``constraint`` specifies the name of the function in the form ``"module_name.function_name"``.
+	When ``constraint_module`` is also set to ``true``, the value of ``constraint`` is adopted for the function name.
+       
 - ``[[config.base_structure]]`` section
 
-  ``type`` and ``coords`` specify the atomic species that do not move in Monte Carlo calculation and their coordinates.
+    ``type`` and ``coords`` specify the atomic species that do not move in Monte Carlo calculation and their coordinates.
     If there are multiple atomic species, specify multiple [[config.base_structure]] sections.
 
     - ``type``

docs/sphinx/ja/source/inputfiles/parameter_config.rst

@@ -88,8 +88,27 @@
 
        **説明 :**
        モンテカルロサンプリングの初期構造ファイル(POSCAR やCIF 形式など)を指定します.
-       指定しなかった場合、ランダムに生成されます.
+       指定しなかった場合，ランダムに生成されます.
 
+    -  ``constraint_module``
+
+       **形式 :** bool型
+
+       **説明 :**
+       配位に対して拘束条件を課すかどうかを指定します．デフォルト値は ``false`` です．
+
+       ``true`` の場合，拘束条件はユーザが定義する関数で与えます．この関数は ``constraint_module.py`` 内に ``constraint_func`` という関数名で配置し，pymatgen.core.Structure 型の構造データを引数にとりbool型の値を返す関数として定義します．また， ``shuffle`` を行う際に構造データからエネルギー値を計算する ``constraint_energy`` 関数を定義して使用することもできます．
+
+    -  ``constraint``
+
+       **形式 :** str型
+
+       **説明 :**
+       配位に対する拘束条件を与えるユーザ定義関数を指定します．指定しない場合は拘束条件を課しません．デフォルト値は指定なしです．
+
+       拘束条件は，任意のモジュール内に配置された，pymatgen.core.Structure型の構造データを引数にとりbool型の値を返す関数として定義します． ``constraint`` パラメータには関数名を ``"モジュール名.関数名"`` の形式で指定します．
+       ``constraint_module`` が ``true`` に指定されている場合は， ``constraint`` パラメータの指定が優先されます．
+       
 
 - ``[[config.base_structure]]`` セクション
 
@@ -210,7 +229,7 @@
 
 	**形式 :** str型 もしくは str型のリスト
 
-	**説明 :** 原子種または原子グループの名前を指定します．複数の原子種・原子グループにまとめて同じ値を設定する場合は、それらをリストで指定します。
+	**説明 :** 原子種または原子グループの名前を指定します．複数の原子種・原子グループにまとめて同じ値を設定する場合は，それらをリストで指定します．
 
     - ``mu``
 
@@ -220,26 +239,26 @@
 
 - ``[[config.grandcanonical_move]]`` セクション
 
-    グランドカノニカルサンプリングにおいて、原子種または原子グループの増減や、原子種の入れ替えが起きる場合の入れ替わる原子種を指定します。指定方法は以下のとおりです。
+    グランドカノニカルサンプリングにおいて，原子種または原子グループの増減や，原子種の入れ替えが起きる場合の入れ替わる原子種を指定します．指定方法は以下のとおりです．
 
     - 原子種または原子グループの増減
 
         - ``species``
 
           **形式 :** str型 もしくは str型のリスト
 
-          **説明 :** 原子種または原子グループの名前を指定します．複数の原子種・原子グループを同時に増減させる場合は、それらをリストで指定します。同種の原子種を複数個指定することもできます。
+          **説明 :** 原子種または原子グループの名前を指定します．複数の原子種・原子グループを同時に増減させる場合は，それらをリストで指定します．同種の原子種を複数個指定することもできます．
 
     - 原子種の入れ替え
 
         - ``from``, ``to``
 
           **形式 :** str型 もしくは str型のリスト
 
-          **説明 :** 入れ替わる原子種または原子グループの名前を ``from A to B`` の形で指定します． ``from B to A`` の入れ替えも自動的に考慮されます。 ``from``, ``to`` で指定する原子種の数は同じで、同一の defect sublattice に配置されているとします。
+          **説明 :** 入れ替わる原子種または原子グループの名前を ``from A to B`` の形で指定します． ``from B to A`` の入れ替えも自動的に考慮されます． ``from``, ``to`` で指定する原子種の数は同じで，同一の defect sublattice に配置されているとします．
 
-    ``grandcanonical_move`` の指定がないときは、 ``chemical_potential`` に記述される原子種・原子グループまたはその組が増減する指定が自動的に挿入されます。
-    一方、 ``grandcanonical_move`` の指定が一つでもあれば、その操作のみが行われます。
+    ``grandcanonical_move`` の指定がないときは， ``chemical_potential`` に記述される原子種・原子グループまたはその組が増減する指定が自動的に挿入されます．
+    一方， ``grandcanonical_move`` の指定が一つでもあれば，その操作のみが行われます．
 
 
 ``solver.type = "potts"`` の場合