Index: dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.pdf =================================================================== diff -u -r802 -r867 Binary files differ Index: dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex =================================================================== diff -u -r802 -r867 --- dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex (.../DAM Engine - Technical Design.tex) (revision 802) +++ dam engine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex (.../DAM Engine - Technical Design.tex) (revision 867) @@ -23,7 +23,7 @@ \classification{-} \date{Jun. 2017} -\version{0.3} +\version{0.4} \keywords{Dike, safety assessment, design, software, macro stability, piping} @@ -34,7 +34,7 @@ \textbf{\footnotesize{Samenvatting}} \\ Dit document bevat het technisch ontwerp voor \ProgramName, een software module die een gebruiker in staat stelt om voor een dijktraject berekeningen uit te voeren voor verschillende faalmechanismen, waaronder macrostabiliteit en piping.} -\versioni{0.3} +\versioni{0.4} \datei{Mar 2017} \authori{Tom The} \revieweri{John Bokma \newline Andr\'e Grijze} @@ -107,6 +107,13 @@ \label{sec:Revision03} Adapted based on review of this document by John Bokma. +\subsection{Revision 0.4} +\label{sec:Revision04} +\begin{itemize} + \item Updated the interface description of the failure mechanism wrapper. + \item Added a chapter on adding a new Failure Mechanism. +\end{itemize} + %------------------------------------------------------------------------------ \chapter{System Architecture} \label{chapterSystemArchitecture} @@ -299,15 +306,15 @@ \subsection{Failure mechanisms} \label{sec:FailureMechanisms} The failure mechanisms are treated as external libraries. Some failure mechanisms were part of the source of the original DAM program. -With the new architecture of \ProgramName this will longer be the case. +With the new architecture of \ProgramName this will no longer be the case. These failure mechanisms will be placed in a DAM failure mechanisms library, that is not part of \ProgramName anymore. The following failure mechanisms are currently supported by the original DAM program: \begin{itemize} - \item Piping Bligh (not opensource) - \item Piping Sellmeijer VNK (not opensource) - \item Piping Sellmeijer 2 forces (not opensource) - \item D-Geo Stability inward (not opensource, but commerical) - \item D-Geo Stability outward (not opensource, but commerical) + \item Piping Bligh (not opensource). + \item Piping Sellmeijer VNK (not opensource). + \item Piping Sellmeijer 4 forces (not opensource). + \item D-Geo Stability inward (not opensource, but commerical). + \item D-Geo Stability outward (not opensource, but commerical). \end{itemize} After the original failure mechanisms have been implemented, the new WBI failure mechanisms will be added: @@ -361,18 +368,18 @@ \section{Type enumerations} \label{sec:TypeEnumerations} \subsection{MainMechanismType} \begin{itemize} - \item Macrostability inward - \item Macrostability outward - \item Piping + \item Macrostability inward. + \item Macrostability outward. + \item Piping. \end{itemize} \section{Scenarios} \label{sec:Scenarios} -Scenarios are widely (a)bused within DAM. It is good to define in which context scenarios are used and how they are to be called. Simply using the word scenario is not enough. +The verb Scenarios is widely (ab)used within DAM. It is good to define in which context scenarios are used and how they are to be called. Simply using the word scenario is not enough. Within DAM we have 3 types of scenarios: \begin{itemize} - \item Subsoil scenario - \item Design scenario - \item Regional scenario + \item Subsoil scenario. + \item Design scenario. + \item Regional scenario. \end{itemize} \subsection{Subsoil scenario} @@ -746,7 +753,26 @@ public SendMessageDelegate SendMessageDelegate \newline public UserAbortDelegate UserAbortDelegate \newline } + %------------------------------------------------------------------------------ +\chapter{Adding a Failure Mechanism} \label{chapterAddingFailureMechanism} +Adding a new failure mechanism to \ProgramName is something that should be releative easy to do. The architecture of \ProgramnName has been setup in a way that all failure mechanism specific code is put as much as possible in 1 place. + +\section{Failure Mechanism Wrapper} +\label{sec:FailureMechanismWrapper} + +\section{Creating an Instance of a Failure Mechanism Wrapper} +\label{sec:CreatingInstanceFailureMechanismWrapper} + +\section{Adding Failure Mechanism Specific Data to Data Model} +\label{sec:AddingFailureMechanismSpecificDataToDataModel} + +\section{Adding Failure Mechanism Specific Data to XML Input} +\label{sec:AddingFailureMechanismSpecificDataToXmlInput} + +\section{Adding Failure Mechanism Specific Data to XML Output} +\label{sec:AddingFailureMechanismSpecificDataToXmlOutput} +%------------------------------------------------------------------------------ \chapter{Literature} \label{chapterLiterature} \bibliography{../DAM_references/dam_references}