/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2019-     Equinor 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 "RiaDefines.h"

#include <cstddef>
#include <map>
#include <vector>

#include <QString>

class RimEclipseResultCase;
class RimFlowDiagSolution;
class QString;

//==================================================================================================
//
//
//
//==================================================================================================
class RigTofWellDistributionCalculator
{
public:
    RigTofWellDistributionCalculator( RimEclipseResultCase* caseToApply, QString targetWellname, size_t timeStepIndex, RiaDefines::PhaseType phase );

    void groupSmallContributions( double smallContribThreshold );

    const std::vector<double>& sortedUniqueTofValues() const;

    size_t                     contributingWellCount() const;
    const QString&             contributingWellName( size_t contribWellIndex ) const;
    const std::vector<double>& accumulatedVolumeForContributingWell( size_t contributingWellIndex ) const;

private:
    static std::map<double, std::vector<size_t>> buildSortedTofToCellIndicesMap( const std::vector<double>& tofData );
    static std::vector<QString>
        findCandidateContributingWellNames( const RimFlowDiagSolution& flowDiagSolution, QString targetWellname, size_t timeStepIndex );

    struct ContribWellEntry
    {
        QString             name;
        std::vector<double> accumulatedVolAlongTof; // This array has same size as m_tofInIncreasingOrder
    };

private:
    std::vector<double>           m_tofInIncreasingOrder;
    std::vector<ContribWellEntry> m_contributingWells;
};
