crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-27 21:55:41 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Move surface source file format description under source file format

Browse source
This commit is contained in:
YoungHui Park 2021-01-08 15:21:37 -06:00
parent e427dbde50
commit 1e01c9b0d0
2 changed files with 4 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/io_formats/source.rst
View file

@ -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.

21
docs/source/io_formats/surface_source.rst
View file

@ -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.