Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lanl/cgmf

CGMF nuclear fission fragment de-excitation statistical code
https://github.com/lanl/cgmf

fission gammas hauser-feshbach neutrons nuclear prompt

Last synced: 2 months ago
JSON representation

CGMF nuclear fission fragment de-excitation statistical code

Host: GitHub
URL: https://github.com/lanl/cgmf
Owner: lanl
License: bsd-3-clause
Created: 2020-04-28T12:38:08.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-03-26T13:20:33.000Z (11 months ago)
Last Synced: 2024-11-05T09:44:32.534Z (4 months ago)
Topics: fission, gammas, hauser-feshbach, neutrons, nuclear, prompt
Language: Jupyter Notebook
Homepage: https://cgmf.readthedocs.io/
Size: 24.4 MB
Stars: 25
Watchers: 6
Forks: 7
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        CGMF, Cascading Gamma-ray Multiplicity and Fission

==================================================

Updated on Feb. 5, 2024

---

Authors

-------

Patrick Talou, XCP-5, Los Alamos National Laboratory, [email protected]

Ionel Stetcu, T-2, Los Alamos National Laboratory, [email protected]

Patrick Jaffke, Institute for Defense Analyses, [email protected]

Michael E. Rising, XCP-3, Los Alamos National Laboratory, [email protected]

Amy E. Lovell, T-2, Los Alamos National Laboratory, [email protected]

Toshihiko Kawano, T-2, Los Alamos National Laboratory, [email protected]

---

Abstract

--------

CGMF is a code that simulates the emission of prompt fission neutrons and gamma rays from excited fission fragments right after scission. It implements a Monte Carlo version of the Hauser-Feshbach statistical theory of nuclear reactions to follow the decay of the fission fragments on an event-by-event basis. Probabilities for emitting neutrons and gamma rays are computed at each stage of the decay. Each fission event history records characteristics of the parent fragment (mass, charge, kinetic energy, momentum vector, excitation energy, spin, parity) and the number (multiplicity) and characteristics (energy, direction) of the prompt neutrons and gamma rays emitted in this event.

---

Citing

------

The main publication (and documentation) to cite for CGMF is:

Patrick Talou, Ionel Stetcu, Patrick Jaffke, Michael E. Rising, Amy E. Lovell, and Toshihiko Kawano, “Fission Fragment Decay Simulations with the CGMF Code,” Comp. Phys. Comm., 269 (2021), Article 108087. DOI: [10.1016/j.cpc.2021.108087](https://doi.org/10.1016/j.cpc.2021.108087)

---

Documentation

-------------

- Patrick Talou, Ionel Stetcu, Patrick Jaffke, Michael E. Rising, Amy E. Lovell, and Toshihiko Kawano, “Fission Fragment Decay Simulations with the CGMF Code,” Comp. Phys. Comm., 269 (2021), Article 108087. Los Alamos Technical Report LA-UR-20-21264 (2020).

---

Version

-------

### Current Version 1.1.X

- Open source, BSD-3

- Copyright: Triad National Security, LLC. All rights reserved.

- Programming language: C++ (and Python for post-processing)

- Fission reactions handled: spontaneous fission of Pu-238,240,242,244 and Cf-252,254; neutron-induced fission reactions from thermal up to 20 MeV for n+U-233,234,235,238, n+Np-237, and n+Pu-239,241.

---

Building, Testing and Installing Instructions

---------------------------------------------

0) Optional, set CGMFDATA environment variable to point to data/ directory

1) Create a build directory

2) Change to build directory

3) Configuration: type `cmake ..` and then `make` for default build

    * The `..` needs to point to the top-level CGMF directory

    * Options:

        * CMAKE_BUILD_TYPE [Debug, RelWithDebInfo, Release]

        * CMAKE_INSTALL_PREFIX [path/to/install/directory]

        * cgmf.shared_library [ON/OFF (default)]

        * cgmf.x.MPI [ON/OFF (default)]

        * cgmf.tests [(default) ON/OFF]

5) Building: type `make` for default build

    * This creates the static library `libcgmf.a` in the build/libcgmf directory

    * This creates the executable `cgmf.x` in the build/utils/cgmf directory

6) Testing: type `make test` or `ctest` to run the default tests

7) Installing: type `make install` to install CGMF

    * This creates the following directory structure in the CMAKE_INSTALL_PREFIX directory:

        * bin/ [contains cgmf executable]

        * include/cgmf-1.1.X [contains cgmf header files]

        * lib/cgmf-1.1.X [contains libcgmf library]

        * share/data/cgmf-1.1.X [contains cgmf data files]

Example configuration in release mode with build, test and install:

* `cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../install -Dcgmf.x.MPI=ON ..`

* `make && ctest && make install`

* If the build and tests pass:

    * This creates the static library `libcgmf.a` in the build directory

    * This creates the executable `cgmf.mpi.x` in the build/utils/cgmf directory

    * This installs bin, lib, cgmf/data, and cgmf/include directories into install directory

---

Execution Instructions and Options

----------------------------------

`./cgmf.x [options]`

Options:

	-i $ZAIDt   		[required]	1000*Z+A of target nucleus, or fissioning nucleus if spontaneous fission

	-e $Einc    		[required]	incident neutron energy in MeV (0.0 for spontaneous fission)

	-n $nevents 		[optional]	number of Monte Carlo fission events to run or to be read. If $nevents is negative, produces initial fission fragments yields Y(A,Z,KE,U,J,p)

	-s $startingEvent	[optional]	skip ahead to particular Monte Carlo event (1 is default)

	-f $filename		[optional]	fission histories or yields result file (default: "histories.cgmf" or "yields.cgmf")

	-t $timeCoinc		[optional]	time coincidence window for long-lived isomer gamma-ray emission cutoff (in sec)

	-d $datapath		[optional]	overrides the environment variable CGMFDATA and default datapath

---

Results

-------

A concise summary of average results is displayed on the standard output, and event-by-event results or initial fragment distributions are saved in "histories.cgmf" or "yields.cgmf" (default names).