Index: DamClients/DamUI/trunk/doc/DAM UI - Technical Design/DAM UI - Technical Design.tex =================================================================== diff -u -r3430 -r3567 --- DamClients/DamUI/trunk/doc/DAM UI - Technical Design/DAM UI - Technical Design.tex (.../DAM UI - Technical Design.tex) (revision 3430) +++ DamClients/DamUI/trunk/doc/DAM UI - Technical Design/DAM UI - Technical Design.tex (.../DAM UI - Technical Design.tex) (revision 3567) @@ -16,19 +16,19 @@ \client{Deltares - Geo engineering DKS} \reference{1210702-000-GEO-0009} \classification{-} -\author{Tom The} +\author{Tom The, John Bokma} \partner{-} -\contact{tom.the@deltares.nl} +\contact{tom.the@deltares.nl, john.bokma@deltares.nl} \documentid{-} \organisationi{Deltares} \publisheri{Deltares - DSC} -\date{Feb. 2021} +\date{April 2022} \version{0.2} \keywords{Dike, safety assessment, design, software, macro stability, piping} -\references{Refer to \autoref{chapterLiterature}.} +\reference{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.\newline \newline @@ -41,6 +41,12 @@ \revieweri{John Bokma} \approvali{Hans van Putten} +\versionii{0.2} +\dateii{April 2022} +\authorii{Tom The, John Bokma} +\reviewerii{Tom The} +\approvalii{Hans van Putten} + \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.} @@ -152,9 +158,43 @@ %------------------------------------------------------------------------------ \chapter{Data Description} \label{chapterDataDescription} -\todo{Data Description} +\section{Input} +\todo{Data Description Input} +\section{Results} +First of all, +not all calculations will pass kernel validations or lead to valid results due to errors that occur in the calculations (e.g. uplift does not occur where it is expected). +Some calculations may be performed but causes warnings. +Using a log manager, +all these cases are reported back to the user via a log that is to be displayed at the end of the calculation process. +This log is cleared at the start of each new calculation process. +When the project is saved, the existing log is saved too with a time stamp. +Note that the saved log will not be loaded again in the program itself. +The results of the calculations differ per failure mechanism per model. +An overview of all "single" result parameters is provided by the DAM documentation on the public wiki for DAM (https://publicwiki.deltares.nl/display/DAM/Tabblad+Ontwerpberekeningen). +These results are presented in a table for all performed calculations. + +Per individual calculation, +a property editor provides access to the most important "single" result parameters. +This editor also provided the opportunity for a user to evaluate the calculation and to add notes on it. +This editor may also provide other options such as direct access to external programs to view and recalculate results. +This depends on the Failure mechanism and the model. +For the failure mechanism stability, +all relevant data (input and output) is available as stix file to enable starting D-Stability of the D-Geo Suite. + +Next to these results parameters, other more complex result data is available for presentation and/or use too. + +For the failure mechanism stability, output data is available for the resulting slip plane. +This data is used to display that slip plane graphically within \ProgramName itself. +This slip plane is super imposed on the existing geometry as shown in the cross section tab. + +For failure mechanisms piping, +in case of design with the "Adapt geometry" option, +a resulting surface line is available together with its (1D) profile. +For the selected individual result, this adapted surface line is shown as dotted line within \ProgramName super imposed on the existing geometry as shown in the cross section tab. + + %------------------------------------------------------------------------------ \chapter{Module Description} \label{chapterModuleDescription}