// Copyright (C) Stichting Deltares 2025. All rights reserved.
//
// This file is part of the application DAM - UI.
//
// DAM - UI is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
//
// You should have received a copy of the GNU 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 System;
using System.IO;
using Deltares.Geometry;
using Deltares.Geotechnics.Soils;
using Deltares.Standard.Validation;
using DGeoSuite.Components.Persistence;
using NUnit.Framework;
namespace Deltares.Dam.StixFileReader.Tests;
[TestFixture]
public class StixFileReaderTest
{
[Test]
public void WhenNonExistingFileIsRead_ThenFileNotFoundExceptionIsThrown()
{
Assert.That(() => new StixFileReader().ReadSoilProfile("nonExistingFile.stix"),
Throws.Exception.TypeOf().With.Message.Contains("Could not find file nonExistingFile.stix."));
}
[Test]
public void WhenEmptyArchiveIsRead_ThenStorageReadExceptionIsThrown()
{
Assert.That(() => new StixFileReader().ReadSoilProfile(@".\TestFiles\Corrupt.stix"), Throws.Exception.TypeOf());
}
[Test]
public void WhenStixFileIsRead_ThenSoilProfile2DIsAsExpected()
{
const string fileName = @".\TestFiles\DWP_1.stix";
SoilProfile2D soilProfile2D = new StixFileReader().ReadSoilProfile(fileName);
Assert.That(soilProfile2D, Is.Not.Null);
Assert.Multiple(() =>
{
Assert.That(soilProfile2D.Name, Is.EqualTo("DWP_1.stix"));
Assert.That(soilProfile2D.Geometry, Is.Not.Null);
});
Assert.That(soilProfile2D.Geometry.Surfaces, Has.Count.EqualTo(12));
ValidationResult[] validationResults = Array.Empty();
for (var index = 0; index < 12; index++)
{
Assert.That(validationResults, Has.Length.EqualTo(0));
validationResults = soilProfile2D.Surfaces[index].ValidateLayer();
}
validationResults = soilProfile2D.Geometry.ValidateGeometry();
Assert.That(validationResults, Has.Length.EqualTo(0));
soilProfile2D.Geometry.RegenerateGeometry();
validationResults = soilProfile2D.Geometry.ValidateGeometry();
Assert.That(validationResults, Has.Length.EqualTo(0));
}
[Test]
public void GivenStixFileWithOneInnerLoop_WhenRead_ThenLoopsAreAsExpected()
{
const string fileName = @".\TestFiles\SimpleInnerLoop.stix";
SoilProfile2D soilProfile2D = new StixFileReader().ReadSoilProfile(fileName);
Assert.That(soilProfile2D, Is.Not.Null);
Assert.That(soilProfile2D.Geometry.Surfaces, Has.Count.EqualTo(2));
// L 1 outer loop
var surfaceIndex = 0;
GeometryLoop outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 0, 0, 1, 10, 59, 10, 60, 0);
// L 1 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(1));
GeometryLoop innerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops[0];
Assert.That(innerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(innerLoop, 11, 8, 29, 8, 30, 2, 10, 2);
// L 2 outer loop
surfaceIndex = 1;
outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 11, 8, 29, 8, 30, 2, 10, 2);
// L 2 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(0));
}
[Test]
public void GivenStixFileWithTwoInnerLoops_WhenRead_ThenLoopsAreAsExpected()
{
const string fileName = @".\TestFiles\SimpleTwoInnerLoops.stix";
SoilProfile2D soilProfile2D = new StixFileReader().ReadSoilProfile(fileName);
Assert.That(soilProfile2D, Is.Not.Null);
Assert.That(soilProfile2D.Geometry.Surfaces, Has.Count.EqualTo(3));
// L 1 outer loop
var surfaceIndex = 1;
GeometryLoop outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 0, 0, 1, 10, 59, 10, 60, 0);
// L 1 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(2));
GeometryLoop innerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops[0];
Assert.That(innerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(innerLoop, 11, 8, 29, 8, 30, 2, 10, 2);
innerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops[1];
Assert.That(innerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(innerLoop, 40, 2, 41, 8, 49, 8, 50, 2);
// L 2 outer loop
surfaceIndex = 0;
outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 11, 8, 29, 8, 30, 2, 10, 2);
// L 2 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(0));
// L 3 outer loop
surfaceIndex = 2;
outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 40, 2, 41, 8, 49, 8, 50, 2);
// L 3 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(0));
}
[Test]
public void GivenStixFileWithInnerLoopInAnotherInnerLoop_WhenRead_ThenLoopsAreAsExpected()
{
const string fileName = @".\TestFiles\SimpleInnerLoopInAnotherInnerLoop.stix";
SoilProfile2D soilProfile2D = new StixFileReader().ReadSoilProfile(fileName);
Assert.That(soilProfile2D, Is.Not.Null);
Assert.That(soilProfile2D.Geometry.Surfaces, Has.Count.EqualTo(3));
// L 1 outer loop
var surfaceIndex = 0;
GeometryLoop outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 0, 0, 1, 10, 59, 10, 60, 0);
// L 1 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(1));
GeometryLoop innerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops[0];
Assert.That(innerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(innerLoop, 11, 8, 29, 8, 30, 2, 10, 2);
// L 2 outer loop
surfaceIndex = 1;
outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(outerLoop, 11, 8, 29, 8, 30, 2, 10, 2);
// L 2 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(1));
innerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops[0];
Assert.That(innerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(innerLoop, 12, 3, 13, 7, 27, 7, 28, 3);
// L 3 outer loop
surfaceIndex = 2;
outerLoop = soilProfile2D.Geometry.Surfaces[surfaceIndex].OuterLoop;
Assert.That(outerLoop, Has.Count.EqualTo(4));
CheckIfLoopWith4PointsIsAsExpected(innerLoop, 12, 3, 13, 7, 27, 7, 28, 3);
// L 3 inner loops
Assert.That(soilProfile2D.Geometry.Surfaces[surfaceIndex].InnerLoops, Has.Count.EqualTo(0));
}
private static GeometryCurve CheckIfLoopWith4PointsIsAsExpected(GeometryLoop loop, double x1, double z1, double x2, double z2, double x3, double z3, double x4, double z4)
{
GeometryCurve curve = loop.CurveList[0];
Assert.Multiple(() =>
{
Assert.That(curve.HeadPoint.X, Is.EqualTo(x1));
Assert.That(curve.HeadPoint.Z, Is.EqualTo(z1));
Assert.That(curve.EndPoint.X, Is.EqualTo(x2));
Assert.That(curve.EndPoint.Z, Is.EqualTo(z2));
});
curve = loop.CurveList[1];
Assert.Multiple(() =>
{
Assert.That(curve.HeadPoint.X, Is.EqualTo(x2));
Assert.That(curve.HeadPoint.Z, Is.EqualTo(z2));
Assert.That(curve.EndPoint.X, Is.EqualTo(x3));
Assert.That(curve.EndPoint.Z, Is.EqualTo(z3));
});
curve = loop.CurveList[2];
Assert.Multiple(() =>
{
Assert.That(curve.HeadPoint.X, Is.EqualTo(x3));
Assert.That(curve.HeadPoint.Z, Is.EqualTo(z3));
Assert.That(curve.EndPoint.X, Is.EqualTo(x4));
Assert.That(curve.EndPoint.Z, Is.EqualTo(z4));
});
curve = loop.CurveList[3];
Assert.Multiple(() =>
{
Assert.That(curve.HeadPoint.X, Is.EqualTo(x4));
Assert.That(curve.HeadPoint.Z, Is.EqualTo(z4));
Assert.That(curve.EndPoint.X, Is.EqualTo(x1));
Assert.That(curve.EndPoint.Z, Is.EqualTo(z1));
});
return curve;
}
}