ResInsight/ApplicationCode/Commands/ExportCommands/RicExportEclipseSectorModelUi.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017-     Statoil 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 "RicExportEclipseSectorModelUi.h"

#include "RiaApplication.h"
#include "RigCaseCellResultsData.h"
#include "RigEclipseCaseData.h"

#include "RimEclipseResultDefinition.h"

#include "cafPdmUiFilePathEditor.h"
#include "cafPdmUiGroup.h"
#include "cafPdmUiLineEditor.h"
#include "cafPdmUiListEditor.h"
#include "cafPdmUiOrdering.h"

#include <QDir>
#include <QFileInfo>
#include <QIntValidator>

#include <set>

CAF_PDM_SOURCE_INIT(RicExportEclipseSectorModelUi, "RicExportEclipseInputGridUi");

namespace caf
{
template<>
void RicExportEclipseSectorModelUi::ResultExportOptionsEnum::setUp()
{
    addItem(RicExportEclipseSectorModelUi::EXPORT_NO_RESULTS, "NO_RESULTS", "Do not export");
    addItem(RicExportEclipseSectorModelUi::EXPORT_TO_GRID_FILE, "TO_GRID_FILE", "Append to grid file");
    addItem(RicExportEclipseSectorModelUi::EXPORT_TO_SINGLE_SEPARATE_FILE, "TO_SINGLE_RESULT_FILE", "Export to single file");
    addItem(RicExportEclipseSectorModelUi::EXPORT_TO_SEPARATE_FILE_PER_RESULT, "TO_SEPARATE_RESULT_FILES", "Export to a separate file per property");

    setDefault(RicExportEclipseSectorModelUi::EXPORT_TO_SEPARATE_FILE_PER_RESULT);
}

} // namespace caf

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RicExportEclipseSectorModelUi::RicExportEclipseSectorModelUi(RigEclipseCaseData* caseData)
    : m_caseData(caseData)
{
    CAF_PDM_InitObject("Export Visible Cells as Eclipse Input Grid", "", "", "");

    CAF_PDM_InitField(&exportGrid, "ExportGrid", true, "Export Grid", "", "Includes COORD, ZCORN and ACTNUM", "");
    CAF_PDM_InitField(&exportGridFilename, "ExportGridFilename", QString(), "Grid File Name", "", "", "");
    exportGridFilename.uiCapability()->setUiEditorTypeName(caf::PdmUiFilePathEditor::uiEditorTypeName());

    CAF_PDM_InitField(&makeInvisibleCellsInactive, "InvisibleCellActnum", false, "Make Invisible Cells Inactive", "", "", "");

    CAF_PDM_InitFieldNoDefault(&exportFaults, "ExportFaults", "Export Faults", "", "", "");
    exportFaults = EXPORT_TO_SINGLE_SEPARATE_FILE;

    CAF_PDM_InitField(&exportFaultsFilename, "ExportFaultsFilename", QString(), "Faults File Name", "", "", "");
    exportFaultsFilename.uiCapability()->setUiEditorTypeName(caf::PdmUiFilePathEditor::uiEditorTypeName());

    CAF_PDM_InitFieldNoDefault(&exportResults, "ExportResults", "Export Properties", "", "", "");
    CAF_PDM_InitField(&exportResultsFilename, "ExportResultsFilename", QString(), "Properties File Name", "", "", "");
    exportResultsFilename.uiCapability()->setUiEditorTypeName(caf::PdmUiFilePathEditor::uiEditorTypeName());
    
    CAF_PDM_InitFieldNoDefault(&exportMainKeywords, "ExportMainKeywords", "Main Keywords", "", "", "");
    CAF_PDM_InitFieldNoDefault(&exportAdditionalKeywords, "ExportAdditionalKeywords", "Additional Keywords", "", "", "");

    QString ijkLabel = "Cell Count I, J, K";
    CAF_PDM_InitField(&cellCountI, "CellCountI", 1, ijkLabel, "", "", "");
    CAF_PDM_InitField(&cellCountJ, "CellCountJ", 1, "", "", "", "");
    CAF_PDM_InitField(&cellCountK, "CellCountK", 1, "", "", "", "");

    exportGridFilename    = defaultGridFileName();
    exportResultsFilename = defaultResultsFileName();
    exportFaultsFilename  = defaultFaultsFileName();

    for (QString keyword : mainKeywords())
    {
        exportMainKeywords.v().push_back(keyword);
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RicExportEclipseSectorModelUi::~RicExportEclipseSectorModelUi()
{
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<QString> RicExportEclipseSectorModelUi::allSelectedKeywords() const
{
    std::vector<QString> additionalResults = exportAdditionalKeywords();
    std::vector<QString> allRes = exportMainKeywords();
    allRes.insert(allRes.end(), additionalResults.begin(), additionalResults.end());
    return allRes;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RicExportEclipseSectorModelUi::defineEditorAttribute(const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute * attribute)
{
    if (field == &exportResultsFilename || field == &exportGridFilename || field == &exportFaultsFilename)
    {
        caf::PdmUiFilePathEditorAttribute* myAttr = dynamic_cast<caf::PdmUiFilePathEditorAttribute*>(attribute);
        if (myAttr)
        {
            myAttr->m_selectSaveFileName = true;
        }
    }
    else if (field == &exportMainKeywords || field == &exportAdditionalKeywords)
    {
        caf::PdmUiListEditorAttribute* myAttr = dynamic_cast<caf::PdmUiListEditorAttribute*>(attribute);
        if (myAttr)
        {
            myAttr->m_heightHint = 200;
        }
    }
    else if (field == &cellCountI || field == &cellCountJ || field == &cellCountK)
    {
        caf::PdmUiLineEditorAttribute* myAttr = dynamic_cast<caf::PdmUiLineEditorAttribute*>(attribute);
        if (myAttr)
        {
            QIntValidator* validator = new QIntValidator(1, 10, nullptr);
            myAttr->validator = validator;
        }
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RicExportEclipseSectorModelUi::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
{
    caf::PdmUiGroup* gridGroup = uiOrdering.addNewGroup("Grid Export");
    gridGroup->add(&exportGrid);
    gridGroup->add(&exportGridFilename);
    exportGridFilename.uiCapability()->setUiReadOnly(!exportGrid());        
    gridGroup->add(&makeInvisibleCellsInactive);

    gridGroup->add(&exportFaults);
    if (exportFaults() != EXPORT_NO_RESULTS)
    {
        if (exportFaults() == EXPORT_TO_SINGLE_SEPARATE_FILE)
        {
            gridGroup->add(&exportFaultsFilename);
        }
    }


    caf::PdmUiGroup* resultsGroup = uiOrdering.addNewGroup("Results and Faults Export");

    resultsGroup->add(&exportResults);
    if (exportResults() != EXPORT_NO_RESULTS)
    {
        if (exportResults() == EXPORT_TO_SINGLE_SEPARATE_FILE)
        {
            resultsGroup->add(&exportResultsFilename);
        }
    }
    
    if (exportResults() != EXPORT_NO_RESULTS)
    {
        resultsGroup->add(&exportMainKeywords);
        resultsGroup->add(&exportAdditionalKeywords);
    }

    caf::PdmUiGroup* gridRefinement = uiOrdering.addNewGroup("Grid Refinement");
    gridRefinement->add(&cellCountI, { true, 2, 1 });
    gridRefinement->add(&cellCountJ, { false });
    gridRefinement->add(&cellCountK, { false });

    uiOrdering.skipRemainingFields(true);
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RicExportEclipseSectorModelUi::fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue)
{
    if (changedField == &exportGridFilename)
    {
        QFileInfo info(exportGridFilename());
        QDir      dirPath = info.absoluteDir();

        if (exportResultsFilename() == defaultResultsFileName())
        {
            exportResultsFilename = dirPath.absoluteFilePath("RESULTS.GRDECL");
        }
        if (exportFaultsFilename() == defaultFaultsFileName())
        {
            exportFaultsFilename = dirPath.absoluteFilePath("FAULTS.GRDECL");
        }
    }
    else if (changedField == &exportResultsFilename)
    {
        QFileInfo info(exportResultsFilename());
        QDir      dirPath = info.absoluteDir();

        if (exportGridFilename() == defaultGridFileName())
        {
            exportGridFilename = dirPath.absoluteFilePath("GRID.GRDECL");
        }
        if (exportFaultsFilename() == defaultFaultsFileName())
        {
            exportFaultsFilename = dirPath.absoluteFilePath("FAULTS.GRDECL");
        }
    }
    else if (changedField == &exportFaultsFilename)
    {
        QFileInfo info(exportFaultsFilename());
        QDir      dirPath = info.absoluteDir();

        if (exportGridFilename() == defaultGridFileName())
        {
            exportGridFilename = dirPath.absoluteFilePath("GRID.GRDECL");
        }
        if (exportResultsFilename() == defaultResultsFileName())
        {
            exportResultsFilename = dirPath.absoluteFilePath("RESULTS.GRDECL");
        }
    }
}


//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QList<caf::PdmOptionItemInfo>
    RicExportEclipseSectorModelUi::calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions, bool* useOptionsOnly)
{
    QList<caf::PdmOptionItemInfo> options;
    if (fieldNeedingOptions == &exportMainKeywords)
    {
        RigCaseCellResultsData* resultData = m_caseData->results(RiaDefines::MATRIX_MODEL);
        QList<caf::PdmOptionItemInfo> allOptions = RimEclipseResultDefinition::calcOptionsForVariableUiFieldStandard(RiaDefines::STATIC_NATIVE, resultData);        

        std::set<QString> mainKeywords = this->mainKeywords();
        for (caf::PdmOptionItemInfo option : allOptions)
        { 
            if (mainKeywords.count(option.optionUiText()))
            {
                options.push_back(option);
            }
        }
    }
    else if (fieldNeedingOptions == &exportAdditionalKeywords)
    {
        RigCaseCellResultsData*       resultData = m_caseData->results(RiaDefines::MATRIX_MODEL);
        QList<caf::PdmOptionItemInfo> allOptions =
            RimEclipseResultDefinition::calcOptionsForVariableUiFieldStandard(RiaDefines::STATIC_NATIVE, resultData);

        std::set<QString> mainKeywords = this->mainKeywords();
        for (caf::PdmOptionItemInfo option : allOptions)
        {
            if (!mainKeywords.count(option.optionUiText()) && option.optionUiText() != "None")
            {
                if (option.optionUiText() == "ACTNUM" && exportGrid())
                {
                    if (exportResults() != EXPORT_TO_GRID_FILE)
                        options.push_back(caf::PdmOptionItemInfo("ACTNUM (included in Grid File)", "ACTNUM"));
                }
                else
                {
                    options.push_back(option);
                }
            }
        }
    }
    else if (fieldNeedingOptions == &exportFaults)
    {
        std::set<ResultExportOptions> validFaultOptions = { EXPORT_NO_RESULTS, EXPORT_TO_GRID_FILE, EXPORT_TO_SINGLE_SEPARATE_FILE };
        for (ResultExportOptions option : validFaultOptions)
        {
            options.push_back(caf::PdmOptionItemInfo(ResultExportOptionsEnum::uiText(option), option));
        }
    }
    return options;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::set<QString> RicExportEclipseSectorModelUi::mainKeywords()
{
    return { RiaDefines::eqlnumResultName(), "FIPNUM", "NTG", "PERMX", "PERMY", "PERMZ", "PORO", "PVTNUM", "SATNUM", "SWATINIT" };
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicExportEclipseSectorModelUi::defaultFolder() const
{
    QString projectDirectory    = RiaApplication::instance()->currentProjectPath();
    QString fallbackDirectory   = projectDirectory;
    if (fallbackDirectory.isEmpty())
    {
        QString generalFallback = RiaApplication::instance()->lastUsedDialogDirectory("GENERAL_DATA");
        fallbackDirectory = RiaApplication::instance()->lastUsedDialogDirectoryWithFallback("BINARY_GRID", generalFallback);
    }
    return RiaApplication::instance()->lastUsedDialogDirectoryWithFallback("EXPORT_INPUT_GRID", fallbackDirectory);

}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicExportEclipseSectorModelUi::defaultGridFileName() const
{
    
    QDir baseDir(defaultFolder());
    return baseDir.absoluteFilePath("GRID.GRDECL");    
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicExportEclipseSectorModelUi::defaultResultsFileName() const
{
    QDir baseDir(defaultFolder());
    return baseDir.absoluteFilePath("RESULTS.GRDECL");
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicExportEclipseSectorModelUi::defaultFaultsFileName() const
{
    QDir baseDir(defaultFolder());
    return baseDir.absoluteFilePath("FAULTS.GRDECL");
}