Skip to content

Commit

Permalink
manual updated
Browse files Browse the repository at this point in the history
  • Loading branch information
aoymt committed Nov 29, 2023
1 parent dbd57b0 commit 8e880c7
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/en/source/uhfk/filespecification/config/index_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,20 @@ and the latter on the output files (such as locations to store).
The input file is in NumPy binary format that corresponds to the output format of
``green`` in ``file.output`` section.

- ``initial_mode``

**Type :**
String

**Description :**
This parameter specifies how the initial value of the Green's function is set when the initial configuration is not given from files. It takes one of the following:

- ``random``: set the initial configuration by random numbers.

- ``zero``: set the initial configuration to be zero.

- ``one`` or ``unity``: set the initial configuration as :math:`G_{\alpha\sigma,\beta\sigma^\prime}(\vec{r}) = \delta_{\vec{r},0}\delta_{\alpha\beta}\delta_{\sigma\sigma^\prime}`.

``file.input.interaction`` section
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
13 changes: 13 additions & 0 deletions docs/ja/source/uhfk/filespecification/config/index_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,19 @@ TOML形式
ファイルは NumPy binary 形式です。
``file.output`` の ``green`` の出力ファイル形式に対応しています。

- ``initial_mode``

**形式 :** str型

**説明 :** 初期状態の一体グリーン関数データが指定されていない場合、初期値をどのように取るかを指定します。以下のいずれかの値を取ります。

``random``: 初期値を乱数で与えます。(デフォルト)

``zero``: 初期値を 0 に設定します。

``one`` または ``unity``: 初期値を :math:`G_{\alpha\sigma,\beta\sigma^\prime}(\vec{r}) = \delta_{\vec{r},0}\delta_{\alpha\beta}\delta_{\sigma\sigma^\prime}` で与えます。


``file.input.interaction`` セクション
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 8e880c7

Please sign in to comment.