// 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 Deltares.DamEngine.Calculators.KernelWrappers.Interfaces;
using Deltares.DamEngine.Data.General;
using Deltares.WTIPiping;

namespace Deltares.DamEngine.Calculators.KernelWrappers.WtiPipingSellmeijerRevised;

/// <summary>
/// Input parameters for Wti Piping SellmeijerRevised
/// </summary>
public class WtiPipingSellmeijerRevisedInput : IKernelDataInput
{
    // For now, Ich is just used with a default value (see MWDAM-1299)
    private const double cIch = 0.3;

    /// <summary>
    /// Gets or sets the model factor piping.
    /// </summary>
    /// <value>
    /// The model factor piping.
    /// </value>
    public double ModelFactorPiping { get; set; } = 1.0;

    /// <summary>
    /// Gets or sets the River level .
    /// </summary>
    /// <value>
    /// The h river.
    /// </value>
    public double HRiver { get; set; }

    /// <summary>
    /// Gets or sets the head at exitpoint.
    /// </summary>
    /// <value>
    /// The h exit.
    /// </value>
    public double HExit { get; set; }

    /// <summary>
    /// Gets or sets the reduction factor.
    /// </summary>
    /// <value>
    /// The rc.
    /// </value>
    public double Rc { get; set; } = WTIPipingConstants.RcDefault;

    /// <summary>
    /// Gets or sets the total thickness of cover layer .
    /// </summary>
    /// <value>
    /// The d total.
    /// </value>
    public double DTotal { get; set; }

    /// <summary>
    /// Gets or sets the ich (critical Heave gradient).
    /// </summary>
    /// <value>
    /// The ich.
    /// </value>
    public double Ich { get; set; } = cIch;

    /// <summary>
    /// The bottom level of the aquitard layer which is on a level above the exit point's
    /// z-coordinate. A value of <see cref="double.NaN"/> indicates that no such aquitard
    /// layer exists.
    /// </summary>
    public double BottomLevelAquitardAboveExitPointZ { get; set; } = double.NaN;

    /// <summary>
    /// Gets or sets the whites drag coefficient.
    /// </summary>
    /// <value>
    /// The whites drag coefficient.
    /// </value>
    public double WhitesDragCoefficient = WTIPipingConstants.WhitesDragCoefficient;

    /// <summary>
    /// Gets or sets the bedding angle.
    /// </summary>
    /// <value>
    /// The bedding angle.
    /// </value>
    public double BeddingAngle = WTIPipingConstants.BeddingAngleSellmeijerRevised;

    /// <summary>
    /// Gets or sets the gamma sub particles.
    /// </summary>
    /// <value>
    /// The gamma sub particles.
    /// </value>
    public double GammaSubParticles { get; set; } = WTIPipingConstants.GammaSubParticles;

    /// <summary>
    /// Gets or sets the volumetric weight of water.
    /// </summary>
    /// <value>
    /// The volumetric weight of water.
    /// </value>
    public double VolumetricWeightOfWater { get; set; } = Physics.UnitWeightOfwater;

    /// <summary>
    /// Gets or sets the kinematic viscosity of water.
    /// </summary>
    /// <value>
    /// The kinematic viscosity water.
    /// </value>
    public double KinematicViscosityWater { get; set; } = Physics.WaterViscosity;

    /// <summary>
    /// Gets or sets the gravity.
    /// </summary>
    /// <value>
    /// The gravity.
    /// </value>
    public double Gravity { get; set; } = Physics.GravityConstant;

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

    /// <summary>
    /// Gets or sets the D70 mean.
    /// </summary>
    /// <value>
    /// The D70 mean.
    /// </value>
    public double D70Mean { get; set; } = WTIPipingConstants.D70Mean;

    /// <summary>
    /// Gets or sets the seepagelength.
    /// </summary>
    /// <value>
    /// The length of the seepage.
    /// </value>
    public double SeepageLength { get; set; }

    /// <summary>
    /// Gets or sets the darcy permeability.
    /// </summary>
    /// <value>
    /// The darcy permeability.
    /// </value>
    public double DarcyPermeability { get; set; }

    /// <summary>
    /// Gets or sets the height of the aquifer.
    /// </summary>
    /// <value>
    /// The height of the aquifer.
    /// </value>
    public double DAquifer { get; set; }

    /// <summary>
    /// Gets or sets the model factor uplift.
    /// </summary>
    /// <value>
    /// The model factor uplift.
    /// </value>
    public double ModelFactorUplift { 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 phi exit.
    /// </summary>
    /// <value>
    /// The phi exit.
    /// </value>
    public double PhiExit { get; set; }

    /// <summary>
    /// Gets or sets the r exit.
    /// </summary>
    /// <value>
    /// The r exit.
    /// </value>
    public double RExit { get; set; }

    /// <summary>
    /// Gets or sets the phi polder.
    /// </summary>
    /// <value>
    /// The phi polder.
    /// </value>
    public double PhiPolder { get; set; }
}