// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of the Macro Stability kernel.
//
// The Macro Stability kernel is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser 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 System.Collections.Generic;
using Deltares.Geometry;
using Deltares.Geotechnics;
using Deltares.Geotechnics.Soils;
using Deltares.Standard;

namespace Deltares.Geotechnics.WaternetCreator
{
    /// <summary>
    /// Calculation class to determine the uplift factor.
    /// </summary>
    public class UpliftCalculatorWTI
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="UpliftCalculator"/> class.
        /// </summary>
        public UpliftCalculatorWTI()
        {
            VolumicWeightOfWater = Physics.UnitWeightOfwater;
            UnitWeightSoilEmbankment = null;
            IsUseOvenDryUnitWeight = false;
        }

        /// <summary>
        /// Gets or sets a value indicating whether this instance is use oven dry unit weight.
        /// </summary>
        /// <value>
        /// <c>true</c> if this instance is use oven dry unit weight; otherwise, <c>false</c>.
        /// </value> 
        public bool IsUseOvenDryUnitWeight { get; set; }

        /// <summary>
        /// Gets or sets the volumic weight of water.
        /// </summary>
        /// <value>
        /// The volumic weight of water.
        /// </value>
        public double VolumicWeightOfWater { get; set; }

        /// <summary>
        /// Gets or sets the soil profile 1D.
        /// </summary>
        /// <value>
        /// The soil profile 1D.
        /// </value>
        public SoilProfile1D SoilProfile { get; set; }

        /// <summary>
        /// Gets or sets the top of layer to be evaluated.
        /// </summary>
        /// <value>
        /// The top of layer to be evaluated.
        /// </value>
        public double TopOfLayerToBeEvaluated { get; set; }

        /// <summary>
        /// Gets or sets the PL-lines.
        /// </summary>
        /// <value>
        /// The PL-lines.
        /// </value>
        public List<GeometryPointString> PLLines { get; set; }

        /// <summary>
        /// Gets or sets the surface level.
        /// </summary>
        /// <value>
        /// The surface level.
        /// </value>
        public double SurfaceLevel { get; set; }

        /// <summary>
        /// Gets or sets the phreatic level.
        /// </summary>
        /// <value>
        /// The phreatic level.
        /// </value>
        public double PhreaticLevel { get; set; }

        /// <summary>
        /// Gets or sets uplift top level.
        /// </summary>
        /// <value>
        /// Uplift top level.
        /// </value>
        public double UpLiftTopLevel { get; set; }

        /// <summary>
        /// Gets or sets the unit weight soil embankment.
        /// </summary>
        /// <value>
        /// The unit weight soil embankment.
        /// </value>
        public double? UnitWeightSoilEmbankment { get; set; }

        /// <summary>
        /// Calculates the uplift factor associated to a given <paramref name="headOfPLLine"/>.
        /// </summary>
        /// <param name="headOfPLLine">The head of pl line.</param>
        /// <returns>The uplift factor</returns>
        public double CalculateUpliftFactor(double headOfPLLine)
        {
            var massCalculator = CreateSoilVolumeMassCalculator();

            massCalculator.IsUseOvenDryUnitWeight = IsUseOvenDryUnitWeight;
            var mass = massCalculator.Calculate();
            var height = headOfPLLine - TopOfLayerToBeEvaluated;
            var phreaticPressure = VolumicWeightOfWater*height;

            if (phreaticPressure > 0)
            {
                return mass/phreaticPressure;
            }
            else
            {
                return double.MaxValue;
            }
        }

        /// <summary>
        /// Calculate soil extra height to be added to obtain the specified <paramref name="upliftFactor"/> with a given <paramref name="headOfPLLine"/>.
        /// </summary>
        /// <param name="headOfPLLine"></param>
        /// <param name="upliftFactor"></param>
        /// <returns>Required soil extra heigh to obtain the specified uplift factor.</returns>
        public double CalculateExtraHeight(double headOfPLLine, double upliftFactor)
        {
            var massCalculator = CreateSoilVolumeMassCalculator();

            var mass = massCalculator.Calculate();
            var toplevel = Math.Min(SurfaceLevel, TopOfLayerToBeEvaluated);
            var height = headOfPLLine - toplevel;
            var phreaticPressure = VolumicWeightOfWater*height;

            double requiredExtraMass = upliftFactor*phreaticPressure - mass;

            double unitWeightSoil = SoilProfile.Layers[0].Soil.AbovePhreaticLevel;
            if (UnitWeightSoilEmbankment != null)
            {
                unitWeightSoil = UnitWeightSoilEmbankment.Value;
            }

            if (requiredExtraMass > 0)
            {
                return requiredExtraMass/unitWeightSoil;
            }
            else
            {
                return 0.0;
            }
        }

        /// <summary>
        /// Calculates the head of PL-line associated to <paramref name="upliftFactor"/>.
        /// </summary>
        /// <param name="upliftFactor">The uplift factor.</param>
        /// <returns>The head of PL-line associated to a given uplift factor.</returns>
        public double CalculateHeadOfPLLine(double upliftFactor)
        {
            var massCalculator = CreateSoilVolumeMassCalculator();
            massCalculator.IsUseOvenDryUnitWeight = IsUseOvenDryUnitWeight;

            var massSoils = massCalculator.Calculate();
            var massWater = massSoils/(upliftFactor*VolumicWeightOfWater);
            return massWater + TopOfLayerToBeEvaluated;
        }

        private SoilVolumeMassCalculator CreateSoilVolumeMassCalculator()
        {
            return new SoilVolumeMassCalculator
            {
                PhreaticLevel = PhreaticLevel,
                SoilProfile = SoilProfile,
                TopOfLayerToBeEvaluated = TopOfLayerToBeEvaluated,
                SurfaceLevel = SurfaceLevel,
                VolumicWeightOfWater = VolumicWeightOfWater
            };
        }
    }
}