fdsreader 1.2.0rc2__tar.gz → 1.2.8__tar.gz

{fdsreader-1.2.0rc2/fdsreader.egg-info → fdsreader-1.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fdsreader
-Version: 1.2.0rc2
+Version: 1.2.8
 Summary: Python reader for data generated by FDS.
 Home-page: https://github.com/JanVogelsang/fdsreader
 Author: FZJ IAS-7 (Prof. Dr. Lukas Arnold, Jan Vogelsang)

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/_version.py

@@ -7,5 +7,5 @@ Provides fdsreader version information.
 
 from incremental import Version
 
-__version__ = Version('fdsreader', 1, 2, 0, release_candidate=2)
+__version__ = Version('fdsreader', 1, 2, 8)
 __all__ = ["__version__"]

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/bndf/obstruction.py

@@ -3,7 +3,7 @@ from typing import List, Dict, Tuple, Union, Sequence
 from typing_extensions import Literal
 import numpy as np
 
-from fdsreader.utils import Surface, Extent, Quantity, Dimension
+from fdsreader.utils import Extent, Quantity, Dimension
 import fdsreader.utils.fortran_data as fdtype
 from fdsreader import settings
 
@@ -149,12 +149,12 @@ class SubObstruction:
 
     :ivar extent: :class:`Extent` object containing 3-dimensional extent information.
     :ivar bound_indices: Indices used to define obstruction bounds in terms of mesh locations.
-    :ivar side_surfaces: Tuple of six surfaces for each side of the cuboid.
+    :ivar side_surfaces: Tuple of six :class:`Surface`s for each side of the cuboid.
     :ivar hide_times: List with points in time from when on the SubObstruction will be hidden.
     :ivar show_times: List with points in time from when on the SubObstruction will be shown.
     """
 
-    def __init__(self, side_surfaces: Tuple[Surface, ...], bound_indices: Tuple[int, int, int, int, int, int],
+    def __init__(self, side_surfaces: Tuple, bound_indices: Tuple[int, int, int, int, int, int],
                  extent: Extent):
         self.extent = extent
         self.side_surfaces = side_surfaces
@@ -167,11 +167,12 @@ class SubObstruction:
         self.hide_times = list()
         self.show_times = list()
 
-    def _add_patches(self, bid: int, cell_centered: bool, quantity: str, short_name: str, unit: str, patches: List[Patch],
-                     times: np.ndarray, n_t: int, lower_bounds: np.ndarray, upper_bounds: np.ndarray):
+    def _add_patches(self, bid: int, cell_centered: bool, quantity: str, short_name: str, unit: str,
+                     patches: List[Patch], times: np.ndarray, n_t: int, lower_bounds: np.ndarray,
+                     upper_bounds: np.ndarray):
         if bid not in self._boundary_data:
-            self._boundary_data[bid] = Boundary(Quantity(quantity, short_name, unit), cell_centered, times, n_t, patches,
-                                                lower_bounds, upper_bounds)
+            self._boundary_data[bid] = Boundary(Quantity(quantity, short_name, unit), cell_centered, times, n_t,
+                                                patches, lower_bounds, upper_bounds)
 
         if not settings.LAZY_LOAD:
             _ = self._boundary_data[bid].data

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/evac/EvacCollection.py

@@ -4,15 +4,15 @@ from typing import Iterable, Dict, List, Union
 import numpy as np
 
 from fdsreader.evac import Evacuation
-from fdsreader.utils import Mesh
+from fdsreader.fds_classes import Mesh
 from fdsreader.utils.data import FDSDataCollection, Quantity
 import fdsreader.utils.fortran_data as fdtype
 from fdsreader import settings
 
 
 class EvacCollection(FDSDataCollection):
-    """Collection of :class:`Plot3D` objects. Offers extensive functionality for filtering and
-        using plot3Ds as well as its subclasses such as :class:`SubPlot3D`.
+    """Collection of :class:`Evacuation` objects. Next to agent-class specific data (such as trajectories) lots of
+        other data such as FED-data is provided via this class.
 
         :ivar times: List of all time steps of the simulation.
         :ivar z_offsets: The offset in z-direction for each mesh where the evac plane lays.
@@ -92,8 +92,8 @@ class EvacCollection(FDSDataCollection):
                                          units[i] == "TargetDoorCounter"}
 
     @property
-    def xyz(self) -> np.ndarray:
-        """
+    def xyz(self) -> List[np.ndarray]:
+        """List of xyz-data for each mesh.
         """
         if not hasattr(self, "_xyz"):
             self._load_xyz_data()
@@ -121,18 +121,26 @@ class EvacCollection(FDSDataCollection):
             n_corrs = meta[2]
             n_devc = fdtype.read(infile, fdtype.INT, 1)[0][0][0]
 
-            n_i, n_j, n_k, n = fdtype.read(infile, dtype_grid_meta, 1)[0][0]  # n_k will always be 1
+            n_i = list()
+            n_j = list()
+            for g in range(n_grids):
+                n_i_g, n_j_g, _, _ = fdtype.read(infile, dtype_grid_meta, 1)[0][0]
+                n_i.append(n_i_g)
+                n_j.append(n_j_g)
+                for i in range(n_i_g):
+                    for j in range(n_j_g):
+                        _ = fdtype.read(infile, dtype_grid_data, 1)
 
             # Reset pointer (after file header)
             infile.seek(fdtype.INT.itemsize * 2 + dtype_meta.itemsize)
 
-            self._xyz = np.empty((n_grids, n_i, n_j, 3))
+            self._xyz = [np.empty((n_i[g], n_j[g], 3)) for g in range(n_grids)]
 
             for g in range(n_grids):
                 infile.seek(dtype_grid_meta.itemsize, 1)
-                for i in range(n_i):
-                    for j in range(n_j):
-                        self._xyz[g, i, j] = fdtype.read(infile, dtype_grid_data, 1)[0][0]
+                for i in range(n_i[g]):
+                    for j in range(n_j[g]):
+                        self._xyz[g][i, j] = fdtype.read(infile, dtype_grid_data, 1)[0][0]
 
         if os.path.exists(self._base_path + ".fed"):
             self._load_fed_data(n_corrs)
@@ -183,6 +191,9 @@ class EvacCollection(FDSDataCollection):
             dtype_meta = fdtype.new((('i', 6),))
             dtype_time = fdtype.new((('f', 2),))
             dtype_grid_meta = fdtype.new((('i', 4),))
+            dtype_corr = fdtype.new((('f', 8),))
+            dtype_devs_meta = fdtype.new((('i', 2),))
+            dtype_devs_data = fdtype.new((('i', 1), ('f', 1), ('i', 2), ('f', 1)))
 
             # File header
             file_format = fdtype.read(infile, fdtype.INT, 1)[0][0][0]
@@ -195,26 +206,35 @@ class EvacCollection(FDSDataCollection):
 
             # Read gridsize from first timestep header
             infile.seek(dtype_time.itemsize, 1)
-            n_i, n_j, n_k, n = fdtype.read(infile, dtype_grid_meta, 1)[0][0]  # n_k will always be 1
+
+            n_i = list()
+            n_j = list()
+            n = list()
+            dtype_grid_data = list()
+            for g in range(n_grids):
+                n_i_g, n_j_g, _, n_g = fdtype.read(infile, dtype_grid_meta, 1)[0][0]
+                n_i.append(n_i_g)
+                n_j.append(n_j_g)
+                n.append(n_g)
+                dtype_grid_data.append(fdtype.new((('f', n_g),)))
+                for i in range(n_i_g):
+                    for j in range(n_j_g):
+                        _ = fdtype.read(infile, dtype_grid_data[-1], 1)
 
             # Reset pointer (after file header)
             infile.seek(dtype_meta.itemsize + fdtype.INT.itemsize * 2)
 
-            dtype_grid_data = fdtype.new((('f', n),))
-            dtype_corr = fdtype.new((('f', 8),))
-            dtype_devs_meta = fdtype.new((('i', 2),))
-            dtype_devs_data = fdtype.new((('i', 1), ('f', 1), ('i', 2), ('f', 1)))
-
-            n_t = (os.stat(file_path).st_size - (fdtype.INT.itemsize * 2 + dtype_meta.itemsize)) // \
-                  (dtype_time.itemsize + n_grids * (dtype_grid_meta.itemsize + n_i * n_j * dtype_grid_data.itemsize) +
-                   n_corrs * dtype_corr.itemsize + fdtype.FLOAT.itemsize + n_devc * (
-                           dtype_devs_meta.itemsize + dtype_devs_data.itemsize))
+            n_t = (os.stat(file_path).st_size - (fdtype.INT.itemsize * 2 + dtype_meta.itemsize)) // (
+                        dtype_time.itemsize + sum(
+                    (dtype_grid_meta.itemsize + n_i[g] * n_j[g] * dtype_grid_data[g].itemsize) for g in
+                    range(n_grids)) + n_corrs * dtype_corr.itemsize + fdtype.FLOAT.itemsize + n_devc * (
+                                    dtype_devs_meta.itemsize + dtype_devs_data.itemsize))
 
             times = list()
-            self._fed_grid = dict(co_co2_o2=[np.empty((n_t, n_i, n_j)) for _ in range(n_grids)],
-                                  soot_dens=[np.empty((n_t, n_i, n_j)) for _ in range(n_grids)],
-                                  tmp_g=[np.empty((n_t, n_i, n_j)) for _ in range(n_grids)],
-                                  radflux=[np.empty((n_t, n_i, n_j)) for _ in range(n_grids)])
+            self._fed_grid = dict(co_co2_o2=[np.empty((n_t, n_i[g], n_j[g])) for g in range(n_grids)],
+                                  soot_dens=[np.empty((n_t, n_i[g], n_j[g])) for g in range(n_grids)],
+                                  tmp_g=[np.empty((n_t, n_i[g], n_j[g])) for g in range(n_grids)],
+                                  radflux=[np.empty((n_t, n_i[g], n_j[g])) for g in range(n_grids)])
             self._fed_corr = dict(co_co2_o2=[np.empty((n_t, 2)) for _ in range(n_corrs)],
                                   soot_dens=[np.empty((n_t, 2)) for _ in range(n_corrs)],
                                   tmp_g=[np.empty((n_t, 2)) for _ in range(n_corrs)],
@@ -229,9 +249,9 @@ class EvacCollection(FDSDataCollection):
 
                 for g in range(n_grids):
                     infile.seek(dtype_grid_meta.itemsize, 1)
-                    for i in range(n_i):
-                        for j in range(n_j):
-                            co_co2_o2, soot_dens, tmp_g, radflux = fdtype.read(infile, dtype_grid_data, 1)[0][0][:4]
+                    for i in range(n_i[g]):
+                        for j in range(n_j[g]):
+                            co_co2_o2, soot_dens, tmp_g, radflux = fdtype.read(infile, dtype_grid_data[g], 1)[0][0][:4]
                             self._fed_grid["co_co2_o2"][g][t, i, j] = co_co2_o2
                             self._fed_grid["soot_dens"][g][t, i, j] = soot_dens
                             self._fed_grid["tmp_g"][g][t, i, j] = tmp_g
@@ -271,25 +291,29 @@ class EvacCollection(FDSDataCollection):
 
         with open(file_path, 'rb') as infile:
             dtype_grid_meta = fdtype.new((('i', 3),))
-            dtype_grid_data = fdtype.new((('f', 2),))
+            dtype_grid_data = fdtype.new((('f', 2),))  # u, v
 
             n_grids = fdtype.read(infile, fdtype.INT, 1)[0][0][0]
 
-            n_i, n_j, n_k = fdtype.read(infile, dtype_grid_meta, 1)[0][0]  # n_k will always be 1
-
-            # Reset pointer (after file header)
-            infile.seek(fdtype.INT.itemsize)
-
-            n_fields = (os.stat(file_path).st_size - fdtype.INT.itemsize) // (
-                    n_grids * (dtype_grid_meta.itemsize + n_i * n_j * dtype_grid_data.itemsize))
-
-            self._eff = np.empty((n_grids, n_fields, n_i, n_j, 2))
-            for g in range(n_grids):
-                for f in range(n_fields):
-                    infile.seek(dtype_grid_meta.itemsize, 1)
-                    for i in range(n_i):
-                        for j in range(n_j):
-                            self._eff[g, f, i, j] = fdtype.read(infile, dtype_grid_data, 1)[0][0]
+            # n_fields = (os.stat(file_path).st_size - fdtype.INT.itemsize) // (
+            #         sum(dtype_grid_meta.itemsize + n_i[g] * n_j[g] * dtype_grid_data.itemsize for g in range(n_grids)))
+            #
+            # self._eff = np.empty((n_grids, n_fields, n_i, n_j, 2))
+            # for g in range(n_grids):
+            #     for f in range(n_fields):
+            #         infile.seek(dtype_grid_meta.itemsize, 1)
+            #         for i in range(n_i[g]):
+            #             for j in range(n_j[g]):
+            #                 self._eff[g, f, i, j] = fdtype.read(infile, dtype_grid_data, 1)[0][0]
+
+            self._eff = list()
+            meta = fdtype.read(infile, dtype_grid_meta, 1)
+            while len(meta) > 0:
+                n_i, n_j, _ = meta[0][0]
+                for i in range(n_i + 2):
+                    for j in range(n_j + 2):
+                        self._eff.append(fdtype.read(infile, dtype_grid_data, 1)[0][0])
+                meta = fdtype.read(infile, dtype_grid_meta, 1)
 
     def get_unfiltered_positions(self, quantity: Union[Quantity, str] = None):
         """Convenience function that combines all trajectories into a single array.
@@ -357,7 +381,10 @@ class EvacCollection(FDSDataCollection):
                     for quantity in evac.quantities:
                         evac._data[quantity.name].append(np.empty((size,), dtype=np.float32))
                     evac._positions.append(np.empty((size, 3), dtype=np.float32))
-                    evac._ap.append(np.empty((size, 4), dtype=np.float32))
+                    evac._body_angles.append(np.empty((size,), dtype=np.float32))
+                    evac._semi_major_axis.append(np.empty((size,), dtype=np.float32))
+                    evac._semi_minor_axis.append(np.empty((size,), dtype=np.float32))
+                    evac._agent_heights.append(np.empty((size,), dtype=np.float32))
                     evac._tags.append(np.empty((size,), dtype=int))
 
         for mesh, file_path in self._file_paths.items():
@@ -385,8 +412,10 @@ class EvacCollection(FDSDataCollection):
                         pos = fdtype.read(infile, dtype_positions, 1)[0][0].reshape((n_humans, 7),
                                                                                     order='F').astype(float)
                         evac._positions[t][offset: offset + n_humans] = pos[:, :3]
-                        # Todo: What might this be for?
-                        evac._ap[t][offset: offset + n_humans] = pos[:, 3:]
+                        evac._body_angles[t][offset: offset + n_humans] = pos[:, 3]
+                        evac._semi_major_axis[t][offset: offset + n_humans] = pos[:, 4]
+                        evac._semi_minor_axis[t][offset: offset + n_humans] = pos[:, 5]
+                        evac._agent_heights[t][offset: offset + n_humans] = pos[:, 6]
                         # Read tags
                         dtype_tags = fdtype.new((('i', n_humans),))
                         evac._tags[t][offset: offset + n_humans] = fdtype.read(infile, dtype_tags, 1)[0][0]

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/evac/evacuation.py

@@ -2,7 +2,8 @@ from typing import List, Tuple, Dict, Sequence, Union
 
 import numpy as np
 
-from fdsreader.utils import Quantity, Mesh, Extent
+from fdsreader.fds_classes import Mesh
+from fdsreader.utils import Quantity
 
 
 # class Entrance:
@@ -54,7 +55,10 @@ class Evacuation:
         self.n_humans: Dict[Mesh, List[int]] = dict()
 
         self._positions: List[np.ndarray] = list()
-        self._ap: List[np.ndarray] = list()
+        self._body_angles: List[np.ndarray] = list()
+        self._semi_major_axis: List[np.ndarray] = list()
+        self._semi_minor_axis: List[np.ndarray] = list()
+        self._agent_heights: List[np.ndarray] = list()
         self._tags: List[np.ndarray] = list()
         self._data: Dict[str, List[np.ndarray]] = {q.name: [] for q in self.quantities}
         self.times: Sequence[float] = list()
@@ -146,12 +150,36 @@ class Evacuation:
         return self._positions
 
     @property
-    def ap(self) -> List[np.ndarray]:
+    def body_angles(self) -> List[np.ndarray]:
         """
         """
         if len(self._positions) == 0 and len(self._tags) == 0:
             self._init_callback()
-        return self._ap
+        return self._body_angles
+
+    @property
+    def semi_major_axis(self) -> List[np.ndarray]:
+        """
+        """
+        if len(self._positions) == 0 and len(self._tags) == 0:
+            self._init_callback()
+        return self._semi_major_axis
+
+    @property
+    def semi_minor_axis(self) -> List[np.ndarray]:
+        """
+        """
+        if len(self._positions) == 0 and len(self._tags) == 0:
+            self._init_callback()
+        return self._semi_minor_axis
+
+    @property
+    def agent_heights(self) -> List[np.ndarray]:
+        """
+        """
+        if len(self._positions) == 0 and len(self._tags) == 0:
+            self._init_callback()
+        return self._agent_heights
 
     def clear_cache(self):
         """Remove all data from the internal cache that has been loaded so far to free memory.

{fdsreader-1.2.0rc2/fdsreader/utils → fdsreader-1.2.8/fdsreader}/fds_classes/MeshCollection.py

@@ -1,6 +1,6 @@
 from typing import Iterable
 
-from fdsreader.utils import Mesh
+from fdsreader.fds_classes import Mesh
 from fdsreader.utils.data import FDSDataCollection
 
 

fdsreader-1.2.8/fdsreader/fds_classes/__init__.py

@@ -0,0 +1,7 @@
+from .mesh import Mesh
+
+from .MeshCollection import MeshCollection
+
+from .surface import Surface
+
+from .ventilation import Ventilation

{fdsreader-1.2.0rc2/fdsreader/utils → fdsreader-1.2.8/fdsreader}/fds_classes/mesh.py

@@ -1,8 +1,10 @@
-from typing import Dict, Tuple, Sequence
+from typing import Dict, Tuple, Sequence, List, Union
 from typing_extensions import Literal
 import numpy as np
 
-from fdsreader.utils import Dimension, Extent
+from fdsreader import settings
+from fdsreader.utils import Dimension, Extent, Quantity
+from fdsreader.bndf import Boundary, Patch
 
 
 class Mesh:
@@ -37,6 +39,8 @@ class Mesh:
 
         self.obstructions = list()
 
+        self._boundary_data: Dict[int, Boundary] = dict()
+
     def get_obstruction_mask(self, times: Sequence[float], cell_centered=False) -> np.ndarray:
         """Marks all cells which are blocked by an obstruction.
 
@@ -85,7 +89,7 @@ class Mesh:
         :param dimension: The dimensions in which to return the indices (1=x, 2=y, 3=z).
         """
         # Convert possible integer input to chars
-        dimension = tuple(('x', 'y', 'z')[dim-1] if type(dim) == int else dim for dim in dimension)
+        dimension = tuple(('x', 'y', 'z')[dim - 1] if type(dim) == int else dim for dim in dimension)
 
         ret = list()
         for i, dim in enumerate(dimension):
@@ -101,6 +105,23 @@ class Mesh:
                 ret.append(idx)
         return tuple(ret)
 
+    def _add_patches(self, bid: int, cell_centered: bool, quantity: str, short_name: str, unit: str,
+                     patches: List[Patch], times: np.ndarray, n_t: int, lower_bounds: np.ndarray,
+                     upper_bounds: np.ndarray):
+        if bid not in self._boundary_data:
+            self._boundary_data[bid] = Boundary(Quantity(quantity, short_name, unit), cell_centered, times, n_t,
+                                                patches, lower_bounds, upper_bounds)
+
+        if not settings.LAZY_LOAD:
+            _ = self._boundary_data[bid].data
+
+    def get_boundary_data(self, quantity: Union[str, Quantity]):
+        if type(quantity) == Quantity:
+            quantity = quantity.name
+        return next(b for b in self._boundary_data.values() if
+                    b.quantity.name.lower() == quantity.lower() or b.quantity.short_name.lower() == quantity.lower())
+
+
     def __getitem__(self, dimension: Literal[0, 1, 2, 'x', 'y', 'z']) -> np.ndarray:
         """Get all values in given dimension.
 

{fdsreader-1.2.0rc2/fdsreader/utils → fdsreader-1.2.8/fdsreader}/fds_classes/ventilation.py

@@ -1,6 +1,7 @@
 from typing import Union, Tuple, Dict
 
-from fdsreader.utils import Surface, Extent, Mesh
+from fdsreader.fds_classes import Surface, Mesh
+from fdsreader.utils import Extent
 
 
 class SubVentilation:

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/geom/geometry.py

@@ -3,7 +3,8 @@ from typing import Tuple, Dict, Iterable
 
 import numpy as np
 
-from fdsreader.utils import Surface, Quantity
+from fdsreader.fds_classes import Surface
+from fdsreader.utils import Quantity
 import fdsreader.utils.fortran_data as fdtype
 
 

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/isof/isosurface.py

@@ -4,7 +4,8 @@ from typing import BinaryIO, Dict, Union, List, Tuple, Optional
 
 import numpy as np
 
-from fdsreader.utils import Quantity, Mesh
+from fdsreader.fds_classes import Mesh
+from fdsreader.utils import Quantity
 from fdsreader import settings
 import fdsreader.utils.fortran_data as fdtype
 

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/part/ParticleCollection.py

@@ -2,7 +2,7 @@ from typing import Iterable, Dict, List
 import numpy as np
 
 from fdsreader.part import Particle
-from fdsreader.utils import Mesh
+from fdsreader.fds_classes import Mesh
 from fdsreader.utils.data import FDSDataCollection, Quantity
 import fdsreader.utils.fortran_data as fdtype
 from fdsreader import settings

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/part/particle.py

@@ -2,7 +2,8 @@ from typing import List, Tuple, Dict, Sequence
 
 import numpy as np
 
-from fdsreader.utils import Quantity, Mesh
+from fdsreader.fds_classes import Mesh
+from fdsreader.utils import Quantity
 
 
 class Particle:

{fdsreader-1.2.0rc2 → fdsreader-1.2.8}/fdsreader/pl3d/pl3d.py

@@ -4,7 +4,8 @@ from copy import deepcopy
 from typing import Dict, Sequence
 import numpy as np
 
-from fdsreader.utils import Quantity, Mesh
+from fdsreader.fds_classes import Mesh
+from fdsreader.utils import Quantity
 from fdsreader import settings
 import fdsreader.utils.fortran_data as fdtype