2024/01/18改訂

1. FRENDYのディレクトリ構造について
    FRENDYのディレクトリ構造は以下の通りである。
      frend_project
       |- README : 本ファイル
       |- frendy : FRENDYのソースファイル一式
       |- tests  : FRENDYの各ソースファイルのテストプログラム一式
       |- sample : ACE作成までのサンプル計算が入ったフォルダ
       |- tools  : FRENDYの機能を用いたツール群


2. FRENDYのコンパイルについて
    FRENDYのコンパイルはfrend_project/frendyで./compile_all.cshを
    実行すれば、frend_project/frendy/main及びfrend_project/frendy/main_njoy_modeに
    実行ファイルが作成される。
    なお、main_njoy_modeはNJOYと同じ計算モデルを採用したモードとなっている。

    また、frend_project/frendy/main/Makefileに記載している通り、FRENDYの
    コンパイルはg++で実施するようになっている。
    g++以外のコンパイラーを使用する場合には、"CXX = g++"と、コンパイル
    オプションの"CXXFLAGS = -Wall -O2 -MMD -MP"を変更する必要がある。

    FRENDYは最新の共鳴公式であるR-matrix Limitedを処理するために
    AMURコードを利用している。AMURコードでは、一部の関数にlapackの
    関数を用いている。FRENDYをコンパイルするためには事前にlapackを
    インストールしておく必要がある。
    lapackを使いたくない(R-matrix Limitedを処理出来なくても構わない)
    場合には、frendy/main/Makefileを以下のように書き換える必要がある。
      CXXFLAGS = -Wall -O2 -MMD -MP -I../
      ↓
      CXXFLAGS = -Wall -O2 -MMD -MP -I../ -DNO_AMUR_MODE

      $(CXX) -o $@ $^ -L. -llapack -lblas
      ↓
      $(CXX) -o $@ $^ -L.


3. FRENDYのテストプログラムについて
    FRENDYでは、各クラス、各モジュールの検証用にBoost.Testを用いた
    テストプログラムを利用している。
    frend_project/testsには、クラス毎に作成したテストプログラムが
    用意されている。
    本プログラムは、FRENDYのソースの理解やFRENDYの改良・修正に
    役立つと思われる。
    本プログラムを全て実行する場合には、frend_project/testsの
    run_all_class.cshを実行すればよい。
    なお、本テストプログラムは、全てg++でコンパイル・実行するように
    なっているため、他のコンパイラーで実行するためには全てのシェルを
    書き換える必要がある。


4. FRENDYのサンプル入力及び実行結果について
    本ディレクトリでは、同梱のFRENDYマニュアルに記載の入力例を実行する。
    また、frend_project/sampleは、以下のような構造になっている。

      sample
       |- input : ACEファイル作成に用いた入力ファイル格納フォルダ
       |- lib   : JENDL-4.0ライブラリ格納フォルダ
       |- run   : FRENDY実行フォルダ

    また、サンプルのFRENDYを実行する場合、sample/runのrun_frendy.cshを
    実行すれば、コンパイルから全ての処理を実行するようになっている。
    なお、計算時間は3.7GHzのCPU一個で約3時間である。

5. FRENDYの入手先
   https://rpg.jaea.go.jp/main/ja/program_frendy/

6. マニュアル
    K. Tada, A. Yamamoto, S. Kunieda, Y. Nagaya, "Nuclear data processing code FRENDY version 2," JAEA-Data/Code 2022-009 (2023).
    https://doi.org/10.11484/jaea-data-code-2022-009

7. FRENDYの参考文献
    K. Tada, A. Yamamoto, S. Kunieda, C. Konno, R. Kondo, T. Endo, G. Chiba, M. Ono, M. Tojo, "Development and verification of nuclear data processing code FRENDY version 2," J. Nucl. Sci. Technol. (2023).
    https://www.tandfonline.com/doi/full/10.1080/00223131.2023.2278600