ResInsight/ApplicationCode/ReservoirDataModel/RigFlowDiagSolverInterface.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2016-     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 "RigFlowDiagResultAddress.h"
#include "cvfBase.h"
#include "cvfObject.h"
#include "cafPdmPointer.h"

#include <string>
#include <vector>
#include <map>

class RimEclipseResultCase;
class RimFlowDiagSolution;


class RigFlowDiagTimeStepResult
{
public:
    explicit RigFlowDiagTimeStepResult(size_t activeCellCount);

    void setTracerTOF     (const std::string& tracerName, RigFlowDiagResultAddress::PhaseSelection phaseSelection, const std::map<int, double>& cellValues);
    void setTracerFraction(const std::string& tracerName, RigFlowDiagResultAddress::PhaseSelection phaseSelection, const std::map<int, double>& cellValues);
    void setInjProdWellPairFlux(const std::string& injectorTracerName,
                                const std::string& producerTracerName, 
                                const std::pair<double, double>& injProdFluxes) ;

    using Curve = std::pair< std::vector<double>, std::vector<double> >;

    // Used to "steal" the data from this one using swap
    std::map<RigFlowDiagResultAddress, std::vector<double> >&                    nativeResults() { return m_nativeResults; }
    std::map<std::pair<std::string, std::string>, std::pair<double, double> > &  injProdWellPairFluxes() { return m_injProdWellPairFluxes; }

private:

    void addResult(const RigFlowDiagResultAddress& resAddr, const std::map<int, double>& cellValues);

    std::map<RigFlowDiagResultAddress, std::vector<double> >                  m_nativeResults;
    std::map<std::pair<std::string, std::string>, std::pair<double, double> > m_injProdWellPairFluxes;

    size_t m_activeCellCount;
};


class RigEclipseCaseData;
class RigOpmFlowDiagStaticData;

class RigFlowDiagSolverInterface : public cvf::Object
{
public:
    struct FlowCharacteristicsResultFrame
    {
        FlowCharacteristicsResultFrame();

        using Curve = std::pair< std::vector<double>, std::vector<double> >;

        Curve m_flowCapStorageCapCurve;
        Curve m_sweepEfficiencyCurve;
        double m_lorenzCoefficient;
    };

    struct RelPermCurve
    {
        enum Ident { KRW, KRG, KROW, KROG, PCOW, PCOG };
        enum EpsMode { EPS_ON, EPS_OFF };

        Ident               ident;
        std::string         name;
        EpsMode             epsMode;
        std::vector<double> saturationVals;
        std::vector<double> yVals;
    };

    enum PvtCurveType
    {
        PVT_CT_FVF, 
        PVT_CT_VISCOSITY
    };

    struct PvtCurve
    {
        enum Phase { OIL, GAS };
        enum Ident { Unknown, Bo, Bg, Visc_o, Visc_g };

        Ident               ident;
        Phase               phase;
        std::vector<double> pressureVals;
        std::vector<double> yVals;
        std::vector<double> mixRatVals;
    };

public:
    explicit RigFlowDiagSolverInterface(RimEclipseResultCase * eclipseCase);
    ~RigFlowDiagSolverInterface() override;

    RigFlowDiagTimeStepResult      calculate(size_t timeStepIdx,  
                                             RigFlowDiagResultAddress::PhaseSelection phaseSelection,
                                             std::map<std::string, std::vector<int> > injectorTracers,
                                             std::map<std::string, std::vector<int> > producerTracers);

    FlowCharacteristicsResultFrame calculateFlowCharacteristics(const std::vector<double>* injector_tof,
                                                                const std::vector<double>* producer_tof,
                                                                const std::vector<size_t>& selected_cell_indices,
                                                                double max_pv_fraction);

    std::vector<RelPermCurve>      calculateRelPermCurves(size_t activeCellIndex);
    std::vector<PvtCurve>          calculatePvtCurves(PvtCurveType pvtCurveType, size_t activeCellIndex);
    bool                           calculatePvtDynamicPropertiesFvf(size_t activeCellIndex, double pressure, double rs, double rv, double* bo, double* bg);
    bool                           calculatePvtDynamicPropertiesViscosity(size_t activeCellIndex, double pressure, double rs, double rv, double* mu_o, double* mu_g);

private:
    std::string                    getInitFileName() const;
    bool                           ensureStaticDataObjectInstanceCreated();
    void                           assignPhaseCorrecedPORV(RigFlowDiagResultAddress::PhaseSelection phaseSelection, 
                                                           size_t timeStepIdx);
    void                           reportRelPermCurveError(const QString &message);
    void                           reportPvtCurveError(const QString &message);

    RimEclipseResultCase *             m_eclipseCase;
    cvf::ref<RigOpmFlowDiagStaticData> m_opmFlowDiagStaticData;


    int                                m_pvtCurveErrorCount; 
    int                                m_relpermCurveErrorCount; 

};