Merge pull request #819 from kordusas/feature/525-detect-empty-lines

Feature/525 detect empty lines

Author: MicahGale

doc/source/changelog.rst

@@ -11,14 +11,16 @@ MontePy Changelog
 
 **Features Added**
 
-* Allow multiple universe fills to accept 2D MNCP lattices (:issue:`719`)
+* Added checking for additional input after the ``data`` block, and raising a warning if it exists (:issue:`525`).
+* Allow multiple universe fills to accept 2D MNCP lattices (:issue:`719`).
 * Make `LatticeType.RECTANGULAR` and `LatticeType.HEXAHEDRAL` synonymous (:issue:`808`).
 * Allow setting ``cell.fill.universes`` with a numpy array of universe IDs (:issue:`736`).
 
 **Bugs Fixed**
 
 * Fixed bug where lines that were the allowed length was raising a ``LineOverRunWarning`` when read by MontePy (:issue:`517`). 
 * Added descriptive TypeError messages (:issue:`801`)
+* Fixed a bug that caused to write an extra termination line between the data block and the cell data section in the MCNP input. (:pull:`819`) (:issue:`703`).
 
 **Documentation**
 
@@ -37,7 +39,6 @@ MontePy Changelog
 
 1.1.3
 --------------
-
 **Features Added**
 
 * Added Boundary condition type to the representation of a ``montepy.Surface`` (e.g., ``repr(surf)``)  (:issue:`682`).
@@ -51,6 +52,7 @@ MontePy Changelog
 * Fixed bug where lines that were the allowed length was raising a ``LineOverRunWarning`` when read by MontePy (:issue:`517`). 
 * Added descriptive TypeError messages (:issue:`801`)
 
+
 1.1.2
 --------------
 

montepy/exceptions.py

@@ -10,6 +10,13 @@ def __init__(self, message):
         self.message = message
 
 
+class UndefinedBlock(UserWarning):
+    """Raised when additional blocks exist after the default data block."""
+
+    def __init__(self, message):
+        self.message = message
+
+
 class MalformedInputError(ValueError):
     """Raised when there is an error with the MCNP input not related to the parser."""
 

montepy/input_parser/input_syntax_reader.py

@@ -146,6 +146,7 @@ def read_data(fh, mcnp_version, block_type=None, recursion=False):
 
     def flush_block():
         nonlocal block_counter, block_type
+        # keep parsing while there is input or termination has not been triggered
         if len(input_raw_lines) > 0:
             yield from flush_input()
         block_counter += 1
@@ -154,6 +155,17 @@ def flush_block():
 
     def flush_input():
         nonlocal input_raw_lines
+        # IF 3  BLOCKS are parsed, the rest should be ignored with a warning and print 3 lines
+        if block_counter >= 3:
+            joined_lines = "\n".join(input_raw_lines[0:3])
+            msg = f"Unexpected input after line {current_file.lineno - 1}\n line content: {joined_lines}\n"
+            warnings.warn(
+                msg,
+                UndefinedBlock,
+                stacklevel=6,
+            )
+            return
+
         start_line = current_file.lineno + 1 - len(input_raw_lines)
         input = Input(
             input_raw_lines,
@@ -191,6 +203,7 @@ def flush_input():
             and input_raw_lines
         ):
             yield from flush_input()
+
         # die if it is a vertical syntax format
         start_o_line = line[0:BLANK_SPACE_CONTINUE]
         # eliminate comments, and inputs that use # for other syntax

montepy/mcnp_problem.py

@@ -612,14 +612,16 @@ def _write_to_stream(self, inp):
                             warning.handled = True
                     for line in lines:
                         inp.write(line + "\n")
-                if terminate:
+
+                # writing cell data in DATA BLOCK if the last written object inherits DataInputAbstract and there is cell data to write
+                if objects is self.data_inputs:
+                    for line in self.cells._run_children_format_for_mcnp(
+                        self.data_inputs, self.mcnp_version
+                    ):
+                        inp.write(line + "\n")
+                elif terminate:
                     inp.write("\n")
-            for line in self.cells._run_children_format_for_mcnp(
-                self.data_inputs, self.mcnp_version
-            ):
-                inp.write(line + "\n")
 
-            inp.write("\n")
         self._handle_warnings(warning_catch)
 
     def _handle_warnings(self, warning_queue):

tests/constants.py

@@ -15,6 +15,7 @@
     "test_extra_data_param.imcnp",
     "test_extra_data_imp.imcnp",
     "number_conflict_pin_cell.imcnp",
+    "test_pin_cell_extra_block_warning.imcnp",
 }
 IGNORE_FILES = {
     "testReadRec1.imcnp",

tests/inputs/test_pin_cell_extra_block_warning.imcnp

@@ -0,0 +1,36 @@
+Made up PWR pin Cell Problem
+c uranium rod 
+1    1  10.0   -1     101 -102 imp:n=1
+c gas gap
+2    0           1  -2 101 -102 imp:n=1
+c cladding
+3    10 5.0     2  -3 101 -102 imp:n=1
+c water cell
+5    2  1.0    2     101 -102
+                       103 -104
+                       105 -106 imp:n=1
+
+1 CZ 0.39
+2 CZ 0.40
+3 CZ 0.46
+101 PZ -0.63
+102 PZ  0.63
+103 PX -0.63
+104 PX  0.63
+105 PY -0.63
+106 PY  0.63
+
+M1    92235.80c 0.04 
+      92238.80c 0.96
+M2     1001.80c 0.66
+       8016.80c 0.33
+M10   40090.80c 0.515
+      40091.80c 0.112
+      40092.80c 0.171
+      40094.80c 0.174
+      40096.80c 0.028
+mode n
+nps 1e3 
+
+M101   92235.80c 0.04 
+       92238.80c 0.96

tests/test_syntax_parsing.py

@@ -13,6 +13,7 @@
 from montepy.input_parser.shortcuts import Shortcuts
 from montepy.input_parser import syntax_node
 from montepy.particle import Particle
+from montepy.exceptions import UndefinedBlock
 import warnings
 
 
@@ -1472,6 +1473,33 @@ def test_jump_and_a_hop(self):
         str(jump)
         repr(jump)
 
+    def test_extra_block_warning(self):
+        # Define constants for better readability and maintainability
+        INPUT_FILE = "tests/inputs/test_pin_cell_extra_block_warning.imcnp"
+        EXPECTED_LINE = 34
+        EXPECTED_CONTENT = "M101   92235.80c 0.04\n       92238.80c 0.96\n"
+        EXPECTED_WARNING_TYPE = UndefinedBlock
+
+        # Setup: Use the common pattern for defining the generator
+        generator = input_syntax_reader.read_input_syntax(MCNP_InputFile(INPUT_FILE))
+
+        # Check that the expected warning is raised
+        with pytest.warns(EXPECTED_WARNING_TYPE) as recs:
+            # Exhaust generator so parser runs and warnings are emitted
+            for _ in generator:
+                pass
+
+        # Assertions
+        assert len(recs) == 1, f"Expected exactly one warning, but got {len(recs)}"
+        warning = recs[0]
+        assert issubclass(
+            warning.category, EXPECTED_WARNING_TYPE
+        ), f"Expected warning type {EXPECTED_WARNING_TYPE}, but got {warning.category}"
+        assert (
+            str(warning.message)
+            == f"Unexpected input after line {EXPECTED_LINE}\n line content: {EXPECTED_CONTENT}"
+        ), f"Expected warning message 'Unexpected input after line {EXPECTED_LINE}\n line content: {EXPECTED_CONTENT}', but got '{str(warning.message)}'"
+
 
 class TestClassifierNode:
     def test_classifier_init(self):