\chapter{Introduction} 
\label{chapterIntroduction}

\section{Purpose and scope of this document} \label{sec:PurposeAndScope}

This document contains the functional design for the \ProgramName. The DAMLive is designed for the automated calculation of the strength of dikes with the use of the DAM Engine.
DAM was developed by Deltares with and for STOWA for all water authorities.
This document describes requirements and functional design of \ProgramName. 
What will actually will be implemented depends on the requirements of the clients using this \ProgramName.
If some functionality is not (yet) needed, then that part does not need to be implemented. 

\subsection{Future options}
\label{sec:FutureOptions}
As mentioned above this document contains some options that will not be implemented in the first release, but are foreseen to be implemented in the near future. Therefore although sometimes a reference will be made to these options, these will not be described in detail yet.

That applies in particular to the following subjects:
\begin{itemize}
	\item ----
	\item ----
\end{itemize}

\section{Other system documents} 
\label{sec:SystemDocuments}

The full documentation on the program comprises the following documents.

\renewcommand{\arraystretch}{1.3}

\begin{table}[H]
%\caption{xxx}
%\label{xxx}
\begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline
\textbf{Title} & \textbf{Content} \\ \hline
DAM Architecture Overall \newline \citep{DAM_ArchitectureOverall} & Description of overall architecture of DAM and its components. \\ \hline
\ProgramName - Technical Design\newline \citep{DAMEngine_TechnicalDesign}& Description of the implementation of the technical design of DAM Engine. \\ \hline
DAM Engine - Technical documentation \newline \citep{DAMEngine_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline
DAM UI - Functional Design\newline  \citep{DAMUI_FunctionalDesign} & Description of the requirements and functional design. \\ \hline
Architecture Guidelines \newline \citep{ArchitectureGuidelines} & Architecture guidelines that are used by DSC-Deltares. \\ \hline
\end{tabular}
\caption{\small \ProgramName system documents.}
\label{table-SystemDocuments}
\end{table}

\section{Document revisions}
\label{sec:DocumentRevisions}
\subsection{Revision 0.1}
\label{sec:Revision01}
First concept of the document.

\chapter{Functional requirements}

Main purpose of \ProgramName
DAMLive can combine a dam project with sensor data to calculation input for the DAM Engine. The sensor data is provided by an external application, i.e. FEWS. After calculations made by DAM Engine DAMLive can produce an output files with results. These results can be imported by other external applications.

\section{REQ Data.Input}\label{sec:REQDataInput}
\ProgramName needs a DAM project file (*.damx) and sensordata.
The generation of the DAM project file is described in the Functional Design of DAM UI, see \citep{DAMUI_FunctionalDesign}.
In this DAM project information containing situation information about the sensors; where are the sensors placed and for which PL-line is the data used.

The sensordata itself (the measurements0 must be provided in xml format.
For DAM-FEWS is this described in the FEWS Public Wiki: https://publicwiki.deltares.nl/display/FEWSDOC/Delft-Fews+Published+Interface+timeseries+Format+Import.

\section{REQ Calc.Settings}\label{sec:REQCalcSettings}
\ProgramName can use the kernels which are used by DAM Engine. Via a xml file ables \ProgramName the user to change calculations settings such as failure mechanisms (kernel) and models. The xsd is described in \autoref{sec:DamLiveCalculationParameters}.
The available failure mechanisms and models are described in the Functional Design of DAM Engine \citep{
DAMEngine_FunctionalDesign}.\newline
Available for DAM live are:

\begin{table}[H]
\begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline
\textbf{Parameter} & \textbf{Options} \\ \hline
Calculation Module & Stability inside\newline Stability outside\newline Piping Bligh\newline PipingWTI\newline PipingSellmeijer \\ \hline
Calculation model & Bishop\newline UpliftVan  \\ \hline
Search method & Grid \\ \hline
Use zones & Use of Forbidden zones: yes or no \\ \hline
Forbidden zone factor & Value between 0 and 1 \\ \hline
\end{tabular}
\caption{\small \ProgramName system documents.}
\label{table-SystemDocuments}
\end{table}

 
\section{REQ Data.Output}\label{sec:REQDataOutput}
\ProgramName can produce output files.

\section{REQ Save.Project}\label{sec:REQSaveProject}
The \ProgramName can save a project.
