ResInsight/ApplicationLibCode/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 "RigFlowDiagDefines.h"
#include "RigFlowDiagTimeStepResult.h"

#include "cafPdmPointer.h"

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

class RimEclipseResultCase;
class RimFlowDiagSolution;

class RigEclipseCaseData;
class RigOpmFlowDiagStaticData;

class RigFlowDiagSolverInterface
{
public:
    explicit RigFlowDiagSolverInterface( RimEclipseResultCase* eclipseCase );
    virtual ~RigFlowDiagSolverInterface();

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

    RigFlowDiagDefines::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<RigFlowDiagDefines::RelPermCurve> calculateRelPermCurves( const std::string& gridName, size_t gridLocalActiveCellIndex );

    std::vector<RigFlowDiagDefines::PvtCurve> calculatePvtCurves( RigFlowDiagDefines::PvtCurveType pvtCurveType, int pvtNum );
    bool calculatePvtDynamicPropertiesFvf( int pvtNum, double pressure, double rs, double rv, double* bo, double* bg );
    bool calculatePvtDynamicPropertiesViscosity( int pvtNum, double pressure, double rs, double rv, double* mu_o, double* mu_g );

private:
    std::wstring 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;
    std::unique_ptr<RigOpmFlowDiagStaticData> m_opmFlowDiagStaticData;

    int m_pvtCurveErrorCount;
    int m_relpermCurveErrorCount;
};