// Copyright (C) Stichting Deltares 2018. 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.Data.Standard;
using Deltares.DamEngine.Data.Standard.Language;

namespace Deltares.DamEngine.Data.Geotechnics
{
    /// <summary>
    /// Soil class, representing a specific soil material and its properties
    /// </summary>
    [Serializable]
    public class Soil : IName
    {
        // Stability properties
        private string name = "";
        private SoilType soilType;

        /// <summary>
        /// Initializes a new instance of the <see cref="Soil"/> class.
        /// </summary>
        public Soil()
        {
            Name = LocalizationManager.GetTranslatedText(this, "DefaultNameSoilMaterial");
            soilType = SoilType.Sand;            
        }


        /// <summary>
        /// Initializes a new instance of the <see cref="Soil"/> class.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="belowPhreaticLevel">Unit weight below phreatic level</param>
        /// <param name="abovePhreaticLevel">Unit weight above phreatic level</param>
        public Soil(string name, double belowPhreaticLevel, double abovePhreaticLevel) : this()
        {
            Name = name;
            AbovePhreaticLevel = abovePhreaticLevel;
            BelowPhreaticLevel = belowPhreaticLevel;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="Soil"/> class.
        /// </summary>
        /// <param name="name">The name.</param>
        public Soil(string name) : this()
        {
            Name = name;            
        }

        /// <summary>
        /// Gets or sets the type of the soil.
        /// </summary>
        /// <value>
        /// The type of the soil.
        /// </value>
        public virtual SoilType SoilType
        {
            get
            {
                return soilType;
            }
            set
            {
                if (!soilType.Equals(value))
                {
                    soilType = value;                    
                }                
            }
        }

        #region property Name

        /// <summary>
        /// Gets or sets the name of the soil.
        /// </summary>
        public string Name
        {
            get
            {
                return name;
            }
            set
            {
                name = value;                
            }
        }

        /// <summary>
        /// Returns a <see cref="System.String" /> that represents this instance.
        /// </summary>
        /// <returns>
        /// A <see cref="System.String" /> that represents this instance.
        /// </returns>
        public override string ToString()
        {
            return Name;
        }

        #endregion property Name

        #region property Weight

        /// <summary>
        /// Unit Weight below the phreatic level (kN/m3)
        /// </summary>
        public double BelowPhreaticLevel { get; set; } = double.NaN;

        /// <summary>
        /// Unit Weight above the phreatic level (kN/m3)
        /// </summary>
        public double AbovePhreaticLevel { get; set; } = double.NaN;
        #endregion

        #region Piping
        /// <summary>
        /// Bedding Angle (degree).
        /// </summary>
        /// <value>
        /// The bedding angle.
        /// </value>
        public double BeddingAngle { get; set; } =  double.NaN;
        /// <summary>
        /// Diameter D70 (micrometer).
        /// </summary>
        /// <value>
        /// The diameter D70.
        /// </value>
        public double DiameterD70 { get; set; } = double.NaN;
        /// <summary>
        /// Horizontal permeability (m/s)
        /// </summary>
        /// <value>
        /// The permeab kx.
        /// </value>
        public double PermeabKx { get; set; } = double.NaN;
        /// <summary>
        /// Whites constant (-).
        /// </summary>
        /// <value>
        /// The whites constant.
        /// </value>
        public double WhitesConstant { get; set; } = double.NaN;
        /// <summary>
        /// Diameter D90 (micrometer).
        /// </summary>
        /// <value>
        /// The diameter D90.
        /// </value>
        public double DiameterD90 { get; set; } = double.NaN;
        #endregion

        #region Macrostability

        /// <summary>
        /// Ovendry unit weight [kN/m3]
        /// </summary>
        public double DryUnitWeight { get; set; } = double.NaN;

        /// <summary>
        /// Cohesion (the force that holds together molecules or like particles within a soil) [kN/m2]
        /// </summary>
        public double Cohesion { get; set; } = double.NaN;

        /// <summary>
        /// Critical state friction angle (deg)
        /// </summary>
        public double FrictionAngle { get; set; } = double.NaN;

        /// <summary>
        /// Pre-overburden pressure (POP) 
        /// Equal to pre-consolidation stress minus effective stress
        /// </summary>
        public double PoP { get; set; } = double.NaN;

        /// <summary>
        /// Over-consolidation ratio (OCR)
        /// </summary>
        public double Ocr { get; set; } = double.NaN;

        /// <summary>
        /// Ratio Cu/Pc
        /// </summary>
        public double RatioCuPc { get; set; } = double.NaN;

        /// <summary>
        /// Cu Top
        /// </summary>
        public double CuTop { get; set; } = double.NaN;

        /// <summary>
        /// Cu Bottom
        /// </summary>
        public double CuBottom { get; set; } = double.NaN;

        /// <summary>
        /// Use POP for shear strength model
        /// </summary>
        public bool UsePop { get; set; } = false;
        
        /// <summary>
        /// Dilatancy (shear thickening) type
        /// </summary>
        public DilatancyType? DilatancyType { get; set; } = null;

        /// <summary>
        /// Gets or sets the strength increase exponent.
        /// </summary>
        /// <value>
        /// The strength increase exponent.
        /// </value>
        public double StrengthIncreaseExponent { get; set; } = double.NaN;

        /// <summary>
        /// Shear strength model to use
        /// </summary>
        public ShearStrengthModel? ShearStrengthModel { get; set; } = null;

        /// <summary>
        /// Gets or sets a value indicating whether to use the default shear strength model.
        /// </summary>
        /// <value>
        ///   <c>true</c> if default shear strength model must be used; otherwise, <c>false</c>.
        /// </value>
        public bool? UseDefaultShearStrengthModel { get; set; } = null;

        /// <summary>
        /// Gets or sets the slope of the rest profile.
        /// </summary>
        /// <value>
        /// The slope of the rest profile.
        /// </value>
        public double SlopeRestProfile { get; set; } = double.NaN;

        #endregion


        /// <summary>
        /// Assigns the specified a soil.
        /// </summary>
        /// <param name="aSoil">a soil.</param>
        public void Assign(Soil aSoil)
        {
            name = aSoil.Name;
            BeddingAngle = aSoil.BeddingAngle;
            DiameterD70 = aSoil.DiameterD70;
            PermeabKx = aSoil.PermeabKx;
            WhitesConstant = aSoil.WhitesConstant;
            DiameterD90 = aSoil.DiameterD90;
            DilatancyType = aSoil.DilatancyType;
            ShearStrengthModel = aSoil.ShearStrengthModel;
            BelowPhreaticLevel = aSoil.BelowPhreaticLevel;
            AbovePhreaticLevel = aSoil.AbovePhreaticLevel;
            Cohesion = aSoil.Cohesion;
            FrictionAngle = aSoil.FrictionAngle;
            PoP = aSoil.PoP;
            Ocr = aSoil.Ocr;
            RatioCuPc = aSoil.RatioCuPc;
            CuTop = aSoil.CuTop;
            CuBottom = aSoil.CuBottom;
            UsePop = aSoil.UsePop;
            StrengthIncreaseExponent = aSoil.StrengthIncreaseExponent;
        }
    }
}