Merge pull request #14384 from rmcdermo/master

Manuals: fix TOC captions

Author: rmcdermo

Manuals/FDS_Technical_Reference_Guide/Appendices.tex

@@ -506,7 +506,7 @@ \subsubsection{Carbon Monoxide: $\rm CO$}
 Carbon Monoxide is a diatomic molecule and as such, it has only one vibrational mode \cite{Herzberg:1949}. RADCAL includes one distinct band, see Table \ref{Table::CO}.
 \begin{table}[h!]
     \centering
-    \caption{Spectral bands of $\rm CO$ included in RADCAL.}
+    \caption[Spectral bands of $\rm CO$ included in RADCAL]{Spectral bands of $\rm CO$ included in RADCAL.}
     \vspace{0.1in}
     \label{Table::CO}
     \begin{tabular}{|c|c|c|c|}

Manuals/FDS_User_Guide/FDS_User_Guide.tex

@@ -791,7 +791,7 @@ \section{Input File Structure}
 \vspace{\baselineskip}
 \begin{table}[ht]
 \begin{center}
-\caption{Namelist Group Reference Table}
+\caption[Namelist Group Reference Table]{Namelist Group Reference Table}
 \label{tbl:namelistgroups}
 \begin{tabular}{|c|l|c|c|}
 \hline
@@ -943,7 +943,7 @@ \subsubsection{Simulation Time Ramp}
 \begin{figure}[ht!]
 \centering
 \includegraphics[width=3.2in]{SCRIPT_FIGURES/ramp_time}
-\caption{An example of ramping the simulation time values.}
+\caption[Ramping simulation time values]{An example of ramping the simulation time values.}
 \label{fig:ramp_time}
 \end{figure}
 
@@ -1003,7 +1003,7 @@ \subsection{Multiple Meshes}
 
 \begin{figure}[ht!]
 \includegraphics[width=\textwidth]{FIGURES/hallways}
-\caption{An example of a multiple-mesh geometry.}
+\caption[Multiple-mesh geometry]{An example of a multiple-mesh geometry.}
 \label{fig:domain}
 \end{figure}
 
@@ -1312,7 +1312,7 @@ \subsection{Method for avoiding mesh interfaces in blockage outline view}
 outlines drawn at blockage edges and mesh interfaces&outlines drawn as specified in the input file
 \end{tabular}
 \end{center}
-\caption[Blockage outlines drawn at mesh interfaces and as specified in the input file.]{Blockage outlines drawn at mesh interfaces and as specified in the input file.}
+\caption[Blockage outlines at mesh interfaces and as specified in the input file]{Blockage outlines drawn at mesh interfaces and as specified in the input file.}
 \label{fig:outlinehack}%
 \end{figure}
 
@@ -2765,7 +2765,7 @@ \section{Specified Heat Release Rate}
 \begin{figure}[ht]
 \centering
 \includegraphics[width=3.2in]{SCRIPT_FIGURES/multiple_reac_hrrpua}
-\caption[Demonstration of specifying HRRPUA with multiple reactions.]{Demonstration of specifying HRRPUA with multiple reactions.}
+\caption[Specifying HRRPUA with multiple reactions]{Demonstration of specifying HRRPUA with multiple reactions.}
 \label{fig:mulitple_reac_hrrpua}
 \end{figure}
 
@@ -2864,7 +2864,7 @@ \subsection{Scaling Pyrolysis (SPyro) Model: Scaled Burning Rate from Cone Data}
 \begin{figure}[ht]
 \centering
 \includegraphics[width=3.2in]{SCRIPT_FIGURES/spyro_cone_demo}
-\caption[Demonstration of extrapolating cone test data to other heat fluxes.]{Demonstration of extrapolating cone test data to other heat fluxes.}
+\caption[Extrapolating cone test data to other heat fluxes]{Demonstration of extrapolating cone test data to other heat fluxes.}
 \label{fig:spyro_cone_demo}
 \end{figure}
 
@@ -6231,7 +6231,7 @@ \subsection{Drag}
 
 \begin{table}[ht]
 \begin{center}
-\caption{Drag laws available in FDS}
+\caption[Drag laws available in FDS]{Drag laws available in FDS}
 \label{tbl:draglaws}
 \begin{tabular}{|c|c|}
 \hline
@@ -8881,14 +8881,14 @@ \section{Simulation Mode}
 
 \begin{table}[ht]
 \centering
-\caption{Parameters effected by \ct{SIMULATION_MODE}.}
+\caption[Parameters effected by \ct{SIMULATION_MODE}]{Parameters effected by \ct{SIMULATION_MODE}.}
 \label{tbl:SIMULATION_MODE}
 \begin{tabular}{|l|c|c|c|c|c|}
 \hline
-Key Parameter                          & Section                        & \ct{'DNS'}   & \ct{'LES'}    & \ct{'VLES'}      & \ct{'SVLES'}    \\ \hline \hline
-\ct{CFL_VELOCITY_NORM}              & \ref{info:CFL}                 & 1             & 1              & 2                 & 3                \\ \hline
-\ct{CHECK_VN}                        & \ref{info:VN}                  & T             & T              & T                 & F                \\ \hline
-\ct{FLUX_LIMITER}                    & \ref{info:flux_limiters}       & \ct{'CHARM'} & \ct{'CHARM'}  & \ct{'SUPERBEE'}  & \ct{'SUPERBEE'} \\ \hline
+Key Parameter                      & Section                        & \ct{'DNS'}    & \ct{'LES'}     & \ct{'VLES'}       & \ct{'SVLES'}     \\ \hline \hline
+\ct{CFL_VELOCITY_NORM}             & \ref{info:CFL}                 & 1             & 1              & 2                 & 3                \\ \hline
+\ct{CHECK_VN}                      & \ref{info:VN}                  & T             & T              & T                 & F                \\ \hline
+\ct{FLUX_LIMITER}                  & \ref{info:flux_limiters}       & \ct{'CHARM'}  & \ct{'CHARM'}   & \ct{'SUPERBEE'}   & \ct{'SUPERBEE'}  \\ \hline
 \ct{CONSTANT_SPECIFIC_HEAT_RATIO}  & \ref{info:Enthalpy}            & F             & F              & F                 & T                \\ \hline
 \ct{EXTINCTION_MODEL}              & ~\ref{info:extinction}         & 2             & 2              & 1                 & 1                \\ \hline
 \end{tabular}
@@ -14458,7 +14458,7 @@ \section{FDS Source Code}
 
 \begin{table}[ht]
 \begin{center}
-\caption{FDS source code files}
+\caption[FDS source code files]{FDS source code files}
 \label{tab:sourcefiles}
 \vspace{.1in}
 \begin{tabular}{|l|l|}
@@ -14869,7 +14869,6 @@ \section{FDS GEOM I/O binary format ({\tt .bingeom})}
 WRITE(LU_BINGEOM) FACES(1:3*N_FACES)
 WRITE(LU_BINGEOM) SURFS(1:N_FACES)
 WRITE(LU_BINGEOM) VOLUS(1:4*N_VOLUS)
-
 \end{lstlisting}
 
 \noindent where:
@@ -14944,23 +14943,22 @@ \section{FDS HVAC I/O binary format}
 \label{inout:binhvac}
 The HVAC outputs under the namelist group \ct{HVAC} are written out unformatted to the file \ct{CHID.hvac}. These files are written out from \ct{dump.f90} with the following lines:
 \begin{lstlisting}
-      WRITE(LU_HVAC) N_NODE_OUT, N_NODE_QUANTITY, N_DUCT_OUT, N_DUCT_QUANTITY
-      WRITE(LU_HVAC) DUCT_CELL(1:N_DUCT_OUT)
-
-      WRITE(LU_HVAC) TIME
-    DO N=1,N_NODE_OUT
-       WRITE(LU_HVAC) OUTVAL_N(1:N_NODE_QUANTITY)
-    ENDDO
-      DO N=1,N_DUCT_OUT
-         IF (DUCT(N)%N_CELLS > 0) THEN
-        DO N=1,DUCT(N)%N_CELLS
-             WRITE(LU_HVAC) OUTVAL_D(1:N_DUCT_QUANTITY)
-          ENDDO
-       ELSE
-          WRITE(LU_HVAC) OUTVAL_D(1:N_DUCT_QUANTITY)
-       ENDIF
-    ENDDO
+WRITE(LU_HVAC) N_NODE_OUT, N_NODE_QUANTITY, N_DUCT_OUT, N_DUCT_QUANTITY
+WRITE(LU_HVAC) DUCT_CELL(1:N_DUCT_OUT)
 
+WRITE(LU_HVAC) TIME
+DO N=1,N_NODE_OUT
+   WRITE(LU_HVAC) OUTVAL_N(1:N_NODE_QUANTITY)
+ENDDO
+   DO N=1,N_DUCT_OUT
+      IF (DUCT(N)%N_CELLS > 0) THEN
+      DO N=1,DUCT(N)%N_CELLS
+         WRITE(LU_HVAC) OUTVAL_D(1:N_DUCT_QUANTITY)
+      ENDDO
+   ELSE
+      WRITE(LU_HVAC) OUTVAL_D(1:N_DUCT_QUANTITY)
+   ENDIF
+ENDDO
 \end{lstlisting}
 where \ct{DUCT_CELL} is the number of mass transport cells for a duct (if a duct doesn't have mass transport, then the value 1 is written), and the second block of output is written for each \ct{DT_HVAC} output interval.
 
@@ -14973,7 +14971,7 @@ \section{File Extension Glossary}
 \vspace{\baselineskip}
 \begin{table}[ht]
 \begin{center}
-\caption{File Extension Reference Table}
+\caption[File Extension Reference Table]{File Extension Reference Table}
 \label{tbl:fileextensions}
 \begin{tabular}{|c|l|c|}
 \hline

Manuals/FDS_Validation_Guide/Ceiling_Jet_Chapter.tex

@@ -796,7 +796,7 @@ \subsection{UL/NIJ House Experiments}
 \includegraphics[height=2.15in]{SCRIPT_FIGURES/UL_NIJ_Houses/Two_Story_Gas_4_CJ_LR} &
 \includegraphics[height=2.15in]{SCRIPT_FIGURES/UL_NIJ_Houses/Two_Story_Gas_6_CJ_LR} \\
 \end{tabular*}
-\caption{UL/NIJ Experiments, ceiling jet temperature}
+\caption[UL/NIJ Experiments, ceiling jet temperature]{UL/NIJ Experiments, ceiling jet temperature}
 \label{UL_NIJ_CJ_1}
 \end{figure}
 

Manuals/FDS_Validation_Guide/Experiment_Chapter.tex

@@ -44,7 +44,7 @@ \section{ATF Corridors Experiments}
 
 \begin{figure}[p]
 \includegraphics[width=\textwidth]{FIGURES/ATF_Corridors/ATF_Corridors_Drawing}
-\caption{Geometry of the ATF Corridors Experiments.}
+\caption[Geometry of the ATF Corridors Experiments]{Geometry of the ATF Corridors Experiments.}
 \label{ATF Drawing}
 \end{figure}
 
@@ -433,7 +433,7 @@ \section{Cup Burner Experiments}
 The cup-burner is a widely used experimental apparatus for studying the effectiveness of flame extinguishing agents. Typically, these experiments feature a steady fuel-air co-flow diffusion flame that is established above the cup. The extinguishing agent is gradually introduced into the air stream to determine the minimum concentration of the agent that leads to lift off. One hundred and ten experimental data sets are examined. The data sets include sixteen fuels: acetone, acetylene, benzene, butane, dodecane, ethanol, ethylene, heptane, hexane, hydrogen, methane, methanol, octane, propanol, and toluene, and five inert gases: argon (Ar), carbon dioxide (CO$_2$), helium (He), and nitrogen (N$_2$), and sulfur hexaflouride (SF$_6$). A STANJAN\footnote{STANJAN is a program for chemical equilibrium calculations.} calculation has been performed to determine the equilibrium temperature using the measured minimum extinguishing concentration for each experiment. The calculation assumes constant pressure and enthalpy using a stoichiometric mixture of fuel and air plus agent. For combinations of fuel and agent with multiple experiments, the average extinguishing concentration and the average flame temperature is taken, resulting in forty-six unique combinations of fuel and agent listed in Table~\ref{Cup_Table}.
 
 \begin{table}[p]
-\caption{Summary of Cup Burner Data}
+\caption[Summary of Cup Burner Data]{Summary of Cup Burner Data}
 \label{Cup_Table}
 \small
 \begin{tabular}{|l|c|c|c|c|l|}
@@ -664,7 +664,7 @@ \subsubsection{Modeling Notes}
 
 \begin{figure}[!ht]
 \includegraphics[width=\textwidth]{FIGURES/FHWA_Tunnel/IFAB_photo.jpg}
-\caption{Photograph taken upwind of the fire in one of the FHWA/IFAB experiments.}
+\caption[Upwind of the fire in an FHWA/IFAB experiment]{Photograph taken upwind of the fire in one of the FHWA/IFAB experiments.}
 \label{IFAB_photo}
 \end{figure}
 
@@ -800,7 +800,7 @@ \section{FM/SNL Experiments}
 %
 %\begin{table}[h!]
 %\centering
-%\caption{Summary of FPRF/HAI Corridor Experiments.}
+%\caption[Summary of FPRF/HAI Corridor Experiments]{Summary of FPRF/HAI Corridor Experiments.}
 %\begin{tabular}{|c|c|c|c|}
 %\hline
 %Test    &  Ceiling Height &  Ceiling Width &  Beam Depth  \\
@@ -888,7 +888,7 @@ \section{Harrison Spill Plumes}
 \begin{figure}[!ht]
 \centering
 \includegraphics[width=5in]{FIGURES/Harrison_Spill_Plumes/Harrison_Spill_Plumes}
-\caption{Geometry of the Harrison Spill Plumes Experiments.}
+\caption[Geometry of the Harrison Spill Plumes Experiments]{Geometry of the Harrison Spill Plumes Experiments.}
 \label{Harrison_Drawing}
 \end{figure}
 
@@ -1035,7 +1035,7 @@ \subsubsection{Modeling Notes}
 
 \begin{table}[h]
 \centering
-\caption{Thermophysical properties.}
+\caption[Thermophysical properties]{Thermophysical properties.}
 \small
 \renewcommand{\arraystretch}{1.2}
 \begin{tabular}{lcccccc}
@@ -1064,7 +1064,7 @@ \subsubsection{Modeling Notes}
 
 \begin{table}[h]
 \centering
-\caption{Kinetic parameters and yields.}
+\caption[Kinetic parameters and yields]{Kinetic parameters and yields.}
 \small
 \renewcommand{\arraystretch}{1.2}
 \begin{tabular}{lcccccccccr}
@@ -1112,7 +1112,7 @@ \section{Lattimer Corridor Ceiling}
 \begin{figure}[!ht]
     \centering
     \includegraphics[width=6in]{FIGURES/Lattimer_Corridor_Ceiling/lattimer_apparatus.png}
-    \caption{Lattimer fire impinging on a corridor ceiling experiments~\cite{Lattimer:FTJ:2013}.}
+    \caption[Lattimer fire impinging on a corridor ceiling experiments]{Lattimer fire impinging on a corridor ceiling experiments~\cite{Lattimer:FTJ:2013}.}
       \label{fig:lattimer}
 \end{figure}
 
@@ -1709,7 +1709,7 @@ \subsection{NIST Reduced Scale Enclosure Experiments, 2007}
 
 \begin{table}[!ht]
 \centering
-\caption{Summary of NIST Reduced-Scale Experiments, 2007.}
+\caption[Summary of NIST Reduced-Scale Experiments, 2007]{Summary of NIST Reduced-Scale Experiments, 2007.}
 \begin{tabular}{|c|c|c|c|c|c|}
 \hline
 Test   &  Fuel         &  Fuel           & Peak        &  Burner       &  Doorway          \\
@@ -1973,7 +1973,7 @@ \subsection{Cabinet Effects}
 The test matrix is as follows:
 \begin{table}[!ht]
 \centering
-\caption{Summary of NIST/NRC Cabinet Experiments.}
+\caption[Summary of NIST/NRC Cabinet Experiments]{Summary of NIST/NRC Cabinet Experiments.}
 \begin{tabular}{|c|c|c|c|l|l|}
 \hline
 Test   & Cabinet    & Front Door & Top Vents        & Upper Side Vents                   & HRR (kW)               \\ \hline \hline
@@ -2215,7 +2215,7 @@ \section{NIST Soot Deposition Gauge}
 
 \begin{table}[h!]
    \centering
-   \caption{Experiment Details for Gravimetric Measurements of Soot Deposition}
+   \caption[Experiment Details for Gravimetric Measurements of Soot Deposition]{Experiment Details for Gravimetric Measurements of Soot Deposition}
       \begin{tabular}{|c|c|c|c|}
          \hline
       Test no. & Flow Speed & $\Delta$T & Inlet Soot Conc.  \\
@@ -2320,7 +2320,7 @@ \subsubsection{Thermocouples}
 
 \begin{table}[h!]
 \centering
-\caption{Heights of the thermocouples above the floor of each level of the enclosure}
+\caption[Heights of the thermocouples above the floor]{Heights of the thermocouples above the floor of each level of the enclosure}
 \begin{tabular}{|c|c|c|c|c|c|c|c|c|c|c|c|c|c|c|c|c|}
 \hline
 Floor 2 TC's   & 1& 2& 3 & 4& 5& 6& 7&8\\ \hline
@@ -2337,7 +2337,7 @@ \subsubsection{Test Procedure}
 
 \begin{table}[h!]
 \centering
-\caption{Vent State by Experiment: Time Opened}
+\caption[Vent State by Experiment: Time Opened]{Vent State by Experiment: Time Opened}
 \begin{tabular}{|c|c|c|c|c|c|c|c|c|c|}
 \hline
 Test & Front    & Left    & Right     & Left     & Right   & Left         & Right        & Right   & Roof    \\
@@ -2414,13 +2414,13 @@ \section{NRCC Smoke Tower Experiments}
 %
 %\begin{figure}[ht]
 %%\includegraphics[width=5.in]{FIGURES/NRL_Confined_Space/confined_space_hvac_layout}
-%\caption{Confined space HVAC system layouts.}
+%\caption[Confined space HVAC system layouts]{Confined space HVAC system layouts.}
 %\label{confined_HVAC}
 %\end{figure}
 %
 %\begin{figure}[ht]
 %%\includegraphics[width=5.in]{FIGURES/NRL_Confined_Space/confined_space_bypass}
-%\caption{Confined space bypass ducts.}
+%\caption[Confined space bypass ducts]{Confined space bypass ducts.}
 %\label{confined_bypass}
 %\end{figure}
 %
@@ -3032,7 +3032,7 @@ \section{UL/NIST Vent Experiments}
 
 \begin{figure}[ht]
 \includegraphics[width=\textwidth]{FIGURES/UL_NIST_Vents/UL_NIST_Vents_Drawing}
-\caption{Geometry of the UL/NIST Experiments.}
+\caption[Geometry of the UL/NIST Experiments]{Geometry of the UL/NIST Experiments.}
 \label{UL_NIST_Drawing}
 \end{figure}
 
@@ -3362,7 +3362,7 @@ \section{UL/NIJ House Experiments}
 
 \begin{figure}[p]
 \includegraphics[width=\textwidth]{FIGURES/UL_NIJ_Houses/UL_NIJ_Colonial_layout}
-\caption{Geometry of UL NIJ Colonial-style House}
+\caption[Geometry of UL NIJ Colonial-style House]{Geometry of UL NIJ Colonial-style House}
 \label{Colonial_layout}
 \end{figure}
 
@@ -3543,7 +3543,7 @@ \section{UMD SBI Experiment}
 
 \begin{figure}[!ht]
 \includegraphics[width=\textwidth]{FIGURES/UMD_SBI/UMDCornerFireSpreadSetup}
-\caption[Schematic diagram of the UMD SBI experiment.]{Schematic diagram of the UMD SBI experiment.}
+\caption[Schematic diagram of the UMD SBI experiment]{Schematic diagram of the UMD SBI experiment.}
 \label{UMD_SBI_Schematic}
 \end{figure}
 
@@ -3765,7 +3765,7 @@ \section{Wasson Impinging Plumes}
 \begin{figure}[htb!]
     \centering
     \includegraphics[width=6in]{FIGURES/Wasson_Impinging_Plumes/wasson_apparatus_01.png}
-    \caption{Wasson fire impinging on an unconfined ceiling~\cite{Wasson2014:Thesis}.}
+    \caption[Wasson fire impinging on an unconfined ceiling]{Wasson fire impinging on an unconfined ceiling~\cite{Wasson2014:Thesis}.}
     \label{Wasson_Impinging_Plumes_fig}
 \end{figure}
 

Manuals/FDS_Validation_Guide/Heat_Flux_Chapter.tex

@@ -2350,7 +2350,7 @@ \subsection{UMD Line Burner}
 \begin{figure}[h!]
 \centering
 \includegraphics[height=3in]{FIGURES/UMD_Line_Burner/integrated_intensity}
-\caption{UMD Line Burner contour of integrated radiation intensity.}
+\caption[UMD Line Burner contour of integrated radiation intensity]{UMD Line Burner contour of integrated radiation intensity.}
 \label{fig_umd_integrated_intensity}
 \end{figure}
 

Manuals/FDS_Verification_Guide/FDS_Verification_Guide.tex

@@ -3023,7 +3023,7 @@ \section{Radiation inside a Box (\texorpdfstring{\ct{radiation_box}}{radiation\_
 \begin{figure}[ht]
 \centering
 \includegraphics[width=4.0in]{FIGURES/box}
-\caption{\label{fig_box_radiation} Radiation inside a box geometry.}
+\caption[Radiation inside a box geometry]{\label{fig_box_radiation} Radiation inside a box geometry.}
 \end{figure}
 The configuration factors are calculated at the diagonal of the cold wall opposite to the hot wall. The exact values of the configuration factor from plane element $\d A$ to parallel rectangle $H$ are calculated using the analytical solution~\cite{Siegel:1}
 \begin{center}
@@ -3044,7 +3044,7 @@ \section{Radiation inside a Box (\texorpdfstring{\ct{radiation_box}}{radiation\_
 \includegraphics[height=2.2in]{SCRIPT_FIGURES/radiation_box_20} &
 \includegraphics[height=2.2in]{SCRIPT_FIGURES/radiation_box_100}
 \end{tabular*}
-\caption{Incident heat flux.}\label{fig_incident_heat_flux}
+\caption[Incident heat flux]{Incident heat flux.}\label{fig_incident_heat_flux}
 \end{figure}
 
 The results provide an illustration of numerical errors due to both angular resolution and spatial resolution. With 20$^3$ cells (5-cm spatial resolution), the discrepancies between the FDS and analytical solutions decrease when increasing the number of radiation angles used in the Radiation Transfer Equation (RTE) solver: this decrease may be explained by the increasingly accurate description of the angular region occupied by the hot wall when viewed from the selected opposite wall locations. The results also show that at 5-cm spatial resolution (20$^3$ cells), the discrepancies between the FDS and analytical solutions do not totally vanish and feature a residual error of approximately 10$\%$ even when using a large number of radiation angles: this residual error may be explained by inaccuracies in the numerical description of the configuration factors (configuration factors are defined as spatial integrals over the hot wall surface of an expression that features two cosine angles and a separation distance; the implicit evaluation of configuration factors in the RTE solver is subject to spatial integration errors). Consistent with this explanation, the results show that at 1-cm spatial resolution (100$^3$ cells), the discrepancies between the FDS and analytical solutions decrease to very small levels and feature a residual error of less than 1$\%$.