//-----------------------------------------------------------------------
// <copyright file="UpliftFactorToBetaCalculator.cs" company="Deltares">
//  Copyright (c) 2011 Deltares. All rights reserved.
// </copyright>
// <author>B.S.T. The</author>
// <email>tom.the@deltares.nl</email>
// <date>06-01-2011</date>
// <summary>Class to calculate the probability of uplift from upliftfactor</summary>
//-----------------------------------------------------------------------
namespace Deltares.Dam.Data
{
    using System;

    /// <summary>
    /// Exception class for UpliftFactorToBetaCalculator
    /// </summary>
    public class UpliftFactorToBetaCalculatorException : ApplicationException
    {
        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(String.Format("Upliftfactor of {0} is < 0.0 not allowed", upliftFactor));
            }
        }
    }
}