FireX: Merge with firemodels/master

.github/workflows/linux.yml

@@ -34,9 +34,9 @@ jobs:
     - uses: rscohn2/setup-oneapi@v0
       with:
         components: |
-          ifx
-          impi
-          mkl
+          ifx@2025.2.0
+          impi@2021.16.0
+          mkl@2025.2.0
         prune: false       
 
     - uses: actions/checkout@v5
@@ -98,7 +98,7 @@ jobs:
     steps:
     - uses: actions/checkout@v5
 
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       with:
         python-version: '3.9'
         cache: 'pip' # caching pip dependencies

.github/workflows/windows.yml

@@ -26,9 +26,9 @@ permissions:
 env:
   # update urls for oneapi packages according to
   # https://github.com/oneapi-src/oneapi-ci/blob/master/.github/workflows/build_all.yml
-  WINDOWS_BASEKIT_URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/09a8acaf-265f-4460-866c-a3375ed5b4ff/intel-oneapi-base-toolkit-2025.2.0.591_offline.exe
+  WINDOWS_BASEKIT_URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/f5881e61-dcdc-40f1-9bd9-717081ac623c/intel-oneapi-base-toolkit-2025.2.1.46_offline.exe
   WINDOWS_BASEKIT_COMPONENTS: intel.oneapi.win.mkl.devel
-  WINDOWS_HPCKIT_URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/3bbdaf75-6728-492e-a18c-be654dae9ee2/intel-oneapi-hpc-toolkit-2025.2.0.576_offline.exe
+  WINDOWS_HPCKIT_URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/e63ac2b4-8a9a-4768-979a-399a8b6299de/intel-oneapi-hpc-toolkit-2025.2.1.46_offline.exe
   WINDOWS_HPCKIT_COMPONENTS: intel.oneapi.win.ifort-compiler:intel.oneapi.win.mpi.devel
 
 

Build/makefile

@@ -403,7 +403,7 @@ ompi_gnu_linux : setup $(obj_mpi)
 	$(FCOMPL) $(FFLAGS) $(FOPENMPFLAGS) -o $(obj) $(obj_mpi) $(LFLAGSMKL)
 # Add ignores for vtk library
 
-ompi_gnu_linux_db : FFLAGS = -O0 -std=f2018 -ggdb -Wall -Wunused-parameter -Wcharacter-truncation -Wno-target-lifetime -Wno-maybe-uninitialized -Wno-uninitialized -Wno-unused-function -fcheck=all -fbacktrace -ffpe-trap=invalid,zero,overflow -frecursive -ffpe-summary=none -fall-intrinsics -fbounds-check $(GITINFOGNU) $(FFLAGSMKL) $(GFORTRAN_OPTIONS) $(FFLAGS_HYPRE) $(FFLAGS_SUNDIALS) $(FFLAGS_HDF5)
+ompi_gnu_linux_db : FFLAGS = -O0 -std=f2018 -ggdb -finit-real=snan -finit-integer=-999999 -Wall -Wunused-parameter -Wcharacter-truncation -Wno-target-lifetime -Wno-maybe-uninitialized -Wno-uninitialized -Wno-unused-function -fcheck=all -fbacktrace -ffpe-trap=invalid,zero,overflow -frecursive -ffpe-summary=none -fall-intrinsics -fbounds-check $(GITINFOGNU) $(FFLAGSMKL) $(GFORTRAN_OPTIONS) $(FFLAGS_HYPRE) $(FFLAGS_SUNDIALS) $(FFLAGS_HDF5)
 ompi_gnu_linux_db : LFLAGSMKL = $(LFLAGSMKL_GNU_OPENMP) $(LFLAGS_HYPRE) $(LFLAGS_SUNDIALS) $(LFLAGS_HDF5) $(LFLAGS_GPU)
 ompi_gnu_linux_db : FCOMPL = $(COMP_FC)
 ompi_gnu_linux_db : FOPENMPFLAGS = -fopenmp

Manuals/Bibliography/FDS_general.bib

@@ -4068,6 +4068,17 @@ @ARTICLE{Mawhinney:FT2012
   year         = {2012}
 }
 
+@ARTICLE{McCaffrey:1976,
+	author      = {B.J. McCaffrey and G. Heskestad},
+	title       = {{A Robust Bidirectional Low-Velocity Probe
+	for Flame and Fire Application}},
+	journal     = {Combustion and Flame},
+	volume      = {26},
+	number      = {},
+	pages       = {125-127},
+	year        = {1976},
+}
+
 @TECHREPORT{McCaffrey:NBSIR_79-1910,
   author       = {McCaffrey, B.J.},
   title        = {{Purely Buoyant Diffusion Flames: Some Experimental Results}},

Manuals/FDS_User_Guide/FDS_User_Guide.tex

@@ -10554,7 +10554,7 @@ \subsection{Thermocouples}
    \tau = \frac{D_{\rm eff} \, \rho_{\rm eff} \, c_{\rm eff} }{6 \, h}  \quad ; \quad  h=\frac{k \, \NU}{D_{\rm eff}} \quad ; \quad \NU = 2 + 0.6 \, \RE^{1/2} \, \PR^{1/3}  \quad ; \quad
    \RE = \frac{\rho \|\bu\| D_{\rm eff}}{\mu}  \label{TC_tau}
 \ee
-For a given value of the time constant, $\tau$, and effective thermal properties, Eq.~(\ref{TC_tau}) can be solved implicitly for the effective diameter. The \ct{TIME_CONSTANT} is specified on a \ct{PROP} line which is identified by the \ct{DEVC} line using a \ct{PROP_ID}. If you specify the \ct{TIME_CONSTANT}, you can still specify the effective \ct{EMISSIVITY}, \ct{DENSITY}, \ct{SPECIFIC_HEAT}, and \ct{HEAT_TRANSFER_COEFFICIENT} as well, but not the \ct{DIAMETER} because this will be calculated automatically. In most cases, it is sufficient to simply specify the \ct{TIME_CONSTANT}.
+For a given value of the time constant, $\tau$, and effective thermal properties, Eq.~(\ref{TC_tau}) can be solved implicitly for the effective diameter. The \ct{TIME_CONSTANT} is specified on a \ct{PROP} line which is identified by the \ct{DEVC} line using a \ct{PROP_ID}. If you specify the \ct{TIME_CONSTANT}, you can still specify the effective \ct{EMISSIVITY}, \ct{DENSITY}, \ct{SPECIFIC_HEAT} (or \ct{SPECIFIC_HEAT_RAMP}), and \ct{HEAT_TRANSFER_COEFFICIENT} as well, but not the \ct{DIAMETER} because this will be calculated automatically. In most cases, it is sufficient to simply specify the \ct{TIME_CONSTANT}.
 
 Figure~\ref{fig:thermocouple_time_constant} shows the results of a simple test case called \ct{thermocouple_time_constant} whose input file is in the \ct{Heat_Transfer} samples folder. Three thermocouples with given time constants of 0.5~s, 3.0~s, and 8.0~s are suddenly subjected to a 20~m/s air stream of 30~$^\circ$C. It is expected that each TC should reach a temperature of 26.32~$^\circ$C at their given time constants.
 \begin{figure}[!ht]
@@ -10566,13 +10566,24 @@ \subsection{Thermocouples}
 
 \subsection{Bi-Directional Probe}
 \label{info:bidir_probe}
+\label{bi_dir}
 
 The output quantity \ct{BI-DIRECTIONAL PROBE} is the velocity of a modeled bi-directional probe. A bi-directional probe uses the following equation:
 \be
 C \sqrt{\frac{2 \Delta P}{\rho}}
 \label{BDP}
 \ee
-where $C$ is a calibration constant (default value is 0.93), $\Delta P$ is the pressure difference across the probe, and $\rho$ is the gas density at the probe. In a typical experiment, the gas density is computed assuming standard pressure (101325 Pa), the molecular weight of air (28.8 g/mol), and the temperature as measured by a thermocouple near the probe. Bi-directional probes have biases due to both the Reynolds number (based on the probe diameter) of the flow and the angle of the flow with respect to the probe axis. This model accounts for those sensitivities and the impact of density differences from varied molecular weight at the probe. The orientation of the probe can be specified with either \ct{IOR} or \ct{ORIENTATION} on \ct{DEVC}. A probe with \ct{IOR}=-1 would have a positive velocity output when the flow is in the negative x direction. Parameters for the probe can be specified with a \ct{PROP_ID} on the \ct {DEVC}. The calibration constant and the probe diameter (default of 0.0254 m) can be set respectively with \ct{CALIBRATION_CONSTANT} and \ct{PROBE_DIAMETER} on \ct{PROP}. If the probe temperature is an aspirated thermocouple or other measurement not sensitive to the radiative environment, then set \ct{TC=F} on \ct{PROP}.
+where $C$ is a calibration constant (default value is 0.93), $\Delta P$ is the pressure difference across the probe, and $\rho$ is the gas density at the probe. In a typical experiment, the gas density is computed assuming standard pressure (101325 Pa), the molecular weight of air (28.8 g/mol), and the temperature as measured by a thermocouple near the probe.
+
+Bi-directional probes have biases due to both the Reynolds number (based on the probe diameter) of the flow and the angle of the flow with respect to the probe axis~\cite{McCaffrey:1976}. At low Reynolds number a probe will measure a higher effective velocity. As the angle of the flow vector with the axis increases, the effective velocity at first increases up to an angle of 30$^\circ$ due to a low pressure region forming downstream of the probe, and then decreases reaching no measured flow at an angle of 90$^\circ$. This model accounts for these sensitivities and the impact of density differences from varied molecular weight at the probe. The orientation of the probe can be specified with either \ct{IOR} or \ct{ORIENTATION} on \ct{DEVC}. A probe with \ct{IOR}=-1 would have a positive velocity output when the flow is in the -x direction. Parameters for the probe can be specified with a \ct{PROP_ID} on the \ct {DEVC}. The calibration constant (default of 0.93) and the probe diameter (default of 0.0254 m) can be set respectively with \ct{CALIBRATION_CONSTANT} and \ct{PROBE_DIAMETER} on \ct{PROP}. If the probe temperature is an aspirated thermocouple or other measurement not sensitive to the radiative environment, then set \ct{TC=F} on \ct{PROP}. Thermocouple specific properties for a bi-directional probe, see Section~\ref{info:THERMOCOUPLE}, should be set with the same \ct{PROP} as for the probe.
+
+Figure~\ref{bi_dir_fig} shows the results of a bi-directional probe with varying angle to a 1~m/s flow and varying flow speed. 
+\begin{figure}[ht]
+	\includegraphics[width=3in]{SCRIPT_FIGURES/bi_dir}
+	\includegraphics[width=3in]{SCRIPT_FIGURES/bi_dir_2}
+	\caption[Results of the \ct{bi_dir} test case]{Measured velocities using a bi-directional probe. (Left) Varying angle for a 1~m/s flow. (Right) Probe axis aligned flow with varied flow speed.}
+	\label{bi_dir_fig}
+\end{figure}
 
 \subsection{Volume Flow}
 \label{info:volume_flow}

Source/wall.f90

@@ -10,7 +10,7 @@ MODULE WALL_ROUTINES
 PRIVATE
 
 REAL(EB), POINTER, DIMENSION(:,:) :: PBAR_P
-REAL(EB), POINTER, DIMENSION(:,:,:) :: RHOP,HP,UU,VV,WW
+REAL(EB), POINTER, DIMENSION(:,:,:) :: RHOP,UU,VV,WW
 REAL(EB), POINTER, DIMENSION(:,:,:,:) :: ZZP
 
 PUBLIC WALL_BC,TGA_ANALYSIS,HT3D_TEMPERATURE_EXCHANGE
@@ -57,15 +57,13 @@ SUBROUTINE WALL_BC(T,DT,NM)
    RHOP => RHOS
    ZZP  => ZZS
    PBAR_P => PBAR_S
-   HP     => HS
 ELSE
    UU => U
    VV => V
    WW => W
    RHOP => RHO
    ZZP  => ZZ
    PBAR_P => PBAR
-   HP     => H
 ENDIF
 
 ! For thermally-thick boundary conditions, set the flag, CALL_HT_1D, to call the subroutine SOLID_HEAT_TRANSFER.
@@ -924,7 +922,7 @@ SUBROUTINE CALCULATE_ZZ_F(T,DT,WALL_INDEX,CFACE_INDEX,PARTICLE_INDEX)
 REAL(EB) :: T_SCALE(MAX_QDOTPP_REF),QDOTPP_REF(MAX_QDOTPP_REF),QDOTPP_T(MAX_QDOTPP_REF), &
             QDOTPP,QDOTPP1,QDOTPP2,DT_SPYRO(MAX_QDOTPP_REF),CP,H_G,MW_RATIO
 REAL(EB) :: RVC,M_DOT_PPP_SINGLE,ZZ_GET(1:N_TRACKED_SPECIES),DENOM
-INTEGER :: N,NS,IDX1,IDX2,NQ,ITER,IIO,JJO,KKO,OBST_INDEX,OTHER_MESH_OBST_INDEX,LL,SPECIES_BC_INDEX,IC,ICG,N_ZZ_MAX
+INTEGER :: N,NS,IDX1,IDX2,NQ,ITER,IIO,JJO,KKO,OBST_INDEX,OTHER_MESH_OBST_INDEX,LL,SPECIES_BC_INDEX,IC,ICG
 INTEGER, INTENT(IN), OPTIONAL :: WALL_INDEX,CFACE_INDEX,PARTICLE_INDEX
 TYPE(RAMPS_TYPE), POINTER :: RP,RP_E2T,RP_REF
 TYPE(EXTERNAL_WALL_TYPE), POINTER :: EWC
@@ -1030,12 +1028,11 @@ SUBROUTINE CALCULATE_ZZ_F(T,DT,WALL_INDEX,CFACE_INDEX,PARTICLE_INDEX)
 
       IF (B1%U_NORMAL_S<0._EB) THEN  ! If there is a non-zero velocity into the domain, assign appropriate species
                                      ! mass fractions to the face
-         DO N=1,N_TRACKED_SPECIES
+         DO N=2,N_TRACKED_SPECIES
             ZZ_GET(N) = SPECIES_MIXTURE(N)%ZZ0 + EVALUATE_RAMP(TSI,SF%RAMP(N)%INDEX,TAU=SF%RAMP(N)%TAU)* &
                            (SF%MASS_FRACTION(N)-SPECIES_MIXTURE(N)%ZZ0)
          ENDDO
-         N_ZZ_MAX = MAXLOC(ZZ_GET(1:N_TRACKED_SPECIES),1)
-         ZZ_GET(N_ZZ_MAX) = 1._EB-SUM(ZZ_GET(1:N_ZZ_MAX-1))-SUM(ZZ_GET(N_ZZ_MAX+1:N_TRACKED_SPECIES))
+         ZZ_GET(1) = 1._EB-SUM(ZZ_GET(2:N_TRACKED_SPECIES))
          CALL GET_REALIZABLE_MF(ZZ_GET)
          B1%ZZ_F = ZZ_GET
       ELSE
@@ -1330,9 +1327,10 @@ SUBROUTINE CALCULATE_ZZ_F(T,DT,WALL_INDEX,CFACE_INDEX,PARTICLE_INDEX)
 ! Only set species mass fraction in the ghost cell if it is not solid
 
 IF (PRESENT(WALL_INDEX)) THEN
-   IF (WALL_INDEX<=N_EXTERNAL_WALL_CELLS .AND. .NOT.CELL(IC)%SOLID .AND. .NOT.CELL(ICG)%SOLID) &
-       ZZP(BC%II,BC%JJ,BC%KK,1:N_TRACKED_SPECIES) = 2._EB*B1%ZZ_F(1:N_TRACKED_SPECIES) - B1%ZZ_G(1:N_TRACKED_SPECIES)
-       ZZP(BC%II2,BC%JJ2,BC%KK2,1:N_TRACKED_SPECIES) = 2._EB*B1%ZZ_F(1:N_TRACKED_SPECIES) - B1%ZZ_G(1:N_TRACKED_SPECIES)
+   IF (WALL_INDEX<=N_EXTERNAL_WALL_CELLS .AND. .NOT.CELL(IC)%SOLID .AND. .NOT.CELL(ICG)%SOLID) THEN
+      ZZP(BC%II,BC%JJ,BC%KK,1:N_TRACKED_SPECIES)    = 2._EB*B1%ZZ_F(1:N_TRACKED_SPECIES) - B1%ZZ_G(1:N_TRACKED_SPECIES)
+      ZZP(BC%II2,BC%JJ2,BC%KK2,1:N_TRACKED_SPECIES) = 2._EB*B1%ZZ_F(1:N_TRACKED_SPECIES) - B1%ZZ_G(1:N_TRACKED_SPECIES)
+   ENDIF
 ENDIF
 
 END SUBROUTINE CALCULATE_ZZ_F

Utilities/Matlab/FDS_verification_dataplot_inputs.csv

@@ -36,6 +36,8 @@ d,back_wall_test_2,Heat_Transfer/back_wall_test_2_git.txt,Heat_Transfer/back_wal
 d,back_wall_test_2,Heat_Transfer/back_wall_test_2_git.txt,Heat_Transfer/back_wall_test_2_devc.csv,2,3,Time,T_F_Target|T_B_Target,Exact Front|Exact Back,ko|ro,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Heat_Transfer/back_wall_test_2_devc.csv,2,3,Time,T_F3|T_B3,FDS Front|FDS Back,k-|r-,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Rotated GEOM Surface Temp. (back\_wall\_test\_2),Time (s),Temperature (°C),0,20,1,0,1000,1,no,0.05 0.90,SouthEast,,1,linear,FDS_Verification_Guide/SCRIPT_FIGURES/back_wall_test_2_temp_geom_rotated,Relative Error,end,0.02,Heat Transfer,r^,r,TeX
 d,beam_detector,Detectors/beam_detector_git.txt,Detectors/beam_detector.csv,1,2,Time,Obs|Obs|Obs,Exact|Exact|Exact,k-|k-|k-,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Detectors/beam_detector_devc.csv,2,3,Time,beam_1|beam_2|beam_3,FDS (beam\_1)|FDS (beam\_2)|FDS (beam\_3),ko|ro|go,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Path Obscuration (beam\_detector),Time (s),Path Obscuration (%),0,1,1,0,110,1,no,0.25 0.90,East,,1,linear,FDS_User_Guide/SCRIPT_FIGURES/beam_detector_obs,Relative Error,end,0.01,Aerosols,r^,r,TeX
 d,beam_detector,Detectors/beam_detector_git.txt,Detectors/beam_detector_ss_check.csv,1,2,L,value,Exact,k-,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Detectors/beam_detector_ss_smv.csv,1,2,L,value,Smokeview,ko,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Smoke Obscuration (beam\_detector),Distance (m),Pixel Value,0,10,1,0,255,1,no,0.25 0.90,East,,1,linear,FDS_User_Guide/SCRIPT_FIGURES/beam_detector,N/A,end,0.02,Aerosols,r^,r,TeX
+d,bi_dir,Controls/bi_dir_git.txt,Controls/bi_dir.csv,1,2,Time,V1_0|V1_180|V1_30|V1_55,Expected 0^\circ|Expected 180^\circ|Expected 30^\circ|Expected 55^\circ,ko|ro|bo|go,0,100000,,5,100000,-1.00E+09,1.00E+09,0,Controls/bi_dir_devc.csv,2,3,Time,V1_0|V1_180|V1_30|V1_55,FDS 0^\circ|FDS 180^\circ|FDS 30^\circ|FDS 55^\circ,k-|r-|b-|g-,0,100000,,5,100000,-1.00E+09,1.00E+09,0,Measured Velocity (bi\_dir),Time (s),Velocity (m/s),0,20,1,-1.5,1.5,1,no,0.25 0.92,East,,1,linear,FDS_User_Guide/SCRIPT_FIGURES/bi_dir,Relative Error,mean,0.02,Controls,kd,k,TeX
+d,bi_dir,Controls/bi_dir_git.txt,Controls/bi_dir.csv,1,2,Time,Vp1_0|V10_0,Expected 0.1 m/s \times 100 |Expected  10 m/s,ko|ro,0,100000,,5,100000,-1.00E+09,1.00E+09,0,Controls/bi_dir_devc.csv,2,3,Time,Vp1_0|V10_0,FDS 0.1 m/s \times 100 |FDS  10 m/s,k-|r-,0,100000,,5,100000,-1.00E+09,1.00E+09,0,Measured Velocity (bi\_dir),Time (s),Velocity (m/s),0,20,1,0,15,1,no,0.25 0.92,SouthEast,,1,linear,FDS_User_Guide/SCRIPT_FIGURES/bi_dir_2,Relative Error,mean,0.02,Controls,kd,k,TeX
 d,bound_test_1,Species/bound_test_1_git.txt,Species/bound_test_1.csv,1,2,Time,F1|A1|P1|F2|A2|P2|Sum,F1|A1|P1|F2|A2|P2|Sum,ko|ro|bo|go|mo|co|k+,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Species/bound_test_1_devc.csv,2,3,Time,XF1|XA1|XP1|XF2|XA2|XP2|SUM,FDS F1|FDS A1|FDS P1|FDS F2|FDS A2|FDS P2|FDS SUM,k-|r-|b-|g-|m-|c-|k--,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Boundedness Test (bound\_test\_1),Time (s),Volume Fraction,0,1,1,0,1.05,1,no,0.05 0.90,EastOutside,,1.3,linear,FDS_Verification_Guide/SCRIPT_FIGURES/bound_test_1,Absolute Error,end,0.001,Species,kd,k,TeX
 d,bound_test_2,Species/bound_test_2_git.txt,Species/bound_test_2.csv,1,2,Time,F1|F2|A1|A2|P1|P2|P3|Sum,F1|F2|A1|A2|P1|P2|P3|Sum,ko|ro|bo|go|mo|co|yo|k+,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Species/bound_test_2_devc.csv,2,3,Time,XF1|XF2|XA1|XA2|XP1|XP2|XP3|SUM,FDS F1|FDS F2|FDS A1|FDS A2|FDS P1|FDS P2|FDS P3|FDS SUM,k-|r-|b-|g-|m-|c-|y-|k--,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Boundedness Test (bound\_test\_2),Time (s),Volume Fraction,0,1,1,0,1.05,1,no,0.05 0.90,EastOutside,,1.3,linear,FDS_Verification_Guide/SCRIPT_FIGURES/bound_test_2,Absolute Error,end,0.001,Species,kd,k,TeX
 d,box_burn_away1,Fires/box_burn_away1_git.txt,Fires/box_burn_away.csv,1,2,Time,Mass (kg),Ideal,ko,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Fires/box_burn_away1_devc.csv,2,3,Time,Mass fuel,FDS (fuel),k-,0,100000,,0,100000,-1.00E+09,1.00E+09,0,Pyrolyzed Mass (box\_burn\_away1),Time (s),Mass (kg),0,30,1,0,1.5,1,no,0.05 0.90,East,,1,linear,FDS_User_Guide/SCRIPT_FIGURES/box_burn_away1,Relative Error,end,0.02,Fires,r*,r,TeX