Index: trunk/doc/LaTex/DAM - Technical Design/DAM - Technical Design.tex =================================================================== diff -u -r47 -r117 --- trunk/doc/LaTex/DAM - Technical Design/DAM - Technical Design.tex (.../DAM - Technical Design.tex) (revision 47) +++ trunk/doc/LaTex/DAM - Technical Design/DAM - Technical Design.tex (.../DAM - Technical Design.tex) (revision 117) @@ -1,62 +1,29 @@ -\documentclass[signature]{deltares_manual} +\documentclass[signature]{deltares_report} \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} -} - +\usepackage{lipsum} %----------------------------------------------- \begin{document} \pagestyle{empty} -\includepdf[pages=1, offset=72 -70]{pictures/dam_cover_technical_design.pdf} % links-rechts past precies \cleardoublepage % -\newcommand{\ProgramName}{DAM} -\newcommand{\ProgramNamePlusSpace}{DAM } +\newcommand{\ProgramName}{DAM UI} +\newcommand{\ProgramNamePlusSpace}{DAM UI } \title{\ProgramName} -\manualtype{Technical Design} -\subtitle{} +\subtitle{Technical Design} \projectnumber{1210702-000} \client{Deltares - Geo engineering DKS} -\reference{1210702-000-GEO-0004} +\reference{1210702-000-GEO-0009} \classification{-} \date{Jan. 2017} \version{0.1} \keywords{Dike, safety assessment, design, software, macro stability, piping} -\references{Refer to \autoref{chapter5}.} +\references{Refer to \autoref{chapterLiterature}.} \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.\\ \\ @@ -70,13 +37,13 @@ \approvali{Maya Sule} \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{chapter1} +\chapter{Introduction} \label{chapterIntroduction} \section{Purpose and scope of this document} \label{sec:1.1} @@ -94,56 +61,70 @@ %\label{xxx} \begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline \textbf{Title} & \textbf{Content} \\ \hline -Functional Design \newline \citep{DAM_FunctionalDesign} & Description of the requirements and functional design. \\ \hline -Technical Design (this document) & Description of the implementation of the technical design of \ProgramName. \\ \hline -Technical documentation \newline \citep{DAM_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline -Test Plan \newline \citep{DAM_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline -Test Report \newline \citep{DAM_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline -User Manual \newline \citep{DAM_Manual} & Description of the different functionalites available in the \textit{User Interface} and background information. \\ \hline +Functional Design \newline \citep{DAMUI_FunctionalDesign} & Description of the requirements and functional design. \\ \hline +Technical Design (this document) \newline \citep{DAMUI_TechnicalDesign}& Description of the implementation 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. \\ \hline +Test Report \newline \citep{DAMUI_TestReport} & Description of the test results (benchmarks and test scripts). \\ \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{chapter2} +\chapter{System Architecture} \label{chapterSystemArchitecture} -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 +\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 \ProgramNamePlusSpace and its components.} + \label{fig-DamComponents} +\end{figure} -%------------------------------------------------------------------------------ -\chapter{Architectural Choices} \label{chapter3} +The arrows illustrate the dependencies of the components. -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 Model} \label{chapter4} +\chapter{Architectural Choices} \label{chapterArchitecturalChoices} -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 +\lipsum[1-2] %------------------------------------------------------------------------------ -\chapter{Data Description} \label{chapter5} +\chapter{Data Model} \label{chapterDataModel} -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 +\lipsum[1-2] %------------------------------------------------------------------------------ -\chapter{Literature} \label{chapter6} +\chapter{Data Description} \label{chapterDataDescription} -\bibliography{../DAM_references/dam_references} +\lipsum[1-2] +%------------------------------------------------------------------------------ +\chapter{Module Description} \label{chapterModuleDescription} -\cleardoublepage +\lipsum[1-2] + +%------------------------------------------------------------------------------ +\chapter{Literature} \label{chapterLiterature} + +\bibliography{../DAM_references/dam_references} + \pagestyle{empty} -\cleardoublepage \mbox{} -\includepdf[pages=2, offset=-72 -70]{pictures/dam_cover_technical_design.pdf} % links-rechts past precies %------------------------------------------------------------------------------ \end{document}