Index: DamClients/DamUI/trunk/doc/DAM UI - User manual/DAM UI - User manual.tex
===================================================================
diff -u -r6878 -r6883
--- DamClients/DamUI/trunk/doc/DAM UI - User manual/DAM UI - User manual.tex (.../DAM UI - User manual.tex) (revision 6878)
+++ DamClients/DamUI/trunk/doc/DAM UI - User manual/DAM UI - User manual.tex (.../DAM UI - User manual.tex) (revision 6883)
@@ -3427,49 +3427,44 @@
\hline
\textbf{Name} & \textbf{Type} & \textbf{Unit} & \textbf{Required} & \textbf{Description} \\
\endhead
-Location\_id & StringId & - & yes & Name of location \\ \hline
-Surfaceline\_id & StringId & - & yes & Reference to surfaceline \\ \hline
-Segment\_id & StringId & - & yes & Reference to segment \\ \hline
+location\_id & StringId & - & yes & Name of location \\ \hline
+surfaceline\_id & StringId & - & yes & Reference to surfaceline \\ \hline
+segment\_id & StringId & - & yes & Reference to segment \\ \hline
+dikering\_id & StringId & - & no & Name of the dike \\ \hline
geo\_x & Float & m & yes & X-coördinate \\ \hline
geo\_y & Float & m & yes & Y-coördinate \\ \hline
x\_soilgeometry2D\_origin & Float & m & no & The distance in x-direction between the origin of the soilgeometry2D and the first point of the surfaceline \\ \hline
polderlevel & Float & m & yes & Level of water in polder \\ \hline
head\_pl2 & Float & m & yes & Head of PL-Line2 \\ \hline
head\_pl3 & Float & m & no & Head of PL-Line3; use MHW if not specified \\ \hline
head\_pl4 & Float & m & no & Head of PL-Line4; use MHW if not specified \\ \hline
-Ophoogmateriaaldijk & StringId & - & no & Material to use for raising dike \\ \hline
-Ophoogmateriaalberm & StringId & - & no & Material to use for generating shoulder \\ \hline
+ophoogmateriaaldijk & StringId & - & no & Material to use for raising dike \\ \hline
+ophoogmateriaalberm & StringId & - & no & Material to use for generating shoulder \\ \hline
PenetrationLength & Float & m & yes & indringingslengte (for PL2); must >= 0; if 0 then no indringing is applied \\ \hline
TrafficLoad & Float & kN/m$^{\text{2}}$ & yes & Load of traffic (non-uniform load will be added for this) \\ \hline
TrafficLoadDistributionAngle & Float & degree & no & Distribution angle of the traffic load \\ \hline
minimal\_circle\_depth & Float & m & no & Minimal depth of circle of stability \\ \hline
dempingsfactor\_pl3 & Float & - & yes & Factor of damping for PL-Line 3 (deep sandlayer) (0.0 -1.0) \\ \hline
dempingsfactor\_pl4 & Float & - & yes & Factor of damping for PL-Line 4 (in between sandlayer) (0.0 -1.0) \\ \hline
-SlopeDampingPiezometricHeight PolderSide & Float & - & no & Factor for damping PL3 and PL4 in hinterland (0.0-1.0) \\ \hline
PLLineCreationMethod & StringId & - & no & Method for creating PL-Lines \newline
Possible values (attention: case sensitive!): \newline
-- ExpertKnowledgeRRD \newline
-- ExpertKnowledgeLinearInDike \newline
-- GaugesWithFallbackToExpertKnowledgeRRD \\ \hline
+safety\_factor\_piping & Float & - & no & required safety factor for piping for design option. \\ \hline
+safety\_factor\_stability\_inner\_slope & Float & - & no & required safety factor for stability innerslope for design option. \\ \hline
+safety\_factor\_stability\_outer\_slope & Float & - & no & required safety factor for stability outerslope for design option for design option. \\ \hline
uplift\_criterion\_piping & Float & - & No & Criterion to determine if uplift occurs for piping. \\ \hline
uplift\_criterion\_stability & Float & - & No & Criterion to determine if uplift occurs for stability. \\ \hline
distance\_to\_entry\_point & Float & m & No & Distance from toe of dike to entry point of river in deep sandlayer \\ \hline
PLLineOffsetBelowDikeTopAtRiver & Float & m & No & PL1 below top of dike (riverside) \\ \hline
PLLineOffsetBelowDikeTopAtPolder & Float & m & No & PL1 below top of dike (polderside) \\ \hline
PLLineOffsetBelowShoulderBase Inside & Float & m & No & PL1 below top of shoulder (polderside) \\ \hline
PLLineOffsetBelowDikeToeAtPolder & Float & m & No & PL1 below toe of dike (polderside) \\ \hline
-PLLineOffsetDryBelowDikeTop AtRiver & Float & m & No & PL1 below top of dike (riverside) in dry situtation \\ \hline
-PLLineOffsetDryBelowDikeTopAt Polder & Float & m & No & PL1 below top of dike (polderside) in dry situtation \\ \hline
-PLLineOffsetDryBelowShoulder BaseInside & Float & m & No & PL1 below top of shoulder (polderside) in dry situtation \\ \hline
-PLLineOffsetDryBelowDikeToeAt Polder & Float & m & No & PL1 below toe of dike (polderside) in dry situtation \\ \hline
UsePLLineOffsetBelowDikeCrest Middle & Boolean & - & No & Use the Offset below the middle of the dike crest for pl-line 1. \\ \hline
PLLineOffsetBelowDikeCrestMiddle & Float & m & No & Offset below the middle of the dike crest for pl-line 1. \\ \hline
UsePLLineOffsetFactorBelow ShoulderCrest & Boolean & - & No & Use the Offset below the shoulder crest defined as factor (0-1) on the difference in height between shoulder crest and shoulder (= dike) toe for pl-line 1. \\ \hline
PLLineOffsetFactorBelowShoulder Crest & Float & - & No & Offset below the shoulder crest defined as factor (0-1) on the difference in height between shoulder crest and shoulder (= dike) toe for pl-line 1. \\ \hline
-UsePLLineOffsetDryBelowDike CrestMiddle & Boolean & - & No & Use the Offset below the middle of the dike crest for pl-line 1 in dry situtation. \\ \hline
-PLLineOffsetDryBelowDikeCrest Middle & Float & m & No & Offset below the middle of the dike crest for pl-line 1 in dry situtation. \\ \hline
-UsePLLineOffsetDryFactorBelow ShoulderCrest & Boolean & - & No & Use the Offset below the shoulder crest defined as factor (0-1) on the difference in height between shoulder crest and shoulder (= dike) toe for pl-line 1 in dry situtation. \\ \hline
-PLLineOffsetDryFactorBelow ShoulderCrest & Float & - & No & Offset below the shoulder crest defined as factor (0-1) on the difference in height between shoulder crest and shoulder (= dike) toe for pl-line 1 in dry situtation. \\ \hline
IntrusionVerticalWaterPressure & String id & - & No & Defines how vertical water pressures should intrude. Options are (case insensitive): \newline
-- Standard \newline
-- Linear \newline
@@ -3479,6 +3474,7 @@
StabilityShoulderGrowSlope & Float & m & No & Shoulder growth slope for stability design \\ \hline
StabilityShoulderGrowDeltaX & Float & m & No & Shoulder growth delta X for stability design \\ \hline
StabilitySlopeAdaptionDeltaX & Float & m & No & Slope adaption delta X for stability design \\ \hline
+SlopeDampingPiezometricHeight PolderSide & Float & m & No & The slope at which PL3 and PL4 decrease from the dike toe on the polder side to the polder level. \\ \hline
DikeTableHeight & Float & m & No & Dike table height \\ \hline
StabilityDesignMethod & String Id & - & No & Design method \newline
-- OptimizedSlopeAndShoulderAdaption (apply slope adaption when slipcircle exits in slope, apply shoulder when slipcircle exits in polder) \newline
@@ -3487,6 +3483,8 @@
Possible values (attention: case sensitive!): \newline
-- NoZones \newline
-- ForbiddenZone \\ \hline
+ForbiddenZoneFactor & Float & m & No & Factor indicating where the left limit of the forbidden zone lies:
+0 corresponds to the dike crest at polder and 1 corresponds to the dike toe at polder, see also \autoref{fig:VerbodenZoneFactor}. \\ \hline
SlopeAdaptionStartCotangent & Float & - & No & Start slope for design method SlopeAdaptionBeforeShoulderAdaption \\ \hline
SlopeAdaptionEndCotangent & Float & - & No & End slope for design method SlopeAdaptionBeforeShoulderAdaption \\ \hline
SlopeAdaptionStepCotangent & Float & - & No & Step of slope for design method SlopeAdaptionBeforeShoulderAdaption \\ \hline
@@ -3508,6 +3506,8 @@
NewWidthDitchBottom & Float & m & No & Design method: value of the width of the bottom of the new ditch. \\ \hline
NewDepthDitch & Float & m & No & Design method: value of the depth of the bottom of the new ditch (related to polder level). \\ \hline
NewSlopeAngleDitch & Float & - & No & Design method: value of the slope angles of the new ditch. \\ \hline
+water\_height & Float & m & No & River level (MHW). \\ \hline
+water\_height\_low & Float & m & No & River level low (GLW). \\ \hline
\end{longtable}
\end{footnotesize}
@@ -3608,26 +3608,28 @@
\hline
\textbf{Name} & \textbf{Type} & \textbf{Unit} & \textbf{Required} & \textbf{Description} \\
\endhead
-Location\_id & StringId & - & yes & Reference to location (in locations.csv) \\ \hline
-Location\_scenario\_id & Integer & - & yes & Sequence number of scenario for location. \\ \hline
-water\_height & Float & m & yes & Waterheight for scenario (MHW). \\ \hline
-water\_height\_low & Float & m & no & Waterheight lw for scenario (GLW). \\ \hline
-dike\_table\_height & Float & m & yes & Dike table height for scenario. \\ \hline
-safety\_factor\_piping & Float & - & no & required safety factor for piping for design option. \\ \hline
-safety\_factor\_stability\_inner\_slope & Float & - & no & required safety factor for stability innerslope for design option. \\ \hline
-safety\_factor\_stability\_outer\_slope & Float & - & no & required safety factor for stability outerslope for design option for design option. \\ \hline
-uplift\_criterion\_piping & Float & - & no & Criterion to determine if uplift occurs for piping. \\ \hline
-uplift\_criterion\_stability & Float & - & no & Criterion to determine if uplift occurs for stability. \\ \hline
-PLLineOffsetBelowDikeTopAtRiver & Float & m & no & Offset below the dike top at river for pl-line 1. \\ \hline
-PLLineOffsetBelowDikeTopAtPolder & Float & m & no & Offset below the dike top at polder for pl-line 1. \\ \hline
-PLLineOffsetBelowShoulderBaseInside & Float & m & no & Offset below the base of the shoulder inside for pl-line 1. \\ \hline
-PLLineOffsetBelowDikeToeAtPolder & Float & m & no & Offset below the dike toe at polder for pl-line 1. \\ \hline
+Location\_id & StringId & - & Yes & Reference to location (in locations.csv) \\ \hline
+Location\_scenario\_id & Integer & - & Yes & Sequence number of scenario for location. \\ \hline
+water\_height & Float & m & No & River level for scenario (MHW). \\ \hline
+water\_height\_low & Float & m & No & River level low for scenario (GLW). \\ \hline
+dike\_table\_height & Float & m & No & Dike table height for scenario. \\ \hline
+safety\_factor\_piping & Float & - & No & required safety factor for piping for design option. \\ \hline
+safety\_factor\_stability\_inner\_slope & Float & - & No & required safety factor for stability innerslope for design option. \\ \hline
+safety\_factor\_stability\_outer\_slope & Float & - & No & required safety factor for stability outerslope for design option for design option. \\ \hline
+uplift\_criterion\_piping & Float & - & No & Criterion to determine if uplift occurs for piping. \\ \hline
+uplift\_criterion\_stability & Float & - & No & Criterion to determine if uplift occurs for stability. \\ \hline
+PLLineOffsetBelowDikeTopAtRiver & Float & m & No & Offset below the dike top at river for pl-line 1. \\ \hline
+PLLineOffsetBelowDikeTopAtPolder & Float & m & No & Offset below the dike top at polder for pl-line 1. \\ \hline
+PLLineOffsetBelowShoulderBaseInside & Float & m & No & Offset below the base of the shoulder inside for pl-line 1. \\ \hline
+PLLineOffsetBelowDikeToeAtPolder & Float & m & No & Offset below the dike toe at polder for pl-line 1. \\ \hline
UsePLLineOffsetBelowDikeCrestMiddle & Boolean & - & No & Use the Offset below the middle of the dike crest for pl-line 1. \\ \hline
PLLineOffsetBelowDikeCrestMiddle & Float & m & No & Offset below the middle of the dike crest for pl-line 1. \\ \hline
UsePLLineOffsetFactorBelowShoulderCrest & Boolean & - & No & Use the Offset below the shoulder crest defined as factor (0-1) on the difference in height between shoulder crest and shoulder (= dike) toe for pl-line 1. \\ \hline
PLLineOffsetFactorBelowShoulderCrest & Float & - & No & Offset below the shoulder crest defined as factor (0-1) on the difference in height between shoulder crest and shoulder (= dike) toe for pl-line 1. \\ \hline
-HeadPL3 & Float & m & No & Head for pl-line 3. \\ \hline
-HeadPL4 & Float & m & No & Head for pl-line 4. \\ \hline
+head\_pl3 & Float & m & No & Head for pl-line 3. \\ \hline
+head\_pL4 & Float & m & No & Head for pl-line 4. \\ \hline
+polderlevel & Float & m & No & Level of water in polder. \\ \hline
+head\_pl2 & Float & m & No & Head for pl-line 2. \\ \hline
\end{longtable}
\end{footnotesize}
@@ -3831,35 +3833,23 @@
-
-
-
-
-
-
-
-
-
-
-
-
\end{verbatim}