Computer Programs
NEA-1907 FRENDY V2.
last modified: 04-MAR-2022 | catalog | categories | new | search |

NEA-1907 FRENDY V2.

FRENDY V2, Nuclear Data Processing System for Evaluated Nuclear Data File

top ]
1. NAME OR DESIGNATION OF PROGRAM

FRENDY Version 2.

 

FRENDY is freely available at https://rpg.jaea.go.jp/main/en/program_frendy/

 

top ]
2. COMPUTERS

To submit a request, click below on the link of the version you wish to order. Rules for end-users are available here.

Program name Package id Status Status date
FRENDY V2 NEA-1907/02 Tested 04-MAR-2022

Machines used:

Package ID Orig. computer Test computer
NEA-1907/02 Linux-based PC Gitlab,Linux-based PC
top ]
3. DESCRIPTION OF PROGRAM OR FUNCTION

FRENDY (FRom Evaluated Nuclear Data librarY to any application) is a nuclear data processing system to generate a cross-section file from evaluated nuclear data file. FRENDY supports recently evaluated nuclear data libraries (e.g., JENDL-4.0 and JENDL-5 in Japan, ENDF-B/VII.1 and ENDF-B/VIII.0 in the US, JEFF-3.2 and JEFF-3.3 in Europe). The first version of FRENDY, which is called FRENDY Version 1 generates the ACE file which is used for continuous energy Monte Carlo codes such as PHITS, Serpent, and MCNP. FRENDY Version 2 generates the multi-group neutron cross-section file for multi-group deterministic calculation codes from the ACE file. The available multi-group cross section format is GENDF and MATXS. The other major improvements are as follows: (1) uncertainty quantification for the probability tables of the unresolved resonance cross-sections, (2) perturbation of the ACE file for uncertainty quantification using a continuous Monte Carlo code, and (3) modification of the ENDF-6 formatted nuclear data file.

Features of FRENDY are as follows:

  • Two types of input formats (Simple input format and NJOY compatible format)
    FRENDY accepts two types of input formats.
    The simple input format requires only the processing mode and evaluated nuclear data file name at the minimum. This input format does not require the expertise of nuclear data processing. The other input parameters are automatically set from the evaluated nuclear data file. Users can also specify the parameters in the input file if they want to change them.

 

FRENDY has an alternative capability of reading ordinary NJOY inputs without any modifications. Many users process the evaluated nuclear data file with NJOY. They can easily use FRENDY without changing the input files for NJOY. They can therefore replace NJOY modules with FRENDY ones as they need. In addition, the modules of FRENDY and NJOY can be used in combination. For example, users can generate the multi-group cross-section data library using the GROUPR module of NJOY with the PENDF file generated by FRENDY. Available NJOY modules in FRENDY are RECONR (resonance reconstruction and linearization), BROADR (Doppler broadening), GASPR (calculation of gas production cross-section), PURR (generation of probability table), UNRESR (calculation of Bondarenko-type self-shielded cross-section), THERMR (calculation of thermal scattering cross-section), ACER (generation of ACE file), and MODER (modification of PENDF file).

  • Extensibility & Modularity

FRENDY is developed not only to process evaluated nuclear data files but also to apply the modules to other codes. FRENDY is written in C++ and all the modules are encapsulated. Users can easily employ many functions (e.g., read, write, and process an evaluated nuclear data file) in their codes when they implement the classes of FRENDY to their codes. FRENDY prepares utility tools, e.g., the ACE file perturbation tool, in the code package.

  • Open source software under 2-clause BSD license

There is no restriction to introducing the FRENDY modules into other codes.

FRENDY is freely available at https://rpg.jaea.go.jp/main/en/program_frendy/

Some introduction articles are also published on this website.

top ]
4. METHODS

FRENDY version 2 generates an ACE file from an evaluated nuclear data file. The detail of the processing methods to generate an ACE file are documented in JAEA-Data/Code2018-014.

top ]
6. TYPICAL RUNNING TIME

FRENDY prepares sample cases to generate ACE files. All 15 sample input files ran in about 15 minutes on Intel Xeon Gold 6154 (3.00 GHz) without parallel computation.

The other sample input files to generate ACE, GENDF, and MATXS files can be found in the manual of FRENDY in the FRENDY package.

top ]
7. UNUSUAL FEATURES OF THE PROGRAM

FRENDY has the following unusual capabilities:

  • Generation of the multi-nuclide data, e.g., U-235, U-238, and O-16 in UO2, to explicitly consider the resonance interference effect in a material.

  • Automatic background cross section set with the minimum number of background cross-sections.

  • Perturbation of ACE file with perturbation_ace_file.exe.

  • A random sampling of ACE file with make_perturbation_factor.

top ]
8. RELATED OR AUXILIARY PROGRAMS
  • perturbation_ace_file: Program to perturb an ACE file when a user sets the ACE file name, reaction type, energy region, and amount of perturbation.

  • make_perturbation_factor: Program for uncertainty analysis using the random sampling method for ACE file.

  • read_errorr_data: Program to generate the input file and the CSV file for the make_perturbation_factor tool from the GENDF file generated by the ERRORR module in the NJOY code.

  • make_xsdir_list: Program to generate the XSDIR file and copy ACE files to use continuous energy Monte Carlo codes without any modification.

top ]
9. STATUS
Package ID Status date Status
NEA-1907/02 04-MAR-2022 Tested at NEADB
top ]
10. REFERENCES
  • K. Tada, Y. Nagaya, S. Kunieda, K. Suyama, T. Fukahori, "Development and verification of a new nuclear data processing system FRENDY," J. Nucl. Sci. Technol., 54, pp.806-817 (2017).

  • K. Tada, S. Kunieda, Y. Nagaya, “Nuclear data processing code FRENDY version 1,” JAEA-Data/Code 2018-014 (2019).

  • A. Yamamoto, K. Tada, G. Chiba, T. Endo, “Multi-group neutron cross section generation capability for FRENDY nuclear data processing code,” J. Nucl. Sci. Technol., 54, pp.1165-1183 (2021).

NEA-1907/02, included references:
- Manual of FRENDY Version 2 (Preliminary version) (2022/Jan/21)
- FRENDY Ver.2, JAEA 2022/02/24 (flyer)
top ]
11. HARDWARE REQUIREMENTS

FRENDY runs on various platforms such as Linux, Windows, and Mac. Disk space of about 1.5 Gbytes is required to compile FRENDY and run all sample programs. To compile FRENDY, Disk space of 250 Mbyte is required.

 

Tested at the NEA Data Bank on:

  • MACHINE: CPS GitLab Service (GitLab repository located at https://git2.oecd-nea.org/databank/cps/frendy - please note the access is restricted)

  • OPERATING SYSTEM: Dockerized Ubuntu 16.04, Ubuntu 18.04, and Ubuntu 20.04 respectively.

  • COMPILER: gfortran v5, gfortran v7, and gfortran v9 for each respective Ubuntu version tested.

top ]
12. PROGRAMMING LANGUAGE(S) USED
Package ID Computer language
NEA-1907/02 C++
top ]
13. SOFTWARE REQUIREMENTS

FRENDY runs on the following operation systems: Linux, Windows, and Mac.

The supported C++ compilers are Intel compiler and GNU compiler.

BOOST and LAPACK libraries are required to compile FRENDY.

Matrix calculation library Eigen is required to compile related program make_perturbation_factor.

 

top ]
15. NAME AND ESTABLISHMENT OF AUTHORS

Kenichi TADA, Satoshi KUNIEDA, Yasunobu NAGAYA

Research Group for Reactor Physics and Standard Nuclear Code System

Nuclear and LWR Engineering Division

Nuclear Science and Engineering Center

Sector of Nuclear Science Research

Japan Atomic Energy Agency

Tokai-mura, Naka-gun, Ibaraki

Japan

top ]
16. MATERIAL AVAILABLE
NEA-1907/02
FRENDY_V2.0.inf  Information file
FRENDY_manual_2020121.pdf  Manual of FRENDY Version 2
Updatelist.txt   List of FRENDY updates
README           Detailed readme file
README_jp        Detailed readme file in Japanese
/frendy/         Source files of FRENDY
/sample/         Input files for the test calculations
/tests/          Source files to run the Boost.Test library for verification
/tools/          Tools which use FRENDY modules
top ]
17. CATEGORIES
  • B. Spectrum Calculations, Generation of Group Constants and Cell Problems

Keywords: ACE, ENDF, ENDF-B/VII.1, ENDF-B/VIII.0, JEFF, JEFF-3.2, JEFF-3.3, JENDL, JENDL-3.3, JENDL-4.0, cross sections, data library, data processing, evaluated nuclear data, nuclear data, open-source code.