/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017 Statoil ASA
// 
//  ResInsight 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.
// 
//  ResInsight 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 at <http://www.gnu.org/licenses/gpl.html> 
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "RigCompletionData.h"

#include "RicExportCompletionDataSettingsUi.h"
#include "RicMultiSegmentWellExportInfo.h"
#include "RicWellPathFractureReportItem.h"

#include <QFile>

#include "cvfBase.h"
#include "cvfVector3.h"

#include <vector>
#include <memory>

class RigCell;
class RigEclipseCaseData;
class RigMainGrid;
class RimEclipseCase;
class RimFishbonesMultipleSubs;
class RimSimWellInView;
class RimPerforationInterval;
class RimWellPath;
class RimWellPathFracture;
class RimNonDarcyPerforationParameters;
class RifEclipseDataTableFormatter;
class RigVirtualPerforationTransmissibilities;
class SubSegmentIntersectionInfo;

//==================================================================================================
/// 
//==================================================================================================
typedef std::shared_ptr<QFile> QFilePtr;

//==================================================================================================
/// 
//==================================================================================================
class RicWellPathExportCompletionDataFeatureImpl
{

public:
    static RicMswExportInfo               generateFishbonesMswExportInfo(const RimEclipseCase* caseToApply,
                                                                         const RimWellPath*    wellPath,
                                                                         bool                  enableSegmentSplitting);

    static RicMswExportInfo               generateFishbonesMswExportInfo(const RimEclipseCase*                         caseToApply,
                                                                         const RimWellPath*                            wellPath,
                                                                         const std::vector<RimFishbonesMultipleSubs*>& fishbonesSubs,
                                                                         bool                                          enableSegmentSplitting);

    static RicMswExportInfo               generateFracturesMswExportInfo(RimEclipseCase*    caseToApply,
                                                                         const RimWellPath* wellPath);

    static RicMswExportInfo               generateFracturesMswExportInfo(RimEclipseCase*                          caseToApply,
                                                                         const RimWellPath*                       wellPath,
                                                                         const std::vector<RimWellPathFracture*>& fractures);

    static RicMswExportInfo               generatePerforationsMswExportInfo(const RicExportCompletionDataSettingsUi& exportSettings,
                                                                            const RimWellPath*                       wellPath,
                                                                            const std::vector<const RimPerforationInterval*>& perforationIntervals);

    static CellDirection                  calculateDirectionInCell(RimEclipseCase* eclipseCase,
                                                                   size_t globalCellIndex, 
                                                                   const cvf::Vec3d& lengthsInCell);
    
    static double                         calculateTransmissibility(RimEclipseCase* eclipseCase, 
                                                                    const RimWellPath* wellPath, 
                                                                    const cvf::Vec3d& internalCellLengths, 
                                                                    double skinFactor, 
                                                                    double wellRadius, 
                                                                    size_t globalCellIndex, 
                                                                    bool useLateralNTG, 
                                                                    size_t volumeScaleConstant = 1, 
                                                                    CellDirection directionForVolumeScaling = CellDirection::DIR_I);

    static double                         calculateDFactor(RimEclipseCase* eclipseCase,
                                                           const cvf::Vec3d&  internalCellLengths,
                                                           const double wellRadius,
                                                           size_t globalCellIndex,
                                                           const RimNonDarcyPerforationParameters* nonDarcyParameters,
                                                           const double effectiveTransmissibilityForCell);

    static void                           exportCompletions(const std::vector<RimWellPath*>& wellPaths, 
                                                            const std::vector<RimSimWellInView*>& simWells, 
                                                            const RicExportCompletionDataSettingsUi& exportSettings);

    static std::vector<RigCompletionData> computeStaticCompletionsForWellPath(RimWellPath* wellPath,
                                                                              RimEclipseCase* eclipseCase);

    static std::vector<RigCompletionData> computeDynamicCompletionsForWellPath(RimWellPath* wellPath,
                                                                               RimEclipseCase* eclipseCase,
                                                                               size_t timeStepIndex);

    static void                           generateWelsegsTable(RifEclipseDataTableFormatter& formatter,
                                                               const RicMswExportInfo& exportInfo);

    static void                           generateWelsegsSegments(RifEclipseDataTableFormatter &formatter,
                                                                  const RicMswExportInfo &exportInfo,
                                                                  const std::set<RigCompletionData::CompletionType>& exportCompletionTypes);
    static void                           generateWelsegsCompletionCommentHeader(RifEclipseDataTableFormatter &formatter,
                                                                                 RigCompletionData::CompletionType completionType);
    static void                           generateCompsegTables(RifEclipseDataTableFormatter& formatter,
                                                                const RicMswExportInfo& exportInfo);
    static void                           generateCompsegTable(RifEclipseDataTableFormatter& formatter,
                                                               const RicMswExportInfo& exportInfo,
                                                               bool exportSubGridIntersections,
                                                               const std::set<RigCompletionData::CompletionType>& exportCompletionTypes);
    static void                           generateCompsegHeader(RifEclipseDataTableFormatter&     formatter,
                                                                const RicMswExportInfo&           exportInfo,
                                                                RigCompletionData::CompletionType completionType,
                                                                bool                              exportSubGridIntersections);
    static void                           generateWsegvalvTable(RifEclipseDataTableFormatter& formatter,
                                                                const RicMswExportInfo& exportInfo);

private:
    static double                         calculateTransmissibilityAsEclipseDoes(RimEclipseCase* eclipseCase,
                                                                                 double skinFactor,
                                                                                 double wellRadius,
                                                                                 size_t globalCellIndex,
                                                                                 CellDirection direction);
    
    static RigCompletionData              combineEclipseCellCompletions(const std::vector<RigCompletionData>& completions, 
                                                                        const RicExportCompletionDataSettingsUi& settings);

    static QFilePtr                       openFileForExport(const QString& fullFileName);

    static QFilePtr                       openFileForExport(const QString& folderName,
                                                            const QString& fileName);

    static std::vector<RigCompletionData> mainGridCompletions(std::vector<RigCompletionData>& allCompletions);

    static std::map<QString, std::vector<RigCompletionData>> subGridsCompletions(std::vector<RigCompletionData>& allCompletions);

    static void                           exportWellPathFractureReport(RimEclipseCase*                                          sourceCase,
                                                                       QFilePtr                                                 exportFile,
                                                                       const std::vector<RicWellPathFractureReportItem>&        wellPathFractureReportItems);

    static void                           exportWelspecsToFile(RimEclipseCase* gridCase,
                                                               QFilePtr exportFile,
                                                               const std::vector<RigCompletionData>& completions);

    static void                           exportWelspeclToFile(RimEclipseCase* gridCase,
                                                               QFilePtr exportFile,
                                                               const std::map<QString, std::vector<RigCompletionData>>& completions);

    static void                           sortAndExportCompletionsToFile(RimEclipseCase* eclipseCase,
                                                                         const QString& exportFolder, 
                                                                         const QString& fileName, 
                                                                         std::vector<RigCompletionData>& completions, 
                                                                         const std::vector<RicWellPathFractureReportItem>& wellPathFractureReportItems,
                                                                         RicExportCompletionDataSettingsUi::CompdatExportType exportType);

    static void                           exportCompdatAndWpimultTables(RimEclipseCase* sourceCase,
                                                                        QFilePtr exportFile,
                                                                        const std::map<QString, std::vector<RigCompletionData>>& completionsPerGrid, 
                                                                        RicExportCompletionDataSettingsUi::CompdatExportType exportType);

    static void                           exportCompdatTableUsingFormatter(RifEclipseDataTableFormatter& formatter, 
                                                                           const QString& gridName, 
                                                                           const std::vector<RigCompletionData>& completionData);

    static void                           exportWpimultTableUsingFormatter(RifEclipseDataTableFormatter& formatter,
                                                                           const QString& gridName,
                                                                           const std::vector<RigCompletionData>& completionData);

    static std::vector<RigCompletionData> generatePerforationsCompdatValues(const RimWellPath* wellPath,
                                                                            const std::vector<const RimPerforationInterval*>& intervals,
                                                                            const RicExportCompletionDataSettingsUi& settings);

    static void                           assignFishbonesLateralIntersections(const RimEclipseCase*           caseToApply,
                                                                              const RimFishbonesMultipleSubs* fishbonesSubs,
                                                                              RicMswSegment*                  location,
                                                                              bool*                           foundSubGridIntersections,
                                                                              double                          maxSegmentLength);

    static void                           assignFractureIntersections(const RimEclipseCase*                 caseToApply,
                                                                      const RimWellPathFracture*            fracture,
                                                                      const std::vector<RigCompletionData>& completionData,
                                                                      RicMswSegment*                        location,
                                                                      bool*                                 foundSubGridIntersections);

    static void                           assignPerforationIntervalIntersections(const RimEclipseCase*                 caseToApply,
                                                                                 const RimPerforationInterval*         interval,
                                                                                 const std::vector<RigCompletionData>& completionData,
                                                                                 RicMswSegment*                        location,
                                                                                 const SubSegmentIntersectionInfo*     cellIntInfo,
                                                                                 bool* foundSubGridIntersections);

    static void                           assignBranchAndSegmentNumbers(const RimEclipseCase* caseToApply,
                                                                        RicMswSegment*        location,
                                                                        int*                  branchNum,
                                                                        int*                  segmentNum);
    static void                           assignBranchAndSegmentNumbers(const RimEclipseCase* caseToApply,
                                                                        RicMswExportInfo* exportInfo);

    static void                           appendCompletionData(std::map<RigCompletionDataGridCell, std::vector<RigCompletionData>>* completionData,
                                                               const std::vector<RigCompletionData>& data);

    static cvf::Vec2i                     wellPathUpperGridIntersectionIJ(const RimEclipseCase* gridCase, const RimWellPath* wellPath, const QString& gridName = "");

    static void                           exportWellSegments(RimEclipseCase* eclipseCase,
                                                             QFilePtr exportFile,
                                                             const RimWellPath* wellPath,
                                                             const std::vector<RimWellPathFracture*>& fractures);

    static void                           exportWellSegments(RimEclipseCase* eclipseCase,
                                                             QFilePtr exportFile,
                                                             const RimWellPath* wellPath,
                                                             const std::vector<RimFishbonesMultipleSubs*>& fishbonesSubs);

    static void                           exportWellSegments(const RicExportCompletionDataSettingsUi& exportSettings,
                                                             QFilePtr exportFile,
                                                             const RimWellPath* wellPath,
                                                             const std::vector<const RimPerforationInterval*>& perforationIntervals);
    static QString                        createPressureDepletionFileNameSuffix(const RicExportCompletionDataSettingsUi& exportSettings);
};