Adding interactCoupled to dev docs (#1581)

terrapower · Jan 15, 2024 · bceafc9 · bceafc9
1 parent a9feedf
commit bceafc9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 17 deletions.
diff --git a/README.rst b/README.rst
@@ -405,7 +405,7 @@ The ARMI system is licensed as follows:
 
 .. code-block:: none
 
-	Copyright 2009-2023 TerraPower, LLC
+	Copyright 2009-2024 TerraPower, LLC
 
 	Licensed under the Apache License, Version 2.0 (the "License");
 	you may not use this file except in compliance with the License.

diff --git a/armi/__init__.py b/armi/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2009-2019 TerraPower, LLC
+# Copyright 2019 TerraPower, LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/armi/bookkeeping/db/tests/__init__.py b/armi/bookkeeping/db/tests/__init__.py
@@ -13,16 +13,3 @@
 # limitations under the License.
 
 """Database tests."""
-# Copyright 2009-2019 TerraPower, LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
diff --git a/doc/developer/guide.rst b/doc/developer/guide.rst
@@ -221,8 +221,8 @@ hooks include:
 * :py:meth:`interactBOC <armi.interfaces.Interface.interactBOC>` -- Beginning of cycle.
   Happens once per cycle.
 
-* :py:meth:`interactEveryNode <armi.interfaces.Interface.interactEveryNode>` -- happens
-  after every node step/flux calculation
+* :py:meth:`interactEveryNode <armi.interfaces.Interface.interactEveryNode>` -- Happens
+  after every node step/flux calculation.
 
 * :py:meth:`interactEOC <armi.interfaces.Interface.interactEOC>` -- End of cycle.
 
@@ -231,6 +231,9 @@ hooks include:
 * :py:meth:`interactError <armi.interfaces.Interface.interactError>` -- When an error
   occurs, this can run to clean up or print debugging info.
 
+* :py:meth:`interactCoupled <armi.interfaces.Interface.interactCoupled>` -- Happens
+  after every node step/flux calculation, if tight physics coupling is active.
+
 These interaction points are optional in every interface, and you may override one or
 more of them to suit your needs.  You should not change the arguments to the hooks,
 which are integers.