// Copyright (C) Stichting Deltares 2017. 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 Ringtoets.Common.Data.Probabilistics;
using Ringtoets.Common.Data.Properties;

namespace Ringtoets.StabilityPointStructures.Data
{
    /// <summary>
    /// Class that holds all static stability point structures calculation specific input parameters.
    /// </summary>
    public class GeneralStabilityPointStructuresInput
    {
        private const int numberOfDecimalPlacesN = 2;
        private static readonly Range<RoundedDouble> validityRangeN = new Range<RoundedDouble>(new RoundedDouble(numberOfDecimalPlacesN, 1),
                                                                                               new RoundedDouble(numberOfDecimalPlacesN, 20));
        private RoundedDouble n;

        /// <summary>
        /// Initializes a new instance of the <see cref="GeneralStabilityPointStructuresInput"/> class.
        /// </summary>
        public GeneralStabilityPointStructuresInput()
        {
            n = new RoundedDouble(numberOfDecimalPlacesN, 3.0);

            GravitationalAcceleration = new RoundedDouble(2, 9.81);

            ModelFactorStorageVolume = new LogNormalDistribution(2)
            {
                Mean = (RoundedDouble) 1,
                StandardDeviation = (RoundedDouble) 0.2
            };

            ModelFactorSubCriticalFlow = new VariationCoefficientNormalDistribution(2)
            {
                Mean = (RoundedDouble) 1,
                CoefficientOfVariation = (RoundedDouble) 0.1
            };

            ModelFactorCollisionLoad = new VariationCoefficientNormalDistribution(1)
            {
                Mean = (RoundedDouble) 1,
                CoefficientOfVariation = (RoundedDouble) 0.2
            };

            ModelFactorLoadEffect = new NormalDistribution(2)
            {
                Mean = (RoundedDouble) 1,
                StandardDeviation = (RoundedDouble) 0.05
            };

            ModelFactorInflowVolume = new RoundedDouble(2, 1);
            ModificationFactorWavesSlowlyVaryingPressureComponent = new RoundedDouble(0, 1);
            ModificationFactorDynamicOrImpulsivePressureComponent = new RoundedDouble(0, 1);

            WaveRatioMaxHN = new RoundedDouble(2, 5000);
            WaveRatioMaxHStandardDeviation = new RoundedDouble(2, 0.5);
        }

        /// <summary>
        /// Gets the gravitational acceleration.
        /// [m/s^2]
        /// </summary>
        public RoundedDouble GravitationalAcceleration { get; }

        #region Length effect parameters

        /// <summary>
        /// Gets or sets the 'N' parameter used to factor in the 'length effect'.
        /// </summary>
        /// <exception cref="ArgumentOutOfRangeException">Thrown when the <paramref name="value"/>
        /// is not in the [1.0, 20.0] interval.</exception>
        public RoundedDouble N
        {
            get
            {
                return n;
            }
            set
            {
                RoundedDouble newValue = value.ToPrecision(n.NumberOfDecimalPlaces);
                if (!validityRangeN.InRange(newValue))
                {
                    throw new ArgumentOutOfRangeException(nameof(value), string.Format(Resources.N_Value_should_be_in_Range_0_,
                                                                                       validityRangeN));
                }

                n = newValue;
            }
        }

        #endregion

        #region Model factors

        /// <summary>
        /// Gets the model factor for the storage volume.
        /// </summary>
        public LogNormalDistribution ModelFactorStorageVolume { get; }

        /// <summary>
        /// Gets the model factor for sub critical flow.
        /// </summary>
        public VariationCoefficientNormalDistribution ModelFactorSubCriticalFlow { get; }

        /// <summary>
        /// Gets the model factor for collision load.
        /// </summary>
        public VariationCoefficientNormalDistribution ModelFactorCollisionLoad { get; }

        /// <summary>
        /// Gets the model factor for load effect.
        /// </summary>
        public NormalDistribution ModelFactorLoadEffect { get; }

        /// <summary>
        /// Gets the model factor for incoming flow volume.
        /// </summary>
        public RoundedDouble ModelFactorInflowVolume { get; }

        /// <summary>
        /// Gets the modification factor for wave slowly varying pressure component.
        /// </summary>
        public RoundedDouble ModificationFactorWavesSlowlyVaryingPressureComponent { get; }

        /// <summary>
        /// Gets the modification factor for waves dynamic or impulsive pressure component.
        /// </summary>
        public RoundedDouble ModificationFactorDynamicOrImpulsivePressureComponent { get; }

        #endregion

        #region Rayleigh-N properties

        /// <summary>
        /// Gets the N of the Rayleigh-N distribution for wave ratio max H. 
        /// </summary>
        public RoundedDouble WaveRatioMaxHN { get; }

        /// <summary>
        /// Gets the standard deviation of the Rayleigh-N distribution for wave ratio max H.
        /// </summary>
        public RoundedDouble WaveRatioMaxHStandardDeviation { get; }

        #endregion
    }
}