ResInsight/ApplicationLibCode/FileInterface/RifMultipleSummaryReaders.cpp

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

#include "RifMultipleSummaryReaders.h"

#include "RimCalculatedSummaryCurveReader.h"

#include "cafAssert.h"

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifMultipleSummaryReaders::RifMultipleSummaryReaders() = default;

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifMultipleSummaryReaders::addReader( std::unique_ptr<RifSummaryReaderInterface> reader )
{
    if ( findReader( reader->serialNumber() ) != nullptr ) return;

    m_readers.push_back( std::move( reader ) );

    // https://github.com/OPM/ResInsight/issues/12989
    // Reorder readers so the calculated reader is at the front of the vector. This ensures that RifMultipleSummaryReaders::values()
    // evaluates calculated reader first.
    auto calculatedReaderFirst = []( const auto& first, const auto& second )
    {
        bool isFirstCalc  = dynamic_cast<RifCalculatedSummaryCurveReader*>( first.get() ) != nullptr;
        bool isSecondCalc = dynamic_cast<RifCalculatedSummaryCurveReader*>( second.get() ) != nullptr;
        if ( isFirstCalc && !isSecondCalc ) return true;
        if ( !isFirstCalc && isSecondCalc ) return false;
        return first->serialNumber() < second->serialNumber();
    };

    std::sort( m_readers.begin(), m_readers.end(), calculatedReaderFirst );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifSummaryReaderInterface* RifMultipleSummaryReaders::findReader( int serialNumber ) const
{
    auto reader = std::find_if( m_readers.begin(),
                                m_readers.end(),
                                [serialNumber]( const std::unique_ptr<RifSummaryReaderInterface>& r )
                                { return r->serialNumber() == serialNumber; } );
    if ( reader != m_readers.end() )
    {
        return reader->get();
    }
    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifMultipleSummaryReaders::removeReader( int serialNumber )
{
    auto reader = std::find_if( m_readers.begin(),
                                m_readers.end(),
                                [serialNumber]( const std::unique_ptr<RifSummaryReaderInterface>& r )
                                { return r->serialNumber() == serialNumber; } );

    if ( reader != m_readers.end() )
    {
        m_readers.erase( reader );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<time_t> RifMultipleSummaryReaders::timeSteps( const RifEclipseSummaryAddress& resultAddress ) const
{
    for ( const auto& r : m_readers )
    {
        const auto& timeSteps = r->timeSteps( resultAddress );
        if ( !timeSteps.empty() ) return timeSteps;
    }

    return {};
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<bool, std::vector<double>> RifMultipleSummaryReaders::values( const RifEclipseSummaryAddress& resultAddress ) const
{
    for ( const auto& r : m_readers )
    {
        const auto& okAndValues = r->values( resultAddress );
        if ( okAndValues.first && !okAndValues.second.empty() ) return okAndValues;
    }

    return { false, {} };
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::string RifMultipleSummaryReaders::unitName( const RifEclipseSummaryAddress& resultAddress ) const
{
    for ( const auto& r : m_readers )
    {
        auto name = r->unitName( resultAddress );
        if ( !name.empty() ) return name;
    }

    return {};
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaDefines::EclipseUnitSystem RifMultipleSummaryReaders::unitSystem() const
{
    CAF_ASSERT( !m_readers.empty() );

    // Readers without unit information are ignored, conflicting readers give an unknown unit system
    auto unitSystem = RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN;
    for ( const auto& reader : m_readers )
    {
        auto readerUnitSystem = reader->unitSystem();
        if ( readerUnitSystem == RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN ) continue;

        if ( unitSystem == RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN )
            unitSystem = readerUnitSystem;
        else if ( unitSystem != readerUnitSystem )
            return RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN;
    }

    return unitSystem;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifMultipleSummaryReaders::createAndSetAddresses()
{
    m_allErrorAddresses.clear();
    m_allResultAddresses.clear();

    // Loop over readers in inverted order to ensure calculated readers are processed after native file readers. Creation of summary
    // addresses for calculated readers depend on native readers.
    // https://github.com/OPM/ResInsight/issues/13137

    std::vector<RifSummaryReaderInterface*> readers;
    for ( auto& r : m_readers )
    {
        readers.push_back( r.get() );
    }

    auto nativeReaderFirst = []( const auto& first, const auto& second )
    {
        bool isFirstCalc  = dynamic_cast<RifCalculatedSummaryCurveReader*>( first ) != nullptr;
        bool isSecondCalc = dynamic_cast<RifCalculatedSummaryCurveReader*>( second ) != nullptr;
        if ( isFirstCalc && !isSecondCalc ) return false;
        if ( !isFirstCalc && isSecondCalc ) return true;
        return first->serialNumber() < second->serialNumber();
    };

    std::sort( readers.begin(), readers.end(), nativeReaderFirst );

    for ( auto reader : readers )
    {
        reader->createAndSetAddresses();

        auto resultAddresses = reader->allResultAddresses();
        m_allResultAddresses.insert( resultAddresses.begin(), resultAddresses.end() );

        auto errorResultAddresses = reader->allErrorAddresses();
        m_allErrorAddresses.insert( errorResultAddresses.begin(), errorResultAddresses.end() );
    }
}

//--------------------------------------------------------------------------------------------------
/// Recreate the addresses of the calculated readers, and leave the addresses of the native readers untouched. Calculation objects can be
/// created and modified after the addresses of a summary case have been created, and the addresses of the calculated readers must be
/// updated to reflect this.
//--------------------------------------------------------------------------------------------------
void RifMultipleSummaryReaders::refreshCalculatedAddresses()
{
    // If no addresses have been created, do nothing. The calculated addresses will be created along with the addresses of the native
    // readers in createAndSetAddresses().
    if ( m_allResultAddresses.empty() ) return;

    std::erase_if( m_allResultAddresses, []( const RifEclipseSummaryAddress& adr ) { return adr.isCalculated(); } );

    for ( const auto& r : m_readers )
    {
        if ( dynamic_cast<RifCalculatedSummaryCurveReader*>( r.get() ) == nullptr ) continue;

        r->createAndSetAddresses();

        const auto& resultAddresses = r->allResultAddresses();
        m_allResultAddresses.insert( resultAddresses.begin(), resultAddresses.end() );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
size_t RifMultipleSummaryReaders::keywordCount() const
{
    for ( const auto& r : m_readers )
    {
        if ( r->keywordCount() > 0 ) return r->keywordCount();
    }

    return 0;
}