Merge pull request #747 from idaholab/652-surfaces-cant-be-created-and-exported-from-scratch

Made making surfaces from scratch possible.

Author: tjlaboss

doc/source/changelog.rst

@@ -14,9 +14,13 @@ MontePy Changelog
 
 **Bugs Fixed**
 
+* Fixed bug where surfaces created from scratch couldn't be accurately written out to the file (:issue:`652`).
+* Fixed bug where surface transformations couldn't be unset and exported properly (:issue:`711`).
+* Fixed bug where negative numbers were treated as valid by ``append_renumber`` (:issue:`690`).
 * Fixed bug that couldn't parse ``SDEF`` by simply not parsing the input for the time being (:pull:`767`).
 * Fixed parsing bug with ``DE LOG`` style inputs by simply not parsing them for now (:pull:`767`).
 
+
 1.1.0
 --------------
 
@@ -31,6 +35,8 @@ MontePy Changelog
 * Fixed bug where MontePy would overly aggressively round outputs and remove the user's intent (:issue:`756`).
 * Fixed bug where a cell complement in the first five characters causes a spurious vertical mode detection (:issue:`753`).
 
+1.0 releases
+============
 
 1.0 releases
 ============

doc/source/developing.rst

@@ -347,7 +347,8 @@ How to __init__
 """""""""""""""
 After running the super init method
 you will then have access to ``self.surface_type``, and ``self.surface_constants``.
-You then need to verify that the surface type is correct, and there are the correct number of surface constants. 
+You will need to implement a ``_allowed_surface_types`` to specify which surface types are allowed for your class.
+You then need to verify that there are the correct number of surface constants. 
 You will also need to add a branch in the logic for :func:`montepy.surfaces.surface_builder.surface_builder`.
 
 :func:`~montepy.surfaces.surface.Surface.find_duplicate_surfaces`

montepy/input_parser/syntax_node.py

@@ -1049,7 +1049,7 @@ def _convert_to_enum(
             convert to enum.
         """
         self._type = enum_class
-        if switch_to_upper:
+        if switch_to_upper and self._value is not None:
             value = self._value.upper()
         else:
             value = self._value

montepy/numbered_mcnp_object.py

@@ -55,7 +55,8 @@ def __init__(
         parser: montepy.input_parser.parser_base.MCNP_Parser,
         number: int = None,
     ):
-        self._number = self._generate_default_node(int, -1)
+        if not input:
+            self._number = self._generate_default_node(int, -1)
         super().__init__(input, parser)
         self._load_init_num(number)
 

montepy/numbered_object_collection.py

@@ -243,8 +243,11 @@ def check_number(self, number):
         """
         if not isinstance(number, Integral):
             raise TypeError("The number must be an int")
+
+        if number < 0:
+            raise ValueError(f"The number must be non-negative. {number} given.")
         conflict = False
-        # only can trust cache if being
+        # only can trust cache if being updated
         if self._problem:
             if number in self.__num_cache:
                 conflict = True
@@ -476,6 +479,8 @@ def __internal_append(self, obj, **kwargs):
             raise TypeError(
                 f"Object must be of type: {self._obj_class.__name__}. {obj} given."
             )
+        if obj.number < 0:
+            raise ValueError(f"The number must be non-negative. {obj.number} given.")
         if obj.number in self.__num_cache:
             try:
                 if obj is self[obj.number]:
@@ -603,12 +608,12 @@ def append_renumber(self, obj, step=1):
             raise TypeError(f"object being appended must be of type: {self._obj_class}")
         if not isinstance(step, Integral):
             raise TypeError("The step number must be an int")
-        number = obj.number
+        number = obj.number if obj.number > 0 else 1
         if self._problem:
             obj.link_to_problem(self._problem)
         try:
             self.append(obj)
-        except NumberConflictError:
+        except (NumberConflictError, ValueError) as e:
             number = self.request_number(number, step)
             obj.number = number
             self.append(obj)

montepy/surfaces/axis_plane.py

@@ -5,6 +5,8 @@
 from montepy.errors import *
 from montepy.utilities import *
 
+from typing import Union
+
 
 class AxisPlane(Surface):
     """Represents PX, PY, PZ
@@ -19,22 +21,23 @@ class AxisPlane(Surface):
         The Input object representing the input
     number : int
         The number to set for this object.
+    surface_type: Union[SurfaceType, str]
+        The surface_type to set for this object
     """
 
     COORDINATE = {SurfaceType.PX: "x", SurfaceType.PY: "y", SurfaceType.PZ: "z"}
 
-    def __init__(self, input: InitInput = None, number: int = None):
+    def __init__(
+        self,
+        input: InitInput = None,
+        number: int = None,
+        surface_type: Union[SurfaceType, str] = None,
+    ):
         self._location = self._generate_default_node(float, None)
-        super().__init__(input, number)
-        ST = SurfaceType
-        if input:
-            if self.surface_type not in [ST.PX, ST.PY, ST.PZ]:
-                raise ValueError("AxisPlane must be a surface of type: PX, PY, or PZ")
-            if len(self.surface_constants) != 1:
-                raise ValueError("AxisPlane must have exactly 1 surface constant")
-            self._location = self._surface_constants[0]
-        else:
-            self._surface_constants = [self._location]
+        super().__init__(input, number, surface_type)
+        if len(self.surface_constants) != 1:
+            raise ValueError("AxisPlane must have exactly 1 surface constant")
+        self._location = self._surface_constants[0]
 
     @make_prop_val_node("_location", (float, int), float)
     def location(self):
@@ -46,6 +49,10 @@ def location(self):
         """
         pass
 
+    @staticmethod
+    def _allowed_surface_types():
+        return {SurfaceType.PX, SurfaceType.PY, SurfaceType.PZ}
+
     def validate(self):
         super().validate()
         if self.location is None:

montepy/surfaces/cylinder_on_axis.py

@@ -4,6 +4,8 @@
 from montepy.errors import *
 from montepy.utilities import *
 
+from typing import Union
+
 
 def _enforce_positive_radius(self, value):
     if value < 0.0:
@@ -23,20 +25,21 @@ class CylinderOnAxis(Surface):
         The Input object representing the input
     number : int
         The number to set for this object.
+    surface_type: Union[SurfaceType, str]
+        The surface_type to set for this object
     """
 
-    def __init__(self, input: InitInput = None, number: int = None):
+    def __init__(
+        self,
+        input: InitInput = None,
+        number: int = None,
+        surface_type: Union[SurfaceType, str] = None,
+    ):
         self._radius = self._generate_default_node(float, None)
-        super().__init__(input, number)
-        ST = SurfaceType
-        if input:
-            if self.surface_type not in [ST.CX, ST.CY, ST.CZ]:
-                raise ValueError("CylinderOnAxis must be of surface_type: CX, CY, CZ")
-            if len(self.surface_constants) != 1:
-                raise ValueError("CylinderOnAxis only accepts one surface_constant")
-            self._radius = self._surface_constants[0]
-        else:
-            self._surface_constants = [self._radius]
+        super().__init__(input, number, surface_type)
+        if len(self.surface_constants) != 1:
+            raise ValueError("CylinderOnAxis only accepts one surface_constant")
+        self._radius = self._surface_constants[0]
 
     @make_prop_val_node(
         "_radius", (float, int), float, validator=_enforce_positive_radius
@@ -50,6 +53,10 @@ def radius(self):
         """
         pass
 
+    @staticmethod
+    def _allowed_surface_types():
+        return {SurfaceType.CX, SurfaceType.CY, SurfaceType.CZ}
+
     def validate(self):
         super().validate()
         if self.radius is None:

montepy/surfaces/cylinder_par_axis.py

@@ -5,6 +5,7 @@
 from montepy.utilities import *
 
 from numbers import Real
+from typing import Union
 
 
 def _enforce_positive_radius(self, value):
@@ -25,6 +26,8 @@ class CylinderParAxis(Surface):
         The Input object representing the input
     number : int
         The number to set for this object.
+    surface_type: Union[SurfaceType, str]
+        The surface_type to set for this object
     """
 
     COORDINATE_PAIRS = {
@@ -34,27 +37,30 @@ class CylinderParAxis(Surface):
     }
     """Which coordinate is what value for each cylinder type."""
 
-    def __init__(self, input: InitInput = None, number: int = None):
+    def __init__(
+        self,
+        input: InitInput = None,
+        number: int = None,
+        surface_type: Union[SurfaceType, str] = None,
+    ):
         self._coordinates = [
             self._generate_default_node(float, None),
             self._generate_default_node(float, None),
         ]
         self._radius = self._generate_default_node(float, None)
-        super().__init__(input, number)
-        ST = SurfaceType
-        if input:
-            if self.surface_type not in [ST.C_X, ST.C_Y, ST.C_Z]:
-                raise ValueError(
-                    "CylinderParAxis must be a surface of types: C/X, C/Y, C/Z"
-                )
-            if len(self.surface_constants) != 3:
-                raise ValueError(
-                    "CylinderParAxis must have exactly 3 surface_constants"
-                )
-            self._coordinates = self._surface_constants[0:2]
-            self._radius = self._surface_constants[2]
-        else:
-            self._surface_constants = [*self._coordinates, self._radius]
+        super().__init__(input, number, surface_type)
+        if len(self.surface_constants) != 3:
+            raise ValueError("CylinderParAxis must have exactly 3 surface_constants")
+        self._coordinates = self._surface_constants[0:2]
+        self._radius = self._surface_constants[2]
+
+    @staticmethod
+    def _number_of_params():
+        return 3
+
+    @staticmethod
+    def _allowed_surface_types():
+        return {SurfaceType.C_X, SurfaceType.C_Y, SurfaceType.C_Z}
 
     @property
     def coordinates(self):