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

using System.Collections.Generic;
using Deltares.DamEngine.Calculators.DikesDesign;
using Deltares.DamEngine.Calculators.KernelWrappers.Common;
using Deltares.DamEngine.Data.Design;
using Deltares.DamEngine.Data.General;
using Deltares.DamEngine.Data.General.Results;
using Deltares.DamEngine.Data.Geometry;
using Deltares.DamEngine.Data.Standard.Logging;

namespace Deltares.DamEngine.Calculators.KernelWrappers.Interfaces;

/// <summary>
/// Result of the Prepare method
///   Successful : the input data was created susccesfully
///   Failed     : the input data could not be created
///   NotRelevant: the DamKernelInput contains data that is not a relevant input for this mechanism 
/// </summary>
public enum PrepareResult
{
    Successful,
    Failed,
    NotRelevant
}

/// <summary>
/// The design strategy that has to be followed
/// </summary>
public enum DesignStrategy
{
    /// <summary>
    /// No design is possible
    /// </summary>
    NoDesignPossible,

    /// <summary>
    /// The surfaceline is discretized with a minimum distance between points and for each point a new design is evaluated
    /// </summary>
    ShoulderPerPoint,

    /// <summary>
    /// Iterative process.
    /// Dependendent on the most recent design iteration a choice between slope adaption or shoulder adaption is for the next iteration 
    /// </summary>
    OptimizedSlopeAndShoulderAdaption,

    /// <summary>
    /// Iterative process.
    /// First slope adaption is done then shoulder adaption
    /// </summary>
    SlopeAdaptionBeforeShoulderAdaption
}

/// <summary>
/// Based on DesignEvaluation, the advise for the next design step
/// </summary>
public enum DesignAdvise
{
    None,
    ShoulderInwards,
    SlopeInwards,
    Height,
    Abort // The design is not possible (e.g. because of a calculation failure)
}

/// <summary>
/// Interface to implement external failure mechanisms
/// </summary>
public interface IKernelWrapper
{
    /// <summary>
    /// Prepares the failure mechanism input based on general dam kernel input.
    /// </summary>
    /// <param name="damKernelInput">The dam kernel input.</param>
    /// <param name="iterationIndex">The number of the current iteration</param>
    /// <param name="kernelDataInput">The kernel data input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <returns>
    /// Result of the prepare
    /// </returns>
    PrepareResult Prepare(DamKernelInput damKernelInput, int iterationIndex, out IKernelDataInput kernelDataInput, out IKernelDataOutput kernelDataOutput);

    /// <summary>
    /// Validates the kernel data input.
    /// </summary>
    /// <param name="kernelDataInput">The kernel data input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <param name="messages">The messages.</param>
    /// <returns>
    /// Number of errors that prevent a calculation
    /// </returns>
    int Validate(IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput, out List<LogMessage> messages);

    /// <summary>
    /// Performs a failure mechanism calculation based on the input.
    /// </summary>
    /// <param name="kernelDataInput">The kernel data input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <param name="messages">The messages.</param>
    void Execute(IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput, out List<LogMessage> messages);

    /// <summary>
    /// Fills the dam result based on the kernel output.
    /// </summary>
    /// <param name="damKernelInput">The dam kernel input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <param name="designScenario">The design scenario.</param>
    /// <param name="resultMessage">The result message.</param>
    /// <param name="designResults">The design results</param>
    void PostProcess(DamKernelInput damKernelInput, IKernelDataOutput kernelDataOutput, DesignScenario designScenario, string resultMessage, out List<DesignResult> designResults);

    /// <summary>
    /// Calculates the design at point.
    /// </summary>
    /// <param name="damKernelInput">The dam kernel input.</param>
    /// <param name="kernelDataInput">The kernel data input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <param name="point">The point.</param>
    /// <param name="messages">The messages.</param>
    /// <returns></returns>
    ShoulderDesign CalculateDesignAtPoint(DamKernelInput damKernelInput, IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput, Point2D point, out List<LogMessage> messages);

    /// <summary>
    /// Evaluates the design (current factor greater than desired factor)
    /// </summary>
    /// <param name="damKernelInput">The dam kernel input.</param>
    /// <param name="kernelDataInput">The kernel data input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <param name="designAdvise">The design advise.</param>
    /// <param name="evaluationMessage">The evaluation message.</param>
    /// <returns>
    /// if the design was succesful
    /// </returns>
    bool EvaluateDesign(DamKernelInput damKernelInput, IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput,
                        out DesignAdvise designAdvise, out string evaluationMessage);

    /// <summary>
    /// Prepares the design.
    /// </summary>
    /// <param name="kernelDataInput">The kernel data input.</param>
    /// <param name="kernelDataOutput">The kernel data output.</param>
    /// <param name="damKernelInput">The dam kernel input.</param>
    /// <param name="iterationIndex">Index of the iteration.</param>
    /// <param name="embankmentDesignParameters">The embankment design parameters.</param>
    void PrepareDesign(IKernelDataInput kernelDataInput, IKernelDataOutput kernelDataOutput, DamKernelInput damKernelInput,
                       int iterationIndex, out EmbankmentDesignParameters embankmentDesignParameters);

    /// <summary>
    /// Gets the design strategy 
    /// </summary>
    /// <param name="damKernelInput"></param>
    /// <returns></returns>
    DesignStrategy GetDesignStrategy(DamKernelInput damKernelInput);
}