// 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.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
{
    // Soil properties
    private string name = "";

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

    /// <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>
    /// Assigns the properties of aSoil to this Soil.
    /// </summary>
    /// <param name="aSoil">a soil.</param>
    public void Assign(Soil aSoil)
    {
        name = aSoil.Name;
        DiameterD70 = aSoil.DiameterD70;
        PermeabKx = aSoil.PermeabKx;
        ShearStrengthModel = aSoil.ShearStrengthModel;
        BelowPhreaticLevel = aSoil.BelowPhreaticLevel;
        AbovePhreaticLevel = aSoil.AbovePhreaticLevel;
        Cohesion = aSoil.Cohesion;
        FrictionAngle = aSoil.FrictionAngle;
        PoP = aSoil.PoP;
        Ocr = aSoil.Ocr;
        RatioCuPc = aSoil.RatioCuPc;
        StrengthIncreaseExponent = aSoil.StrengthIncreaseExponent;
        SigmaTauCurve = new SigmaTauCurve();
        if ((ShearStrengthModel == Geotechnics.ShearStrengthModel.SigmaTauCurve) && (aSoil.SigmaTauCurve != null))
        {
            SigmaTauCurve.Assign(aSoil.SigmaTauCurve);
        }
        SuTableCurve = new SuTableCurve();
        if ((ShearStrengthModel == Geotechnics.ShearStrengthModel.SuTable) && (aSoil.SuTableCurve != null))
        {
            SuTableCurve.Assign(aSoil.SuTableCurve);
        }
    }

    #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>
    /// 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;

    #endregion

    #region Macrostability
    
    /// <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>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; }

    /// <summary>
    /// The sigma tau curve (for Shear Strength Model = SigmaTauCurve)  
    /// </summary>
    public SigmaTauCurve SigmaTauCurve { get; set; } = new();

    /// <summary>
    /// The su table (for Shear Strength Model = SuTable)  
    /// </summary>
    public SuTableCurve SuTableCurve { get; set; } = new();

    #endregion
}