ResInsight/ApplicationCode/FileInterface/RifEclipseRestartFilesetAccess.cpp

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

#include "RifEclipseRestartFilesetAccess.h"
#include "RifEclipseOutputFileTools.h"
#include "cafProgressInfo.h"


//--------------------------------------------------------------------------------------------------
/// Constructor
//--------------------------------------------------------------------------------------------------
RifEclipseRestartFilesetAccess::RifEclipseRestartFilesetAccess()
    : RifEclipseRestartDataAccess()
{
}

//--------------------------------------------------------------------------------------------------
/// Destructor
//--------------------------------------------------------------------------------------------------
RifEclipseRestartFilesetAccess::~RifEclipseRestartFilesetAccess()
{
    close();

    for (size_t i = 0; i < m_ecl_files.size(); i++)
    {
        if (m_ecl_files[i])
        {
            ecl_file_close(m_ecl_files[i]);
        }

        m_ecl_files[i] = NULL;
    }

}

//--------------------------------------------------------------------------------------------------
/// Open files
//--------------------------------------------------------------------------------------------------
bool RifEclipseRestartFilesetAccess::open()
{
    if (m_fileNames.size() > 0)
    {
        caf::ProgressInfo progInfo(m_fileNames.size(), "");

        int i;
        for (i = 0; i < m_fileNames.size(); i++)
        {
            progInfo.setProgressDescription(m_fileNames[i]);

            openTimeStep(i);

            progInfo.incrementProgress();
        }
    }

    return true;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RifEclipseRestartFilesetAccess::setRestartFiles(const QStringList& fileSet)
{
    close();
    m_ecl_files.clear();

    m_fileNames = fileSet;
    m_fileNames.sort(); // To make sure they are sorted in increasing *.X000N order. Hack. Should probably be actual time stored on file.

    for (int i = 0; i < m_fileNames.size(); i++)
    {
        m_ecl_files.push_back(NULL);
    }

    CVF_ASSERT(m_fileNames.size() == static_cast<int>(m_ecl_files.size()));
}

//--------------------------------------------------------------------------------------------------
/// Close files
//--------------------------------------------------------------------------------------------------
void RifEclipseRestartFilesetAccess::close()
{
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RifEclipseRestartFilesetAccess::setTimeSteps(const std::vector<QDateTime>& timeSteps)
{
    CVF_ASSERT((size_t)m_fileNames.size() == timeSteps.size());
    m_timeSteps = timeSteps;
}

//--------------------------------------------------------------------------------------------------
/// Get the number of time steps
//--------------------------------------------------------------------------------------------------
size_t RifEclipseRestartFilesetAccess::timeStepCount()
{
    return m_timeSteps.size();
}

//--------------------------------------------------------------------------------------------------
/// Get the time steps
//--------------------------------------------------------------------------------------------------
std::vector<QDateTime> RifEclipseRestartFilesetAccess::timeSteps()
{
    if (m_timeSteps.size() == 0)
    {
        size_t numSteps = m_fileNames.size();
        size_t i;
        for (i = 0; i < numSteps; i++)
        {
            std::vector<QDateTime> stepTime;

            openTimeStep(i);

            RifEclipseOutputFileTools::timeSteps(m_ecl_files[i], &stepTime);
        
            if (stepTime.size() == 1)
            {
                m_timeSteps.push_back(stepTime[0]);
            }
            else
            {
                m_timeSteps.push_back(QDateTime());
            }
        }

    }

    return m_timeSteps;
}

//--------------------------------------------------------------------------------------------------
/// Get list of result names
//--------------------------------------------------------------------------------------------------
void RifEclipseRestartFilesetAccess::resultNames(QStringList* resultNames, std::vector<size_t>* resultDataItemCounts)
{
    CVF_ASSERT(timeStepCount() > 0);

    for (int i = 0; i < m_fileNames.size(); i++)
    {
        openTimeStep(i);
    }

    RifEclipseOutputFileTools::findKeywordsAndItemCount(m_ecl_files, resultNames, resultDataItemCounts);
}

//--------------------------------------------------------------------------------------------------
/// Get result values for given time step
//--------------------------------------------------------------------------------------------------
bool RifEclipseRestartFilesetAccess::results(const QString& resultName, size_t timeStep, size_t gridCount, std::vector<double>* values)
{
    if (timeStep >= timeStepCount())
    {
        return false;
    }

    openTimeStep(timeStep);

    size_t fileGridCount = ecl_file_get_num_named_kw(m_ecl_files[timeStep], resultName.toAscii().data());

    // No results for this result variable for current time step found
    if (fileGridCount == 0) return true;

    // Result handling depends on presents of result values for all grids
    if (gridCount != fileGridCount)
    {
        return false;
    }

    size_t i;
    for (i = 0; i < fileGridCount; i++)
    {
        std::vector<double> gridValues;

        if (!RifEclipseOutputFileTools::keywordData(m_ecl_files[timeStep], resultName, i, &gridValues))
        {
            return false;
        }

        values->insert(values->end(), gridValues.begin(), gridValues.end());
    }

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifEclipseRestartFilesetAccess::readWellData(well_info_type* well_info, bool importCompleteMswData)
{
    if (!well_info) return;

    for (size_t i = 0; i < m_ecl_files.size(); i++)
    {
        openTimeStep(i);

        const char* fileName = ecl_file_get_src_file(m_ecl_files[i]);
        int reportNumber = ecl_util_filename_report_nr(fileName);
        if(reportNumber != -1)
        {
            well_info_add_wells(well_info, m_ecl_files[i], reportNumber, importCompleteMswData);
        }
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RifEclipseRestartFilesetAccess::openTimeStep(size_t timeStep)
{
    CVF_ASSERT(timeStep < m_ecl_files.size());

    if (m_ecl_files[timeStep] == NULL)
    {
        int index = static_cast<int>(timeStep);
        ecl_file_type* ecl_file = ecl_file_open(m_fileNames[index].toAscii().data(), ECL_FILE_CLOSE_STREAM);

        m_ecl_files[timeStep] = ecl_file;
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
int RifEclipseRestartFilesetAccess::readUnitsType()
{
    ecl_file_type* ecl_file = NULL;

    if (m_ecl_files.size() > 0)
    {
        openTimeStep(0);
        ecl_file = m_ecl_files[0];
    }

    return RifEclipseOutputFileTools::readUnitsType(ecl_file);
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
std::vector<int> RifEclipseRestartFilesetAccess::reportNumbers()
{
    std::vector<int> reportNr;

    for (size_t i = 0; i < m_ecl_files.size(); i++)
    {
        const char* fileName = ecl_file_get_src_file(m_ecl_files[i]);
        int reportNumber = ecl_util_filename_report_nr(fileName);
        if (reportNumber != -1)
        {
            reportNr.push_back(reportNumber);
        }
    }

    return reportNr;
}