ResInsight/ApplicationLibCode/FileInterface/RifEclipseRestartDataAccess.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2011-     Statoil ASA
//  Copyright (C) 2013-     Ceetron Solutions AS
//  Copyright (C) 2011-2012 Ceetron AS
//
//  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 "cvfObject.h"

#include <QDateTime>
#include <QStringList>

#include <vector>

#include "ert/ecl_well/well_info.hpp"

#include "RifReaderInterface.h"

//==================================================================================================
//
//==================================================================================================
class RifKeywordValueCount
{
public:
    enum class KeywordDataType
    {
        UNKNOWN,
        FLOAT,
        DOUBLE,
        INTEGER,
    };

public:
    RifKeywordValueCount( const std::string& keyword, size_t itemCount, KeywordDataType dataType )
        : m_keyword( keyword )
        , m_valueCount( itemCount )
        , m_dataType( dataType )
    {
    }

    RifKeywordValueCount()
        : m_valueCount( 0 )
        , m_dataType( KeywordDataType::UNKNOWN )
    {
    }

    void addValueCount( size_t valueCount ) { m_valueCount += valueCount; }

    std::string     keyword() const { return m_keyword; }
    size_t          valueCount() const { return m_valueCount; }
    KeywordDataType dataType() const { return m_dataType; }

    static RiaDefines::ResultDataType mapType( RifKeywordValueCount::KeywordDataType dataType )
    {
        switch ( dataType )
        {
            case RifKeywordValueCount::KeywordDataType::FLOAT:
                return RiaDefines::ResultDataType::FLOAT;
            case RifKeywordValueCount::KeywordDataType::DOUBLE:
                return RiaDefines::ResultDataType::DOUBLE;
            case RifKeywordValueCount::KeywordDataType::INTEGER:
                return RiaDefines::ResultDataType::INTEGER;
        }

        return RiaDefines::ResultDataType::UNKNOWN;
    }

private:
    std::string     m_keyword;
    size_t          m_valueCount;
    KeywordDataType m_dataType;
};

//==================================================================================================
//
//==================================================================================================
class RifRestartReportKeywords
{
public:
    void appendKeywordCount( const RifRestartReportKeywords& other );
    void appendKeywordCount( const std::string& keyword, size_t valueCount, RifKeywordValueCount::KeywordDataType dataType );

    std::vector<RifKeywordValueCount> keywordValueCounts() const;

private:
    std::map<std::string, RifKeywordValueCount> m_keywordValueCounts;
};

//==================================================================================================
//
// Abstract class for results access
//
//==================================================================================================
class RifEclipseRestartDataAccess : public cvf::Object
{
public:
    RifEclipseRestartDataAccess();
    ~RifEclipseRestartDataAccess() override;

    virtual bool open()                                        = 0;
    virtual void setRestartFiles( const QStringList& fileSet ) = 0;
    virtual void close()                                       = 0;

    virtual void             setTimeSteps( const std::vector<QDateTime>& timeSteps ){};
    virtual size_t           timeStepCount()                                                                               = 0;
    virtual void             timeSteps( std::vector<QDateTime>* timeSteps, std::vector<double>* daysSinceSimulationStart ) = 0;
    virtual std::vector<int> reportNumbers()                                                                               = 0;

    virtual std::vector<RifKeywordValueCount> keywordValueCounts()                                                    = 0;
    virtual bool results( const QString& resultName, size_t timeStep, size_t gridCount, std::vector<double>* values ) = 0;

    virtual bool dynamicNNCResults( const ecl_grid_type* grid,
                                    size_t               timeStep,
                                    std::vector<double>* waterFlux,
                                    std::vector<double>* oilFlux,
                                    std::vector<double>* gasFlux ) = 0;

    virtual void readWellData( well_info_type* well_info, bool importCompleteMswData ) = 0;
    virtual int  readUnitsType()                                                       = 0;

    virtual std::set<RiaDefines::PhaseType> availablePhases() const = 0;

    virtual void updateFromGridCount( size_t gridCount ){};
};