Index: src/Plugins/Wti/Wti.Calculation/Piping/PipingCalculationInput.cs
===================================================================
diff -u -r9f140a1d7ebc5dfaabd213c626b596ad55f66e56 -r2f9f3715577a997e8717aedc5f3667627ba7eac5
--- src/Plugins/Wti/Wti.Calculation/Piping/PipingCalculationInput.cs (.../PipingCalculationInput.cs) (revision 9f140a1d7ebc5dfaabd213c626b596ad55f66e56)
+++ src/Plugins/Wti/Wti.Calculation/Piping/PipingCalculationInput.cs (.../PipingCalculationInput.cs) (revision 2f9f3715577a997e8717aedc5f3667627ba7eac5)
@@ -31,6 +31,9 @@
#region properties
+ ///
+ /// Gets the volumetric weight of water.
+ ///
public double WaterVolumetricWeight
{
get
@@ -39,6 +42,9 @@
}
}
+ ///
+ /// Gets the calculation value used to account for uncertainty in the model for uplift.
+ ///
public double UpliftModelFactor
{
get
@@ -47,6 +53,9 @@
}
}
+ ///
+ /// Gets the effective stress of a layer.
+ ///
public double EffectiveStress
{
get
@@ -55,6 +64,9 @@
}
}
+ ///
+ /// Gets the outside high water level.
+ ///
public double AssessmentLevel
{
get
@@ -63,6 +75,9 @@
}
}
+ ///
+ /// Gets the piezometric head at the exit point.
+ ///
public double PiezometricHeadExit
{
get
@@ -71,6 +86,9 @@
}
}
+ ///
+ /// Gets the damping factor at the exit point.
+ ///
public double DampingFactorExit
{
get
@@ -79,6 +97,9 @@
}
}
+ ///
+ /// Gets the phreatic level at the exit point.
+ ///
public double PhreaticLevelExit
{
get
@@ -87,6 +108,9 @@
}
}
+ ///
+ /// Gets the piezometric head in the hinterland.
+ ///
public double PiezometricHeadPolder
{
get
@@ -95,6 +119,9 @@
}
}
+ ///
+ /// Gets the critical exit gradient for heave.
+ ///
public double CriticalHeaveGradient
{
get
@@ -103,6 +130,9 @@
}
}
+ ///
+ /// Gets the total thickness of the coverage layer at the exit point.
+ ///
public double ThicknessCoverageLayer
{
get
@@ -111,13 +141,19 @@
}
}
+ ///
+ /// Gets the calculation value used to account for uncertainty in the model for Sellmeijer.
+ ///
public double SellmeijerModelFactor {
get
{
return sellmeijerModelFactor;
}
}
+ ///
+ /// Gets the reduction factor Sellmeijer.
+ ///
public double ReductionFactorSellmeijer
{
get
@@ -126,6 +162,9 @@
}
}
+ ///
+ /// Gets the horizontal distance between entree and exit point.
+ ///
public double SeepageLength
{
get
@@ -134,6 +173,9 @@
}
}
+ ///
+ /// Gets the (lowerbound) volumic weight of sand grain material of a sand layer under water.
+ ///
public double SandParticlesVolumicWeight
{
get
@@ -142,6 +184,9 @@
}
}
+ ///
+ /// Gets the White's drag coefficient.
+ ///
public double WhitesDragCoefficient
{
get
@@ -150,6 +195,9 @@
}
}
+ ///
+ /// Gets the sieve size through which 70% fraction of the grains of the top part of the aquifer passes.
+ ///
public double Diameter70
{
get
@@ -158,6 +206,9 @@
}
}
+ ///
+ /// Gets the Darcy-speed with which water flows through the aquifer layer.
+ ///
public double DarcyPermeability
{
get
@@ -166,6 +217,9 @@
}
}
+ ///
+ /// Gets the kinematic viscosity of water at 10 degrees Celsius.
+ ///
public double WaterKinematicViscosity
{
get
@@ -174,6 +228,9 @@
}
}
+ ///
+ /// Gets the gravitational acceleration.
+ ///
public double Gravity
{
get
@@ -182,6 +239,9 @@
}
}
+ ///
+ /// Gets the thickness of the aquifer layer.
+ ///
public double ThicknessAquiferLayer
{
get
@@ -190,6 +250,9 @@
}
}
+ ///
+ /// Gets the mean diameter of small scale tests applied to different kinds of sand, on which the formula of Sellmeijer has been fit.
+ ///
public double MeanDiameter70
{
get
@@ -198,6 +261,9 @@
}
}
+ ///
+ /// Gets the angle of the force balance representing the amount in which sand grains resist rolling.
+ ///
public double BeddingAngle
{
get
@@ -206,6 +272,9 @@
}
}
+ ///
+ /// Gets the x coordinate of the exit point.
+ ///
public double ExitPointXCoordinate
{
get
@@ -221,28 +290,28 @@
/// in the piping sub calculations.
///
/// The volumetric weight of water.
- /// Calculation value used to account for uncertainty in the model for uplift.
+ /// The calculation value used to account for uncertainty in the model for uplift.
/// The effective stress of a layer.
- /// Outside high water level.
- /// Piezometric head at the exit point.
- /// Damping factor at the exit point.
- /// Phreatic level at the exit point.
- /// Piezometric head in the hinterland.
- /// Critical exit gradient for heave.
+ /// The outside high water level.
+ /// The piezometric head at the exit point.
+ /// The damping factor at the exit point.
+ /// The phreatic level at the exit point.
+ /// The piezometric head in the hinterland.
+ /// The critical exit gradient for heave.
/// The total thickness of the coverage layer at the exit point.
- /// Calculation value used to account for uncertainty in the model for Sellmeijer.
- /// Reduction factor Sellmeijer.
- /// Horizontal distance between entree and exit point.
+ /// The calculation value used to account for uncertainty in the model for Sellmeijer.
+ /// The reduction factor Sellmeijer.
+ /// The horizontal distance between entree and exit point.
/// The (lowerbound) volumic weight of sand grain material of a sand layer under water.
- /// White's drag coefficient.
- /// Sieve size through which 70% fraction of the grains of the top part of the aquifer passes.
- /// Darcy-speed with which water flows through the aquifer layer.
+ /// The White's drag coefficient.
+ /// The sieve size through which 70% fraction of the grains of the top part of the aquifer passes.
+ /// The Darcy-speed with which water flows through the aquifer layer.
/// The kinematic viscosity of water at 10 degrees Celsius.
- /// Gravitational acceleration.
+ /// The gravitational acceleration.
/// The thickness of the aquifer layer.
- /// Mean diameter of small scale tests applied to different kinds of sand, on which the formula of Sellmeijer has been fit.
- /// Angle of the force balance representing the amount in which sand grains resist rolling.
- /// X coordinate of the exit point.
+ /// The mean diameter of small scale tests applied to different kinds of sand, on which the formula of Sellmeijer has been fit.
+ /// The angle of the force balance representing the amount in which sand grains resist rolling.
+ /// The x coordinate of the exit point.
public PipingCalculationInput(
double waterVolumetricWeight,
double upliftModelFactor,
Index: src/Plugins/Wti/Wti.Calculation/Piping/PipingCalculationResult.cs
===================================================================
diff -u -r9f140a1d7ebc5dfaabd213c626b596ad55f66e56 -r2f9f3715577a997e8717aedc5f3667627ba7eac5
--- src/Plugins/Wti/Wti.Calculation/Piping/PipingCalculationResult.cs (.../PipingCalculationResult.cs) (revision 9f140a1d7ebc5dfaabd213c626b596ad55f66e56)
+++ src/Plugins/Wti/Wti.Calculation/Piping/PipingCalculationResult.cs (.../PipingCalculationResult.cs) (revision 2f9f3715577a997e8717aedc5f3667627ba7eac5)
@@ -1,5 +1,8 @@
namespace Wti.Calculation.Piping
{
+ ///
+ /// This class contains all the results of a complete piping calculation.
+ ///
public class PipingCalculationResult {
private readonly double upliftZValue;
private readonly double upliftFactorOfSafety;
@@ -11,7 +14,7 @@
#region properties
///
- /// The z-value of the Uplift sub calculation.
+ /// Gets the z-value of the Uplift sub calculation.
///
public double UpliftZValue { get
{
@@ -20,7 +23,7 @@
}
///
- /// The factory of safety of the Uplift sub calculation.
+ /// Gets the factory of safety of the Uplift sub calculation.
///
public double UpliftFactorOfSafety
{
@@ -31,7 +34,7 @@
}
///
- /// The z-value of the Heave sub calculation.
+ /// Gets the z-value of the Heave sub calculation.
///
public double HeaveZValue
{
@@ -42,7 +45,7 @@
}
///
- /// The factory of safety of the Heave sub calculation.
+ /// Gets the factory of safety of the Heave sub calculation.
///
public double HeaveFactorOfSafety
{
@@ -53,7 +56,7 @@
}
///
- /// The z-value of the Sellmeijer sub calculation.
+ /// Gets the z-value of the Sellmeijer sub calculation.
///
public double SellmeijerZValue
{
@@ -64,7 +67,7 @@
}
///
- /// The factory of safety of the Sellmeijer sub calculation.
+ /// Gets the factory of safety of the Sellmeijer sub calculation.
///
public double SellmeijerFactorOfSafety
{
Index: src/Plugins/Wti/Wti.Calculation/Piping/PipingProfileCreator.cs
===================================================================
diff -u -r9f140a1d7ebc5dfaabd213c626b596ad55f66e56 -r2f9f3715577a997e8717aedc5f3667627ba7eac5
--- src/Plugins/Wti/Wti.Calculation/Piping/PipingProfileCreator.cs (.../PipingProfileCreator.cs) (revision 9f140a1d7ebc5dfaabd213c626b596ad55f66e56)
+++ src/Plugins/Wti/Wti.Calculation/Piping/PipingProfileCreator.cs (.../PipingProfileCreator.cs) (revision 2f9f3715577a997e8717aedc5f3667627ba7eac5)
@@ -7,6 +7,10 @@
///
internal class PipingProfileCreator
{
+ ///
+ /// Creates a simple with a single default constructed .
+ ///
+ ///
public PipingProfile Create()
{
var profile = new PipingProfile();
Index: src/Plugins/Wti/Wti.Calculation/Piping/PipingSurfaceLineCreator.cs
===================================================================
diff -u -r9f140a1d7ebc5dfaabd213c626b596ad55f66e56 -r2f9f3715577a997e8717aedc5f3667627ba7eac5
--- src/Plugins/Wti/Wti.Calculation/Piping/PipingSurfaceLineCreator.cs (.../PipingSurfaceLineCreator.cs) (revision 9f140a1d7ebc5dfaabd213c626b596ad55f66e56)
+++ src/Plugins/Wti/Wti.Calculation/Piping/PipingSurfaceLineCreator.cs (.../PipingSurfaceLineCreator.cs) (revision 2f9f3715577a997e8717aedc5f3667627ba7eac5)
@@ -7,6 +7,10 @@
///
internal class PipingSurfaceLineCreator
{
+ ///
+ /// Creates a simple with a single at the origin.
+ ///
+ ///
public PipingSurfaceLine Create()
{
var surfaceLine = new PipingSurfaceLine();