\documentclass{deltares_report}
\usepackage[titletoc]{appendix}
%-----------------------------------------------

\begin{document}
\pagestyle{empty}
\cleardoublepage
%

\newcommand{\ProgramName}{DAM UI\xspace}
\newcommand{\ProgramNamePlusSpace}{DAM UI }

\title{\ProgramName}
\subtitle{Technical Design}
\projectnumber{1210702-000}
\client{Deltares - Geo engineering DKS}
\reference{1210702-000-GEO-0009}
\classification{-}
\author{Tom The, John Bokma}
\partner{-}
\contact{tom.the@deltares.nl, john.bokma@deltares.nl}
\documentid{-}
\organisationi{Deltares}
\publisheri{Deltares - DSC}

\date{April 2022}
\version{0.2}

\keywords{Dike, safety assessment, design, software, macro stability, piping}

\summary{This document contains the technical design for \ProgramName, an application that computes the strength of a complete dikering with respect to several failure mechnanisms, such as macro stability and piping.\newline
\newline
\textbf{\footnotesize{Samenvatting}} \newline
Dit document bevat het technisch ontwerp voor \ProgramName, een User Interface applicatie die een gebruiker in staat stelt om voor een dijktraject berekeningen uit te voeren voor verschillende faalmechanismen, waaronder macrostabiliteit en piping.}

\versioni{0.1}
\datei{Jan 2017}
\authori{Tom The}
\revieweri{John Bokma}
\approvali{Hans van Putten}

\versionii{0.2}
\dateii{April 2022}
\authorii{Tom The, John Bokma}
\reviewerii{Walter Austmann}
\approvalii{Arthur Baart}

\status{draft}
\disclaimer{This is a draft report, intended for discussion purposes only. No part of this report may be relied upon by either principals or third parties.}

\deltarestitle


%------------------------------------------------------------------------------
\chapter{Introduction} \label{chapterIntroduction}

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

This document contains the technical design for the standalone program \ProgramName, a software package for the automated calculation of the strength of dikes. DAM was developed by Deltares with and for STOWA for all water authorities.


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

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
Functional Design \newline \citep{DAMUI_FunctionalDesign} & Description of the requirements and functional design of \ProgramName. \\ \hline
Technical Design (this document) \newline \citep{DAMUI_TechnicalDesign}& Description of the technical design of \ProgramName. \\ \hline
Technical documentation \newline \citep{DAMUI_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline
Test Plan \newline \citep{DAMUI_TestPlan} & Description of the different regression and acceptation tests, including target values, of \ProgramName.  \\ \hline
Test Report \newline \citep{DAMUI_TestReport} & Description of the test results (benchmarks and test scripts),of \ProgramName. \\ \hline
User Manual  \newline \citep{DAMUI_Manual} & Description of the different functionalites available in the \textit{User Interface} and background information. \\ \hline
\end{tabular}
\caption{\small \ProgramNamePlusSpace system documents.}
\label{table-SystemDocuments}
\end{table}


%------------------------------------------------------------------------------
\chapter{System Architecture} \label{chapterSystemArchitecture}

\section{DAM components} \label{sec:DamComponents}

\ProgramNamePlusSpace is part of the whole DAM system that contains several components. Please see \autoref{fig-DamComponents} for an overview of the components of DAM. In \citep{DAM_ArchitectureOverall} a description of the overall architecture of the DAM system can be found.

\begin{figure}[H]
  \begin{center}
    \includegraphics[width=15cm]{pictures/DamComponents.pdf}
  \end{center}
  \caption{\small DAM and its components.}
  \label{fig-DamComponents}
\end{figure}

The arrows illustrate the dependencies of the components.

\section{DAM UI components} \label{sec:DamUIComponents}

See \autoref{fig-DAMUIMainModules} for an overview of the components of \ProgramNamePlusSpace. 
\begin{figure}[H]
	\begin{center}
		\includegraphics[width=15cm]{pictures/DAM UI Main Modules.pdf}
	\end{center}
	\caption{\small \ProgramNamePlusSpace components.}
	\label{fig-DAMUIMainModules}
\end{figure}

\section{DAM UI Dataflow} \label{sec:DamUIDataflow}

See \autoref{fig-DAMUIDataflow} for an overview of the dataflow in \ProgramNamePlusSpace. 
\begin{figure}[H]
	\begin{center}
		\includegraphics[width=15cm]{pictures/DAM UI Main Dataflow.pdf}
	\end{center}
	\caption{\small \ProgramNamePlusSpace Dataflow.}
	\label{fig-DAMUIDataflow}
\end{figure}

In case the DAM Engine is used to calculate the macro stability, 
additional output is available in the form of an output file per calculation. 
This file (.stix) holds the resulting slip plan besides to the input and can be used to review the result using D-Stability.
The input files can be used to check/redo the calculation using the UI suitable for the used kernel.

The required input is specified via the MacroStabilityInput object as defined in the C \# wrapper module for the Macro Stability kernel. 
In the communication between Engine and UI, 
the name of the resulting stix file is part of the Design Results of the XML output of the Engine. 
This name of course has to unique and will be created based on the names of the location, scenario and profile combined with the number of the iteration in case of design. 
To indicate its purpose, it ends on "\_result".

Future developments foreseen for the stability calculations include the addition of the bare input for the Macro Stability kernel in order to be able to check the position of the input grid(s).

%------------------------------------------------------------------------------
\chapter{Architectural Choices} \label{chapterArchitecturalChoices}

\todo{Architectural Choices}



%------------------------------------------------------------------------------
\chapter{Data Model}  \label{chapterDataModel}

See \autoref{fig-DAMUIDataModelMain} for an overview of the data model of \ProgramNamePlusSpace. 
\begin{figure}[H]
	\begin{center}
		\includegraphics[width=15cm]{pictures/DAM UI Data Model Main.pdf}
	\end{center}
	\caption{\small \ProgramNamePlusSpace UI Data Model.}
	\label{fig-DAMUIDataModelMain}
\end{figure}



%------------------------------------------------------------------------------
\chapter{Data Description}  \label{chapterDataDescription}

\section{Input}
\todo{Data Description Input}

\section{Results}
First of all,
not all calculations will pass kernel validations or lead to valid results due to errors that occur in the calculations (e.g. uplift does not occur where it is expected). 
Some calculations may be performed but cause warnings.
Using a log manager, 
all these cases are reported back to the user via a log that is to be displayed at the end of the calculation process.
This log is then also saved automatically with a time stamp.
Note that the saved log will not be loaded again in the program itself.  
Finally, the log is cleared at the start of each new calculation process.

The results of the calculations differ per failure mechanism per model. 
An overview of all "single" result parameters is provided by the DAM documentation on the public wiki for DAM (https://publicwiki.deltares.nl/display/DAM/Tabblad+Ontwerpberekeningen).
These results are presented in a table for all performed calculations.

Per individual calculation, 
a property editor provides access to the most important "single" result parameters.
This editor also provided the opportunity for a user to evaluate the calculation and to add notes on it.
This editor may also provide other options such as direct access to external programs to view and recalculate results.
This depends on the Failure mechanism and the model.
For the failure mechanism stability, 
all relevant data (input and output) is available as stix file to enable starting D-Stability of the D-Geo Suite.
This functionality is made available at the push of a button in the editor.

Next to these results parameters, other more complex result data is available for presentation and/or use too. 

For the failure mechanism stability, output data is available for the resulting slip plane. 
This data is used to display that slip plane graphically within \ProgramName itself.
This slip plane is super imposed on the existing geometry as shown in the cross section tab. 

For failure mechanisms piping, 
in case of design with the "Adapt geometry" option, 
a resulting surface line is available together with its (1D) profile. 
This data is written to a separate xml file per calculation with a proper identifiable name which is unique to the individual calculation.
This name is comprised of location name, profile name, scenario name and if need be the iteration number.
For the selected individual result, this adapted surface line is shown as dotted line within \ProgramName super imposed on the existing geometry as shown in the cross section tab.
For this, 
upon selection of an individual calculation result,
the file with the data is read and the resulting surface line is drawn.


%------------------------------------------------------------------------------
\chapter{Module Description}  \label{chapterModuleDescription}

\todo{Module Description}


%------------------------------------------------------------------------------
\chapter{Literature}  \label{chapterLiterature}

\bibliography{../DAM_references/dam_references}

\pagestyle{empty}
\mbox{}

%------------------------------------------------------------------------------
\end{document}
