Skip to content

Commit

Permalink
Final cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
john-science committed Mar 7, 2022
1 parent 93770ab commit 601066b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 2 additions & 0 deletions doc/requirements/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Requirements
############

.. note:: Work In Progress: The ARMI Requirements are thus-far incomplete.

This section gives a general overview of the requirements of ARMI. These requirements
are meant to satisfy NRC regulations and also give a firm basis for the high-level
goals of ARMI.
Expand Down
12 changes: 5 additions & 7 deletions doc/requirements/srsd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Software Requirement Specification Document (SRSD)
**************************************************

Work In Progress: The ARMI Requirements are thus-far incomplete.

-----------------------
Functional Requirements
-----------------------
Expand Down Expand Up @@ -52,35 +50,35 @@ Functional Requirements
and Cartesian structures.

.. req:: ARMI shall support the specification of symmetry options and boundary conditions.
:id: REQ_REACTOR_BOUNDARIES
:id: REQ_REACTOR_4
:status: implemented, need impl/test

ARMI shall support symmetric models including 1/4, 1/8 core models for Cartesian meshes
and 1/3 and full core for Hex meshes. For Cartesian 1/8 core symmetry, the core axial
symmetry plane (midplane) will be located at the top of the reactor.

.. req:: ARMI shall check for basic correctness.
:id: REQ_REACTOR_CORRECTNESS
:id: REQ_REACTOR_5
:status: implemented, need impl/test

ARMI shall check its input for certain obvious errors including unphysical densities
and proper fit.

.. req:: ARMI shall allow for the definition of limited one-dimensional translation paths.
:id: REQ_REACTOR_TRANSLATION
:id: REQ_REACTOR_6
:status: implemented, need impl/test

ARMI shall allow the user specification of translation pathways for certain objects to
follow, to support moving control mechanisms.

.. req:: ARMI shall allow the definition of fuel management operations (i.e. shuffling)
:id: REQ_REACTOR_SHUFFLING
:id: REQ_REACTOR_7
:status: implemented, need impl/test

ARMI shall allow for the modeling of a reactor over multiple cycles.

.. req:: ARMI shall represent and reflect the evolving state of a reactor.
:id: REQ_EVOLVING_STATE
:id: REQ_1
:status: implemented, needs test

The state shale be made available to users and modules, which may in turn modify the
Expand Down

0 comments on commit 601066b

Please sign in to comment.