pycfast 0.2.0__tar.gz → 0.2.1__tar.gz

{pycfast-0.2.0/src/pycfast.egg-info → pycfast-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycfast
-Version: 0.2.0
+Version: 0.2.1
 Summary: Python interface for building, running, and analyzing CFAST fire simulation models
 Author-email: WYGAS Benoît <97663334+bewygs@users.noreply.github.com>
 Maintainer-email: WYGAS Benoît <97663334+bewygs@users.noreply.github.com>
@@ -221,7 +221,7 @@ Check out the [examples](https://pycfast.org/examples.html) for more usage scena
 
 ## Installation
 
-PyCFAST requires **Python 3.10 or later**. It is fully [tested on verification input files](https://github.com/bewygs/pycfast/tree/main/tests/verification_tests) from CFAST version **7.7.0** to version **7.7.5**.
+PyCFAST requires **Python 3.10 or later**. It is fully [tested on verification input files](https://github.com/bewygs/pycfast/tree/main/tests/verification_tests) and [validation input files](https://github.com/bewygs/pycfast/tree/main/tests/validation_tests) from CFAST version **7.7.0** to version **7.7.6**. Versions below **7.7.0** might work but are not guaranteed to be fully compatible.
 
 ### Pip or Conda
 

{pycfast-0.2.0 → pycfast-0.2.1}/README.md

@@ -132,7 +132,7 @@ Check out the [examples](https://pycfast.org/examples.html) for more usage scena
 
 ## Installation
 
-PyCFAST requires **Python 3.10 or later**. It is fully [tested on verification input files](https://github.com/bewygs/pycfast/tree/main/tests/verification_tests) from CFAST version **7.7.0** to version **7.7.5**.
+PyCFAST requires **Python 3.10 or later**. It is fully [tested on verification input files](https://github.com/bewygs/pycfast/tree/main/tests/verification_tests) and [validation input files](https://github.com/bewygs/pycfast/tree/main/tests/validation_tests) from CFAST version **7.7.0** to version **7.7.6**. Versions below **7.7.0** might work but are not guaranteed to be fully compatible.
 
 ### Pip or Conda
 

{pycfast-0.2.0 → pycfast-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pycfast"
-version = "0.2.0"
+version = "0.2.1"
 description = "Python interface for building, running, and analyzing CFAST fire simulation models"
 readme = "README.md"
 requires-python = ">=3.10"

{pycfast-0.2.0 → pycfast-0.2.1}/src/pycfast/__init__.py

@@ -45,6 +45,7 @@ __version__ = version("pycfast")
 __author__ = "WYGAS Benoît"
 
 CFAST_VERSION = [
+    "7.7.6",
     "7.7.5",
     "7.7.4",
     "7.7.3",

{pycfast-0.2.0 → pycfast-0.2.1}/src/pycfast/compartment.py

@@ -12,6 +12,12 @@ from ._base_component import CFASTComponent
 from .utils.namelist import NamelistRecord
 
 
+def _as_list(val: str | float | list | None) -> list:
+    if val is None:
+        return []
+    return val if isinstance(val, list) else [val]
+
+
 class Compartment(CFASTComponent):
     """
     Defines the size, position, materials of construction, and flow characteristics for compartments.
@@ -55,27 +61,30 @@ class Compartment(CFASTComponent):
         point must be the same for all elevations in the input data. All absolute positions
         for all compartments must be greater than or equal to zero, i.e., negative numbers are
         not allowed for these inputs. Default units: m, default value: 0.0 m.
-    ceiling_mat_id : str, optional
-        Material ID from the thermal properties from the Materials tab to define the ceiling
+    ceiling_mat_id : str or list[str], optional
+        Material ID(s) from the thermal properties from the Materials tab to define the ceiling
         surface of the compartment. Up to three materials can be used to define the layer(s)
         of the ceiling surface. The innermost layer is specified first. Default value: Off.
-    ceiling_thickness : float, optional
-        Thickness of each of the layers of the ceiling surface. Default units: m, default
-        value: thickness of material specified on the Materials tab.
-    wall_mat_id : str, optional
-        Material ID from the thermal properties from the Materials tab to define the wall
+    ceiling_thickness : float or list[float], optional
+        Thickness of each of the layers of the ceiling surface. Must match the number of
+        materials in ``ceiling_mat_id``. Default units: m, default value: thickness of
+        material specified on the Materials tab.
+    wall_mat_id : str or list[str], optional
+        Material ID(s) from the thermal properties from the Materials tab to define the wall
         surface of the compartment. Up to three materials can be used to define the layer(s)
         of the wall surface. The innermost layer is specified first. Default value: Off.
-    wall_thickness : float, optional
-        Thickness of each of the layers of the wall surface. Default units: m, default
-        value: thickness of material specified on the Materials tab.
-    floor_mat_id : str, optional
-        Material ID from the thermal properties from the Materials tab to define the floor
+    wall_thickness : float or list[float], optional
+        Thickness of each of the layers of the wall surface. Must match the number of
+        materials in ``wall_mat_id``. Default units: m, default value: thickness of
+        material specified on the Materials tab.
+    floor_mat_id : str or list[str], optional
+        Material ID(s) from the thermal properties from the Materials tab to define the floor
         surface of the compartment. Up to three materials can be used to define the layer(s)
         of the floor surface. The innermost layer is specified first. Default value: Off.
-    floor_thickness : float, optional
-        Thickness of each of the layers of the floor surface. Default units: m, default
-        value: thickness of material specified on the Materials tab.
+    floor_thickness : float or list[float], optional
+        Thickness of each of the layers of the floor surface. Must match the number of
+        materials in ``floor_mat_id``. Default units: m, default value: thickness of
+        material specified on the Materials tab.
     shaft : bool, optional
         For tall compartments or those removed from the room of fire origin, the compartment
         may be modeled as a single, well-mixed zone rather than the default two-zone assumption.
@@ -135,12 +144,12 @@ class Compartment(CFASTComponent):
         width: float | None = 3.6,
         depth: float | None = 2.4,
         height: float | None = 2.4,
-        ceiling_mat_id: str | None = None,
-        ceiling_thickness: float | None = None,
-        wall_mat_id: str | None = None,
-        wall_thickness: float | None = None,
-        floor_mat_id: str | None = None,
-        floor_thickness: float | None = None,
+        ceiling_mat_id: str | list[str] | None = None,
+        ceiling_thickness: float | list[float] | None = None,
+        wall_mat_id: str | list[str] | None = None,
+        wall_thickness: float | list[float] | None = None,
+        floor_mat_id: str | list[str] | None = None,
+        floor_thickness: float | list[float] | None = None,
         origin_x: float | None = 0,
         origin_y: float | None = 0,
         origin_z: float | None = 0,
@@ -195,6 +204,28 @@ class Compartment(CFASTComponent):
                     f"Compartment '{self.id}': {param} must be a list, got {type(list_val).__name__}."
                 )
 
+        for surface in ("ceiling", "wall", "floor"):
+            mat_id = getattr(self, f"{surface}_mat_id")
+            thickness = getattr(self, f"{surface}_thickness")
+            n_mats = (
+                len(mat_id)
+                if isinstance(mat_id, list)
+                else (1 if mat_id is not None else 0)
+            )
+            if n_mats > 3:
+                raise ValueError(
+                    f"Compartment '{self.id}': {surface}_mat_id accepts at most "
+                    f"3 materials, got {n_mats}."
+                )
+            if mat_id is not None and thickness is not None:
+                n_thick = len(thickness) if isinstance(thickness, list) else 1
+                if n_mats != n_thick:
+                    raise ValueError(
+                        f"Compartment '{self.id}': {surface}_mat_id has {n_mats} "
+                        f"material(s) but {surface}_thickness has {n_thick} value(s). "
+                        "They must have the same length."
+                    )
+
         if self.leak_area_ratio is not None and len(self.leak_area_ratio) != 2:
             raise ValueError(
                 f"Compartment '{self.id}': leak_area_ratio must contain exactly 2 values "
@@ -241,8 +272,8 @@ class Compartment(CFASTComponent):
             f"Compartment("
             f"id='{self.id}', "
             f"width={self.width}, depth={self.depth}, height={self.height}, "
-            f"ceiling_mat_id='{self.ceiling_mat_id}', wall_mat_id='{self.wall_mat_id}', "
-            f"floor_mat_id='{self.floor_mat_id}', "
+            f"ceiling_mat_id={self.ceiling_mat_id!r}, wall_mat_id={self.wall_mat_id!r}, "
+            f"floor_mat_id={self.floor_mat_id!r}, "
             f"origin=({self.origin_x}, {self.origin_y}, {self.origin_z})"
             ")"
         )
@@ -259,11 +290,20 @@ class Compartment(CFASTComponent):
 
         materials = []
         if self.ceiling_mat_id:
-            materials.append(f"ceiling: {self.ceiling_mat_id}")
+            val = self.ceiling_mat_id
+            materials.append(
+                f"ceiling: {', '.join(val) if isinstance(val, list) else val}"
+            )
         if self.wall_mat_id:
-            materials.append(f"wall: {self.wall_mat_id}")
+            val = self.wall_mat_id
+            materials.append(
+                f"wall: {', '.join(val) if isinstance(val, list) else val}"
+            )
         if self.floor_mat_id:
-            materials.append(f"floor: {self.floor_mat_id}")
+            val = self.floor_mat_id
+            materials.append(
+                f"floor: {', '.join(val) if isinstance(val, list) else val}"
+            )
 
         material_str = f" ({', '.join(materials)})" if materials else ""
 
@@ -315,16 +355,21 @@ class Compartment(CFASTComponent):
             rec.add_field("HALL", True)
 
         if self.ceiling_mat_id is not None:
-            rec.add_field("CEILING_MATL_ID", self.ceiling_mat_id)
-            rec.add_field("CEILING_THICKNESS", self.ceiling_thickness)
+            rec.add_list_field("CEILING_MATL_ID", _as_list(self.ceiling_mat_id))
+            if self.ceiling_thickness is not None:
+                rec.add_list_field(
+                    "CEILING_THICKNESS", _as_list(self.ceiling_thickness)
+                )
 
         if self.wall_mat_id is not None:
-            rec.add_field("WALL_MATL_ID", self.wall_mat_id)
-            rec.add_field("WALL_THICKNESS", self.wall_thickness)
+            rec.add_list_field("WALL_MATL_ID", _as_list(self.wall_mat_id))
+            if self.wall_thickness is not None:
+                rec.add_list_field("WALL_THICKNESS", _as_list(self.wall_thickness))
 
         if self.floor_mat_id is not None:
-            rec.add_field("FLOOR_MATL_ID", self.floor_mat_id)
-            rec.add_field("FLOOR_THICKNESS", self.floor_thickness)
+            rec.add_list_field("FLOOR_MATL_ID", _as_list(self.floor_mat_id))
+            if self.floor_thickness is not None:
+                rec.add_list_field("FLOOR_THICKNESS", _as_list(self.floor_thickness))
 
         rec.add_list_field("CROSS_SECT_AREAS", self.cross_sect_areas)
         rec.add_list_field("CROSS_SECT_HEIGHTS", self.cross_sect_heights)

{pycfast-0.2.0 → pycfast-0.2.1}/src/pycfast/datasets/_sp_ast_diesel.py

@@ -25,11 +25,9 @@ SP_AST_Diesel_1p1 Dataset
 =========================
 
 This dataset contains 5000 pre-computed CFAST simulation results
-based on the ``SP_AST_Diesel_1p1.in`` validation model. Each sample
+based on the `SP_AST_Diesel_1p1.in <https://github.com/firemodels/cfast/blob/master/Validation/SP_AST/SP_AST_Diesel_1p1.in>`_ validation model. Each sample
 maps fire parameters to the maximum target surface temperature (TRGSURT).
 
-**Base model**: SP_AST_Diesel_1p1.in
-
 **Input features** (4):
   - ``heat_of_combustion`` (kJ/kg): Heat of combustion [5.0, 50.0]
   - ``radiative_fraction`` : Radiative fraction [0.1, 0.5]
@@ -59,7 +57,7 @@ def load_sp_ast_diesel_1p1(
     """Load the SP_AST_Diesel_1p1 pre-computed dataset.
 
     Returns 5000 CFAST simulation results based on the
-    ``SP_AST_Diesel_1p1.in`` validation model, mapping fire parameters
+    `SP_AST_Diesel_1p1.in <https://github.com/firemodels/cfast/blob/master/Validation/SP_AST/SP_AST_Diesel_1p1.in>`_ validation model, mapping fire parameters
     (heat of combustion, radiative fraction, soot yield, target height)
     to maximum target surface temperature (TRGSURT).
 

{pycfast-0.2.0 → pycfast-0.2.1}/src/pycfast/device.py

@@ -103,6 +103,7 @@ class Device(CFASTComponent):
         If location does not contain exactly 3 numeric values.
         If target type is specified but required target parameters are missing.
         If detector type is specified but required detector parameters are missing.
+        If spray_density is negative.
         If both normal and surface_orientation are specified or both are None.
         If normal vector does not contain exactly 3 numeric values.
         If unknown device type is specified.
@@ -382,9 +383,9 @@ class Device(CFASTComponent):
                     raise ValueError(
                         f"SPRINKLER '{self.id}': setpoint must be positive, got {self.setpoint}."
                     )
-                if self.spray_density <= 0:
+                if self.spray_density < 0:
                     raise ValueError(
-                        f"SPRINKLER '{self.id}': spray_density must be positive, got {self.spray_density}."
+                        f"SPRINKLER '{self.id}': spray_density must be >= 0, got {self.spray_density}."
                     )
             elif self.type == "SMOKE_DETECTOR":
                 if not 0.0 <= self.obscuration <= 100.0:

{pycfast-0.2.0 → pycfast-0.2.1}/src/pycfast/model.py

@@ -881,7 +881,6 @@ class CFASTModel:
         """
         if file_name is not None:
             original_file_name = self.file_name
-            original_written_content = self._written_content
             self.file_name = file_name
 
         try:
@@ -890,7 +889,6 @@ class CFASTModel:
         finally:
             if file_name is not None:
                 self.file_name = original_file_name
-                self._written_content = original_written_content
 
     def summary(self) -> str:
         """
@@ -1241,10 +1239,16 @@ class CFASTModel:
         for comp in self.compartments:
             for attr in ("ceiling_mat_id", "wall_mat_id", "floor_mat_id"):
                 m_id = getattr(comp, attr, None)
-                if m_id is not None and m_id != "OFF" and m_id not in material_ids:
-                    raise ValueError(
-                        f"Compartment '{comp.id}': {attr}='{m_id}' does not match any defined material."
-                    )
+                ids_to_check = (
+                    m_id
+                    if isinstance(m_id, list)
+                    else ([m_id] if m_id is not None else [])
+                )
+                for mid in ids_to_check:
+                    if mid != "OFF" and mid not in material_ids:
+                        raise ValueError(
+                            f"Compartment '{comp.id}': {attr}='{mid}' does not match any defined material."
+                        )
 
         # device_id referenced in Fire or Vent must exist in devices
         for fire in self.fires:

{pycfast-0.2.0 → pycfast-0.2.1}/src/pycfast/parsers/cfast_parser.py

@@ -520,11 +520,11 @@ class CFASTParser:
             "depth": {"source": "DEPTH", "required": True, "type": float},
             "height": {"source": "HEIGHT", "required": True, "type": float},
             "ceiling_mat_id": {"source": "CEILING_MATL_ID", "default": "OFF"},
-            "ceiling_thickness": {"source": "CEILING_THICKNESS", "type": float},
+            "ceiling_thickness": {"source": "CEILING_THICKNESS"},
             "wall_mat_id": {"source": "WALL_MATL_ID", "default": "OFF"},
-            "wall_thickness": {"source": "WALL_THICKNESS", "type": float},
+            "wall_thickness": {"source": "WALL_THICKNESS"},
             "floor_mat_id": {"source": "FLOOR_MATL_ID", "default": "OFF"},
-            "floor_thickness": {"source": "FLOOR_THICKNESS", "type": float},
+            "floor_thickness": {"source": "FLOOR_THICKNESS"},
             "shaft": {"source": "SHAFT", "type": bool},
             "hall": {"source": "HALL", "type": bool},
             "leak_area_ratio": {"source": "LEAK_AREA_RATIO", "type": list},

{pycfast-0.2.0 → pycfast-0.2.1/src/pycfast.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycfast
-Version: 0.2.0
+Version: 0.2.1
 Summary: Python interface for building, running, and analyzing CFAST fire simulation models
 Author-email: WYGAS Benoît <97663334+bewygs@users.noreply.github.com>
 Maintainer-email: WYGAS Benoît <97663334+bewygs@users.noreply.github.com>
@@ -221,7 +221,7 @@ Check out the [examples](https://pycfast.org/examples.html) for more usage scena
 
 ## Installation
 
-PyCFAST requires **Python 3.10 or later**. It is fully [tested on verification input files](https://github.com/bewygs/pycfast/tree/main/tests/verification_tests) from CFAST version **7.7.0** to version **7.7.5**.
+PyCFAST requires **Python 3.10 or later**. It is fully [tested on verification input files](https://github.com/bewygs/pycfast/tree/main/tests/verification_tests) and [validation input files](https://github.com/bewygs/pycfast/tree/main/tests/validation_tests) from CFAST version **7.7.0** to version **7.7.6**. Versions below **7.7.0** might work but are not guaranteed to be fully compatible.
 
 ### Pip or Conda