// Copyright (C) Stichting Deltares 2024. All rights reserved.
// 
// This file is part of the Dam Engine.
// 
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
// 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 Deltares.DamEngine.Calculators.Uplift;
using Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.General.PlLines;
using Deltares.DamEngine.Data.General.Sensors;
using Deltares.DamEngine.Data.Geotechnics;

namespace Deltares.DamEngine.Calculators.KernelWrappers.Common;

/// <summary>
///  Helper for Uplift
/// </summary>
public class UpliftHelper
{
    /// <summary>
    /// Determines the pl lines for stability.
    /// </summary>
    /// <param name="damKernelInput">The dam kernel input.</param>
    /// <param name="useRivelLevelLow">if set to <c>true</c> [use rivel level low].</param>
    /// <param name="upliftSituation">The uplift situation.</param>
    /// <returns>pl lines</returns>
    public PlLines DeterminePlLinesForStability(DamKernelInput damKernelInput, bool useRivelLevelLow,
                                                out UpliftSituation upliftSituation)
    {
        double riverLevel = damKernelInput.RiverLevelHigh;
        double? riverLevelLow = null;
        if (useRivelLevelLow)
        {
            riverLevelLow = damKernelInput.RiverLevelLow;
        }

        var sensorPlLineCreatorSettings = new SensorPlLineCreatorSettings
        {
            SensorLocation = damKernelInput.Location.SensorLocation,
            DateTime = damKernelInput.TimeStepDateTime
        };
        PlLines plLines = PlLinesHelper.CreatePlLinesForStability(damKernelInput.Location, damKernelInput.SubSoilScenario, riverLevel,
                                                                  riverLevelLow, sensorPlLineCreatorSettings, out upliftSituation);
        upliftSituation.IsUplift = DetermineIsUplift(plLines, damKernelInput.Location, damKernelInput.SubSoilScenario, out double xCoordLowestUpliftFactor);
        upliftSituation.XCoordinateLowestUpliftFactorPoint = xCoordLowestUpliftFactor;

        return plLines;
    }

    /// <summary>
    /// Determines if there is uplift.
    /// </summary>
    /// <param name="plLines">The pl lines.</param>
    /// <param name="location">The location.</param>
    /// <param name="subSoilScenario">The sub soil scenario.</param>
    /// <param name="xCoordLowestUpliftFactor">The X co-ordinate of the point with the lowest uplift factor.</param>
    /// <returns><c>true</c> if there is uplift</returns>
    private static bool DetermineIsUplift(PlLines plLines, Location location, SoilGeometryProbability subSoilScenario, out double xCoordLowestUpliftFactor)
    {
        if (plLines == null)
        {
            xCoordLowestUpliftFactor = double.NaN;
            return false;
        }

        double upliftCriterion = location.ModelFactors.UpliftCriterionStability;
        SurfaceLine2 surfaceLineWithNewHeight = location.SurfaceLine;
        double? upliftFactor = GetLowestUpliftFactor(surfaceLineWithNewHeight,
                                                     subSoilScenario.SoilProfile1D, subSoilScenario.SoilProfile2D, plLines, 
                                                     location, out xCoordLowestUpliftFactor);
        
        return upliftFactor < upliftCriterion;
    }

    private static double? GetLowestUpliftFactor(SurfaceLine2 surfaceLine, SoilProfile1D soilProfile1D, 
                                                 SoilProfile2D soilProfile2D, PlLines plLines, Location location, 
                                                 out double xCoordLowestUpliftFactor)
    {
        var upliftLocationDeterminator = new UpliftLocationDeterminator
        {
            SurfaceLine = surfaceLine,
            SoilProfile = soilProfile1D,
            SoilProfile2D = soilProfile2D,
            SoilList = location.SoilList,
            DikeEmbankmentMaterial = location.GetDikeEmbankmentSoil(),
            PlLines = plLines,
            XSoilGeometry2DOrigin = location.XSoilGeometry2DOrigin
        };
        UpliftLocationAndResult upliftLocationAndResult = upliftLocationDeterminator.GetLocationWithLowestUpliftFactor();
        xCoordLowestUpliftFactor = upliftLocationAndResult?.X ?? double.NaN;
        return upliftLocationAndResult?.UpliftFactor;
    }
}