// Copyright (C) Stichting Deltares 2018. 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 System.Collections.Generic;
using System.Linq;
using Ringtoets.AssemblyTool.Data;
using Ringtoets.AssemblyTool.KernelWrapper.Calculators;
using Ringtoets.AssemblyTool.KernelWrapper.Calculators.Assembly;
using Ringtoets.AssemblyTool.KernelWrapper.Kernels;
using Ringtoets.Common.Data.AssemblyTool;
using Ringtoets.Common.Data.AssessmentSection;
using Ringtoets.Common.Data.Exceptions;
using Ringtoets.Common.Data.Probability;
using Ringtoets.Common.Primitives;
using RingtoetsCommonDataResources = Ringtoets.Common.Data.Properties.Resources;
namespace Ringtoets.MacroStabilityInwards.Data
{
///
/// Factory for assembling assembly results for a macro stability inwards failure mechanism.
///
public static class MacroStabilityInwardsFailureMechanismAssemblyFactory
{
///
/// Assembles the simple assessment results.
///
/// The failure mechanism section result to assemble the
/// simple assembly results for.
/// A based on the .
/// Thrown when
/// is null.
/// Thrown when the
/// could not be created.
public static FailureMechanismSectionAssembly AssembleSimpleAssessment(
MacroStabilityInwardsFailureMechanismSectionResult failureMechanismSectionResult)
{
if (failureMechanismSectionResult == null)
{
throw new ArgumentNullException(nameof(failureMechanismSectionResult));
}
IAssemblyToolCalculatorFactory calculatorFactory = AssemblyToolCalculatorFactory.Instance;
IFailureMechanismSectionAssemblyCalculator calculator =
calculatorFactory.CreateFailureMechanismSectionAssemblyCalculator(AssemblyToolKernelFactory.Instance);
try
{
return calculator.AssembleSimpleAssessment(failureMechanismSectionResult.SimpleAssessmentResult);
}
catch (FailureMechanismSectionAssemblyCalculatorException e)
{
throw new AssemblyException(e.Message, e);
}
}
///
/// Assembles the detailed assessment result.
///
/// The failure mechanism section result to
/// assemble the detailed assembly for.
/// The calculation scenarios belonging to this section.
/// The failure mechanism this section belongs to.
/// The this section belongs to.
/// A .
/// Thrown when any parameter is null.
/// Thrown when the
/// could not be created.
public static FailureMechanismSectionAssembly AssembleDetailedAssessment(
MacroStabilityInwardsFailureMechanismSectionResult failureMechanismSectionResult,
IEnumerable calculationScenarios,
MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection)
{
if (failureMechanismSectionResult == null)
{
throw new ArgumentNullException(nameof(failureMechanismSectionResult));
}
if (calculationScenarios == null)
{
throw new ArgumentNullException(nameof(calculationScenarios));
}
if (failureMechanism == null)
{
throw new ArgumentNullException(nameof(failureMechanism));
}
if (assessmentSection == null)
{
throw new ArgumentNullException(nameof(assessmentSection));
}
IAssemblyToolCalculatorFactory calculatorFactory = AssemblyToolCalculatorFactory.Instance;
IFailureMechanismSectionAssemblyCalculator calculator =
calculatorFactory.CreateFailureMechanismSectionAssemblyCalculator(AssemblyToolKernelFactory.Instance);
try
{
return calculator.AssembleDetailedAssessment(
failureMechanismSectionResult.DetailedAssessmentResult,
failureMechanismSectionResult.GetDetailedAssessmentProbability(calculationScenarios, failureMechanism, assessmentSection),
failureMechanism.MacroStabilityInwardsProbabilityAssessmentInput.GetN(failureMechanismSectionResult.Section.Length),
CreateAssemblyCategoriesInput(failureMechanism, assessmentSection));
}
catch (FailureMechanismSectionAssemblyCalculatorException e)
{
throw new AssemblyException(e.Message, e);
}
}
///
/// Assembles the tailor made assessment result.
///
/// The failure mechanism section result to
/// assemble the tailor made assembly for.
/// The failure mechanism this section belongs to.
/// The this section belongs to.
/// A .
/// Thrown when any parameter is null.
/// Thrown when the
/// could not be created.
public static FailureMechanismSectionAssembly AssembleTailorMadeAssessment(
MacroStabilityInwardsFailureMechanismSectionResult failureMechanismSectionResult,
MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection)
{
if (failureMechanismSectionResult == null)
{
throw new ArgumentNullException(nameof(failureMechanismSectionResult));
}
if (failureMechanism == null)
{
throw new ArgumentNullException(nameof(failureMechanism));
}
if (assessmentSection == null)
{
throw new ArgumentNullException(nameof(assessmentSection));
}
IAssemblyToolCalculatorFactory calculatorFactory = AssemblyToolCalculatorFactory.Instance;
IFailureMechanismSectionAssemblyCalculator calculator =
calculatorFactory.CreateFailureMechanismSectionAssemblyCalculator(AssemblyToolKernelFactory.Instance);
try
{
return calculator.AssembleTailorMadeAssessment(
failureMechanismSectionResult.TailorMadeAssessmentResult,
failureMechanismSectionResult.TailorMadeAssessmentProbability,
failureMechanism.MacroStabilityInwardsProbabilityAssessmentInput.GetN(failureMechanismSectionResult.Section.Length),
CreateAssemblyCategoriesInput(failureMechanism, assessmentSection));
}
catch (FailureMechanismSectionAssemblyCalculatorException e)
{
throw new AssemblyException(e.Message, e);
}
}
///
/// Assembles the combined assembly.
///
/// The failure mechanism section result to
/// combine the assemblies for.
/// The calculation scenarios belonging to this section.
/// The failure mechanism this section belongs to.
/// The this section belongs to.
/// A .
/// Thrown when any parameter is null.
/// Thrown when the
/// could not be created.
public static FailureMechanismSectionAssembly AssembleCombinedAssessment(
MacroStabilityInwardsFailureMechanismSectionResult failureMechanismSectionResult,
IEnumerable calculationScenarios,
MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection)
{
if (failureMechanismSectionResult == null)
{
throw new ArgumentNullException(nameof(failureMechanismSectionResult));
}
if (calculationScenarios == null)
{
throw new ArgumentNullException(nameof(calculationScenarios));
}
if (failureMechanism == null)
{
throw new ArgumentNullException(nameof(failureMechanism));
}
if (assessmentSection == null)
{
throw new ArgumentNullException(nameof(assessmentSection));
}
IAssemblyToolCalculatorFactory calculatorFactory = AssemblyToolCalculatorFactory.Instance;
IFailureMechanismSectionAssemblyCalculator calculator =
calculatorFactory.CreateFailureMechanismSectionAssemblyCalculator(AssemblyToolKernelFactory.Instance);
try
{
FailureMechanismSectionAssembly simpleAssembly = AssembleSimpleAssessment(failureMechanismSectionResult);
if (failureMechanismSectionResult.SimpleAssessmentResult == SimpleAssessmentResultType.ProbabilityNegligible ||
failureMechanismSectionResult.SimpleAssessmentResult == SimpleAssessmentResultType.NotApplicable)
{
return calculator.AssembleCombined(simpleAssembly);
}
return calculator.AssembleCombined(
simpleAssembly,
AssembleDetailedAssessment(failureMechanismSectionResult, calculationScenarios, failureMechanism, assessmentSection),
AssembleTailorMadeAssessment(failureMechanismSectionResult, failureMechanism, assessmentSection));
}
catch (FailureMechanismSectionAssemblyCalculatorException e)
{
throw new AssemblyException(e.Message, e);
}
}
///
/// Gets the assembly category group of the given .
///
/// The failure mechanism section result to get the assembly category group for.
/// The failure mechanism this section belongs to.
/// The this section belongs to.
/// Indicator that determines whether the manual assembly should be considered when assembling the result.
/// A .
/// Thrown when any parameter is null.
/// Thrown when the
/// could not be created.
public static FailureMechanismSectionAssemblyCategoryGroup GetSectionAssemblyCategoryGroup(MacroStabilityInwardsFailureMechanismSectionResult failureMechanismSectionResult,
MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection,
bool useManual)
{
if (failureMechanismSectionResult == null)
{
throw new ArgumentNullException(nameof(failureMechanismSectionResult));
}
if (failureMechanism == null)
{
throw new ArgumentNullException(nameof(failureMechanism));
}
if (assessmentSection == null)
{
throw new ArgumentNullException(nameof(assessmentSection));
}
return GetSectionAssembly(failureMechanismSectionResult, failureMechanism, assessmentSection, useManual).Group;
}
///
/// Assembles the failure mechanism assembly.
///
/// The failure mechanism to assemble for.
/// The the failure mechanism belongs to.
/// Indicator that determines whether the manual assembly should be considered when assembling the result.
/// A .
/// Thrown when any parameter is null.
/// Thrown when the
/// could not be created.
public static FailureMechanismAssembly AssembleFailureMechanism(
MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection,
bool useManual)
{
if (failureMechanism == null)
{
throw new ArgumentNullException(nameof(failureMechanism));
}
if (assessmentSection == null)
{
throw new ArgumentNullException(nameof(assessmentSection));
}
if (!failureMechanism.IsRelevant)
{
return FailureMechanismAssemblyResultFactory.CreateNotApplicableAssembly();
}
try
{
IAssemblyToolCalculatorFactory calculatorFactory = AssemblyToolCalculatorFactory.Instance;
AssemblyCategoriesInput assemblyCategoriesInput = CreateAssemblyCategoriesInput(failureMechanism, assessmentSection);
IEnumerable sectionAssemblies = failureMechanism.SectionResults
.Select(sr => GetSectionAssembly(sr, failureMechanism, assessmentSection, useManual))
.ToArray();
IFailureMechanismAssemblyCalculator calculator =
calculatorFactory.CreateFailureMechanismAssemblyCalculator(AssemblyToolKernelFactory.Instance);
return calculator.Assemble(sectionAssemblies, assemblyCategoriesInput);
}
catch (FailureMechanismAssemblyCalculatorException e)
{
throw new AssemblyException(e.Message, e);
}
catch (AssemblyException e)
{
throw new AssemblyException(RingtoetsCommonDataResources.FailureMechanismAssemblyFactory_Error_while_assembling_failureMechanism, e);
}
}
///
/// Gets the assembly of the given .
///
/// The failure mechanism section result to get the assembly for.
/// The failure mechanism to assemble for.
/// The the failure mechanism belongs to.
/// Indicator that determines whether the manual assembly should be considered when assembling the result.
/// A .
/// Thrown when a
/// could not be created.
private static FailureMechanismSectionAssembly GetSectionAssembly(MacroStabilityInwardsFailureMechanismSectionResult failureMechanismSectionResult,
MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection,
bool useManual)
{
FailureMechanismSectionAssembly sectionAssembly;
if (failureMechanismSectionResult.UseManualAssembly && useManual)
{
sectionAssembly = AssembleManualAssessment(failureMechanismSectionResult,
failureMechanism,
CreateAssemblyCategoriesInput(failureMechanism, assessmentSection));
}
else
{
sectionAssembly = AssembleCombinedAssessment(failureMechanismSectionResult,
failureMechanism.Calculations.Cast(),
failureMechanism,
assessmentSection);
}
return sectionAssembly;
}
///
/// Assembles the manual assembly.
///
/// The failure mechanism section result to assemble the
/// manual assembly for.
/// The failure mechanism to assemble for.
/// The input parameters used to determine the assembly categories.
/// A .
/// Thrown when the
/// could not be created.
private static FailureMechanismSectionAssembly AssembleManualAssessment(MacroStabilityInwardsFailureMechanismSectionResult sectionResult,
MacroStabilityInwardsFailureMechanism failureMechanism,
AssemblyCategoriesInput assemblyCategoriesInput)
{
IAssemblyToolCalculatorFactory calculatorFactory = AssemblyToolCalculatorFactory.Instance;
IFailureMechanismSectionAssemblyCalculator calculator =
calculatorFactory.CreateFailureMechanismSectionAssemblyCalculator(AssemblyToolKernelFactory.Instance);
try
{
return calculator.AssembleManual(sectionResult.ManualAssemblyProbability,
failureMechanism.MacroStabilityInwardsProbabilityAssessmentInput.GetN(
sectionResult.Section.Length),
assemblyCategoriesInput);
}
catch (FailureMechanismSectionAssemblyCalculatorException e)
{
throw new AssemblyException(e.Message, e);
}
}
private static AssemblyCategoriesInput CreateAssemblyCategoriesInput(MacroStabilityInwardsFailureMechanism failureMechanism,
IAssessmentSection assessmentSection)
{
return AssemblyCategoriesInputFactory.CreateAssemblyCategoriesInput(failureMechanism.MacroStabilityInwardsProbabilityAssessmentInput.GetN(
assessmentSection.ReferenceLine.Length),
failureMechanism,
assessmentSection);
}
}
}