// Copyright (C) Stichting Deltares 2025. 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 Deltares.DamEngine.Calculators.KernelWrappers.Interfaces;
using Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.Standard.Calculation;
using Deltares.DamEngine.Data.Standard.Logging;

namespace Deltares.DamEngine.Calculators.KernelWrappers.WtiPipingSellmeijerRevised;

/// <summary>
/// Output parameters for Wti Piping SellmeijerRevised
/// Note: the Wti kernel does provide more output (such as CCreep, Zp etc) but thta just is not used in DAM.
/// </summary>
public class WtiPipingSellmeijerRevisedOutput : IKernelDataOutput
{
    /// <summary>
    /// Gets or sets the backward erosion safetyfactor.
    /// </summary>
    /// <value>
    /// The FoS be.
    /// </value>
    public double FoSbe { get; set; }

    /// <summary>
    /// Gets or sets the uplift safetyfactor.
    /// </summary>
    /// <value>
    /// The FoS u.
    /// </value>
    public double FoSu { get; set; }

    /// <summary>
    /// Gets or sets the heave safetyfactor.
    /// </summary>
    /// <value>
    /// The FoS h.
    /// </value>
    public double FoSh { get; set; }

    /// <summary>
    /// Gets or sets the H-critical (critical water level for backward erosion).
    /// </summary>
    /// <value>
    /// The Hc be.
    /// </value>
    public double Hcbe { get; set; }

    /// <summary>
    /// Gets or sets the H-critical (critical water level for uplift).
    /// </summary>
    /// <value>
    /// The Hc u.
    /// </value>
    public double Hcu { get; set; }

    /// <summary>
    /// Gets or sets the H-critical (critical waterlevel for heave).
    /// </summary>
    /// <value>
    /// The Hc h.
    /// </value>
    public double Hch { get; set; }

    /// <summary>
    /// Gets or sets the gradient (vertical outflow gradient for heave).
    /// </summary>
    /// <value>
    /// The gradient.
    /// </value>
    public double Gradient { get; set; }

    /// <summary>
    /// Gets or sets the calculation result.
    /// </summary>
    /// <value>
    /// The calculation result.
    /// </value>
    public CalculationResult CalculationResult { get; set; }

    /// <summary>
    /// Gets or sets the uplift factor.
    /// </summary>
    /// <value>
    /// The uplift factor.
    /// </value>
    public double? UpliftFactor { get; set; }

    /// <summary>
    /// Gets or sets the x-coordinate of the exit point.
    /// </summary>
    /// <value>
    /// The exit point x.
    /// </value>
    public double ExitPointX { get; set; }

    /// <summary>
    /// Gets or sets the uplift situation.
    /// </summary>
    /// <value>
    /// The uplift situation.
    /// </value>
    public UpliftSituation UpliftSituation { get; set; }

    /// <summary>
    /// Gets or sets the effective stress.
    /// </summary>
    /// <value>
    /// The effective stress.
    /// </value>
    public double EffectiveStress { get; set; }

    /// <summary>
    /// Gets or sets the delta phi c u (the critical head difference for uplift).
    /// </summary>
    /// <value>
    /// The delta phi cu.
    /// </value>
    public double DeltaPhiCu { get; set; }

    /// <summary>
    /// Gets or sets the delta phi c be (the critical head difference for backward erosion).
    /// </summary>
    /// <value>
    /// The delta phi c be.
    /// </value>
    public double DeltaPhiCbe { get; set; }

    /// <summary>
    /// Gets or sets the delta phi be (the reduced head difference for backward erosion).
    /// </summary>
    /// <value>
    /// The delta phi be.
    /// </value>
    public double DeltaPhibe { get; set; }

    /// <summary>
    /// Gets or sets the length of the seepage.
    /// </summary>
    /// <value>
    /// The length of the seepage.
    /// </value>
    public double SeepageLength { get; set; }
    
    /// <summary>
    /// Gets or sets the message for the log.
    /// </summary>
    /// <value>
    /// The message for the log (in case of an error or a warning).
    /// </value>
    public LogMessage Message { get; set; }
}