// Copyright (C) Stichting Deltares 2026. All rights reserved.
//
// This file is part of the Dam Engine.
//
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see .
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.
using Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Geotechnics;
namespace Deltares.DamEngine.TestHelpers.Factories;
public static class FactoryForSurfaceLines
{
///
/// Creates a surface line, that is almost the same as Tutorial 1
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineTutorial1(bool includingTraffic = false, double ditchBottomLevel = -2)
{
var surfaceLine = new SurfaceLine2
{
Name = "Tutorial1",
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
// Next point adjusted so create PL line can be tested better
surfaceLine.EnsurePointOfType(0.0, 0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(10.0, 0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(34.5, 5, CharacteristicPointType.DikeTopAtRiver);
if (includingTraffic)
{
surfaceLine.EnsurePointOfType(35.0, 5, CharacteristicPointType.TrafficLoadOutside);
surfaceLine.EnsurePointOfType(38.5, 5, CharacteristicPointType.TrafficLoadInside);
}
surfaceLine.EnsurePointOfType(40.5, 5, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(50.5, 0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(58.5, 0, CharacteristicPointType.DitchDikeSide);
surfaceLine.EnsurePointOfType(59.5, ditchBottomLevel, CharacteristicPointType.BottomDitchDikeSide);
surfaceLine.EnsurePointOfType(61.5, ditchBottomLevel, CharacteristicPointType.BottomDitchPolderSide);
surfaceLine.EnsurePointOfType(61.51, 0, CharacteristicPointType.DitchPolderSide);
surfaceLine.EnsurePointOfType(75.0, 0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Creates a surface line as regular "zig zag" line of 120 m length with the highest corners 2 m above the middle line
/// and lowest corners 2 m below. Each corner has a width of 40 m. There are 3 corners in total.
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineInZigZag(double xCoordLeftPoint, double zCoordLeftPoint)
{
var surfaceLine = new SurfaceLine2
{
Name = "Surface line in zig zag"
};
surfaceLine.EnsurePoint(xCoordLeftPoint, zCoordLeftPoint);
surfaceLine.EnsurePoint(xCoordLeftPoint + 20, zCoordLeftPoint + 2);
surfaceLine.EnsurePoint(xCoordLeftPoint + 60, zCoordLeftPoint - 2);
surfaceLine.EnsurePoint(xCoordLeftPoint + 100, zCoordLeftPoint + 2);
surfaceLine.EnsurePoint(xCoordLeftPoint + 120, zCoordLeftPoint);
return surfaceLine;
}
///
/// Creates a surface line for piping bligh.
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineForPipingBligh()
{
//Surface line tutorial 1
var surfaceLine = new SurfaceLine2
{
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePoint(0, 2.5);
surfaceLine.EnsurePoint(2, 2.5);
surfaceLine.EnsurePointOfType(3.5, 4, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePoint(5.5, 4);
surfaceLine.EnsurePointOfType(7.5, 2, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePoint(9.5, 2);
surfaceLine.EnsurePoint(10, 1.5);
surfaceLine.EnsurePoint(11, 2);
surfaceLine.EnsurePoint(13, 2);
return surfaceLine;
}
///
/// Creates a realistic surface line for height adapter.
///
/// surface line
public static SurfaceLine2 CreateRealisticSurfaceLineForHeightAdapter()
{
var surfaceLine = new SurfaceLine2
{
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
var pointSurfaceLevelOutside = new GeometryPoint
{
X = -27.0,
Z = 12.4
};
var pointDikeToeAtRiver = new GeometryPoint
{
X = -17.4,
Z = 12.4
};
var pointDikeTopAtRiver = new GeometryPoint
{
X = 0,
Z = 18.2
};
var pointTrafficLoadOutside = new GeometryPoint
{
X = 1.0,
Z = 18.2
};
var pointTrafficLoadInside = new GeometryPoint
{
X = 6.0,
Z = 18.2
};
var pointDikeTopAtPolder = new GeometryPoint
{
X = 7.0,
Z = 18.2
};
var pointInsteekShoulderInside = new GeometryPoint
{
X = 26.520,
Z = 12.10
};
var pointTopShoulderInside = new GeometryPoint
{
X = 26.620,
Z = 12.10
};
var pointDikeToeAtPolder = new GeometryPoint
{
X = 26.840,
Z = 12.0
};
var pointDitchDikeSide = new GeometryPoint
{
X = 29.840,
Z = 12.0
};
var pointBottomDitchDikeSide = new GeometryPoint
{
X = 30.840,
Z = 11.0
};
var pointBottomDitchPolderSide = new GeometryPoint
{
X = 38.840,
Z = 11.0
};
var pointDitchPolderSide = new GeometryPoint
{
X = 39.840,
Z = 12
};
var pointSurfaceLevelInside = new GeometryPoint
{
X = 140,
Z = 12
};
surfaceLine.EnsurePointOfType(pointSurfaceLevelOutside.X, pointSurfaceLevelOutside.Z, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(pointDikeToeAtRiver.X, pointDikeToeAtRiver.Z, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(pointDikeTopAtRiver.X, pointDikeTopAtRiver.Z, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(pointTrafficLoadOutside.X, pointTrafficLoadOutside.Z, CharacteristicPointType.TrafficLoadOutside);
surfaceLine.EnsurePointOfType(pointTrafficLoadInside.X, pointTrafficLoadInside.Z, CharacteristicPointType.TrafficLoadInside);
surfaceLine.EnsurePointOfType(pointDikeTopAtPolder.X, pointDikeTopAtPolder.Z, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(pointInsteekShoulderInside.X, pointInsteekShoulderInside.Z, CharacteristicPointType.ShoulderBaseInside);
surfaceLine.EnsurePointOfType(pointTopShoulderInside.X, pointTopShoulderInside.Z, CharacteristicPointType.ShoulderTopInside);
surfaceLine.EnsurePointOfType(pointDikeToeAtPolder.X, pointDikeToeAtPolder.Z, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(pointDitchDikeSide.X, pointDitchDikeSide.Z, CharacteristicPointType.DitchDikeSide);
surfaceLine.EnsurePointOfType(pointBottomDitchDikeSide.X, pointBottomDitchDikeSide.Z, CharacteristicPointType.BottomDitchDikeSide);
surfaceLine.EnsurePointOfType(pointBottomDitchPolderSide.X, pointBottomDitchPolderSide.Z, CharacteristicPointType.BottomDitchPolderSide);
surfaceLine.EnsurePointOfType(pointDitchPolderSide.X, pointDitchPolderSide.Z, CharacteristicPointType.DitchPolderSide);
surfaceLine.EnsurePointOfType(pointSurfaceLevelInside.X, pointSurfaceLevelInside.Z, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Creates a horizontal surface line.
///
/// surface line
public static SurfaceLine2 CreateHorizontalSurfaceLine(double level, double left = -10, double right = 10)
{
var surfaceLine = new SurfaceLine2
{
Name = "HorizontalLine"
};
surfaceLine.EnsurePointOfType(left, level, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(left + (right - left) / 4, level, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(left + (right - left) / 2, level, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(right - (right - left) / 4, level, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(right, level, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Creates a surface line based on tutorial DWP_1
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineForTestingGrid(double left, double right)
{
var surfaceLine = new SurfaceLine2
{
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePointOfType(left, 0.0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(29.86, 3.74, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(33.18, 3.81, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(59.96, -0.29, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(right, 0.0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Create a simple surface line without shoulder
///
/// surface line
public static SurfaceLine2 CreateSurfacelineSimpleDike()
{
var surfaceLine = new SurfaceLine2
{
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePointOfType(0.0, 2.0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(1.0, 2.0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(4.0, 5.0, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(7.0, 5.0, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(10.0, 1.0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(12.0, 1.0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Create a simple surface line for dike with sloping shoulder
///
/// surface line
public static SurfaceLine2 CreateSurfacelineDikeWithSlopingShoulder()
{
var surfaceLine = new SurfaceLine2
{
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePointOfType(0.0, 2.0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(1.0, 2.0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(4.0, 5.0, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(7.0, 5.0, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(9.0, 3.0, CharacteristicPointType.ShoulderBaseInside);
surfaceLine.EnsurePointOfType(11.0, 2.5, CharacteristicPointType.ShoulderTopInside);
surfaceLine.EnsurePointOfType(12.5, 1.0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(15.0, 1.0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Create a simple surface line without shoulder and with ditch at polder side
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineForWtiPiping(bool includingTraffic = false)
{
//Surface line tutorial 1
var surfaceLine = new SurfaceLine2
{
Name = "Tutorial1",
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
// Next point adjusted so create PL line can be tested better
surfaceLine.EnsurePointOfType(0.0, 0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(10.0, 0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(34.5, 5, CharacteristicPointType.DikeTopAtRiver);
if (includingTraffic)
{
surfaceLine.EnsurePointOfType(35.0, 5, CharacteristicPointType.TrafficLoadOutside);
surfaceLine.EnsurePointOfType(38.5, 5, CharacteristicPointType.TrafficLoadInside);
}
surfaceLine.EnsurePointOfType(40.5, 5, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(50.5, 0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(58.5, 0, CharacteristicPointType.DitchDikeSide);
surfaceLine.EnsurePointOfType(59.5, -1, CharacteristicPointType.BottomDitchDikeSide);
surfaceLine.EnsurePointOfType(61.5, -1, CharacteristicPointType.BottomDitchPolderSide);
surfaceLine.EnsurePointOfType(61.5, 0, CharacteristicPointType.DitchPolderSide);
surfaceLine.EnsurePointOfType(75.0, 0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Creates a surface line, that contains a dike and a ditch on the polder side.
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineWithDikeAndDitch(double dikeTopLevel = 5, double ditchBottomLevel = -2)
{
var surfaceLine = new SurfaceLine2
{
Name = "SurfaceLineWithDikeAndDitch",
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePointOfType(0.0, 0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(10.0, 0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(34.5, dikeTopLevel, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(40.5, dikeTopLevel, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(50.5, 0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(58.5, 0, CharacteristicPointType.DitchDikeSide);
surfaceLine.EnsurePointOfType(59.5, ditchBottomLevel, CharacteristicPointType.BottomDitchDikeSide);
surfaceLine.EnsurePointOfType(61.5, ditchBottomLevel, CharacteristicPointType.BottomDitchPolderSide);
surfaceLine.EnsurePointOfType(62.5, 0, CharacteristicPointType.DitchPolderSide);
surfaceLine.EnsurePointOfType(75.0, 0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
public static SurfaceLine2 CreateSurfaceLineDike(double offset = 0.0, string name = "SurfaceLineWithDikeAndDitch")
{
var surfaceLine = new SurfaceLine2
{
Name = name,
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePointOfType(0.0, offset + 0.0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(10.0, offset + 0.0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(34.5, offset + 5.0, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(40.5, offset + 5.0, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(50.5, offset + 0.0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(75.0, offset + 0.0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
///
/// Creates a surface line, that contains a dike and is fully above SurfaceLineWithDikeAndDitch.
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineAboveSurfaceLineDikeAndDitch()
{
return CreateSurfaceLineDike(5.0, "AboveSurfaceLineWithDikeAndDitch");
}
///
/// Creates a surface line, that contains a dike and is fully below SurfaceLineWithDikeAndDitch.
///
/// surface line
public static SurfaceLine2 CreateSurfaceLineBelowSurfaceLineDikeAndDitch()
{
return CreateSurfaceLineDike(-10.0, "AboveSurfaceLineWithDikeAndDitch");
}
///
/// Creates a surface line, that contains a dike and is cutting the SurfaceLineWithDikeAndDitch.
///
/// The surface line
public static SurfaceLine2 CreateSurfaceLineCuttingSurfaceLineDikeAndDitch()
{
return CreateSurfaceLineDike(-2.0, "AboveSurfaceLineWithDikeAndDitch");
}
///
/// Creates a surface line, that contains a dike and with points that are not strictly ascending.
///
/// The surface line
public static SurfaceLine2 CreateSurfaceLineDikeNonStrictAscending()
{
var surfaceLine = new SurfaceLine2
{
Name = "DikeNonStrictAscending",
Geometry = new GeometryPointString(),
CharacteristicPoints =
{
GeometryMustContainPoint = true
}
};
surfaceLine.EnsurePointOfType(0.0, 0.0, CharacteristicPointType.SurfaceLevelOutside);
surfaceLine.EnsurePointOfType(10.0, 0.0, CharacteristicPointType.DikeToeAtRiver);
surfaceLine.EnsurePointOfType(34.5, 5.0, CharacteristicPointType.DikeTopAtRiver);
surfaceLine.EnsurePointOfType(40.5, 5.0, CharacteristicPointType.DikeTopAtPolder);
surfaceLine.EnsurePointOfType(40.5, 0.0, CharacteristicPointType.DikeToeAtPolder);
surfaceLine.EnsurePointOfType(75.0, 0.0, CharacteristicPointType.SurfaceLevelInside);
return surfaceLine;
}
}