//-----------------------------------------------------------------------
// <copyright file="UpliftCalculator.cs" company="Deltares">
//  Copyright (c) 2009 Deltares. All rights reserved.
// </copyright>
// <author>B.S.T.I.M. The</author>
// <email>tom.the@deltares.nl</email>
// <date>18-05-2009</date>
// <summary>Calculator for Uplift</summary>
//-----------------------------------------------------------------------

using System;
using System.Runtime.Serialization;
using Deltares.Geotechnics;
using Deltares.Geotechnics.Soils;
using Deltares.Standard;

namespace Deltares.Uplift
{
    [Serializable]
    public class UpliftCalculatorException : ApplicationException
    {
        //
        // For guidelines regarding the creation of new exception types, see
        //    http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconerrorraisinghandlingguidelines.asp
        // and
        //    http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dncscol/html/csharp07192001.asp
        //

        public UpliftCalculatorException() {}
        public UpliftCalculatorException(string message) : base(message) {}
        public UpliftCalculatorException(string message, ApplicationException inner) : base(message, inner) {}

        protected UpliftCalculatorException(
            SerializationInfo info,
            StreamingContext context)
            : base(info, context) {}
    }

    public class UpliftCalculator
    {
        public UpliftCalculator()
        {
            VolumicWeightOfWater = Physics.UnitWeightOfwater;
            UnitWeightSoilEmbankment = null;
            IsUseOvenDryUnitWeight = false;
        }

        public bool IsUseOvenDryUnitWeight { get; set; }
        public double VolumicWeightOfWater { get; set; }
        public SoilProfile1D SoilProfile { get; set; }
        public double TopOfLayerToBeEvaluated { get; set; }
        public double SurfaceLevel { get; set; }
        public double PhreaticLevel { get; set; }
        public double UpLiftTopLevel { get; set; }
        public double? UnitWeightSoilEmbankment { get; set; }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="headOfPLLine"></param>
        /// <returns></returns>
        public double CalculateUpliftFactor(double headOfPLLine)
        {
            ThrowWhenSoilProfileIsNull();

            var massCalculator = CreateSoilVolumeMassCalculator();

            massCalculator.IsUseOvenDryUnitWeight = IsUseOvenDryUnitWeight;
            var mass = massCalculator.CalculateTotalMass();
            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 upliftFactor with a given head of PLline
        /// </summary>
        /// <param name="headOfPLLine"></param>
        /// <param name="upliftFactor"></param>
        /// <param name="unitWeightSoil"></param>
        /// <returns>Required extra height</returns>
        public double CalculateExtraHeight(double headOfPLLine, double upliftFactor)
        {
            ThrowWhenSoilProfileIsNull();

            var massCalculator = CreateSoilVolumeMassCalculator();

            var mass = massCalculator.CalculateTotalMass();
            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>
        /// 
        /// </summary>
        /// <param name="upliftFactor"></param>
        /// <returns></returns>
        public double CalculateHeadOfPLLine(double upliftFactor)
        {
            ThrowWhenSoilProfileIsNull();

            var massCalculator = CreateSoilVolumeMassCalculator();
            massCalculator.IsUseOvenDryUnitWeight = IsUseOvenDryUnitWeight;

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

        /// <summary>
        /// 
        /// </summary>
        /// <returns></returns>
        private SoilVolumicMassCalculator CreateSoilVolumeMassCalculator()
        {
            SoilProfile1D updatedSoilProfile = AddTopLayerIfSurfaceLevelHigherThenToplevelSoilProfile(SoilProfile);
            return new SoilVolumicMassCalculator
                {
                    PhreaticLevel = PhreaticLevel,
                    SoilProfile = updatedSoilProfile,
                    TopOfLayerToBeEvaluated = TopOfLayerToBeEvaluated,
                    SurfaceLevel = SurfaceLevel,
                    VolumicWeightOfWater = VolumicWeightOfWater
                };
        }

        /// <summary>
        /// Adds an extra top layer if surface level is higher then toplevel soil profile.
        /// </summary>
        /// <param name="updatedSoilProfile">The updated soil profile.</param>
        /// <returns></returns>
        private SoilProfile1D AddTopLayerIfSurfaceLevelHigherThenToplevelSoilProfile(SoilProfile1D updatedSoilProfile)
        {
            if ((SurfaceLevel > SoilProfile.TopLevel) && (UnitWeightSoilEmbankment != null))
            {
                updatedSoilProfile = new SoilProfile1D();
                updatedSoilProfile.Assign(SoilProfile);
                updatedSoilProfile.Layers.Insert(0, new SoilLayer1D(new Soil()
                    {
                        AbovePhreaticLevel = UnitWeightSoilEmbankment.Value,
                        BelowPhreaticLevel = UnitWeightSoilEmbankment.Value
                    }, SurfaceLevel));
            }
            return updatedSoilProfile;
        }

        /// <summary>
        /// Check precondition
        /// </summary>
        private void ThrowWhenSoilProfileIsNull()
        {
            if (SoilProfile == null)
            {
                throw new UpliftCalculatorException("The soilprofile is not defined");
            }
        }
    }
}