From dab1c2aef3052a3c761928b2feadff1e94efdf22 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Mon, 16 Feb 2015 20:08:35 -0500 Subject: [PATCH] Fixes to documentation --- docs/source/conf.py | 3 +- docs/source/devguide/statepoint.rst | 2362 +-------------------------- docs/source/devguide/styleguide.rst | 34 +- docs/source/devguide/voxel.rst | 4 +- docs/source/devguide/workflow.rst | 12 +- docs/source/methods/cmfd.rst | 28 +- 6 files changed, 52 insertions(+), 2391 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5af14cc6e..dd622900c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,7 +39,7 @@ master_doc = 'index' # General information about the project. project = u'OpenMC' -copyright = u'2011-2014, Massachusetts Institute of Technology' +copyright = u'2011-2015, Massachusetts Institute of Technology' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -191,6 +191,7 @@ latex_documents = [ latex_elements = { 'preamble': ''' \usepackage{enumitem} +\usepackage{amsfonts} \setlistdepth{9} \usepackage{tikz} \usetikzlibrary{shapes,snakes,shadows,arrows,calc,decorations.markings,patterns,fit,matrix,spy} diff --git a/docs/source/devguide/statepoint.rst b/docs/source/devguide/statepoint.rst index 6407a3cc7..4a1db9478 100644 --- a/docs/source/devguide/statepoint.rst +++ b/docs/source/devguide/statepoint.rst @@ -4,9 +4,7 @@ State Point Binary File Specifications ====================================== ------------ -Revision 13 ------------ +The current revision of the statepoint binary file is 13. **integer(4) FILETYPE_STATEPOINT** @@ -214,7 +212,7 @@ if (run_mode == MODE_EIGENVALUE) **integer(4) tallies(i) % score_bins(j)** Values of specified scoring bins (e.g. SCORE_FLUX). - + **integer(4) tallies(i) % n_score_bins** Number of scoring bins without accounting for those added by @@ -224,7 +222,7 @@ if (run_mode == MODE_EIGENVALUE) **character(8) tallies(i) % moment_order(j)** - Tallying moment order for Legendre and spherical + Tallying moment order for Legendre and spherical harmonic tally expansions (*e.g.*, 'P2', 'Y1,2', etc.). **integer(4) source_present** @@ -291,2357 +289,3 @@ if (run_mode == MODE_EIGENVALUE and source_present) Energy of the i-th source particle. ------------ -Revision 12 ------------ - -Same as revision 11, except **tallies(i) % scatt_order(j)** is now **tallies(i) -% moment_order(j)**. - ------------ -Revision 11 ------------ - -**integer(4) FILETYPE_STATEPOINT** - - Flags whether this file is a statepoint file or a particle restart file. - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**character(255) path** - - Absolute path to directory containing input files. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) k_generation(i)** - - k-effective for the i-th total generation - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th total generation - - **real(8) k_col_abs** - - Sum of product of collision/absorption estimates of k-effective - - **real(8) k_col_tra** - - Sum of product of collision/track-length estimates of k-effective - - **real(8) k_abs_tra** - - Sum of product of absorption/track-length estimates of k-effective - - **real(8) k_combined(2)** - - Mean and standard deviation of a combined estimate of k-effective - - **integer(4) cmfd_on** - - Flag that cmfd is on - - if (cmfd_on) - - **integer(4) cmfd % indices** - - Indices for cmfd mesh (i,j,k,g) - - **real(8) cmfd % k_cmfd(1:current_batch)** - - CMFD eigenvalues - - **real(8) cmfd % src(1:G,1:I,1:J,1:K)** - - CMFD fission source - - **real(8) cmfd % entropy(1:current_batch)** - - CMFD estimate of Shannon entropy - - **real(8) cmfd % balance(1:current_batch)** - - RMS of the residual neutron balance equation on CMFD mesh - - **real(8) cmfd % dom(1:current_batch)** - - CMFD estimate of dominance ratio - - **real(8) cmfd % scr_cmp(1:current_batch)** - - RMS comparison of difference between OpenMC and CMFD fission source - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % id** - - Unique ID of mesh. - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % id** - - Unique ID of tally. - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % scatt_order(j)** - - Scattering Order specified scoring bins. - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins without accounting for those added by - the scatter-pn command. - -**integer(4) source_present** - - Flag indicated if source bank is present in the file - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE and source_present) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ------------ -Revision 10 ------------ - -**integer(4) FILETYPE_STATEPOINT** - - Flags whether this file is a statepoint file or a particle restart file. - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**character(255) path** - - Absolute path to directory containing input files. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) k_generation(i)** - - k-effective for the i-th total generation - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th total generation - - **real(8) k_col_abs** - - Sum of product of collision/absorption estimates of k-effective - - **real(8) k_col_tra** - - Sum of product of collision/track-length estimates of k-effective - - **real(8) k_abs_tra** - - Sum of product of absorption/track-length estimates of k-effective - - **real(8) k_combined(2)** - - Mean and standard deviation of a combined estimate of k-effective - - **integer(4) cmfd_on** - - Flag that cmfd is on - - if (cmfd_on) - - **integer(4) cmfd % indices** - - Indices for cmfd mesh (i,j,k,g) - - **real(8) cmfd % k_cmfd(1:current_batch)** - - CMFD eigenvalues - - **real(8) cmfd % src(1:I,1:J,1:K,1:G)** - - CMFD fission source - - **real(8) cmfd % entropy(1:current_batch)** - - CMFD estimate of Shannon entropy - - **real(8) cmfd % balance(1:current_batch)** - - RMS of the residual neutron balance equation on CMFD mesh - - **real(8) cmfd % dom(1:current_batch)** - - CMFD estimate of dominance ratio - - **real(8) cmfd % scr_cmp(1:current_batch)** - - RMS comparison of difference between OpenMC and CMFD fission source - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % id** - - Unique ID of mesh. - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % id** - - Unique ID of tally. - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % scatt_order(j)** - - Scattering Order specified scoring bins. - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins without accounting for those added by - the scatter-pn command. - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 9 ----------- - -**integer(4) FILETYPE_STATEPOINT** - - Flags whether this file is a statepoint file or a particle restart file. - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**character(255) path** - - Absolute path to directory containing input files. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) k_generation(i)** - - k-effective for the i-th total generation - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th total generation - - **real(8) k_col_abs** - - Sum of product of collision/absorption estimates of k-effective - - **real(8) k_col_tra** - - Sum of product of collision/track-length estimates of k-effective - - **real(8) k_abs_tra** - - Sum of product of absorption/track-length estimates of k-effective - - **real(8) k_combined(2)** - - Mean and standard deviation of a combined estimate of k-effective - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % id** - - Unique ID of mesh. - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % id** - - Unique ID of tally. - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % scatt_order(j)** - - Scattering Order specified scoring bins. - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins without accounting for those added by - the scatter-pn command. - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 8 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**character(255) path** - - Absolute path to directory containing input files. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - - **real(8) k_col_abs** - - Sum of product of collision/absorption estimates of k-effective - - **real(8) k_col_tra** - - Sum of product of collision/track-length estimates of k-effective - - **real(8) k_abs_tra** - - Sum of product of absorption/track-length estimates of k-effective - - **real(8) k_combined(2)** - - Mean and standard deviation of a combined estimate of k-effective - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % id** - - Unique ID of mesh. - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % id** - - Unique ID of tally. - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % scatt_order(j)** - - Scattering Order specified scoring bins. - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins without accounting for those added by - the scatter-pn command. - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 7 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**character(255) path** - - Absolute path to directory containing input files. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - *do i = 1, current_batch \* gen_per_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % id** - - Unique ID of mesh. - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % id** - - Unique ID of tally. - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % scatt_order(j)** - - Scattering Order specified scoring bins. - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins without accounting for those added by - the scatter-pn command. - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 6 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**character(255) path** - - Absolute path to directory containing input files. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - *do i = 1, current_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % id** - - Unique ID of mesh. - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % id** - - Unique ID of tally. - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 5 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - *do i = 1, current_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) tallies(i) % n_realizations** - - Number of realizations for the i-th tally. - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - -**integer(4) n_realizations** - - Number of realizations for global tallies. - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 4 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - *do i = 1, current_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - **integer(4) n_realizations** - - Number of realizations for tally random variables. - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 3 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**character(19) time_stamp** - - Date and time the state point was written. - -**integer(8) seed** - - Pseudo-random number generator seed. - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) current_batch** - - The number of batches already simulated. - -if (run_mode == MODE_EIGENVALUE) - - **integer(4) n_inactive** - - Number of inactive batches - - **integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - - *do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - *do i = 1, current_batch* - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) n_meshes** - - Number of meshes in tallies.xml file - -*do i = 1, n_meshes* - - **integer(4) meshes(i) % type** - - Type of mesh. - - **integer(4) meshes(i) % n_dimension** - - Number of dimensions for mesh (2 or 3). - - **integer(4) meshes(i) % dimension(:)** - - Number of mesh cells in each dimension. - - **real(8) meshes(i) % lower_left(:)** - - Coordinates of lower-left corner of mesh. - - **real(8) meshes(i) % upper_right(:)** - - Coordinates of upper-right corner of mesh. - - **real(8) meshes(i) % width(:)** - - Width of each mesh cell in each dimension. - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - **integer(4) tallies(i) % n_filters** - - *do j = 1, tallies(i) % n_filters* - - **integer(4) tallies(i) % filter(j) % type** - - Type of tally filter. - - **integer(4) tallies(i) % filter(j) % n_bins** - - Number of bins for filter. - - **integer(4)/real(8) tallies(i) % filter(j) % bins(:)** - - Value for each filter bin of this type. - - **integer(4) tallies(i) % n_nuclide_bins** - - Number of nuclide bins. If none are specified, this is just one. - - *do j = 1, tallies(i) % n_nuclide_bins* - - **integer(4) tallies(i) % nuclide_bins(j)** - - Values of specified nuclide bins - - **integer(4) tallies(i) % n_score_bins** - - Number of scoring bins. - - *do j = 1, tallies(i) % n_score_bins* - - **integer(4) tallies(i) % score_bins(j)** - - Values of specified scoring bins (e.g. SCORE_FLUX). - -**integer(4) tallies_on** - - Flag indicated if tallies are present in the file. - -if (tallies_on > 0) - - *do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the - i-th tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th - filter of the i-th tally - -if (run_mode == MODE_EIGENVALUE) - - *do i = 1, n_particles* - - **real(8) source_bank(i) % wgt** - - Weight of the i-th source particle - - **real(8) source_bank(i) % xyz(1:3)** - - Coordinates of the i-th source particle. - - **real(8) source_bank(i) % uvw(1:3)** - - Direction of the i-th source particle - - **real(8) source_bank(i) % E** - - Energy of the i-th source particle. - ----------- -Revision 2 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) n_inactive** - - Number of inactive batches - -**integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - -**integer(4) current_batch** - - The number of batches already simulated. - -*do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - if (entropy_on) - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - -*do i = 1, n_tallies* - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the i-th - tally - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th filter of - the i-th tally - ----------- -Revision 1 ----------- - -**integer(4) REVISION_STATEPOINT** - - Revision of the binary state point file. Any time a change is made in the - format of the state-point file, this integer is incremented. - -**integer(4) VERSION_MAJOR** - - Major version number for OpenMC - -**integer(4) VERSION_MINOR** - - Minor version number for OpenMC - -**integer(4) VERSION_RELEASE** - - Release version number for OpenMC - -**integer(4) run_mode** - - run mode used. The modes are described in constants.F90. - -**integer(8) n_particles** - - Number of particles used per generation. - -**integer(4) n_batches** - - Total number of batches (active + inactive). - -**integer(4) n_inactive** - - Number of inactive batches - -**integer(4) gen_per_batch** - - Number of generations per batch for criticality calculations - -**integer(4) current_batch** - - The number of batches already simulated. - -*do i = 1, current_batch* - - **real(8) k_batch(i)** - - k-effective for the i-th batch - - if (entropy_on) - - **real(8) entropy(i)** - - Shannon entropy for the i-th batch - -**integer(4) N_GLOBAL_TALLIES** - - Number of global tally scores - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum** - - Accumulated sum for the i-th global tally - -*do i = 1, N_GLOBAL_TALLIES* - - **real(8) global_tallies(i) % sum_sq** - - Accumulated sum of squares for the i-th global tally - -**integer(4) n_tallies** - -*do i = 1, n_tallies* - - **integer(4) size(tallies(i) % scores, 1)** - - Total number of score bins for the i-th tally - - **integer(4) size(tallies(i) % scores, 2)** - - Total number of filter bins for the i-th tally - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum** - - Accumulated sum for the j-th score and k-th filter of the i-th - tally - - *do k = 1, size(tallies(i) % scores, 2)* - - *do j = 1, size(tallies(i) % scores, 1)* - - **real(8) tallies(i) % scores(j,k) % sum_sq** - - Accumulated sum of squares for the j-th score and k-th filter of - the i-th tally diff --git a/docs/source/devguide/styleguide.rst b/docs/source/devguide/styleguide.rst index 5ac237148..e9ed119fc 100644 --- a/docs/source/devguide/styleguide.rst +++ b/docs/source/devguide/styleguide.rst @@ -8,7 +8,10 @@ In order to keep the OpenMC code base consistent in style, this guide specifies a number of rules which should be adhered to when modified existing code or adding new code in OpenMC. -------------- +------- +Fortran +------- + General Rules ------------- @@ -35,7 +38,6 @@ Don't use ``print *`` or ``write(*,*)``. If writing to a file, use a specific unit. Writing to standard output or standard error should be handled by the ``write_message`` subroutine or functionality in the error module. ----------- Procedures ---------- @@ -47,7 +49,6 @@ intent(in), intent(out), or intent(inout). Include a comment describing what each argument to a procedure is. ---------- Variables --------- @@ -91,7 +92,7 @@ allocation instead. Use allocatable variables instead of pointer variables when possible. Shared/Module Variables ------------------------ ++++++++++++++++++++++++ Always put shared variables in modules. Access module variables through a ``use`` statement. Always use the ``only`` specifier on the ``use`` statement @@ -99,14 +100,12 @@ except for variables from the global, constants, and various header modules. Never use ``equivalence`` statements, ``common`` blocks, or ``data`` statements. -------------------------- Derived Types and Classes ------------------------- Derived types and classes should have CamelCase names with words not separated by underscores or hyphens. ------------ Indentation ----------- @@ -129,11 +128,10 @@ f90-type-indent, f90-associate-indent, and f90-program indent to 2. Continuation lines should be indented by an extra 5 spaces. This is the default value of f90-continuation-indent in Emacs. -------------------------- Whitespace in Expressions ------------------------- -Use a single space between arguments to procedures. +Use a single space between arguments to procedures. Avoid extraneous whitespace in the following situations: @@ -146,3 +144,23 @@ Avoid extraneous whitespace in the following situations: Yes: if (variable == 2) then No: if ( variable==2 ) then + +------ +Python +------ + +Style for Python code should follow PEP8_. + +Docstrings for functions and methods should follow nummpydoc_ style. + +Python code should work with both Python 2.7+ and Python 3.0+. + +Use of third-party Python packages should be limited to numpy_, scipy_, and +h5py_. Use of other third-party packages must be implemented as optional +dependencies rather than required dependencies. + +.. _PEP8: +.. _numpydoc: +.. _numpy: +.. _scipy: +.. _h5py: diff --git a/docs/source/devguide/voxel.rst b/docs/source/devguide/voxel.rst index 8ce0c6ee8..98f5cb73b 100644 --- a/docs/source/devguide/voxel.rst +++ b/docs/source/devguide/voxel.rst @@ -4,9 +4,7 @@ Voxel Plot Binary File Specifications ===================================== ----------- -Revision 1 ----------- +The current revision of the voxel plot binary file is 1. **integer(4) n_voxels_x** diff --git a/docs/source/devguide/workflow.rst b/docs/source/devguide/workflow.rst index e83a12979..5732bad07 100644 --- a/docs/source/devguide/workflow.rst +++ b/docs/source/devguide/workflow.rst @@ -7,7 +7,7 @@ Development Workflow Anyone wishing to make contributions to OpenMC should be fully acquianted and comfortable working with git_ and GitHub_. We assume here that you have git installed on your system, have a GitHub account, and have setup SSH keys to be -able to create/push to repositories on GitHub. +able to create/push to repositories on GitHub. Overview -------- @@ -71,7 +71,7 @@ features and bug fixes. The general steps for contributing are as follows: git checkout -b newbranch develop 3. Make your changes on the new branch that you intend to have included in - *develop*. If you have made other changes that should not be merged back, + *develop*. If you have made other changes that should not be merged back, ensure that those changes are made on a different branch. 4. Issue a pull request from GitHub and select the *develop* branch of @@ -98,7 +98,7 @@ OpenMC Test Suite The purpose of this test suite is to ensure that OpenMC compiles using various combinations of compiler flags and options, and that all user input options can -be used successfully without breaking the code. The test suite is comprised of +be used successfully without breaking the code. The test suite is comprised of regression tests where different types of input files are configured and the full OpenMC code is executed. Results from simulations are compared with expected results. The test suite is comprised of many build configurations @@ -114,7 +114,7 @@ download these cross sections please do the following: .. code-block:: sh cd ../data - python get_nndc.py + python get_nndc_data.py export CROSS_SECTIONS=/nndc/cross_sections.xml The test suite can be run on an already existing build using: @@ -151,7 +151,7 @@ variables should be set if the default paths are incorrect: * **PHDF5_DIR** - The path to the parallel HDF5 directory. - * Default - */opt/phdf5/1.8.12-gnu* + * Default - */opt/phdf5/1.8.12-gnu* * **PETSC_DIR** - The path to the PETSc directory. @@ -192,7 +192,7 @@ Adding tests to test suite To add a new test to the test suite, create a sub-directory in the tests directory that conforms to the regular expression *test_*. To configure -a test you need to add the following files to your new test directory, +a test you need to add the following files to your new test directory, *test_name* for example: * OpenMC input XML files diff --git a/docs/source/methods/cmfd.rst b/docs/source/methods/cmfd.rst index 3681df3b7..f9ebcfb55 100644 --- a/docs/source/methods/cmfd.rst +++ b/docs/source/methods/cmfd.rst @@ -28,7 +28,7 @@ directions. An example of this is shown in the following expression: :label: not1 \sum\limits_{u\in(x,y,z)}\left\langle\overline{J}^{u,g}_{l+1/2,m,n} - \Delta_m^v\Delta_n^w\right\rangle + \Delta_m^v\Delta_n^w\right\rangle Here, :math:`u` takes on each direction one at a time. The parameter :math:`J` is surface area-averaged over the transverse indices :math:`m` and :math:`n` @@ -142,7 +142,7 @@ defined from MC tallies as follows: {\left\langle\overline{\overline\phi}_{l,m,n}^h \Delta_l^u\Delta_m^v\Delta_n^w\right\rangle} -and +and .. math:: :label: xs3 @@ -306,7 +306,7 @@ interior cell, + \left(\tilde{D}_{l-1/2,m,n}^{u,g} + \tilde{D}_{l+1/2,m,n}^{u,g} - \hat{D}_{l-1/2,m,n}^{u,g} + \hat{D}_{l+1/2,m,n}^{u,g}\right)\overline{\overline{\phi}}_{l,m,n}^g - \\ + + \\ + \left. \left(-\tilde{D}_{l+1/2,m,n}^{u,g} + \hat{D}_{l+1/2,m,n}^{u,g}\right)\overline{\overline{\phi}}_{l+1,m,n}^g \right] + @@ -318,7 +318,7 @@ interior cell, It should be noted that before substitution, eq. :eq:`eq_neut_bal` was divided by the volume of the cell, :math:`\Delta_l^u\Delta_m^v\Delta_n^w`. Equation -:eq:`eq_cmfd_sys` can be represented in operator form as +:eq:`eq_cmfd_sys` can be represented in operator form as .. math:: :label: eq_CMFDopers @@ -349,7 +349,7 @@ and energy group. This is represented as p_{l,m,n}^g = \frac{\sum_{h=1}^{G}\overline{\overline{\nu_f\Sigma}}^{h\rightarrow g}_{f_{l,m,n}}\overline{\overline{\phi}}_{l,m,n}^h\Delta_l^u\Delta_m^v - \Delta_n^w}{\sum_n\sum_m\sum_l\sum_{h=1}^{G}\overline{ + \Delta_n^w}{\sum_n\sum_m\sum_l\sum_{h=1}^{G}\overline{ \overline{\nu_f\Sigma}}^{h\rightarrow g}_{f_{l,m,n}}\overline{\overline{\phi}}_{l,m,n}^h\Delta_l^u\Delta_m^v \Delta_n^w}. @@ -478,14 +478,14 @@ no fission neutrons appear with energies in the thermal group. .. figure:: ../_images/loss.png :scale: 50 - Sparsity of Neutron Loss Operator + Sparsity of Neutron Loss Operator .. _fig_prod: .. figure:: ../_images/prod.png :scale: 50 - Sparsity of Neutron Production Operator + Sparsity of Neutron Production Operator To solve the eigenvalue problem with these matrices, different source iteration and linear solvers can be used. The most common source iteration solver used is @@ -511,7 +511,7 @@ implemented to obtain eigenvalue and multigroup fluxes as described in [Gill]_ and [Knoll]_. This method is not the primary one used, but has gotten recent attention due to its coupling advantages to other physics such as thermal hydraulics. Once multigroup fluxes are obtained, a normalized fission source is -calculated in the code using eq. :eq:`eq_cmfd_psrc` directly. +calculated in the code using eq. :eq:`eq_cmfd_psrc` directly. The next step in the process is to compute weight adjustment factors. These are calculated by taking the ratio of the expected number of neutrons from the CMFD @@ -523,7 +523,7 @@ the current MC source, OpenMC sums the statistical weights of neutrons from the source bank on a given spatial and energy mesh. Once weight adjustment factors were calculated, each neutron's statistical weight in the source bank was modified according to its location and energy. -Examples of CMFD simulations using OpenMC can be found in [Herman_Thesis]_. +Examples of CMFD simulations using OpenMC can be found in [HermanThesis]_. ---------- References @@ -536,23 +536,23 @@ References .. [Gill] Daniel F. Gill. *Newton-Krylov methods for the solution of the k-eigenvalue problem in multigroup neutronics calculations*. Ph.D. thesis, Pennsylvania State University, 2010. -.. [Hebert] Alain Hebert. *Applied reactor physics*. Presses Internationales Polytechnique, +.. [Hebert] Alain Hebert. *Applied reactor physics*. Presses Internationales Polytechnique, Montreal, 2009. .. [Herman] Bryan R. Herman, Benoit Forget, Kord Smith, and Brian N. Aviles. Improved diffusion coefficients generated from Monte Carlo codes. In *Proceedings of M&C 2013*, Sun Valley, ID, USA, May 5 - 9, 2013. -.. [Herman_Thesis] Bryan R. Herman. *Monte Carlo and Thermal Hydraulic Coupling using - Low-Order Nonlinear Diffusion Acceleration*. Sc.D. thesis, - Massachusetts Institute of Technology, 2014. +.. [HermanThesis] Bryan R. Herman. *Monte Carlo and Thermal Hydraulic Coupling using + Low-Order Nonlinear Diffusion Acceleration*. Sc.D. thesis, + Massachusetts Institute of Technology, 2014. .. [Knoll] D.A. Knoll, H. Park, and C. Newman. *Acceleration of k-eigenvalue/criticality calculations using the Jacobian-free Newton-Krylov method*. Nuclear Science and Engineering, 167:133–140, 2011. .. [Park] H. Park, D.A. Knoll, and C.K. Newman. *Nonlinear acceleration of transport - criticality problems*. Nuclear Science and Engineering, 172:52–65, 2012. + criticality problems*. Nuclear Science and Engineering, 172:52–65, 2012. .. [Rhodes] Joel Rhodes and Malte Edenius. *CASMO-4 --- A Fuel Assembly Burnup Program. User’s Manual*. Studsvik of America, ssp-09/443-u rev 0, proprietary edition, 2001.