// 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;
using Core.Common.Base.Data;
using Core.Common.Base.Service;
using Core.Common.Utils;
using log4net;
using Ringtoets.Common.Service.Properties;
using Ringtoets.HydraRing.Calculation.Activities;
using Ringtoets.HydraRing.Calculation.Data.Output;
using Ringtoets.HydraRing.Data;
namespace Ringtoets.Common.Service
{
///
/// for running a design water level calculation.
///
public class DesignWaterLevelCalculationActivity : HydraRingActivity
{
private static readonly ILog log = LogManager.GetLogger(typeof(DesignWaterLevelCalculationActivity));
private readonly IHydraulicBoundaryLocation hydraulicBoundaryLocation;
private readonly double norm;
private readonly string hydraulicBoundaryDatabaseFilePath;
private readonly string ringId;
///
/// Creates a new instance of .
///
/// The to perform the calculation for.
/// The HLCD file that should be used for performing the calculation.
/// The id of the ring to perform the calculation for.
/// The norm to use during the calculation.
/// Thrown when is null.
public DesignWaterLevelCalculationActivity(IHydraulicBoundaryLocation hydraulicBoundaryLocation, string hydraulicBoundaryDatabaseFilePath, string ringId, double norm)
{
if (hydraulicBoundaryLocation == null)
{
throw new ArgumentNullException("hydraulicBoundaryLocation");
}
this.hydraulicBoundaryLocation = hydraulicBoundaryLocation;
this.hydraulicBoundaryDatabaseFilePath = hydraulicBoundaryDatabaseFilePath;
this.ringId = ringId;
this.norm = norm;
Name = string.Format(Resources.DesignWaterLevelCalculationService_Name_Calculate_assessment_level_for_location_0_,
hydraulicBoundaryLocation.Name);
}
protected override void OnRun()
{
if (!double.IsNaN(hydraulicBoundaryLocation.DesignWaterLevel))
{
State = ActivityState.Skipped;
return;
}
PerformRun(() => DesignWaterLevelCalculationService.Validate(hydraulicBoundaryLocation, hydraulicBoundaryDatabaseFilePath),
() => hydraulicBoundaryLocation.DesignWaterLevel = (RoundedDouble) double.NaN,
() => DesignWaterLevelCalculationService.Calculate(hydraulicBoundaryLocation, hydraulicBoundaryDatabaseFilePath,
ringId, norm));
}
protected override void OnFinish()
{
PerformFinish(() =>
{
hydraulicBoundaryLocation.DesignWaterLevel = (RoundedDouble) Output.Result;
bool designWaterLevelCalculationConvergence =
Math.Abs(Output.CalculatedReliabilityIndex - StatisticsConverter.NormToBeta(norm)) <= 1.0e-3;
if (!designWaterLevelCalculationConvergence)
{
log.WarnFormat(Resources.DesignWaterLevelCalculationActivity_DesignWaterLevel_calculation_for_location_0_not_converged, hydraulicBoundaryLocation.Name);
}
hydraulicBoundaryLocation.DesignWaterLevelCalculationConvergence = designWaterLevelCalculationConvergence
? CalculationConvergence.CalculatedConverged
: CalculationConvergence.CalculatedNotConverged;
});
}
}
}