ResInsight/ApplicationCode/ReservoirDataModel/RigAccWellFlowCalculator.h

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

//==================================================================================================
/// 
/// 
//==================================================================================================

class RigMainGrid;
class RigActiveCellInfo;

class RigEclCellIndexCalculator
{
public:
    RigEclCellIndexCalculator(const RigMainGrid* mainGrid, const RigActiveCellInfo* activeCellInfo) 
        : m_mainGrid(mainGrid), m_activeCellInfo(activeCellInfo) 
    {}

    size_t resultCellIndex(size_t gridIndex, size_t gridCellIndex) const;

private:
    const RigMainGrid*       m_mainGrid;
    const RigActiveCellInfo* m_activeCellInfo;
};

//==================================================================================================
/// 
/// 
//==================================================================================================

#include <vector>
#include <map>
#include <QString>
#include "cvfBase.h"
#include "cvfVector3.h"

struct RigWellResultPoint;

class RigAccWellFlowCalculator
{
 
public:
    RigAccWellFlowCalculator(const std::vector< std::vector <cvf::Vec3d> >&         pipeBranchesCLCoords,
                             const std::vector< std::vector <RigWellResultPoint> >& pipeBranchesCellIds,
                             const std::map<QString, const std::vector<double>* >&  tracerCellFractionValues,
                             const RigEclCellIndexCalculator                        cellIndexCalculator,
                             double smallContribThreshold,
                             bool isProducer);

    RigAccWellFlowCalculator(const std::vector< std::vector <cvf::Vec3d> >&         pipeBranchesCLCoords,
                             const std::vector< std::vector <RigWellResultPoint> >& pipeBranchesCellIds,
                             double smallContribThreshold);

    const std::vector<double>&                              accumulatedFlowPrConnection( size_t branchIdx) const;
    const std::vector<double>&                              accumulatedTracerFlowPrConnection(const QString& tracerName, size_t branchIdx) const;
    const std::vector<double>&                              flowPrConnection( size_t branchIdx) const;
    const std::vector<double>&                              tracerFlowPrConnection(const QString& tracerName, size_t branchIdx) const;
    const std::vector<double>&                              connectionNumbersFromTop(size_t branchIdx) const;
    const std::vector<QString>&                             tracerNames() const { return m_tracerNames;}

    std::vector<std::pair<QString, double> >                totalTracerFractions() const;

private:

    void                                                    calculateAccumulatedFlowPrConnection( size_t branchIdx, size_t startConnectionNumberFromTop);
    void                                                    sortTracers();
    void                                                    groupSmallContributions();

    void                                                    groupSmallTracers(std::map<QString, std::vector<double>> &branchFlowSet, 
                                                                              std::vector<QString> tracersToGroup);

    bool                                                    isWellFlowConsistent(bool isProducer) const;
    std::vector<size_t>                                     wrpToConnectionIndexFromBottom( const std::vector<RigWellResultPoint> &branchCells) const;
    static size_t                                           connectionIndexFromTop( const std::vector<size_t>& resPointToConnectionIndexFromBottom, size_t clSegIdx) ;
    std::vector<size_t>                                     findDownstreamBranchIdxs( const RigWellResultPoint& connectionPoint) const;

    std::vector<std::pair<QString, double> >                totalWellFlowPrTracer() const;


    const std::vector< std::vector <cvf::Vec3d> >&          m_pipeBranchesCLCoords;
    const std::vector< std::vector <RigWellResultPoint> >&  m_pipeBranchesCellIds;
    const std::map<QString, const std::vector<double>* >*   m_tracerCellFractionValues;
    RigEclCellIndexCalculator                               m_cellIndexCalculator;
    std::vector<QString>                                    m_tracerNames;
    double                                                  m_smallContributionsThreshold;

    struct BranchFlow
    {
        std::vector<double>                                 depthValuesFromTop;
        std::map<QString, std::vector<double> >             accFlowPrTracer;
        std::map<QString, std::vector<double> >             flowPrTracer;
    };                                                      
                                                            
    std::vector< BranchFlow >                               m_connectionFlowPrBranch;
    std::vector< BranchFlow >                               m_pseudoLengthFlowPrBranch;
    std::vector< BranchFlow >                               m_tvdFlowPrBranch;

};