Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions Manuals/CFAST_Users_Guide/Getting_Started_Chapter.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@

\chapter{Getting Started}

The Consolidated Model of Fire and Smoke Transport (CFAST) is documented by four publications: this user's guide, a technical reference guide~\cite{CFAST_Tech_Guide_8}, a verification and validation guide \cite{CFAST_Valid_Guide_8}, and a configuration management guide~\cite{CFAST_Config_Guide_8}. The technical reference guide describes the underlying physical principles, provides a comparison with other models, and includes an evaluation of the model following the guidelines of ASTM~E1355~\cite{CFAST:ASTM:E1355}. The model verification and validation guide documents verification and validation efforts for the model. The configuration management guide documents the processes used during the development and validation of the model. This user's guide describes how to use the model and the input editor CEdit.
The Consolidated Model of Fire and Smoke Transport (CFAST) is documented by four publications: this User's Guide, the Technical Reference Guide~\cite{CFAST_Tech_Guide_8}, the Verification and Validation Guide \cite{CFAST_Valid_Guide_8}, and the Configuration Management Plan~\cite{CFAST_Config_Guide_8}. The Technical Reference Guide describes the underlying physical principles, provides a comparison with other models, and includes an evaluation of the model following the guidelines of ASTM~E1355~\cite{CFAST:ASTM:E1355}. The Verification and Validation Guide documents verification and validation cases and quantifies the model uncertainty. The Configuration Management Plan documents the processes used during the development and validation of the model. The User's Guide describes how to use the model and the input editor CEdit.

\section{Installation}

The installation of CFAST is made up of three programs. The main program, CFAST, is written in Fortran and can be run as a stand-alone command-line application that reads input data from a text file. It has been compiled and run on a number of different operating systems, but the version in the distribution was compiled to run under Windows. The input editor, CEdit, that is distributed with CFAST is designed to run on a Windows platform. Also, the version of the visualization software, Smokeview, is compiled to run on Windows. All of the files associated with CFAST can be obtained at: \url{http://cfast.nist.gov}
The CFAST installation package consists of three programs. The main program, CFAST, is written in Fortran and can be run as a stand-alone command-line application that reads input data from a text file. Supported operating systems include Windows, macOS, and Linux. The input editor, CEdit, writes the text-based input file that is read by CFAST. The visualization program, Smokeview, displays various types of CFAST output. All of the materials associated with CFAST can be obtained at \url{http://cfast.nist.gov}.

The CFAST distribution consists of a self-extracting set-up program for Windows-based personal computers. After downloading the set-up program, double-clicking on the file's icon walks you through a series of steps for installation of the program. The most important part of the installation is the creation of a folder (\path{C:\Program Files\CFAST} by default) in which the CFAST executable files and supplemental data files are installed. Sample input files are found in the \ct{Examples} folder.

CFAST input files are best created and run using a Windows-based input editor called CEdit. Sample input files are provided with the program for new users who are encouraged to first run the sample calculations before attempting to create an input file. To run the model, browse to the location of the CFAST sample input file (default location is in a folder called \ct{Examples} in the installation folder), copy the file named \ct{Users_Guide_Example.in} to a location of your choice, and then double-click on the copied file. This should open the file in the CFAST input editor, CEdit, as shown in Fig.~\ref{primary_screen}.
CFAST input files are best created and run using the input editor CEdit. Sample input files are provided with the program for new users who are encouraged to first run the sample calculations before attempting to create an input file. To run the model, browse to the location of the CFAST sample input file (default location is in a folder called \ct{Examples} in the installation folder), copy the file named \ct{Users_Guide_Example.in} to a location of your choice, and then open the file in the CFAST input editor.
\begin{figure}[h!]
\includegraphics[width=6.5in]{SCRIPT_FIGURES/Environment_Tab}
\caption[The Primary CFAST Input Page]{The Primary CFAST Input Page.}
Expand All @@ -37,8 +35,8 @@ \section{Basic Features}
\item[Mechanical Ventilation] defines forced air ventilation.
\item[Fires] include user specification of the initial fire source and any additional burning objects in one or more of the compartments of the simulation.
\item[Targets] provide the ability to calculate the temperature and net heat flux to objects placed and oriented arbitrarily in the structure.
\item[Detection / Suppression] defines any heat or smoke alarms and sprinklers in the compartments of the simulation.
\item[Visualizations] allows specification of one or more 2-D and 3-D visualizations to be added to the simulation for viewing with Smokeview. Note that these can require significantly more computational time than a basic CFAST simulation without visualizations.
\item[Detection/Suppression] defines any heat or smoke alarms and sprinklers in the compartments of the simulation.
\item[Output] allows specification of one or more 2-D and 3-D visualizations to be added to the simulation for viewing with Smokeview.
\end{description}


Expand All @@ -52,4 +50,4 @@ \section{The View Menu}

\section{The Help Menu}

The Help menu accesses this user's guide, the CFAST web site, or an about dialog box that displays the user license and version of the program.
The Help menu accesses the User's Guide, the CFAST web site, and version information.
Loading