Index: DamEngine/trunk/doc/Dam Engine - Functional Design/FO.tex =================================================================== diff -u -r3687 -r4963 --- DamEngine/trunk/doc/Dam Engine - Functional Design/FO.tex (.../FO.tex) (revision 3687) +++ DamEngine/trunk/doc/Dam Engine - Functional Design/FO.tex (.../FO.tex) (revision 4963) @@ -5,8 +5,9 @@ This document contains the functional design for the \ProgramName, a computational engine for the automated calculation of the strength of dikes. DAM was developed by Deltares with and for STOWA for all water authorities. -This document describes requirements and functional design of \ProgramName. So it is clear what the purpose of \ProgramName is and which functionaliry -What will actually will be implemented depends on the prioritizing of the requirements by the clients using this \ProgramName. +This document describes requirements and functional design of \ProgramName. +So it is clear what the purpose of \ProgramName is and which functionality should be implemented. +What actually will be implemented depends on the prioritizing of the requirements by the clients using this \ProgramName. If some functionality is not (yet) needed, then that part does not need to be implemented. \subsection{Future options} @@ -47,15 +48,17 @@ \end{table} \section{Document revisions}\label{sec:DocumentRevisions} -\subsection{Revision 0.1} -\label{sec:Revision01} -First concept of the document. +\subsection{Revision 0.4} \label{sec:Revision03} +\todo{Describe new or changed features.}.\newline +\subsection{Revision 0.3} \label{sec:Revision03} +Textual and functional adaptations.\newline \subsection{Revision 0.2} \label{sec:Revision02} Textual adaptations.\newline Assessment is removed from the requirements. {sec:TLDegOfCo} added. -\subsection{Revision 0.3} \label{sec:Revision03} -Textual and functional adaptations.\newline +\subsection{Revision 0.1} +\label{sec:Revision01} +First concept of the document. \chapter{Functional requirements} @@ -64,7 +67,7 @@ User story Design\newline As a user I want to adapt the geometry until given safety for stability or piping is met. -User stort Operational sensors\newline +User story Operational sensors\newline As a user I want to make stability and/or piping calculations with the input from operational sensors. Since most requirements are needed for both user stories, the requirements are classified per theme, not per User story. The themes are: data, calculation and output. Index: DamEngine/trunk/doc/Dam Engine - Functional Design/DAM Engine - Functional Design.tex =================================================================== diff -u -r3788 -r4963 --- DamEngine/trunk/doc/Dam Engine - Functional Design/DAM Engine - Functional Design.tex (.../DAM Engine - Functional Design.tex) (revision 3788) +++ DamEngine/trunk/doc/Dam Engine - Functional Design/DAM Engine - Functional Design.tex (.../DAM Engine - Functional Design.tex) (revision 4963) @@ -27,8 +27,8 @@ \organisationi{Deltares} \publisheri{Deltares - DSC} -\date{Sep. 2022} -\version{0.3} +\date{Dec. 2024} +\version{0.4} \keywords{Dike, safety assessment, design, software, macro stability, piping} @@ -49,6 +49,12 @@ \revieweri{Kin Sun Lam \newline Walter Austmann} \approvali{Leo Voogt} +\versioni{0.4} +\datei{Dec 2024} +\authori{Tom The} +\revieweri{Kin Sun Lam \newline John Bokma} +\approvali{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.} Index: DamEngine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex =================================================================== diff -u -r3812 -r4963 --- DamEngine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex (.../DAM Engine - Technical Design.tex) (revision 3812) +++ DamEngine/trunk/doc/Dam Engine - Technical Design/DAM Engine - Technical Design.tex (.../DAM Engine - Technical Design.tex) (revision 4963) @@ -30,8 +30,8 @@ \organisationi{Deltares} \publisheri{Deltares - DSC} -\date{Sep. 2022} -\version{0.6} +\date{Dec. 2024} +\version{0.7} \keywords{Dike, safety assessment, design, software, macro stability, piping} @@ -105,30 +105,34 @@ \section{Document revisions} \label{sec:DocumentRevisions} -\subsection{Revision 0.1} -\label{sec:Revision01} -First concept of the document. +\subsection{Revision 0.7} +\label{sec:Revision07} +\todo{Adapt to new and changed features.} -\subsection{Revision 0.2} -\label{sec:Revision02} -Adapted based on reviews of this document by Jan Noort and Andr\'e Grijze. +\subsection{Revision 0.6} +\label{sec:Revision06} +Updated for the options of the Macrostability kernel. -\subsection{Revision 0.3} -\label{sec:Revision03} -Adapted based on review of this document by John Bokma. +\subsection{Revision 0.5} +\label{sec:Revision05} +A chapter is added on Failure Mechanism implementations. Furthermore, a description is added of the implementation of the Macrostability kernel. \subsection{Revision 0.4} \label{sec:Revision04} The interface description of the failure mechanism wrapper is updated. Furthermore, a chapter is added on adding a new Failure Mechanism. -\subsection{Revision 0.5} -\label{sec:Revision05} -A chapter is added on Failure Mechanism implementations. Furthermore, a description is added of the implementation of the Macrostability kernel. +\subsection{Revision 0.3} +\label{sec:Revision03} +Adapted based on review of this document by John Bokma. -\subsection{Revision 0.6} -\label{sec:Revision06} -Updated for the options of the Macrostability kernel. +\subsection{Revision 0.2} +\label{sec:Revision02} +Adapted based on reviews of this document by Jan Noort and Andr\'e Grijze. +\subsection{Revision 0.1} +\label{sec:Revision01} +First concept of the document. + %------------------------------------------------------------------------------ \chapter{System Architecture} \label{chapterSystemArchitecture} @@ -230,7 +234,7 @@ \end{figure} \subsection{Dikes NWO calculation} -This is not yet to be implemetend in \ProgramName and therefore this paragraph has not yet been written. +This is not yet to be implementend in \ProgramName and therefore this paragraph has not yet been written. %------------------------------------------------------------------------------ \chapter{Architectural Choices} \label{chapterArchitecturalChoices}