From 1e01c9b0d08fa8dac02e062e14ec97c1c395caf7 Mon Sep 17 00:00:00 2001 From: YoungHui Park Date: Fri, 8 Jan 2021 15:21:37 -0600 Subject: [PATCH] Move surface source file format description under source file format --- docs/source/io_formats/source.rst | 4 ++++ docs/source/io_formats/surface_source.rst | 21 --------------------- 2 files changed, 4 insertions(+), 21 deletions(-) delete mode 100644 docs/source/io_formats/surface_source.rst diff --git a/docs/source/io_formats/source.rst b/docs/source/io_formats/source.rst index f6889a3e15..86ae8a1e5e 100644 --- a/docs/source/io_formats/source.rst +++ b/docs/source/io_formats/source.rst @@ -8,6 +8,10 @@ Normally, source data is stored in a state point file. However, it is possible to request that the source be written separately, in which case the format used is that documented here. +When surface source writing is triggered, a source file named +``surface_source.h5`` is written with only the sources on specified surfaces, +following the same format. + **/** :Attributes: - **filetype** (*char[]*) -- String indicating the type of file. diff --git a/docs/source/io_formats/surface_source.rst b/docs/source/io_formats/surface_source.rst deleted file mode 100644 index 5cf25fc60b..0000000000 --- a/docs/source/io_formats/surface_source.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _io_surface_source: - -========================== -Surface Source File Format -========================== - -When surface source writing is triggered, a separate source file is written with -only the sources on specified surfaces. The format is identical to source file. - -**/** - -:Attributes: - **filetype** (*char[]*) -- String indicating the type of file. - -:Datasets: - - - **source_bank** (Compound type) -- Source bank information for each - particle. The compound type has fields ``r``, ``u``, ``E``, - ``wgt``, ``delayed_group``, ``surf_id`` and ``particle``, - which represent the position, direction, energy, weight, - delayed group, surface ID, and particle type (0=neutron, 1=photon, - 2=electron, 3=positron), respectively.