// Copyright (C) Stichting Deltares 2025. All rights reserved.
// 
// This file is part of the application DAM - UI.
// 
// DAM - UI is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
// 
// You should have received a copy of the GNU 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;

namespace Deltares.Dam.Data;

/// <summary>
/// Exception class for UpliftFactorToBetaCalculator
/// </summary>
public class UpliftFactorToBetaCalculatorException : Exception
{
    public UpliftFactorToBetaCalculatorException(string message) : base(message) {}
}

/// <summary>
/// Class to calculate the probability of uplift from upliftfactor
/// </summary>
public class UpliftFactorToBetaCalculator
{
    /// <summary>
    /// Compute the Beta from the Upliftfactor
    /// </summary>
    /// <param name="upliftFactor"></param>
    /// <returns></returns>
    static public double ComputeBetaFromUpliftFactor(double upliftFactor)
    {
        ThrowWhenUpliftFactorOutOfRange(upliftFactor);
        return ((upliftFactor - 1) * 18.0);
    }

    /// <summary>
    /// Check if upliftfactor in correct range
    /// </summary>
    /// <param name="upliftFactor"></param>
    /// <returns></returns>
    static public void ThrowWhenUpliftFactorOutOfRange(double upliftFactor)
    {
        if (upliftFactor < 0)
        {
            throw new UpliftFactorToBetaCalculatorException($"Upliftfactor of {upliftFactor} is < 0.0 not allowed");
        }
    }
}