Merge pull request #177 from yardasol/openmc-depletion-settings

Add OpenMC depletion settings to input file

doc/fileformatspec/index.rst

@@ -1,11 +1,28 @@
 .. _fileformatspec:
 
-==========================
 File Format Specifications
 ==========================
 
+.. _fileformatspect_input_files:
+
+Input Files
+-----------
+
+.. toctree::
+  :maxdepth: 1
+
+  saltproc_input
+  depcode_input
+  simulation_input
+  reactor_input
+
+
+.. _fileformatspec_output_files:
+
+Output Files
+------------
+
 .. toctree::
   :maxdepth: 1
 
-  inputfile
   databasefile

doc/fileformatspec/reactor_input.rst

@@ -0,0 +1,118 @@
+.. _reactor_input:
+
+``reactor`` Properties
+=========================
+
+Required properties: ``volume``, ``mass_flowrate``, ``power_levels``,
+``depletion_timesteps``, ``timestep_units``
+
+.. _volume_property:
+
+``volume``
+----------
+  :description:
+    reactor core volume [cm^3]
+
+  :type:
+    ``number``
+
+  :minimum:
+    0
+
+
+.. _mass_flowrate_property:
+
+``mass_flowrate``
+-----------------
+
+  :description:
+    Salt mass flowrate through reactor core [g/s]
+
+  :type:
+    ``number``
+
+  :minimum:
+    0
+
+
+.. _power_levels_property:
+
+``power_levels``
+----------------
+
+  :description:
+    Reactor power or power step list durng depletion step [W]
+
+  :type:
+    ``array``
+
+  :items:
+
+    :type:
+      ``number``
+
+    :minimum:
+      0
+
+  :minItems:
+    1
+
+  :uniqueItems:
+    ``false``
+
+
+.. _depletion_timesteps_property:
+
+``depletion_timesteps``
+-----------------------
+
+  :description:
+    Depletion timestep size or list of timestep sizes
+
+  :type:
+    ``array``
+
+  :items:
+
+    :type:
+      ``number``
+
+    :minimum:
+      0
+
+  :minItems:
+    1
+
+  :uniqueItems:
+    ``false``
+
+.. _timestep_type_property:
+
+``timestep_type``
+-----------------
+
+  :description:
+    Depletion step type
+
+  :type:
+    ``string``
+
+  :enum:
+    ``cumulative``, ``stepwise``
+
+  :default:
+    ``stepwise``
+
+.. _timestep_unites_property:
+
+``timestep_units``
+------------------
+
+  :description:
+    Timestep unit
+
+  :type:
+    ``string``
+
+  :enum:
+    ``s``, ``sec``, ``min``, ``minute``, ``h``, ``hr``, ``hour``, ``d``, ``day``, ``a``, ``year``,  ``yr``, ``MWd/kg``, ``mwd/kg``, ``MWD/KG``, ``MWD/kg``, ``MWd/KG``

doc/fileformatspec/saltproc_input.rst

@@ -0,0 +1,121 @@
+.. _saltproc_input:
+
+SaltProc Input File
+===================
+
+The main SaltProc input file is a JSON file validated against a JSON schema.
+In this section, we will describe the structure of this schema. The top level
+datatype of the schema is a JSON ``object``.
+
+Required properties are as follows: ``proc_input_file``, ``dot_input_file``, ``output_path``, ``depcode``, ``simulation``, ``reactor``.
+
+.. _proc_input_file_property:
+
+``proc_input_file``
+-------------------
+
+  :description:
+    File containing processing system objects
+
+  :type: 
+    ``string``
+
+  :pattern:
+    ``^(.*)\\.json$``
+
+
+.. _dot_input_file_property:
+
+``dot_input_file``
+------------------
+
+  :description: 
+    Graph file containing processing system structure
+
+  :type:
+    ``string``
+
+  :pattern:
+    ``^(.*)\\.dot$``
+
+
+.. _output_path_property:
+
+``output_path``
+---------------
+
+  :description:
+    Path output data storing folder
+
+  :type:
+    ``string``
+
+  :pattern:
+    ``^(.\\/)*(.*)$``
+
+  :default:
+    ``saltproc_runtime``
+
+
+.. _n_depletion_steps_property:
+
+``n_depletion_steps``
+---------------------
+
+  :description:
+    Number of steps for constant power and depletion interval case
+
+  :type:
+    ``number``
+
+
+.. _depcode_property:
+
+``depcode``
+-----------
+
+  :description:
+    Depcode class input parameters
+
+  :type:
+    ``object``
+
+  :default:
+    ``{}``
+
+  :properties:
+    :ref:`depcode_input`
+
+.. _simulation_property:
+
+``simulation``
+--------------
+
+  :description:
+    Simulation class input parameters
+
+  :type:
+    ``object``
+
+  :default:
+    ``{}``
+
+  :properties:
+    :ref:`simulation_input`
+
+.. _reactor_property:
+
+``reactor``
+-----------
+
+  :description:
+    Reactor class input parameters
+
+  :type:
+    ``object``. See :ref:`reactor_input` for object properties.
+
+  :default:
+    ``{}``
+
+  :properties:
+    :ref:`reactor_input`

doc/fileformatspec/simulation_input.rst

@@ -0,0 +1,65 @@
+.. _simulation_input:
+
+``simulation`` Properties
+=========================
+
+Required properties: ``sim_name``, ``db_name``
+
+.. _sim_name_property:
+
+``sim_name``
+------------
+
+  :description:
+    Name of simulation
+
+  :type:
+    ``string``
+
+
+.. _db_name_property:
+
+``db_name``
+-----------
+
+  :description:
+    Output HDF5 database file name
+
+  :type:
+    ``string``
+
+  :default:
+    ``saltproc_results.h5``
+
+  :pattern:
+    ``^(.*)\\.h5$``
+
+
+.. _restart_flag_property:
+
+``restart_flag``
+----------------
+
+  :description:
+    Restart simulation from the step when it stopped?
+
+  :type:
+    ``boolean``
+
+  :default:
+    ``false``
+
+
+.. _adjust_geo_property:
+
+``adjust_geo``
+--------------
+
+  :description:
+    switch to another geometry when keff drops below 1?
+
+  :type:
+    ``boolean``
+
+  :default:
+    ``false``