ResInsight/ApplicationLibCode/Commands/ExportCommands/RicEclipseCellResultToFileImpl.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2018-     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 "RicEclipseCellResultToFileImpl.h"

#include "RiaLogging.h"

#include "RigCaseCellResultsData.h"
#include "RigEclipseCaseData.h"
#include "RigEclipseResultAddress.h"
#include "RigMainGrid.h"
#include "RigResultAccessor.h"
#include "RigResultAccessorFactory.h"

#include "RimEclipseResultDefinition.h"

#include "cafProgressInfo.h"

#include <QFile>

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RicEclipseCellResultToFileImpl::writePropertyToTextFile( const QString&      fileName,
                                                              RigEclipseCaseData* eclipseCase,
                                                              size_t              timeStep,
                                                              const QString&      resultName,
                                                              const QString&      eclipseKeyword,
                                                              const double        undefinedValue,
                                                              bool                writeEchoKeywords,
                                                              QString*            errorMsg )
{
    CAF_ASSERT( eclipseCase );
    if ( !eclipseCase ) return false;

    cvf::ref<RigResultAccessor> resultAccessor = RigResultAccessorFactory::createFromResultAddress( eclipseCase,
                                                                                                    0,
                                                                                                    RiaDefines::PorosityModelType::MATRIX_MODEL,
                                                                                                    timeStep,
                                                                                                    RigEclipseResultAddress( resultName ) );
    if ( resultAccessor.isNull() )
    {
        return false;
    }

    return writeResultToTextFile( fileName,
                                  eclipseCase,
                                  resultAccessor.p(),
                                  eclipseKeyword,
                                  undefinedValue,
                                  "writePropertyToTextFile",
                                  writeEchoKeywords,
                                  errorMsg );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RicEclipseCellResultToFileImpl::writeBinaryResultToTextFile( const QString&              fileName,
                                                                  RigEclipseCaseData*         eclipseCase,
                                                                  size_t                      timeStep,
                                                                  RimEclipseResultDefinition* resultDefinition,
                                                                  const QString&              eclipseKeyword,
                                                                  const double                undefinedValue,
                                                                  const QString&              logPrefix,
                                                                  bool                        writeEchoKeywords,
                                                                  QString*                    errorMsg )
{
    CAF_ASSERT( eclipseCase );

    cvf::ref<RigResultAccessor> resultAccessor =
        RigResultAccessorFactory::createFromResultDefinition( eclipseCase, 0, timeStep, resultDefinition );
    if ( resultAccessor.isNull() )
    {
        return false;
    }

    return writeResultToTextFile( fileName, eclipseCase, resultAccessor.p(), eclipseKeyword, undefinedValue, logPrefix, writeEchoKeywords, errorMsg );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RicEclipseCellResultToFileImpl::writeResultToTextFile( const QString&      fileName,
                                                            RigEclipseCaseData* eclipseCase,
                                                            RigResultAccessor*  resultAccessor,
                                                            const QString&      eclipseKeyword,
                                                            const double        undefinedValue,
                                                            const QString&      logPrefix,
                                                            bool                writeEchoKeywords,
                                                            QString*            errorMsg )
{
    CAF_ASSERT( errorMsg != nullptr );

    if ( !resultAccessor )
    {
        *errorMsg = QString( logPrefix + QString( " : : Could not access result data for '%1'" ).arg( fileName ) );
        return false;
    }

    QFile file( fileName );
    if ( !file.open( QIODevice::WriteOnly | QIODevice::Text ) )
    {
        *errorMsg = QString( logPrefix + QString( " : Could not open file '%1'. Do the folder exist?" ).arg( fileName ) );
        return false;
    }

    std::vector<double> resultData;
    for ( size_t i = 0; i < eclipseCase->mainGrid()->cellCount(); i++ )
    {
        double resultValue = resultAccessor->cellScalar( i );
        if ( resultValue == HUGE_VAL )
        {
            resultValue = undefinedValue;
        }

        resultData.push_back( resultValue );
    }

    int valuesPerRow = 5;
    writeDataToTextFile( &file, writeEchoKeywords, eclipseKeyword, resultData, valuesPerRow );

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicEclipseCellResultToFileImpl::writeDataToTextFile( QFile*                     file,
                                                          bool                       writeEchoKeywords,
                                                          const QString&             eclipseKeyword,
                                                          const std::vector<double>& resultData,
                                                          int                        valuesPerRow )
{
    QTextStream textstream( file );
    textstream << "\n";
    textstream << "-- Exported from ResInsight" << "\n";

    if ( writeEchoKeywords )
    {
        textstream << "NOECHO\n";
    }

    textstream << eclipseKeyword << "\n";

    // Special formatting for MAPAXES to match Eclipse format exactly
    if ( eclipseKeyword == "MAPAXES" )
    {
        textstream.setFieldWidth( 0 );
        textstream.setRealNumberPrecision( 3 );
        textstream.setRealNumberNotation( QTextStream::FixedNotation );

        // Write MAPAXES in proper Eclipse format: 2 values per line, 3 lines total
        for ( size_t i = 0; i < resultData.size(); i += 2 )
        {
            textstream << resultData[i] << " " << resultData[i + 1] << "\n";
        }
        textstream << "/\n";
        return; // Skip the normal loop for MAPAXES
    }

    textstream.setFieldWidth( 16 );
    textstream.setFieldAlignment( QTextStream::AlignRight );

    // Set higher precision for coordinate data
    if ( eclipseKeyword == "COORD" || eclipseKeyword == "ZCORN" )
    {
        textstream.setRealNumberPrecision( 3 );
        textstream.setRealNumberNotation( QTextStream::FixedNotation );
    }

    caf::ProgressInfo pi( resultData.size(), QString( "Writing data to file %1" ).arg( file->fileName() ) );
    size_t            progressSteps = std::max( static_cast<size_t>( 1 ), resultData.size() / 20 );

    for ( size_t i = 0; i < resultData.size(); i++ )
    {
        textstream << resultData[i];

        if ( ( i + 1 ) % valuesPerRow == 0 )
        {
            textstream << "\n";
        }

        if ( i % progressSteps == 0 )
        {
            pi.setProgress( i );
        }
    }

    textstream << "\n"
               << "/" << "\n";

    if ( writeEchoKeywords )
    {
        textstream.setFieldWidth( 0 );
        textstream << "ECHO\n";
    }
}