CGMF 1.0.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+__pycache__

CMakeLists.txt

@@ -0,0 +1,31 @@
+cmake_minimum_required(VERSION 3.16.2)
+
+if(NOT CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Specifies the build type on single-configuration generators.")
+endif()
+
+if(NOT DEFINED PROJECT_NAME)
+  set(NOT_SUBPROJECT ON)
+endif()
+
+file(STRINGS VERSION CGMF_VER)
+set(cgmf_version ${CGMF_VER} CACHE STRING "CGMF Library Version")
+
+project(cgmf VERSION ${CGMF_VER} LANGUAGES C CXX)
+
+# Set C++11 Standard
+set(CMAKE_CXX_STANDARD 11)
+
+add_subdirectory(libcgmf)
+
+option(cgmf.tests "Configure tests for CGMF" ON)
+
+if(cgmf.tests)
+  enable_testing()
+endif()
+
+if(NOT_SUBPROJECT)
+  add_subdirectory(utils)
+endif()
+
+install(DIRECTORY data DESTINATION cgmf)

README.md

@@ -1,2 +1,104 @@
-# CGMF
-CGMF nuclear fission fragment de-excitation statistical code
+CGMF, Cascading Gamma-ray Multiplicity and Fission
+==================================================
+
+Updated on Oct. 13, 2020
+
+---
+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,” to be submitted to Comp. Phys. Comm. (2020).
+
+---
+Documentation
+-------------
+
+- Patrick Talou, Ionel Stetcu, Patrick Jaffke, Michael E. Rising, Amy E. Lovell, and Toshihiko Kawano, “Fission Fragment Decay Simulations with the CGMF Code,” to be submitted to Comp. Phys. Comm. (2020). Los Alamos Technical Report LA-UR-20-21264 (2020).
+
+---
+Version
+-------
+
+### Current Version 1.0
+
+- 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 `ctest` for default tests
+7) 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, data, and 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).
+
+

VERSION

@@ -0,0 +1 @@
+1.0.0

data/anisotropy.dat

@@ -0,0 +1,18 @@
+#-------------------------------------------------------------------------------
+#  CGMF-1.0
+#  Copyright TRIAD/LANL/DOE - see file COPYRIGHT.md
+#  For any questions about CGMF, please contact us at [email protected]
+#-------------------------------------------------------------------------------
+# Anisotropy of the fission fragments with respect to the z-axis (incidence neutron)
+# first line is Emin, Emax, and Estep
+# ZAID of the target, followed by anisotropy coefficients for the given target
+# starting at Emin in steps of Estep up to (and including) Emax
+# ------------------------------------------------------------------------------
+0.0 20.0 0.1
+92233 1.0 1.014 1.027 1.041 1.053 1.066 1.078 1.089 1.1 1.11 1.12 1.129 1.138 1.145 1.152 1.159 1.165 1.17 1.174 1.177 1.18 1.182 1.183 1.184 1.184 1.183 1.182 1.181 1.179 1.177 1.174 1.171 1.169 1.166 1.163 1.16 1.157 1.155 1.152 1.15 1.148 1.146 1.145 1.144 1.143 1.143 1.144 1.145 1.147 1.149 1.152 1.156 1.16 1.165 1.171 1.178 1.185 1.192 1.2 1.208 1.217 1.225 1.233 1.241 1.249 1.256 1.263 1.27 1.276 1.281 1.286 1.29 1.294 1.297 1.299 1.301 1.303 1.304 1.305 1.305 1.305 1.304 1.304 1.303 1.301 1.3 1.298 1.295 1.293 1.291 1.288 1.285 1.282 1.279 1.276 1.272 1.269 1.266 1.262 1.259 1.255 1.252 1.249 1.246 1.243 1.24 1.237 1.235 1.233 1.23 1.229 1.227 1.226 1.225 1.224 1.224 1.224 1.224 1.225 1.226 1.228 1.23 1.233 1.236 1.24 1.244 1.249 1.254 1.26 1.266 1.272 1.278 1.285 1.291 1.297 1.304 1.31 1.316 1.322 1.327 1.333 1.337 1.341 1.345 1.348 1.35 1.351 1.352 1.352 1.352 1.351 1.349 1.347 1.345 1.342 1.339 1.335 1.332 1.328 1.324 1.32 1.316 1.312 1.308 1.304 1.3 1.296 1.292 1.288 1.285 1.281 1.277 1.274 1.27 1.267 1.264 1.261 1.258 1.255 1.252 1.25 1.248 1.246 1.244 1.242 1.24 1.239 1.237 1.236 1.234 1.233 1.232 1.231 1.229 1.228 1.227 1.226 1.224 1.223 1.222 1.22 
+92234 1.0 1.044 1.112 1.2 1.303 1.4 1.474 1.523 1.55 1.559 1.552 1.533 1.505 1.472 1.436 1.4 1.368 1.339 1.313 1.291 1.271 1.254 1.24 1.228 1.218 1.21 1.204 1.199 1.195 1.193 1.191 1.19 1.19 1.19 1.19 1.19 1.19 1.189 1.188 1.188 1.187 1.187 1.186 1.187 1.187 1.189 1.191 1.194 1.197 1.202 1.208 1.215 1.223 1.233 1.244 1.257 1.272 1.289 1.307 1.327 1.35 1.375 1.401 1.428 1.455 1.481 1.507 1.53 1.55 1.567 1.581 1.591 1.599 1.604 1.606 1.606 1.604 1.6 1.594 1.587 1.578 1.568 1.556 1.544 1.531 1.518 1.504 1.49 1.477 1.463 1.45 1.437 1.426 1.414 1.403 1.393 1.383 1.374 1.365 1.357 1.349 1.342 1.335 1.328 1.322 1.316 1.31 1.305 1.3 1.295 1.291 1.287 1.283 1.279 1.276 1.273 1.27 1.267 1.264 1.262 1.26 1.258 1.256 1.254 1.252 1.251 1.249 1.248 1.247 1.246 1.245 1.244 1.243 1.242 1.241 1.24 1.239 1.238 1.238 1.237 1.236 1.235 1.235 1.234 1.233 1.232 1.232 1.231 1.23 1.23 1.229 1.228 1.228 1.227 1.227 1.226 1.226 1.225 1.225 1.224 1.224 1.223 1.223 1.222 1.222 1.222 1.221 1.221 1.221 1.22 1.22 1.22 1.219 1.219 1.219 1.219 1.218 1.218 1.218 1.218 1.217 1.217 1.217 1.216 1.216 1.215 1.215 1.214 1.214 1.213 1.212 1.211 1.21 1.209 1.208 1.207 1.206 1.205 1.203 1.202 1.2 
+92235 1.0 1.014 1.028 1.041 1.054 1.066 1.078 1.089 1.1 1.11 1.12 1.129 1.137 1.145 1.152 1.159 1.164 1.169 1.174 1.177 1.18 1.182 1.183 1.184 1.184 1.184 1.183 1.181 1.179 1.177 1.175 1.172 1.169 1.166 1.163 1.16 1.157 1.154 1.151 1.148 1.146 1.144 1.142 1.141 1.14 1.14 1.141 1.142 1.144 1.146 1.15 1.155 1.16 1.166 1.174 1.182 1.191 1.2 1.21 1.221 1.231 1.242 1.252 1.262 1.273 1.282 1.291 1.3 1.308 1.315 1.321 1.327 1.332 1.337 1.341 1.344 1.347 1.349 1.35 1.352 1.352 1.353 1.352 1.352 1.351 1.35 1.348 1.346 1.344 1.342 1.339 1.336 1.333 1.33 1.327 1.323 1.32 1.316 1.312 1.309 1.305 1.302 1.298 1.294 1.291 1.288 1.285 1.282 1.279 1.276 1.274 1.272 1.27 1.269 1.268 1.267 1.267 1.267 1.267 1.268 1.269 1.271 1.274 1.276 1.28 1.284 1.289 1.294 1.299 1.305 1.311 1.317 1.324 1.33 1.337 1.343 1.349 1.356 1.361 1.367 1.372 1.377 1.381 1.385 1.388 1.39 1.392 1.392 1.392 1.392 1.391 1.389 1.387 1.385 1.382 1.379 1.375 1.372 1.368 1.364 1.36 1.356 1.352 1.348 1.344 1.34 1.336 1.332 1.328 1.324 1.32 1.317 1.313 1.31 1.307 1.303 1.3 1.297 1.295 1.292 1.29 1.288 1.286 1.284 1.283 1.281 1.28 1.279 1.278 1.277 1.276 1.275 1.275 1.274 1.273 1.273 1.272 1.272 1.271 1.271 1.27 
+92238 1.0 1.001 1.007 1.018 1.036 1.06 1.093 1.135 1.187 1.25 1.323 1.397 1.463 1.511 1.53 1.515 1.472 1.414 1.352 1.297 1.26 1.25 1.26 1.283 1.309 1.33 1.339 1.337 1.328 1.314 1.3 1.287 1.277 1.268 1.261 1.256 1.252 1.249 1.248 1.247 1.247 1.248 1.249 1.25 1.252 1.253 1.253 1.254 1.253 1.252 1.25 1.247 1.244 1.244 1.246 1.255 1.27 1.293 1.327 1.372 1.43 1.501 1.578 1.65 1.71 1.757 1.792 1.816 1.83 1.835 1.832 1.822 1.806 1.786 1.761 1.734 1.705 1.675 1.645 1.616 1.59 1.567 1.546 1.529 1.514 1.502 1.492 1.484 1.478 1.474 1.471 1.47 1.471 1.472 1.474 1.477 1.48 1.484 1.488 1.492 1.496 1.5 1.503 1.505 1.507 1.507 1.506 1.504 1.5 1.494 1.487 1.479 1.469 1.458 1.446 1.433 1.42 1.406 1.392 1.378 1.364 1.351 1.338 1.325 1.313 1.302 1.292 1.283 1.276 1.271 1.267 1.265 1.265 1.268 1.272 1.28 1.29 1.303 1.317 1.333 1.349 1.366 1.383 1.399 1.415 1.429 1.441 1.45 1.457 1.461 1.462 1.462 1.459 1.455 1.449 1.443 1.435 1.427 1.418 1.409 1.4 1.391 1.383 1.375 1.368 1.36 1.353 1.346 1.34 1.334 1.328 1.322 1.317 1.312 1.307 1.302 1.298 1.294 1.29 1.286 1.283 1.28 1.277 1.274 1.272 1.27 1.268 1.266 1.264 1.263 1.261 1.26 1.26 1.259 1.259 1.258 1.258 1.259 1.259 1.259 1.26 
+93237 1.0 1.016 1.03 1.044 1.056 1.066 1.076 1.084 1.092 1.098 1.103 1.108 1.112 1.115 1.118 1.12 1.122 1.123 1.123 1.124 1.123 1.123 1.122 1.121 1.12 1.119 1.117 1.116 1.114 1.113 1.111 1.11 1.108 1.107 1.106 1.105 1.104 1.104 1.104 1.104 1.104 1.105 1.107 1.109 1.111 1.115 1.118 1.123 1.128 1.133 1.14 1.147 1.155 1.164 1.173 1.182 1.192 1.201 1.211 1.221 1.23 1.239 1.248 1.256 1.263 1.27 1.276 1.281 1.285 1.288 1.291 1.292 1.293 1.294 1.294 1.293 1.291 1.289 1.287 1.284 1.281 1.277 1.273 1.268 1.263 1.258 1.253 1.247 1.242 1.236 1.23 1.223 1.217 1.211 1.205 1.198 1.192 1.186 1.18 1.174 1.169 1.163 1.158 1.153 1.149 1.145 1.141 1.137 1.134 1.132 1.13 1.129 1.128 1.127 1.127 1.128 1.129 1.13 1.132 1.133 1.136 1.138 1.141 1.144 1.148 1.151 1.155 1.159 1.163 1.167 1.171 1.175 1.179 1.183 1.187 1.191 1.195 1.199 1.203 1.207 1.21 1.213 1.216 1.219 1.222 1.224 1.226 1.228 1.23 1.232 1.234 1.235 1.236 1.237 1.238 1.239 1.239 1.24 1.24 1.24 1.24 1.24 1.24 1.239 1.239 1.238 1.238 1.237 1.236 1.235 1.234 1.233 1.232 1.231 1.23 1.228 1.227 1.226 1.224 1.223 1.222 1.221 1.219 1.218 1.217 1.215 1.214 1.213 1.212 1.211 1.21 1.209 1.208 1.208 1.207 1.206 1.206 1.205 1.205 1.205 1.205 
+94239 1.0 1.014 1.027 1.039 1.05 1.06 1.07 1.078 1.086 1.093 1.099 1.104 1.109 1.113 1.117 1.12 1.123 1.125 1.126 1.128 1.128 1.129 1.129 1.129 1.129 1.128 1.127 1.126 1.125 1.123 1.122 1.12 1.118 1.117 1.115 1.113 1.112 1.11 1.109 1.107 1.106 1.105 1.104 1.104 1.104 1.104 1.104 1.105 1.106 1.108 1.11 1.113 1.115 1.119 1.123 1.127 1.131 1.135 1.14 1.145 1.15 1.156 1.161 1.166 1.172 1.177 1.182 1.187 1.192 1.197 1.202 1.206 1.21 1.214 1.217 1.22 1.223 1.225 1.226 1.228 1.229 1.229 1.23 1.229 1.229 1.229 1.228 1.227 1.226 1.224 1.223 1.221 1.219 1.217 1.215 1.213 1.21 1.208 1.206 1.204 1.201 1.199 1.197 1.195 1.193 1.191 1.189 1.188 1.186 1.185 1.184 1.183 1.183 1.183 1.183 1.183 1.184 1.185 1.186 1.188 1.19 1.193 1.195 1.199 1.202 1.206 1.21 1.214 1.218 1.223 1.227 1.231 1.235 1.239 1.243 1.247 1.25 1.253 1.256 1.258 1.26 1.261 1.262 1.263 1.263 1.262 1.262 1.261 1.26 1.258 1.256 1.255 1.253 1.251 1.248 1.246 1.244 1.242 1.24 1.238 1.236 1.234 1.233 1.231 1.23 1.228 1.227 1.226 1.224 1.223 1.222 1.221 1.22 1.219 1.218 1.218 1.217 1.216 1.216 1.215 1.214 1.214 1.213 1.213 1.212 1.212 1.212 1.211 1.211 1.21 1.21 1.21 1.209 1.209 1.208 1.208 1.208 1.207 1.206 1.206 1.205 
+94241 1.0 1.014 1.027 1.039 1.05 1.06 1.07 1.078 1.086 1.093 1.099 1.104 1.109 1.113 1.117 1.12 1.123 1.125 1.126 1.128 1.128 1.129 1.129 1.129 1.129 1.128 1.127 1.126 1.125 1.123 1.122 1.12 1.118 1.117 1.115 1.113 1.112 1.11 1.109 1.107 1.106 1.105 1.104 1.104 1.104 1.104 1.104 1.105 1.106 1.108 1.11 1.113 1.115 1.119 1.123 1.127 1.131 1.135 1.14 1.145 1.15 1.156 1.161 1.166 1.172 1.177 1.182 1.187 1.192 1.197 1.202 1.206 1.21 1.214 1.217 1.22 1.223 1.225 1.226 1.228 1.229 1.229 1.23 1.229 1.229 1.229 1.228 1.227 1.226 1.224 1.223 1.221 1.219 1.217 1.215 1.213 1.21 1.208 1.206 1.204 1.201 1.199 1.197 1.195 1.193 1.191 1.189 1.188 1.186 1.185 1.184 1.183 1.183 1.183 1.183 1.183 1.184 1.185 1.186 1.188 1.19 1.193 1.195 1.199 1.202 1.206 1.21 1.214 1.218 1.223 1.227 1.231 1.235 1.239 1.243 1.247 1.25 1.253 1.256 1.258 1.26 1.261 1.262 1.263 1.263 1.262 1.262 1.261 1.26 1.258 1.256 1.255 1.253 1.251 1.248 1.246 1.244 1.242 1.24 1.238 1.236 1.234 1.233 1.231 1.23 1.228 1.227 1.226 1.224 1.223 1.222 1.221 1.22 1.219 1.218 1.218 1.217 1.216 1.216 1.215 1.214 1.214 1.213 1.213 1.212 1.212 1.212 1.211 1.211 1.21 1.21 1.21 1.209 1.209 1.208 1.208 1.208 1.207 1.206 1.206 1.205