Simulation

class fdsreader.simulation.Simulation(path: str)[source]

Master class managing all data for a given simulation.

Variables:

  • reader_version – The version of the fdsreader used to load the Simulation.

  • smv_file_path – Path to the .smv file of the simulation.

  • root_path – Path to the root directory of the simulation.

  • fds_version – Version of FDS the simulation was performed with.

  • chid – Name (ID) of the simulation.

  • hrrpuv_cutoff – The hrrpuv_cutoff value.

  • default_texture_origin – The default origin used for textures with no explicit origin.

  • out_file_path – Path to the .out file of the simulation.

  • surfaces – List containing all surfaces defined in this simulation.

  • meshes – List containing all meshes (grids) defined in this simulation.

  • ventilations – List containing all ventilations defined in this simulation.

  • obstructions – All defined obstructions combined into a ObstructionCollection.

  • slices – All defined slices combined into a SliceCollection.

  • data_3d – All defined 3D plotting data combined into a Plot3DCollection.

  • smoke_3d – All defined 3D smoke data combine into a Smoke3DCollecction

  • isosurfaces – All defined isosurfaces combined into a IsosurfaceCollection.

  • particles – All defined particles combined into a ParticleCollection.

  • evacs – All defined evacuations combined into a EvacCollection.

  • devices – List containing all Device s defined in this simulation.

  • profiles – Dictionary mapping profile ids to the corresponding Profile s defined in this simulation.

  • geoms – List containing all geometries (Geometry) defined in this simulation.

  • geom_data – All geometry data by quantity combined into a GeometryCollection.

  • cpu – Dictionary mapping .csv header keys to numpy arrays containing cpu data.

  • hrr – Dictionary mapping .csv header keys to numpy arrays containing hrr data.

  • steps – Dictionary mapping .csv header keys to numpy arrays containing steps data.

Parameters:

path – Either the path to the directory containing the simulation data or direct path to the .smv file for the simulation in case that multiple simulation output was written to the same directory.

clear_cache(clear_persistent_cache=False)[source]

Remove all data from the internal cache that has been loaded so far to free memory.

Parameters:

clear_persistent_cache – Whether to clear the persistent simulation cache as well.

parse_smv_file()[source]