Lots of improvements and convenience methods for obstructions

Author: JanVogelsang

README.md

@@ -13,14 +13,15 @@ pip install fdsreader
 _FDS Version 6.7.5 and above are fully supported. Versions below 6.7.5 might work, but are not guaranteed to work._
 
 ## Usage example
+
 ```python
 import fdsreader as fds
 
 # Creates an instance of a simulation master-class which manages all data for a given simulation
 sim = fds.Simulation("./sample_data")
 
 # Examples of data that can be easily accessed
-print(sim.meshes, sim.surfaces, sim.slices, sim.data_3d, sim.isosurfaces, sim.particles, sim.obstructions)
+print(sim.meshes, sim.surfaces, sim.slices, sim.data_3d, sim.smoke_3d, sim.isosurfaces, sim.particles, sim.obstructions)
 ```
 
 More advanced examples can be found in the respective data type directories inside of the examples directory.  

RELEASE.md

@@ -1,4 +1,8 @@
 ## Release History
+* 1.8.1
+    * Lots of improvements and convenience methods for obstructions
+* 1.8.0
+    * Reworked Devices: Now using a DeviceCollection with pandas support, devices do now lazyload as well
 * 1.7.5
     * Fixed bug in get_subslice method
 * 1.7.4

examples/bndf/bndf_example_anim.py

@@ -10,42 +10,16 @@ def main():
     sim = Simulation("./fds_data")
 
     # Get first obstruction
-    obst = sim.obstructions.get_nearest_obstruction((-0.8, 1, 1))
-    obst = sim.obstructions[3]
+    obst = sim.obstructions.get_nearest(-0.8, 1, 1)
 
     # Get all patches with orientation=1 (equals positive x-dimension)
     orientation = 1
     quantity = "Wall Temperature"
-    patches = list()
-    for sub_obst in obst.filter_by_orientation(orientation):
-        # Get boundary data for a specific quantity
-        sub_obst_data = sub_obst.get_data(quantity)
-        patches.append(sub_obst_data.data[orientation])
-
-    # Combine patches to a single face for plotting
-    patches = sort_patches_cartesian(patches)
-
-    shape_dim1 = sum([patch_row[0].shape[0] for patch_row in patches])
-    shape_dim2 = sum([patch.shape[1] for patch in patches[0]])
-    n_t = patches[0][0].n_t  # Number of timesteps
-
-    face = np.empty(shape=(n_t, shape_dim1, shape_dim2))
-    dim1_pos = 0
-    dim2_pos = 0
-    for patch_row in patches:
-        d1 = patch_row[0].shape[0]
-        for patch in patch_row:
-            d2 = patch.shape[1]
-            face[:, dim1_pos:dim1_pos + d1,
-            dim2_pos:dim2_pos + d2] = patch.data
-            dim2_pos += d2
-        dim1_pos += d1
-        dim2_pos = 0
+    face = obst.get_global_boundary_data_arrays(quantity)[orientation]
 
     # Value range
     vmax = np.ceil(obst.vmax(quantity))
-    # vmin = np.floor(obst.vmin(quantity))
-    vmin = 40 - vmax
+    vmin = np.floor(obst.vmin(quantity))
 
     # Value ticks
     ticks = [vmin+i*(vmax-vmin)/10 for i in range(11)]

examples/geom/geom_slices.py

@@ -1,8 +1,4 @@
-import time
-
-import pyvista as pv
 from fdsreader import Simulation
-import numpy as np
 
 
 def main():

examples/smoke3d/smoke3d_example.py

@@ -9,7 +9,6 @@
 
 def main():
     sim = fds.Simulation("./fds_steckler/")
-    sim = fds.Simulation("C:\\Users\\janv1\\Documents\\Unreal Projects\\TBRaymarchProject\\fds_data")
 
     # Select the seconds mesh (index counting starts at 0)
     mesh = sim.meshes[0]

fdsreader/_version.py

@@ -7,5 +7,5 @@
 
 from incremental import Version
 
-__version__ = Version("fdsreader", 1, 7, 5)
+__version__ = Version("fdsreader", 1, 8, 1)
 __all__ = ["__version__"]

fdsreader/bndf/__init__.py

@@ -1,3 +1,3 @@
 from .obstruction import Obstruction, SubObstruction, Patch, Boundary
 
-from .ObstructionCollection import ObstructionCollection
+from .obstruction_collection import ObstructionCollection