// Copyright (C) Stichting Deltares 2016. 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.Collections.Generic; using System.ComponentModel; using System.IO; using System.Linq; using log4net; using Ringtoets.ClosingStructures.Data; using Ringtoets.ClosingStructures.Service.Properties; using Ringtoets.Common.Data.AssessmentSection; using Ringtoets.Common.Data.FailureMechanism; using Ringtoets.Common.Data.Structures; using Ringtoets.Common.IO.HydraRing; using Ringtoets.Common.Service; using Ringtoets.Common.Service.ValidationRules; using Ringtoets.Common.Utils; using Ringtoets.HydraRing.Calculation.Calculator; using Ringtoets.HydraRing.Calculation.Calculator.Factory; using Ringtoets.HydraRing.Calculation.Data; using Ringtoets.HydraRing.Calculation.Data.Input.Structures; using Ringtoets.HydraRing.Calculation.Parsers; using RingtoetsCommonServiceResources = Ringtoets.Common.Service.Properties.Resources; using RingtoetsCommonFormsResources = Ringtoets.Common.Forms.Properties.Resources; using ClosingStructuresFormsResources = Ringtoets.ClosingStructures.Forms.Properties.Resources; namespace Ringtoets.ClosingStructures.Service { /// /// Service that provides methods for performing Hydra-ring calculations for closing structures calculations. /// public class ClosingStructuresCalculationService { private static readonly ILog log = LogManager.GetLogger(typeof(ClosingStructuresCalculationService)); private IStructuresClosureCalculator calculator; private bool canceled; /// /// Performs a closing structures calculation based on the supplied and sets /// if the calculation was successful. Error and status information is /// logged during the execution of the operation. /// /// The that holds all the information required to perform the calculation. /// The that holds information about the norm used in the calculation. /// The that holds the information about the contribution /// and the general inputs used in the calculation. /// The path which points to the hydraulic boundary database file. /// Thrown when is an invalid /// . public void Calculate(StructuresCalculation calculation, IAssessmentSection assessmentSection, ClosingStructuresFailureMechanism failureMechanism, string hydraulicBoundaryDatabaseFilePath) { var calculationName = calculation.Name; FailureMechanismSection failureMechanismSection = StructuresHelper.FailureMechanismSectionForCalculation(failureMechanism.Sections, calculation); StructuresClosureCalculationInput input = CreateStructuresClosureCalculationInput(calculation, failureMechanism, failureMechanismSection, hydraulicBoundaryDatabaseFilePath); string hlcdDirectory = Path.GetDirectoryName(hydraulicBoundaryDatabaseFilePath); calculator = HydraRingCalculatorFactory.Instance.CreateStructuresClosureCalculator(hlcdDirectory, assessmentSection.Id); CalculationServiceHelper.LogCalculationBeginTime(calculationName); var exceptionThrown = false; try { calculator.Calculate(input); if (!canceled) { calculation.Output = ProbabilityAssessmentService.Calculate(assessmentSection.FailureMechanismContribution.Norm, failureMechanism.Contribution, failureMechanism.GeneralInput.N, calculator.ExceedanceProbabilityBeta); } } catch (HydraRingFileParserException) { if (!canceled) { var lastErrorContent = calculator.LastErrorContent; if (string.IsNullOrEmpty(lastErrorContent)) { log.ErrorFormat(Resources.ClosingStructuresCalculationService_Calculate_Unexplained_error_in_closing_structures_0_calculation, calculationName); } else { log.ErrorFormat(Resources.ClosingStructuresCalculationService_Calculate_Error_in_closing_structures_0_calculation_click_details_for_last_error_1, calculationName, lastErrorContent); } exceptionThrown = true; throw; } } finally { try { var lastErrorContent = calculator.LastErrorContent; if (!canceled && !exceptionThrown && !string.IsNullOrEmpty(lastErrorContent)) { log.ErrorFormat(Resources.ClosingStructuresCalculationService_Calculate_Error_in_closing_structures_0_calculation_click_details_for_last_error_1, calculationName, lastErrorContent); throw new HydraRingFileParserException(lastErrorContent); } } finally { log.InfoFormat(Resources.ClosingStructuresCalculationService_Calculate_Calculation_temporary_directory_can_be_found_on_location_0, calculator.OutputDirectory); CalculationServiceHelper.LogCalculationEndTime(calculationName); } } } /// /// Cancels any ongoing structures closure calculation. /// public void Cancel() { if (calculator != null) { calculator.Cancel(); } canceled = true; } /// /// Performs validation over the values on the given . Error and status information is logged during /// the execution of the operation. /// /// The for which to validate the values. /// The for which to validate the values. /// true if has no validation errors; false otherwise. public static bool Validate(StructuresCalculation calculation, IAssessmentSection assessmentSection) { CalculationServiceHelper.LogValidationBeginTime(calculation.Name); var messages = ValidateInput(calculation.InputParameters, assessmentSection); CalculationServiceHelper.LogMessagesAsError(RingtoetsCommonServiceResources.Error_in_validation_0, messages); CalculationServiceHelper.LogValidationEndTime(calculation.Name); return !messages.Any(); } private static StructuresClosureCalculationInput CreateStructuresClosureCalculationInput( StructuresCalculation calculation, ClosingStructuresFailureMechanism failureMechanism, FailureMechanismSection failureMechanismSection, string hydraulicBoundaryDatabaseFilePath) { StructuresClosureCalculationInput input; switch (calculation.InputParameters.InflowModelType) { case ClosingStructureInflowModelType.VerticalWall: input = CreateClosureVerticalWallCalculationInput(calculation, failureMechanismSection, failureMechanism.GeneralInput, hydraulicBoundaryDatabaseFilePath); break; case ClosingStructureInflowModelType.LowSill: input = CreateLowSillCalculationInput(calculation, failureMechanismSection, failureMechanism.GeneralInput, hydraulicBoundaryDatabaseFilePath); break; case ClosingStructureInflowModelType.FloodedCulvert: input = CreateFloodedCulvertCalculationInput(calculation, failureMechanismSection, failureMechanism.GeneralInput, hydraulicBoundaryDatabaseFilePath); break; default: throw new InvalidEnumArgumentException("calculation", (int) calculation.InputParameters.InflowModelType, typeof(ClosingStructureInflowModelType)); } return input; } private static StructuresClosureVerticalWallCalculationInput CreateClosureVerticalWallCalculationInput( StructuresCalculation calculation, FailureMechanismSection failureMechanismSection, GeneralClosingStructuresInput generalInput, string hydraulicBoundaryDatabaseFilePath) { var structuresClosureVerticalWallCalculationInput = new StructuresClosureVerticalWallCalculationInput( calculation.InputParameters.HydraulicBoundaryLocation.Id, new HydraRingSection(1, failureMechanismSection.GetSectionLength(), calculation.InputParameters.StructureNormalOrientation), HydraRingInputParser.ParseForeshore(calculation.InputParameters), HydraRingInputParser.ParseBreakWater(calculation.InputParameters), generalInput.GravitationalAcceleration, calculation.InputParameters.FactorStormDurationOpenStructure, calculation.InputParameters.FailureProbabilityOpenStructure, calculation.InputParameters.FailureProbabilityReparation, calculation.InputParameters.IdenticalApertures, calculation.InputParameters.AllowedLevelIncreaseStorage.Mean, calculation.InputParameters.AllowedLevelIncreaseStorage.StandardDeviation, generalInput.ModelFactorStorageVolume.Mean, generalInput.ModelFactorStorageVolume.StandardDeviation, calculation.InputParameters.StorageStructureArea.Mean, calculation.InputParameters.StorageStructureArea.CoefficientOfVariation, generalInput.ModelFactorInflowVolume, calculation.InputParameters.FlowWidthAtBottomProtection.Mean, calculation.InputParameters.FlowWidthAtBottomProtection.StandardDeviation, calculation.InputParameters.CriticalOvertoppingDischarge.Mean, calculation.InputParameters.CriticalOvertoppingDischarge.CoefficientOfVariation, calculation.InputParameters.FailureProbabilityStructureWithErosion, calculation.InputParameters.StormDuration.Mean, calculation.InputParameters.StormDuration.CoefficientOfVariation, calculation.InputParameters.ProbabilityOpenStructureBeforeFlooding, generalInput.ModelFactorOvertoppingFlow.Mean, generalInput.ModelFactorOvertoppingFlow.StandardDeviation, calculation.InputParameters.StructureNormalOrientation, calculation.InputParameters.ModelFactorSuperCriticalFlow.Mean, calculation.InputParameters.ModelFactorSuperCriticalFlow.StandardDeviation, calculation.InputParameters.LevelCrestStructureNotClosing.Mean, calculation.InputParameters.LevelCrestStructureNotClosing.StandardDeviation, calculation.InputParameters.WidthFlowApertures.Mean, calculation.InputParameters.WidthFlowApertures.CoefficientOfVariation, calculation.InputParameters.DeviationWaveDirection); HydraRingSettingsDatabaseHelper.AssignSettingsFromDatabase(structuresClosureVerticalWallCalculationInput, hydraulicBoundaryDatabaseFilePath); return structuresClosureVerticalWallCalculationInput; } private static StructuresClosureLowSillCalculationInput CreateLowSillCalculationInput( StructuresCalculation calculation, FailureMechanismSection failureMechanismSection, GeneralClosingStructuresInput generalInput, string hydraulicBoundaryDatabaseFilePath) { var structuresClosureLowSillCalculationInput = new StructuresClosureLowSillCalculationInput( calculation.InputParameters.HydraulicBoundaryLocation.Id, new HydraRingSection(1, failureMechanismSection.GetSectionLength(), calculation.InputParameters.StructureNormalOrientation), HydraRingInputParser.ParseForeshore(calculation.InputParameters), HydraRingInputParser.ParseBreakWater(calculation.InputParameters), generalInput.GravitationalAcceleration, calculation.InputParameters.FactorStormDurationOpenStructure, calculation.InputParameters.FailureProbabilityOpenStructure, calculation.InputParameters.FailureProbabilityReparation, calculation.InputParameters.IdenticalApertures, calculation.InputParameters.AllowedLevelIncreaseStorage.Mean, calculation.InputParameters.AllowedLevelIncreaseStorage.StandardDeviation, generalInput.ModelFactorStorageVolume.Mean, generalInput.ModelFactorStorageVolume.StandardDeviation, calculation.InputParameters.StorageStructureArea.Mean, calculation.InputParameters.StorageStructureArea.CoefficientOfVariation, generalInput.ModelFactorInflowVolume, calculation.InputParameters.FlowWidthAtBottomProtection.Mean, calculation.InputParameters.FlowWidthAtBottomProtection.StandardDeviation, calculation.InputParameters.CriticalOvertoppingDischarge.Mean, calculation.InputParameters.CriticalOvertoppingDischarge.CoefficientOfVariation, calculation.InputParameters.FailureProbabilityStructureWithErosion, calculation.InputParameters.StormDuration.Mean, calculation.InputParameters.StormDuration.CoefficientOfVariation, calculation.InputParameters.ProbabilityOpenStructureBeforeFlooding, calculation.InputParameters.ModelFactorSuperCriticalFlow.Mean, calculation.InputParameters.ModelFactorSuperCriticalFlow.StandardDeviation, generalInput.ModelFactorSubCriticalFlow.Mean, generalInput.ModelFactorSubCriticalFlow.CoefficientOfVariation, calculation.InputParameters.ThresholdHeightOpenWeir.Mean, calculation.InputParameters.ThresholdHeightOpenWeir.StandardDeviation, calculation.InputParameters.InsideWaterLevel.Mean, calculation.InputParameters.InsideWaterLevel.StandardDeviation, calculation.InputParameters.WidthFlowApertures.Mean, calculation.InputParameters.WidthFlowApertures.CoefficientOfVariation); HydraRingSettingsDatabaseHelper.AssignSettingsFromDatabase(structuresClosureLowSillCalculationInput, hydraulicBoundaryDatabaseFilePath); return structuresClosureLowSillCalculationInput; } private static StructuresClosureFloodedCulvertCalculationInput CreateFloodedCulvertCalculationInput( StructuresCalculation calculation, FailureMechanismSection failureMechanismSection, GeneralClosingStructuresInput generalInput, string hydraulicBoundaryDatabaseFilePath) { var structuresClosureFloodedCulvertCalculationInput = new StructuresClosureFloodedCulvertCalculationInput( calculation.InputParameters.HydraulicBoundaryLocation.Id, new HydraRingSection(1, failureMechanismSection.GetSectionLength(), calculation.InputParameters.StructureNormalOrientation), HydraRingInputParser.ParseForeshore(calculation.InputParameters), HydraRingInputParser.ParseBreakWater(calculation.InputParameters), generalInput.GravitationalAcceleration, calculation.InputParameters.FactorStormDurationOpenStructure, calculation.InputParameters.FailureProbabilityOpenStructure, calculation.InputParameters.FailureProbabilityReparation, calculation.InputParameters.IdenticalApertures, calculation.InputParameters.AllowedLevelIncreaseStorage.Mean, calculation.InputParameters.AllowedLevelIncreaseStorage.StandardDeviation, generalInput.ModelFactorStorageVolume.Mean, generalInput.ModelFactorStorageVolume.StandardDeviation, calculation.InputParameters.StorageStructureArea.Mean, calculation.InputParameters.StorageStructureArea.CoefficientOfVariation, generalInput.ModelFactorInflowVolume, calculation.InputParameters.FlowWidthAtBottomProtection.Mean, calculation.InputParameters.FlowWidthAtBottomProtection.StandardDeviation, calculation.InputParameters.CriticalOvertoppingDischarge.Mean, calculation.InputParameters.CriticalOvertoppingDischarge.CoefficientOfVariation, calculation.InputParameters.FailureProbabilityStructureWithErosion, calculation.InputParameters.StormDuration.Mean, calculation.InputParameters.StormDuration.CoefficientOfVariation, calculation.InputParameters.ProbabilityOpenStructureBeforeFlooding, calculation.InputParameters.DrainCoefficient.Mean, calculation.InputParameters.DrainCoefficient.StandardDeviation, calculation.InputParameters.AreaFlowApertures.Mean, calculation.InputParameters.AreaFlowApertures.StandardDeviation, calculation.InputParameters.InsideWaterLevel.Mean, calculation.InputParameters.InsideWaterLevel.StandardDeviation); HydraRingSettingsDatabaseHelper.AssignSettingsFromDatabase(structuresClosureFloodedCulvertCalculationInput, hydraulicBoundaryDatabaseFilePath); return structuresClosureFloodedCulvertCalculationInput; } private static string[] ValidateInput(ClosingStructuresInput inputParameters, IAssessmentSection assessmentSection) { var validationResults = new List(); var validationProblem = HydraulicDatabaseHelper.ValidatePathForCalculation(assessmentSection.HydraulicBoundaryDatabase.FilePath); if (!string.IsNullOrEmpty(validationProblem)) { validationResults.Add(validationProblem); return validationResults.ToArray(); } if (inputParameters.HydraulicBoundaryLocation == null) { validationResults.Add(RingtoetsCommonServiceResources.CalculationService_ValidateInput_No_hydraulic_boundary_location_selected); } if (inputParameters.Structure == null) { validationResults.Add(RingtoetsCommonServiceResources.StructuresCalculationService_ValidateInput_No_Structure_selected); } else { IEnumerable validationRules = GetValidationRules(inputParameters); foreach (var validationRule in validationRules) { validationResults.AddRange(validationRule.Validate()); } } return validationResults.ToArray(); } private static IEnumerable GetValidationRules(ClosingStructuresInput inputParameters) { IEnumerable validationRules; switch (inputParameters.InflowModelType) { case ClosingStructureInflowModelType.VerticalWall: validationRules = GetVerticalWallValidationRules(inputParameters); break; case ClosingStructureInflowModelType.LowSill: validationRules = GetLowSillValidationRules(inputParameters); break; case ClosingStructureInflowModelType.FloodedCulvert: validationRules = GetFloodedCulvertValidationRules(inputParameters); break; default: throw new InvalidEnumArgumentException("inputParameters", (int) inputParameters.InflowModelType, typeof(ClosingStructureInflowModelType)); } return validationRules; } private static ValidationRule[] GetVerticalWallValidationRules(ClosingStructuresInput input) { return new ValidationRule[] { new UseBreakWaterRule(input), new VariationCoefficientLogNormalDistributionRule(input.StormDuration, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StormDuration_DisplayName)), new NormalDistributionRule(input.ModelFactorSuperCriticalFlow, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_ModelFactorSuperCriticalFlow_DisplayName)), new NumericInputRule(input.FactorStormDurationOpenStructure, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_FactorStormDurationOpenStructure_DisplayName)), new VariationCoefficientNormalDistributionRule(input.WidthFlowApertures, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_WidthFlowApertures_DisplayName)), new NumericInputRule(input.StructureNormalOrientation, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StructureNormalOrientation_DisplayName)), new LogNormalDistributionRule(input.FlowWidthAtBottomProtection, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_FlowWidthAtBottomProtection_DisplayName)), new VariationCoefficientLogNormalDistributionRule(input.StorageStructureArea, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StorageStructureArea_DisplayName)), new LogNormalDistributionRule(input.AllowedLevelIncreaseStorage, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_AllowedLevelIncreaseStorage_DisplayName)), new NormalDistributionRule(input.LevelCrestStructureNotClosing, ParameterNameExtractor.GetFromDisplayName(ClosingStructuresFormsResources.LevelCrestStructureNotClosing_DisplayName)), new VariationCoefficientLogNormalDistributionRule(input.CriticalOvertoppingDischarge, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_CriticalOvertoppingDischarge_DisplayName)) }; } private static ValidationRule[] GetLowSillValidationRules(ClosingStructuresInput input) { return new ValidationRule[] { new UseBreakWaterRule(input), new VariationCoefficientLogNormalDistributionRule(input.StormDuration, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StormDuration_DisplayName)), new NormalDistributionRule(input.InsideWaterLevel, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_InsideWaterLevel_DisplayName)), new NormalDistributionRule(input.ModelFactorSuperCriticalFlow, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_ModelFactorSuperCriticalFlow_DisplayName)), new NumericInputRule(input.FactorStormDurationOpenStructure, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_FactorStormDurationOpenStructure_DisplayName)), new VariationCoefficientNormalDistributionRule(input.WidthFlowApertures, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_WidthFlowApertures_DisplayName)), new LogNormalDistributionRule(input.FlowWidthAtBottomProtection, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_FlowWidthAtBottomProtection_DisplayName)), new VariationCoefficientLogNormalDistributionRule(input.StorageStructureArea, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StorageStructureArea_DisplayName)), new LogNormalDistributionRule(input.AllowedLevelIncreaseStorage, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_AllowedLevelIncreaseStorage_DisplayName)), new NormalDistributionRule(input.ThresholdHeightOpenWeir, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_ThresholdHeightOpenWeir_DisplayName)), new VariationCoefficientLogNormalDistributionRule(input.CriticalOvertoppingDischarge, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_CriticalOvertoppingDischarge_DisplayName)) }; } private static ValidationRule[] GetFloodedCulvertValidationRules(ClosingStructuresInput input) { return new ValidationRule[] { new UseBreakWaterRule(input), new VariationCoefficientLogNormalDistributionRule(input.StormDuration, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StormDuration_DisplayName)), new NormalDistributionRule(input.InsideWaterLevel, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_InsideWaterLevel_DisplayName)), new NormalDistributionRule(input.DrainCoefficient, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_DrainCoefficient_DisplayName)), new NumericInputRule(input.FactorStormDurationOpenStructure, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_FactorStormDurationOpenStructure_DisplayName)), new LogNormalDistributionRule(input.AreaFlowApertures, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_AreaFlowApertures_DisplayName)), new LogNormalDistributionRule(input.FlowWidthAtBottomProtection, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_FlowWidthAtBottomProtection_DisplayName)), new VariationCoefficientLogNormalDistributionRule(input.StorageStructureArea, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_StorageStructureArea_DisplayName)), new LogNormalDistributionRule(input.AllowedLevelIncreaseStorage, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_AllowedLevelIncreaseStorage_DisplayName)), new VariationCoefficientLogNormalDistributionRule(input.CriticalOvertoppingDischarge, ParameterNameExtractor.GetFromDisplayName(RingtoetsCommonFormsResources.Structure_CriticalOvertoppingDischarge_DisplayName)) }; } } }