// 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 System;
using Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.Geotechnics;

namespace Deltares.DamEngine.Calculators.KernelWrappers.Common;

/// <summary>
/// Input that all dam kernels share
/// </summary>
public class DamKernelInput
{
    /// <summary>
    /// Gets or sets the calculation directory.
    /// </summary>
    /// <value>
    /// The calculation directory.
    /// </value>
    public string CalculationDir { get; set; }

    /// <summary>
    /// Gets or sets the project directory.
    /// </summary>
    /// <value>
    /// The project directory.
    /// </value>
    public string ProjectDir { get; set; }

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

    /// <summary>
    /// Gets or sets the filename prefix.
    /// </summary>
    /// <value>
    /// The filename prefix.
    /// </value>
    public string FilenamePrefix { get; set; }

    /// <summary>
    /// Gets or sets the sub soil scenario.
    /// </summary>
    /// <value>
    /// The sub soil scenario.
    /// </value>
    public SoilGeometryProbability SubSoilScenario { get; set; }

    /// <summary>
    /// Gets or sets the date time (for operational calculation)
    /// </summary>
    /// <value>
    /// The date time.
    /// </value>
    public DateTime TimeStepDateTime { get; set; }

    /// <summary>
    /// The high river level
    /// </summary>
    public double RiverLevelHigh { get; set; }

    /// <summary>
    /// The low river level
    /// </summary>
    public double? RiverLevelLow { get; set; }

    /// <summary>
    /// Gets or sets the dam failure mechanism calculation specification.
    /// </summary>
    /// <value>
    /// The dam failure mechanism calculation specification.
    /// </value>
    public DamFailureMechanismeCalculationSpecification DamFailureMechanismeCalculationSpecification { get; set; }

    /// <summary>
    /// Gets or sets the current embankment soil (either DikeEmbakmentSoil or ShoulderEmbankmentSoil).
    /// </summary>
    /// <value>
    /// The current embankment soil.
    /// </value>
    public Soil CurrentEmbankmentSoil { get; set; }

    /// <summary>
    /// Gets or sets the original soil profile 2D.
    /// Used during the design process to restore the original soil profile 2D.
    /// </summary>
    public SoilProfile2D OriginalSoilProfile2D { get; set; }
}