// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets 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 Core.Common.Base.Data;
using Core.Common.Base.Geometry;
using Core.Common.TestUtil;
using NUnit.Framework;
using Ringtoets.ClosingStructures.Data.TestUtil;
using Ringtoets.Common.Data;
using Ringtoets.Common.Data.Probabilistics;
using Ringtoets.Common.Data.TestUtil;
namespace Ringtoets.ClosingStructures.Data.Test
{
[TestFixture]
public class ClosingStructureTest
{
[Test]
public void Constructor_ValidData_ExpectedValues()
{
// Setup
var location = new Point2D(1.22, 2.333);
// Call
var structure = new ClosingStructure(
new ClosingStructure.ConstructionProperties
{
Name = "aName",
Id = "anId",
Location = location,
StorageStructureArea =
{
Mean = (RoundedDouble) 123.456,
CoefficientOfVariation = (RoundedDouble) 0.123
},
AllowedLevelIncreaseStorage =
{
Mean = (RoundedDouble) 234.567,
StandardDeviation = (RoundedDouble) 0.234
},
StructureNormalOrientation = (RoundedDouble) 345.678,
WidthFlowApertures =
{
Mean = (RoundedDouble) 456.789,
StandardDeviation = (RoundedDouble) 0.456
},
LevelCrestStructureNotClosing =
{
Mean = (RoundedDouble) 567.890,
StandardDeviation = (RoundedDouble) 0.567
},
InsideWaterLevel =
{
Mean = (RoundedDouble) 678.901,
StandardDeviation = (RoundedDouble) 0.678
},
ThresholdHeightOpenWeir =
{
Mean = (RoundedDouble) 789.012,
StandardDeviation = (RoundedDouble) 0.789
},
AreaFlowApertures =
{
Mean = (RoundedDouble) 890.123,
StandardDeviation = (RoundedDouble) 0.890
},
CriticalOvertoppingDischarge =
{
Mean = (RoundedDouble) 901.234,
CoefficientOfVariation = (RoundedDouble) 0.901
},
FlowWidthAtBottomProtection =
{
Mean = (RoundedDouble) 111.222,
StandardDeviation = (RoundedDouble) 0.111
},
ProbabilityOrFrequencyOpenStructureBeforeFlooding = 321.987,
FailureProbabilityOpenStructure = 654.321,
IdenticalApertures = 42,
FailureProbabilityReparation = 987.654,
InflowModelType = ClosingStructureInflowModelType.LowSill
});
// Assert
Assert.IsInstanceOf(structure);
Assert.AreEqual("aName", structure.Name);
Assert.AreEqual("anId", structure.Id);
Assert.AreEqual(location.X, structure.Location.X);
Assert.AreEqual(location.Y, structure.Location.Y);
Assert.AreEqual(345.68, structure.StructureNormalOrientation, structure.StructureNormalOrientation.GetAccuracy());
VariationCoefficientLogNormalDistribution storageStructureArea = structure.StorageStructureArea;
Assert.AreEqual(2, storageStructureArea.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(123.46, storageStructureArea.Mean, storageStructureArea.Mean.GetAccuracy());
Assert.AreEqual(2, storageStructureArea.CoefficientOfVariation.NumberOfDecimalPlaces);
Assert.AreEqual(0.12, storageStructureArea.CoefficientOfVariation, storageStructureArea.CoefficientOfVariation.GetAccuracy());
LogNormalDistribution allowedLevelIncreaseStorage = structure.AllowedLevelIncreaseStorage;
Assert.AreEqual(2, allowedLevelIncreaseStorage.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(234.57, allowedLevelIncreaseStorage.Mean, allowedLevelIncreaseStorage.Mean.GetAccuracy());
Assert.AreEqual(2, allowedLevelIncreaseStorage.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.23, allowedLevelIncreaseStorage.StandardDeviation, allowedLevelIncreaseStorage.StandardDeviation.GetAccuracy());
NormalDistribution widthFlowApertures = structure.WidthFlowApertures;
Assert.AreEqual(2, widthFlowApertures.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(456.79, widthFlowApertures.Mean, widthFlowApertures.Mean.GetAccuracy());
Assert.AreEqual(2, widthFlowApertures.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.46, widthFlowApertures.StandardDeviation, widthFlowApertures.StandardDeviation.GetAccuracy());
NormalDistribution levelCrestStructureNotClosing = structure.LevelCrestStructureNotClosing;
Assert.AreEqual(2, levelCrestStructureNotClosing.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(567.89, levelCrestStructureNotClosing.Mean, levelCrestStructureNotClosing.Mean.GetAccuracy());
Assert.AreEqual(2, levelCrestStructureNotClosing.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.57, levelCrestStructureNotClosing.StandardDeviation, levelCrestStructureNotClosing.StandardDeviation.GetAccuracy());
NormalDistribution insideWaterLevel = structure.InsideWaterLevel;
Assert.AreEqual(2, insideWaterLevel.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(678.90, insideWaterLevel.Mean, insideWaterLevel.Mean.GetAccuracy());
Assert.AreEqual(2, insideWaterLevel.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.68, insideWaterLevel.StandardDeviation, insideWaterLevel.StandardDeviation.GetAccuracy());
NormalDistribution thresholdHeightOpenWeir = structure.ThresholdHeightOpenWeir;
Assert.AreEqual(2, thresholdHeightOpenWeir.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(789.01, thresholdHeightOpenWeir.Mean, thresholdHeightOpenWeir.Mean.GetAccuracy());
Assert.AreEqual(2, thresholdHeightOpenWeir.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.79, thresholdHeightOpenWeir.StandardDeviation, thresholdHeightOpenWeir.StandardDeviation.GetAccuracy());
LogNormalDistribution areaFlowApertures = structure.AreaFlowApertures;
Assert.AreEqual(2, areaFlowApertures.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(890.12, areaFlowApertures.Mean, areaFlowApertures.Mean.GetAccuracy());
Assert.AreEqual(2, areaFlowApertures.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.89, areaFlowApertures.StandardDeviation, areaFlowApertures.StandardDeviation.GetAccuracy());
VariationCoefficientLogNormalDistribution criticalOvertoppingDischarge = structure.CriticalOvertoppingDischarge;
Assert.AreEqual(2, criticalOvertoppingDischarge.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(901.23, criticalOvertoppingDischarge.Mean, criticalOvertoppingDischarge.Mean.GetAccuracy());
Assert.AreEqual(2, criticalOvertoppingDischarge.CoefficientOfVariation.NumberOfDecimalPlaces);
Assert.AreEqual(0.90, criticalOvertoppingDischarge.CoefficientOfVariation, criticalOvertoppingDischarge.CoefficientOfVariation.GetAccuracy());
LogNormalDistribution flowWidthAtBottomProtection = structure.FlowWidthAtBottomProtection;
Assert.AreEqual(2, flowWidthAtBottomProtection.Mean.NumberOfDecimalPlaces);
Assert.AreEqual(111.22, flowWidthAtBottomProtection.Mean, flowWidthAtBottomProtection.Mean.GetAccuracy());
Assert.AreEqual(2, flowWidthAtBottomProtection.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.11, flowWidthAtBottomProtection.StandardDeviation, flowWidthAtBottomProtection.StandardDeviation.GetAccuracy());
Assert.AreEqual(321.987, structure.ProbabilityOrFrequencyOpenStructureBeforeFlooding);
Assert.AreEqual(654.321, structure.FailureProbabilityOpenStructure);
Assert.AreEqual(42, structure.IdenticalApertures);
Assert.AreEqual(987.654, structure.FailureProbabilityReparation);
Assert.AreEqual(ClosingStructureInflowModelType.LowSill, structure.InflowModelType);
}
[Test]
public void Constructor_DefaultConstructionProperties_ExpectedValues()
{
// Setup
var location = new Point2D(1.22, 2.333);
// Call
var structure = new ClosingStructure(
new ClosingStructure.ConstructionProperties
{
Name = "aName",
Id = "anId",
Location = location
});
// Assert
Assert.IsInstanceOf(structure);
Assert.AreEqual("aName", structure.Name);
Assert.AreEqual("anId", structure.Id);
Assert.AreEqual(location.X, structure.Location.X);
Assert.AreEqual(location.Y, structure.Location.Y);
Assert.AreEqual(2, structure.StructureNormalOrientation.NumberOfDecimalPlaces);
Assert.IsNaN(structure.StructureNormalOrientation);
VariationCoefficientLogNormalDistribution storageStructureArea = structure.StorageStructureArea;
Assert.AreEqual(2, storageStructureArea.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(storageStructureArea.Mean);
Assert.AreEqual(2, storageStructureArea.CoefficientOfVariation.NumberOfDecimalPlaces);
Assert.AreEqual(0.1, storageStructureArea.CoefficientOfVariation, storageStructureArea.CoefficientOfVariation.GetAccuracy());
LogNormalDistribution allowedLevelIncreaseStorage = structure.AllowedLevelIncreaseStorage;
Assert.AreEqual(2, allowedLevelIncreaseStorage.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(allowedLevelIncreaseStorage.Mean);
Assert.AreEqual(2, allowedLevelIncreaseStorage.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.1, allowedLevelIncreaseStorage.StandardDeviation, allowedLevelIncreaseStorage.StandardDeviation.GetAccuracy());
NormalDistribution widthFlowApertures = structure.WidthFlowApertures;
Assert.AreEqual(2, widthFlowApertures.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(widthFlowApertures.Mean);
Assert.AreEqual(2, widthFlowApertures.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.2, widthFlowApertures.StandardDeviation, widthFlowApertures.StandardDeviation.GetAccuracy());
NormalDistribution levelCrestStructureNotClosing = structure.LevelCrestStructureNotClosing;
Assert.AreEqual(2, levelCrestStructureNotClosing.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(levelCrestStructureNotClosing.Mean);
Assert.AreEqual(2, levelCrestStructureNotClosing.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.05, levelCrestStructureNotClosing.StandardDeviation, levelCrestStructureNotClosing.StandardDeviation.GetAccuracy());
NormalDistribution insideWaterLevel = structure.InsideWaterLevel;
Assert.AreEqual(2, insideWaterLevel.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(insideWaterLevel.Mean);
Assert.AreEqual(2, insideWaterLevel.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.1, insideWaterLevel.StandardDeviation, insideWaterLevel.StandardDeviation.GetAccuracy());
NormalDistribution thresholdHeightOpenWeir = structure.ThresholdHeightOpenWeir;
Assert.AreEqual(2, thresholdHeightOpenWeir.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(thresholdHeightOpenWeir.Mean);
Assert.AreEqual(2, thresholdHeightOpenWeir.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.1, thresholdHeightOpenWeir.StandardDeviation, thresholdHeightOpenWeir.StandardDeviation.GetAccuracy());
LogNormalDistribution areaFlowApertures = structure.AreaFlowApertures;
Assert.AreEqual(2, areaFlowApertures.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(areaFlowApertures.Mean);
Assert.AreEqual(2, areaFlowApertures.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.01, areaFlowApertures.StandardDeviation, areaFlowApertures.StandardDeviation.GetAccuracy());
VariationCoefficientLogNormalDistribution criticalOvertoppingDischarge = structure.CriticalOvertoppingDischarge;
Assert.AreEqual(2, criticalOvertoppingDischarge.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(criticalOvertoppingDischarge.Mean);
Assert.AreEqual(2, criticalOvertoppingDischarge.CoefficientOfVariation.NumberOfDecimalPlaces);
Assert.AreEqual(0.15, criticalOvertoppingDischarge.CoefficientOfVariation, criticalOvertoppingDischarge.CoefficientOfVariation.GetAccuracy());
LogNormalDistribution flowWidthAtBottomProtection = structure.FlowWidthAtBottomProtection;
Assert.AreEqual(2, flowWidthAtBottomProtection.Mean.NumberOfDecimalPlaces);
Assert.IsNaN(flowWidthAtBottomProtection.Mean);
Assert.AreEqual(2, flowWidthAtBottomProtection.StandardDeviation.NumberOfDecimalPlaces);
Assert.AreEqual(0.05, flowWidthAtBottomProtection.StandardDeviation, flowWidthAtBottomProtection.StandardDeviation.GetAccuracy());
Assert.AreEqual(1, structure.ProbabilityOrFrequencyOpenStructureBeforeFlooding);
Assert.AreEqual(1, structure.FailureProbabilityOpenStructure);
Assert.AreEqual(1, structure.IdenticalApertures);
Assert.AreEqual(1, structure.FailureProbabilityReparation);
Assert.AreEqual(ClosingStructureInflowModelType.VerticalWall, structure.InflowModelType);
}
[Test]
public void CopyProperties_FromStructureNull_ThrowsArgumentNullException()
{
// Setup
var structure = new ClosingStructure(new ClosingStructure.ConstructionProperties
{
Name = "aName",
Id = "anId",
Location = new Point2D(0, 0)
});
// Call
TestDelegate call = () => structure.CopyProperties(null);
// Assert
string paramName = Assert.Throws(call).ParamName;
Assert.AreEqual("fromStructure", paramName);
}
[Test]
public void CopyProperties_FromStructure_UpdatesProperties()
{
// Setup
var random = new Random(123);
var structure = new ClosingStructure(new ClosingStructure.ConstructionProperties
{
Name = "aName",
Id = "anId",
Location = new Point2D(0, 0)
});
var otherStructure = new ClosingStructure(new ClosingStructure.ConstructionProperties
{
Name = "otherName",
Id = "otherId",
Location = new Point2D(1, 1),
StructureNormalOrientation = (RoundedDouble) random.Next(),
AllowedLevelIncreaseStorage =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
AreaFlowApertures =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
CriticalOvertoppingDischarge =
{
Mean = random.NextRoundedDouble(),
CoefficientOfVariation = random.NextRoundedDouble()
},
FlowWidthAtBottomProtection =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
InsideWaterLevel =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
LevelCrestStructureNotClosing =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
StorageStructureArea =
{
Mean = random.NextRoundedDouble(),
CoefficientOfVariation = random.NextRoundedDouble()
},
ThresholdHeightOpenWeir =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
WidthFlowApertures =
{
Mean = random.NextRoundedDouble(),
StandardDeviation = random.NextRoundedDouble()
},
FailureProbabilityOpenStructure = random.NextDouble(),
FailureProbabilityReparation = random.NextDouble(),
InflowModelType = ClosingStructureInflowModelType.FloodedCulvert,
IdenticalApertures = random.Next(),
ProbabilityOrFrequencyOpenStructureBeforeFlooding = random.NextDouble()
});
// Call
structure.CopyProperties(otherStructure);
// Assert
Assert.AreNotEqual(otherStructure.Id, structure.Id);
Assert.AreEqual(otherStructure.Name, structure.Name);
TestHelper.AssertAreEqualButNotSame(otherStructure.Location, structure.Location);
Assert.AreEqual(otherStructure.StructureNormalOrientation, structure.StructureNormalOrientation);
TestHelper.AssertAreEqualButNotSame(otherStructure.AllowedLevelIncreaseStorage, structure.AllowedLevelIncreaseStorage);
TestHelper.AssertAreEqualButNotSame(otherStructure.AreaFlowApertures, structure.AreaFlowApertures);
TestHelper.AssertAreEqualButNotSame(otherStructure.CriticalOvertoppingDischarge, structure.CriticalOvertoppingDischarge);
Assert.AreEqual(otherStructure.FailureProbabilityOpenStructure, structure.FailureProbabilityOpenStructure);
Assert.AreEqual(otherStructure.FailureProbabilityReparation, structure.FailureProbabilityReparation);
Assert.AreEqual(otherStructure.IdenticalApertures, structure.IdenticalApertures);
Assert.AreEqual(otherStructure.ProbabilityOrFrequencyOpenStructureBeforeFlooding, structure.ProbabilityOrFrequencyOpenStructureBeforeFlooding);
TestHelper.AssertAreEqualButNotSame(otherStructure.FlowWidthAtBottomProtection, structure.FlowWidthAtBottomProtection);
TestHelper.AssertAreEqualButNotSame(otherStructure.InsideWaterLevel, structure.InsideWaterLevel);
TestHelper.AssertAreEqualButNotSame(otherStructure.LevelCrestStructureNotClosing, structure.LevelCrestStructureNotClosing);
TestHelper.AssertAreEqualButNotSame(otherStructure.StorageStructureArea, structure.StorageStructureArea);
TestHelper.AssertAreEqualButNotSame(otherStructure.ThresholdHeightOpenWeir, structure.ThresholdHeightOpenWeir);
TestHelper.AssertAreEqualButNotSame(otherStructure.WidthFlowApertures, structure.WidthFlowApertures);
}
[Test]
[TestCase(null)]
[TestCase("string")]
public void Equals_ToDifferentTypeOrNull_ReturnsFalse(object other)
{
// Setup
ClosingStructure structure = new TestClosingStructure();
// Call
bool isEqual = structure.Equals(other);
// Assert
Assert.IsFalse(isEqual);
}
[Test]
public void Equals_ToItself_ReturnsTrue()
{
// Setup
ClosingStructure structure = new TestClosingStructure();
// Call
bool isEqual = structure.Equals(structure);
// Assert
Assert.IsTrue(isEqual);
}
[Test]
public void Equals_TransitivePropertyAllPropertiesEqual_ReturnsTrue()
{
// Setup
ClosingStructure structureX = new TestClosingStructure();
ClosingStructure structureY = new TestClosingStructure();
ClosingStructure structureZ = new TestClosingStructure();
// Call
bool isXEqualToY = structureX.Equals(structureY);
bool isYEqualToZ = structureY.Equals(structureZ);
bool isXEqualToZ = structureX.Equals(structureZ);
// Assert
Assert.IsTrue(isXEqualToY);
Assert.IsTrue(isYEqualToZ);
Assert.IsTrue(isXEqualToZ);
}
[Test]
[TestCaseSource(typeof(ClosingStructurePermutationHelper),
nameof(ClosingStructurePermutationHelper.DifferentClosingStructures),
new object[]
{
"Equals",
"ReturnsFalse"
})]
public void Equals_DifferentProperty_ReturnsFalse(ClosingStructure structure)
{
// Call
bool isEqual = structure.Equals(new TestClosingStructure());
// Assert
Assert.IsFalse(isEqual);
}
[Test]
public void GetHashCode_EqualStructures_ReturnsSameHashCode()
{
// Setup
ClosingStructure structureOne = new TestClosingStructure();
ClosingStructure structureTwo = new TestClosingStructure();
// Call
int hashCodeOne = structureOne.GetHashCode();
int hashCodeTwo = structureTwo.GetHashCode();
// Assert
Assert.AreEqual(hashCodeOne, hashCodeTwo);
}
}
}