ResInsight/ApplicationCode/ProjectDataModel/RimFaultCollection.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) Statoil ASA
//  Copyright (C) Ceetron Solutions 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 "RimFaultCollection.h"

#include "RiaApplication.h"
#include "RiaPreferences.h"
#include "RiaColorTables.h"

#include "RigMainGrid.h"

#include "RiaDefines.h"
#include "RimEclipseCase.h"
#include "RimEclipseView.h"
#include "RimFault.h"
#include "RimNoCommonAreaNNC.h"
#include "RimNoCommonAreaNncCollection.h"

#include "RiuMainWindow.h"

#include "cafAppEnum.h"
#include "cafPdmFieldCvfColor.h"
#include "cafPdmFieldCvfMat4d.h"

namespace caf
{
    template<>
    void AppEnum< RimFaultCollection::FaultFaceCullingMode >::setUp()
    {
        addItem(RimFaultCollection::FAULT_BACK_FACE_CULLING,  "FAULT_BACK_FACE_CULLING",    "Cell behind fault");
        addItem(RimFaultCollection::FAULT_FRONT_FACE_CULLING, "FAULT_FRONT_FACE_CULLING",   "Cell in front of fault");
        addItem(RimFaultCollection::FAULT_NO_FACE_CULLING,    "FAULT_NO_FACE_CULLING",      "Show both");
        setDefault(RimFaultCollection::FAULT_NO_FACE_CULLING);
    }
}



CAF_PDM_SOURCE_INIT(RimFaultCollection, "Faults");

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RimFaultCollection::RimFaultCollection()
{
    CAF_PDM_InitObject("Faults", ":/draw_style_faults_24x24.png", "", "");

    CAF_PDM_InitField(&showFaultCollection, "Active", true, "Active", "", "", "");
    showFaultCollection.uiCapability()->setUiHidden(true);

    CAF_PDM_InitField(&showFaultFaces, "ShowFaultFaces", true, "Show defined faces", "", "", "");
    CAF_PDM_InitField(&showOppositeFaultFaces, "ShowOppositeFaultFaces", true, "Show opposite faces", "", "", "");
    CAF_PDM_InitField(&m_showFaultsOutsideFilters, "ShowFaultsOutsideFilters", true, "Show faults outside filters", "", "", "");

    CAF_PDM_InitField(&faultResult, "FaultFaceCulling", caf::AppEnum<RimFaultCollection::FaultFaceCullingMode>(RimFaultCollection::FAULT_BACK_FACE_CULLING), "Dynamic Face Selection", "", "", "");

    CAF_PDM_InitField(&showFaultLabel, "ShowFaultLabel", false, "Show labels", "", "", "");
    cvf::Color3f defWellLabelColor = RiaApplication::instance()->preferences()->defaultWellLabelColor();
    CAF_PDM_InitField(&faultLabelColor, "FaultLabelColor", defWellLabelColor, "Label color", "", "", "");

    CAF_PDM_InitField(&showNNCs, "ShowNNCs", true, "Show NNCs", "", "", "");
    CAF_PDM_InitField(&hideNncsWhenNoResultIsAvailable, "HideNncsWhenNoResultIsAvailable", true, "Hide NNC geometry if no NNC result is available", "", "", "");

    CAF_PDM_InitFieldNoDefault(&noCommonAreaNnncCollection, "NoCommonAreaNnncCollection", "NNCs With No Common Area", "", "", "");
    noCommonAreaNnncCollection = new RimNoCommonAreaNncCollection;
    noCommonAreaNnncCollection.uiCapability()->setUiHidden(true);

    CAF_PDM_InitFieldNoDefault(&faults, "Faults", "Faults", "", "", "");
    faults.uiCapability()->setUiHidden(true);

    m_reservoirView = NULL;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RimFaultCollection::~RimFaultCollection()
{
   faults.deleteAllChildObjects();

   delete noCommonAreaNnncCollection();
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RimFaultCollection::fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue)
{
    this->updateUiIconFromToggleField();
    
    if (&faultLabelColor == changedField)
    {
        m_reservoirView->scheduleReservoirGridGeometryRegen();
    }

    if (&showFaultFaces == changedField ||
        &showOppositeFaultFaces == changedField ||
        &showFaultCollection == changedField ||
        &showFaultLabel == changedField ||
        &m_showFaultsOutsideFilters == changedField ||
        &faultLabelColor == changedField ||
        &faultResult == changedField ||
        &showNNCs == changedField ||
        &hideNncsWhenNoResultIsAvailable == changedField
        )
    {
        if (m_reservoirView) 
        {
            m_reservoirView->scheduleCreateDisplayModelAndRedraw();
        }
    }


    if (&showFaultLabel == changedField)
    {
        RiuMainWindow::instance()->refreshDrawStyleActions();
    }

}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RimFaultCollection::setReservoirView(RimEclipseView* ownerReservoirView)
{
    m_reservoirView = ownerReservoirView;
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimFaultCollection::objectToggleField()
{
    return &showFaultCollection;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RimFault* RimFaultCollection::findFaultByName(QString name)
{
    for (size_t i = 0; i < this->faults().size(); ++i)
    {
        if (this->faults()[i]->name() == name)
        {
            return this->faults()[i];
        }
    }
    return NULL;
}


//--------------------------------------------------------------------------------------------------
/// A comparing function used to sort Faults in the RimFaultCollection::syncronizeFaults() method
//--------------------------------------------------------------------------------------------------
bool faultComparator(const cvf::ref<RigFault>& a, const cvf::ref<RigFault>& b)
{
    CVF_TIGHT_ASSERT(a.notNull() && b.notNull());

    int compareValue = a->name().compare(b->name(), Qt::CaseInsensitive);

    return (compareValue < 0);
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RimFaultCollection::syncronizeFaults()
{
    if (!(m_reservoirView && m_reservoirView->mainGrid()) ) return;

    const caf::ColorTable& colorTable = RiaColorTables::faultsPaletteColors();

    const cvf::Collection<RigFault> constRigFaults = m_reservoirView->mainGrid()->faults();

    cvf::Collection<RigFault> rigFaults;
    {
        cvf::Collection<RigFault> sortedFaults(constRigFaults);

        std::sort(sortedFaults.begin(), sortedFaults.end(), faultComparator);

        cvf::ref<RigFault> undefinedFaults;
        cvf::ref<RigFault> undefinedFaultsWInactive;

        for (size_t i = 0; i < sortedFaults.size(); i++)
        {
            QString faultName = sortedFaults[i]->name();
            if (faultName.compare(RiaDefines::undefinedGridFaultName(), Qt::CaseInsensitive) == 0)
            {
                undefinedFaults = sortedFaults[i];
            }

            if(faultName.startsWith(RiaDefines::undefinedGridFaultName(), Qt::CaseInsensitive) 
               && faultName.contains("Inactive"))
            {
                undefinedFaultsWInactive = sortedFaults[i];
            }
        }

        if (undefinedFaults.notNull())
        {
            sortedFaults.erase(undefinedFaults.p());
            rigFaults.push_back(undefinedFaults.p());
        }

        if(undefinedFaultsWInactive.notNull())
        {
            sortedFaults.erase(undefinedFaultsWInactive.p());
            rigFaults.push_back(undefinedFaultsWInactive.p());
        }

        for (size_t i = 0; i < sortedFaults.size(); i++)
        {
            rigFaults.push_back(sortedFaults[i].p());
        }
    }


    // Find faults with 

    std::vector<caf::PdmPointer<RimFault> > newFaults;

    // Find corresponding fault from data model, or create a new
    for (size_t fIdx = 0; fIdx < rigFaults.size(); ++fIdx)
    {
        RimFault* rimFault = this->findFaultByName(rigFaults[fIdx]->name());

        if (!rimFault)
        {
            rimFault = new RimFault();
            rimFault->faultColor = colorTable.cycledColor3f(fIdx);
            QString faultName = rigFaults[fIdx]->name();

            if (faultName.startsWith(RiaDefines::undefinedGridFaultName(), Qt::CaseInsensitive) 
                && faultName.contains("Inactive"))
            {
                rimFault->showFault = false; // Turn fault against inactive cells off by default
            }
        }

        rimFault->setFaultGeometry(rigFaults[fIdx].p());

        newFaults.push_back(rimFault);
    }

    this->faults().clear();
    this->faults().insert(0, newFaults);

    QString toolTip = QString("Fault count (%1)").arg(newFaults.size());
    setUiToolTip(toolTip);

    // NNCs
    this->noCommonAreaNnncCollection()->noCommonAreaNncs().deleteAllChildObjects();

    RigMainGrid* mainGrid = m_reservoirView->mainGrid();
    std::vector<RigConnection>& nncConnections = mainGrid->nncData()->connections();
    for (size_t i = 0; i < nncConnections.size(); i++)
    {
        if (!nncConnections[i].hasCommonArea())
        {
            RimNoCommonAreaNNC* noCommonAreaNnc = new RimNoCommonAreaNNC();

            QString firstConnectionText;
            QString secondConnectionText;
            
            {
                const RigCell& cell = mainGrid->globalCellArray()[nncConnections[i].m_c1GlobIdx];

                RigGridBase* hostGrid = cell.hostGrid();
                size_t gridLocalCellIndex = cell.gridLocalCellIndex();

                size_t i, j, k;
                if (hostGrid->ijkFromCellIndex(gridLocalCellIndex, &i, &j, &k))
                {
                    // Adjust to 1-based Eclipse indexing
                    i++;
                    j++;
                    k++;
                     
                    if (!hostGrid->isMainGrid())
                    {
                        QString gridName = QString::fromStdString(hostGrid->gridName());
                        firstConnectionText = gridName + " ";
                    }
                    firstConnectionText += QString("[%1 %2 %3] - ").arg(i).arg(j).arg(k);
                }
            }

            {
                const RigCell& cell = mainGrid->globalCellArray()[nncConnections[i].m_c2GlobIdx];

                RigGridBase* hostGrid = cell.hostGrid();
                size_t gridLocalCellIndex = cell.gridLocalCellIndex();

                size_t i, j, k;
                if (hostGrid->ijkFromCellIndex(gridLocalCellIndex, &i, &j, &k))
                {
                    // Adjust to 1-based Eclipse indexing
                    i++;
                    j++;
                    k++;

                    if (!hostGrid->isMainGrid())
                    {
                        QString gridName = QString::fromStdString(hostGrid->gridName());
                        secondConnectionText = gridName + " ";
                    }
                    secondConnectionText += QString("[%1 %2 %3]").arg(i).arg(j).arg(k);
                }
            }

            noCommonAreaNnc->name = firstConnectionText + secondConnectionText;
            this->noCommonAreaNnncCollection()->noCommonAreaNncs().push_back(noCommonAreaNnc);
        }

        this->noCommonAreaNnncCollection()->updateName();
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
bool RimFaultCollection::isGridVisualizationMode() const
{
    CVF_ASSERT(m_reservoirView);

    return  m_reservoirView->isGridVisualizationMode();
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RimFaultCollection::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
{
    bool isGridVizMode = isGridVisualizationMode();

    faultResult.uiCapability()->setUiReadOnly(isGridVizMode);
    showFaultFaces.uiCapability()->setUiReadOnly(isGridVizMode);
    showOppositeFaultFaces.uiCapability()->setUiReadOnly(isGridVizMode);

    caf::PdmUiGroup* labs = uiOrdering.addNewGroup("Fault Labels");
    labs->add(&showFaultLabel);
    labs->add(&faultLabelColor);

    caf::PdmUiGroup* adv = uiOrdering.addNewGroup("Fault Options");
    adv->add(&m_showFaultsOutsideFilters);

    caf::PdmUiGroup* ffviz = uiOrdering.addNewGroup("Fault Face Visibility");
    ffviz->add(&showFaultFaces);
    ffviz->add(&showOppositeFaultFaces);
    ffviz->add(&faultResult);

    caf::PdmUiGroup* nncViz = uiOrdering.addNewGroup("NNC Visibility");
    nncViz->add(&showNNCs);
    nncViz->add(&hideNncsWhenNoResultIsAvailable);

}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
bool RimFaultCollection::showFaultsOutsideFilters() const
{
    if (!showFaultCollection) return false;

    return m_showFaultsOutsideFilters;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RimFaultCollection::setShowFaultsOutsideFilters(bool enableState)
{
    m_showFaultsOutsideFilters = enableState;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RimFaultCollection::addMockData()
{
    if (!(m_reservoirView && m_reservoirView->mainGrid())) return;

}