// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets 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;
using Core.Common.Base.Data;
using Core.Common.Base.Storage;
using Ringtoets.Piping.Data.Properties;

namespace Ringtoets.Piping.Data
{
    /// <summary>
    /// This class holds parameters which influence the probability estimate for a piping assessment.
    /// </summary>
    public class PipingProbabilityAssessmentInput : IStorable
    {
        private double a;
        private RoundedDouble upliftCriticalSafetyFactor;

        private readonly NormDependentFactorCollection heaveNormDependentFactorCollection = new NormDependentFactorCollection(
            Tuple.Create(100, 0.16),
            Tuple.Create(300, 0.15),
            Tuple.Create(1000, 0.13),
            Tuple.Create(3000, 0.12),
            Tuple.Create(10000, 0.11),
            Tuple.Create(30000, 0.10),
            Tuple.Create(300000, 0.09));

        private readonly NormDependentFactorCollection sellmeijerNormDependentFactorCollection = new NormDependentFactorCollection(
            Tuple.Create(100, 0.32),
            Tuple.Create(300, 0.28),
            Tuple.Create(1000, 0.24),
            Tuple.Create(3000, 0.21),
            Tuple.Create(10000, 0.19),
            Tuple.Create(30000, 0.17),
            Tuple.Create(300000, 0.13));

        /// <summary>
        /// Creates a new instance of <see cref="PipingProbabilityAssessmentInput"/>.
        /// </summary>
        public PipingProbabilityAssessmentInput()
        {
            A = 0.4;
            B = 300.0;
            SectionLength = double.NaN;

            upliftCriticalSafetyFactor = new RoundedDouble(1, 1.2);
        }

        /// <summary>
        /// Gets or sets 'a' parameter used to factor in the 'length effect' when determining the
        /// maximum tolerated probability of failure.
        /// </summary>
        public double A
        {
            get
            {
                return a;
            }
            set
            {
                if (!(value >= 0) || !(value <= 1))
                {
                    throw new ArgumentException(Resources.PipingProbabilityAssessmentInput_A_Value_must_be_between_zero_and_one);
                }

                a = value;
            }
        }

        /// <summary>
        /// Gets or sets the critical safety factor to which the calculated uplift stability factor is compared.
        /// </summary>
        /// <exception cref="ArgumentOutOfRangeException">Thrown when the rounded <paramref name="value"/> is outside
        /// range (0, 50].</exception>
        public RoundedDouble UpliftCriticalSafetyFactor
        {
            get
            {
                return upliftCriticalSafetyFactor;
            }
            set
            {
                var roundedValue = new RoundedDouble(upliftCriticalSafetyFactor.NumberOfDecimalPlaces, value);
                if (roundedValue <= 0 || roundedValue > 50)
                {
                    throw new ArgumentOutOfRangeException(
                        "value",
                        Resources.PipingProbabilityAssessmentInput_UpliftCriticalSafetyFactor_Value_must_be_in_range_zero_and_fifty);
                }
                upliftCriticalSafetyFactor = roundedValue;
            }
        }

        /// <summary>
        /// Gets the norm dependent factor which is used in the relation between safety factor and reliability index
        /// for the Sellmeijer failure mechanism.
        /// </summary>
        /// <param name="norm">The norm for which to obtain the factor.</param>
        /// <returns>A factor which can be used in a semi-probabilistic assessment.</returns>
        public RoundedDouble GetSellmeijerNormDependentFactor(int norm)
        {
            return new RoundedDouble(2, sellmeijerNormDependentFactorCollection.GetFactorFromNorm(norm));
        }

        /// <summary>
        /// Gets the norm dependent factor which is used in the relation between safety factor and reliability index 
        /// for the heave failure mechanism.
        /// </summary>
        /// <param name="norm">The norm for which to obtain the factor.</param>
        /// <returns>A factor which can be used in a semi-probabilistic assessment.</returns>
        public RoundedDouble GetHeaveNormDependentFactor(int norm)
        {
            return new RoundedDouble(2, heaveNormDependentFactorCollection.GetFactorFromNorm(norm));
        }

        /// <summary>
        /// Gets 'b' parameter used to factor in the 'length effect' when determining the
        /// maximum tolerated probability of failure.
        /// </summary>
        public double B { get; private set; }

        /// <summary>
        /// Gets or sets the length of the assessment section.
        /// </summary>
        public double SectionLength { get; set; }

        public long StorageId { get; set; }
    }
}