ResInsight/ApplicationLibCode/FileInterface/RifOpmCommonSummary.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2021- 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 "RifEclipseSummaryAddress.h"
#include "RifSummaryReaderInterface.h"

#include <QString>
#include <QStringList>

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

namespace Opm
{
namespace EclIO
{
    class ESmry;
    class ExtESmry;
} // namespace EclIO
} // namespace Opm

class RiaThreadSafeLogger;

class RifOpmCommonSummaryTools
{
public:
    static std::tuple<std::set<RifEclipseSummaryAddress>, std::map<RifEclipseSummaryAddress, size_t>, std::map<RifEclipseSummaryAddress, std::string>>
        buildAddressesSmspecAndKeywordMap( const Opm::EclIO::ESmry* summaryFile );

    static std::pair<std::set<RifEclipseSummaryAddress>, std::map<RifEclipseSummaryAddress, std::string>>
        buildAddressesAndKeywordMap( const std::vector<std::string>& keywords );
};

//==================================================================================================
//
//
//==================================================================================================
class RifOpmCommonEclipseSummary : public RifSummaryReaderInterface
{
public:
    RifOpmCommonEclipseSummary();
    ~RifOpmCommonEclipseSummary() override;

    void useEnhancedSummaryFiles( bool enable );
    void createEnhancedSummaryFiles( bool enable );

    static void   resetEnhancedSummaryFileCount();
    static size_t numberOfEnhancedSummaryFileCreated();

    bool open( const QString& fileName, bool includeRestartFiles, RiaThreadSafeLogger* threadSafeLogger );

    std::vector<time_t>           timeSteps( const RifEclipseSummaryAddress& resultAddress ) const override;
    bool                          values( const RifEclipseSummaryAddress& resultAddress, std::vector<double>* values ) const override;
    std::string                   unitName( const RifEclipseSummaryAddress& resultAddress ) const override;
    RiaDefines::EclipseUnitSystem unitSystem() const override;

private:
    void buildMetaData();
    bool openFileReader( const QString& fileName, bool includeRestartFiles, RiaThreadSafeLogger* threadSafeLogger );

    static void    increaseEsmryFileCount();
    static QString enhancedSummaryFilename( const QString& fileName );
    static QString smspecSummaryFilename( const QString& fileName );

private:
    std::unique_ptr<Opm::EclIO::ESmry>    m_standardReader;
    std::unique_ptr<Opm::EclIO::ExtESmry> m_enhancedReader;

    std::map<RifEclipseSummaryAddress, std::string> m_summaryAddressToKeywordMap;
    std::vector<time_t>                             m_timeSteps;

    static size_t sm_createdEsmryFileCount;

    bool m_useEsmryFiles;
    bool m_createEsmryFiles;
};