// 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.

namespace Deltares.DamEngine.Data.General;

public class StabilityOptions
{
    /// <summary>
    /// Gets or sets the type of the stability zone.
    /// </summary>
    /// <value>
    /// The type of the stability zone.
    /// </value>
    public StabilityZoneType StabilityZoneType { get; set; } = StabilityZoneType.NoZones;

    /// <summary>
    /// Gets or sets the forbidden zone factor.
    /// </summary>
    /// <value>
    /// The forbidden zone factor.
    /// </value>
    public double? ForbiddenZoneFactor { get; set; } = 1.0;

    /// <summary>
    /// Gets or sets the traffic load.
    /// </summary>
    /// <value>
    /// The traffic load.
    /// </value>
    public double? TrafficLoad { get; set; } = 0;

    /// <summary>Gets or sets the degree of consolidation for the traffic load.</summary>
    /// <value>The degree of consolidation for traffic load.</value>
    public double? TrafficLoadDegreeOfConsolidation { get; set; }

    /// <summary>
    /// Gets or sets the minimal circle depth.
    /// </summary>
    /// <value>
    /// The minimal circle depth.
    /// </value>
    public double? MinimalCircleDepth { get; set; } = 0;
}