Index: dam kernel/trunk/doc/Dam kernel - Technical Design/DAM kernel - Technical Design.tex =================================================================== diff -u --- dam kernel/trunk/doc/Dam kernel - Technical Design/DAM kernel - Technical Design.tex (revision 0) +++ dam kernel/trunk/doc/Dam kernel - Technical Design/DAM kernel - Technical Design.tex (revision 90) @@ -0,0 +1,177 @@ +\documentclass[signature]{deltares_manual} +\usepackage[titletoc]{appendix} + +\renewcommand\BackgroundPicChapter{ + \put(0,0){ + \parbox[b][\paperheight]{\paperwidth}{% + \vspace{4\baselineskip} + \hspace{220mm} + \includegraphics[width=15mm]{pictures/algemeen-strookje20mm.jpg} + \vfill + } + } +} +\renewcommand{\contactsalesandsupport}{ + \textbf{Contact:}\\ + \begin{tabular}[t]{@{}p{0.50\textwidth}p{0.50\textwidth}} + \vspace*{-1.5\baselineskip} + \begin{tabbing} +Deltares \\ +Boussinesqweg 1 \\ +2629 HV Delft \\ +P.O. 177 \\ +2600 MH Delft \\ +The Netherlands \\ + \end{tabbing} + & + \vspace*{-1.5\baselineskip} + \begin{tabbing} + telephone: \= +31\,88\,335\,8273 \\ + www: \> https://www.deltares.nl \\ + \end{tabbing} + \end{tabular} +} + +%----------------------------------------------- + +\begin{document} +\pagestyle{empty} +\includepdf[pages=1, offset=72 -70]{pictures/dam_cover_technical_design.pdf} % links-rechts past precies +\cleardoublepage +% + +\newcommand{\ProgramName}{DAM kernel} +\newcommand{\ProgramNamePlusSpace}{DAM kernel } + +\title{\ProgramName} +\manualtype{Technical Design} +\subtitle{} +\projectnumber{1210702-000} +\client{Deltares - Geo engineering DKS} +\reference{1210702-000-GEO-0004} +\classification{-} + +\date{Jan. 2017} +\version{0.1} + +\keywords{Dike, safety assessment, design, software, macro stability, piping} + +\references{Refer to \autoref{chapter5}.} + +\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.\\ +\\ +\textbf{\footnotesize{Samenvatting}} \\ +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{Maya Sule} + +\status{draft} + + +\deltarestitle + + +%------------------------------------------------------------------------------ +\chapter{Introduction} \label{chapter1} + +\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 +\ProgramNamePlusSpace - Architecture Overall \newline \citep{DAM_ArchitectureOverall} & Description of overall architecture of \ProgramNamePlusSpace and its components. \\ \hline +\ProgramNamePlusSpace- Functional Design \newline \citep{DAMKernel_FunctionalDesign} & Description of the requirements and functional design. \\ \hline +\ProgramNamePlusSpace - Technical Design (this document) \newline \citep{DAMKernel_TechnicalDesign}& Description of the implementation of the technical design of \ProgramName. \\ \hline +\ProgramNamePlusSpace - Technical documentation \newline \citep{DAMKernel_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline +\ProgramNamePlusSpace - Test Plan \newline \citep{DAMKernel_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline +\ProgramNamePlusSpace - Test Report \newline \citep{DAMKernel_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline +\end{tabular} +\end{table} + + +%------------------------------------------------------------------------------ +\chapter{System Architecture} \label{chapter2} + +\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. + +\begin{figure}[H] + \begin{center} + \includegraphics[width=15cm]{pictures/DamComponents.pdf} + \end{center} + + \caption{\small \ProgramNamePlusSpace and its components.} + \label{fig-DamComponents} +\end{figure} + +The arrows illustrate the dependencies of the components. + + + +%------------------------------------------------------------------------------ +\chapter{Architectural Choices} \label{chapter3} + +\section{External libraries and components} \label{sec:3.1} +\ProgramNamePlusSpace uses third-party libraries and components. Only open sources and free components, that are free to redistribute are allowed to be used. + +Furthermore \ProgramNamePlusSpace uses the Delta Shell Light (DSL) library, that is developed by Deltares. + +\section{DSL} \label{sec:3.2} +The \ProgramNamePlusSpace only uses part (the non-UI modules) of the DSL library +\begin{itemize} + \item DSL-Core + \item DSL-Probabilistic + \item DSL-Geo +\end{itemize} + +\section{Other libraries} \label{sec:3.3} +Other libraries taht are used bij the \ProgramNamePlusSpace are: +\begin{itemize} + \item Math.Net: mathematical library +\end{itemize} + + + + +%------------------------------------------------------------------------------ +\chapter{Data Model} \label{chapter4} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum + + +%------------------------------------------------------------------------------ +\chapter{Data Description} \label{chapter5} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum + + +%------------------------------------------------------------------------------ +\chapter{Literature} \label{chapter6} + +\bibliography{../DAM_references/dam_references} + + + +\cleardoublepage + +\pagestyle{empty} +\cleardoublepage +\mbox{} +\includepdf[pages=2, offset=-72 -70]{pictures/dam_cover_technical_design.pdf} % links-rechts past precies + +%------------------------------------------------------------------------------ +\end{document} Index: dam kernel/trunk/doc/Dam kernel - Technical Design/DAM kernel - Technical Design.tcp =================================================================== diff -u --- dam kernel/trunk/doc/Dam kernel - Technical Design/DAM kernel - Technical Design.tcp (revision 0) +++ dam kernel/trunk/doc/Dam kernel - Technical Design/DAM kernel - Technical Design.tcp (revision 90) @@ -0,0 +1,12 @@ +[FormatInfo] +Type=TeXnicCenterProjectInformation +Version=4 + +[ProjectInfo] +MainFile=BM GrasBuitentalud - Test Plan.tex +UseBibTeX=1 +UseMakeIndex=1 +ActiveProfile=LaTeX ⇨ PDF +ProjectLanguage=en +ProjectDialect=US + Index: dam kernel/trunk/doc/Dam kernel - Technical Design/pictures/dam_cover_technical_design.pdf =================================================================== diff -u Binary files differ Index: dam kernel/trunk/doc/Dam kernel - Technical Design/pictures/algemeen-strookje20mm.jpg =================================================================== diff -u Binary files differ Index: dam kernel/trunk/doc/Dam kernel - Technical Design/pictures/DAMComponents.pdf =================================================================== diff -u Binary files differ