Index: DamOverall/trunk/doc/DAM - Architecture Overall/pictures/DamSVNDamEngineLayout.png =================================================================== diff -u -r873 -r908 Binary files differ Index: DamOverall/trunk/doc/DAM - Architecture Overall/pictures/DamSVNFailureMechanismLayout.png =================================================================== diff -u Binary files differ Index: DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.pdf =================================================================== diff -u -r873 -r908 Binary files differ Index: DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.tex =================================================================== diff -u -r873 -r908 --- DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 873) +++ DamOverall/trunk/doc/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 908) @@ -296,23 +296,24 @@ \label{fig-SVNMainLayout} \end{figure} -The 4 main parts are +The 5 main parts are \begin{itemize} - \item dam clients - the client applications that use the \ProgramName Engine. - \item dam clients library - shared libraries by the \ProgramName clients. - \item dam engine - the computational engine of \ProgramName. - \item doc - general documentation for \ProgramName (like this document). + \item DamClients - the client applications that use the \ProgramName Engine. + \item DamClientsLibrary - shared libraries by the \ProgramName clients. + \item DamFailureMechanisms - the failure mechanisms that were used in the orginalversion of \ProgramName; they will also be used in the \ProgramName Engine. + \item DamEngine - the computational engine of \ProgramName. + \item DamOverall - general documentation for \ProgramName (like this document). \end{itemize} -The maps "`dam clients library"',"`dam engine"', and "`doc"' have their own trunk/branches/tags layout. +The maps "`DamClientsLibrary"', "`DamEngine"' and "`DamOverall"' have their own trunk/branches/tags layout. -The map "'DAM tools"' is for storing independent tools that are not part of \ProgramName itself, but support the work processes of \ProgramName (e.g. Dam Edit Design). +The remaining parts are +\begin{itemize} + \item DamClassic - the orginal (15.1) version of \ProgramName (which has UI and calculation engine in one solution); it has its own trunk/branches/tags layout. + \item DamTools - independent tools that are not part of \ProgramName itself, but support the work processes of \ProgramName (e.g. Dam Edit Design). + \item IssueRelatedData - data which belong to Jira issues; \ProgramName uses Jira as issuetracking system, which supports attachments, but \ProgramName attachments can be very large, so it is better to save the attachments in this location; the attachments are stored in a map with the name of the issue number (e.g. MWDAM-982) + \item ProjectData - used for archiving \ProgramName project data. +\end{itemize} -The map "`dam classic"' is used by the previous implementation of \ProgramName. -The map "`project data"' is for archiving \ProgramName project data. -The map "`Issue related data"' is for storing issue related data. -\ProgramName uses Jira as issuetracking system, which supports attachments, but \ProgramName attachments can be very large, so it is better to save the attachments in this location. -The attachments are stored in a map with the name of the issue number (e.g. MWDAM-982) - \section{\ProgramName repository clients layout} \label{sec:RepositoryClientsLayout} Each \ProgramName client has its own entry in the clients map. In \autoref{fig-SVNClientLayout} the layout of the \ProgramName clients map is shown. @@ -364,13 +365,43 @@ \label{fig-SVNDamEngineLayout} \end{figure} -At this moment the project foreseen to be put in the "`dam engine"' src map are: +At this moment the projects foreseen to be put in the "`dam engine"' src map are: \begin{itemize} - \item Deltares.DamEngine.Data: this map contains pure data classes. - \item Deltares.DamEngine.Controllers: this map contains classea to manipulate above data classes. \item Deltares.DamEngine.Calculators: this map contains classes to perform the actual calculations for the \ProgramName Engine. + \item Deltares.DamEngine.Data: this map contains pure data classes. + \item Deltares.DamEngine.Interface: this map contains classes to interface to the engine. + \item Deltares.DamEngine.Io: this map contains classes performing Input/Ooutput to and from the engine. + \item Deltares.DamEngine.Version: this map contains a class to configure the version number for all classes. \end{itemize} +Each project will has a corresponding test project. +\section{\ProgramName repository Failure Mechanisms} \label{sec:RepositoryDamFailureMechanisms} + +The original \ProgramName implementation had its own failure mechanisms implemented. In the current architecture, the failure mechanisms are not part of the \ProgramName engine itself. They will be implemented as independent kernels. +In \autoref{fig-SVNDamEngineLayout} the layout of the \ProgramName Failure Mechanisms map is shown. + +\begin{figure}[H] + \begin{flushleft} + \includegraphics{pictures/DamSVNFailureMechanismLayout.png} + \end{flushleft} + \caption{\small \ProgramName Failure Mechanisms layout.} + \label{fig-SVNFailureMechanismLayout} +\end{figure} + +As will be the case with other, third party kernels, a wrapper will be written around these kernels, to use them in the \ProgramName engine. These wrappers are a part of the \ProgramName engine. + +At this moment the following failure mechanisms will be put here: +\begin{itemize} + \item Macrostability: this is an implementation of the Delphi D-Geo Stability kernel. + \item Piping: there are 3 different piping methods that are implemented here: + \begin{itemize} + \item Bligh + \item Sellmeijer 4 forces + \item Sellmijer VNK (neural network) + \end{itemize} +\end{itemize} + + \section{\ProgramName repository full layout} \label{sec:RepositoryFullLayout} The full layout of the \ProgramName repository will be as shown in \autoref{fig-SVNLayout}. Index: DamOverall/trunk/doc/DAM - Architecture Overall/pictures/DamSVNMainLayout.png =================================================================== diff -u -r873 -r908 Binary files differ Index: DamOverall/trunk/doc/DAM - Architecture Overall/pictures/DamSVNClientLayout.png =================================================================== diff -u -r873 -r908 Binary files differ Index: DamOverall/trunk/doc/DAM - Architecture Overall/pictures/DamSVNClientLibraryLayout.png =================================================================== diff -u -r873 -r908 Binary files differ Index: DamOverall/trunk/doc/DAM - Architecture Overall/pictures/DamSVNLayout.png =================================================================== diff -u -r873 -r908 Binary files differ