ResInsight/ApplicationCode/ProjectDataModel/Surfaces/RimGridCaseSurface.cpp

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

#include "RigSurface.h"

#include "RigMainGrid.h"
#include "RimCase.h"
#include "RimEclipseCase.h"
#include "RimSurfaceCollection.h"
#include "RimTools.h"

#include "cafPdmUiSliderEditor.h"

#include "RigReservoirGridTools.h"
#include "cvfVector3.h"

CAF_PDM_SOURCE_INIT( RimGridCaseSurface, "GridCaseSurface" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimGridCaseSurface::RimGridCaseSurface()
{
    CAF_PDM_InitObject( "Surface", ":/ReservoirSurface16x16.png", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_case, "SourceCase", "Source Case", "", "", "" );

    CAF_PDM_InitField( &m_sliceDirection,
                       "SnapShotDirection",
                       caf::AppEnum<RiaDefines::GridCaseAxis>( RiaDefines::GridCaseAxis::UNDEFINED_AXIS ),
                       "Range Filter Slice",
                       "",
                       "",
                       "" );

    CAF_PDM_InitField( &m_oneBasedSliceIndex, "SliceIndex", 1, "Slice Index", "", "", "" );
    m_oneBasedSliceIndex.uiCapability()->setUiEditorTypeName( caf::PdmUiSliderEditor::uiEditorTypeName() );
}

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

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::setCase( RimCase* sourceCase )
{
    m_case = sourceCase;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::setSliceTypeAndOneBasedIndex( RiaDefines::GridCaseAxis sliceType, int oneBasedSliceIndex )
{
    m_sliceDirection     = sliceType;
    m_oneBasedSliceIndex = oneBasedSliceIndex;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimGridCaseSurface::onLoadData()
{
    return updateSurfaceDataFromGridCase();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QList<caf::PdmOptionItemInfo> RimGridCaseSurface::calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions,
                                                                         bool*                      useOptionsOnly )
{
    QList<caf::PdmOptionItemInfo> options;

    if ( fieldNeedingOptions == &m_case )
    {
        RimTools::caseOptionItems( &options );
    }

    return options;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::defineEditorAttribute( const caf::PdmFieldHandle* field,
                                                QString                    uiConfigName,
                                                caf::PdmUiEditorAttribute* attribute )
{
    caf::PdmUiSliderEditorAttribute* myAttr = dynamic_cast<caf::PdmUiSliderEditorAttribute*>( attribute );
    if ( myAttr && m_case )
    {
        const cvf::StructGridInterface* grid = RigReservoirGridTools::mainGrid( m_case );
        if ( !grid ) return;

        myAttr->m_minimum = 1;

        if ( m_sliceDirection() == RiaDefines::GridCaseAxis::AXIS_I )
        {
            myAttr->m_maximum = static_cast<int>( grid->cellCountI() );
        }
        else if ( m_sliceDirection() == RiaDefines::GridCaseAxis::AXIS_J )
        {
            myAttr->m_maximum = static_cast<int>( grid->cellCountJ() );
        }
        else if ( m_sliceDirection() == RiaDefines::GridCaseAxis::AXIS_K )
        {
            myAttr->m_maximum = static_cast<int>( grid->cellCountK() );
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
                                           const QVariant&            oldValue,
                                           const QVariant&            newValue )
{
    RimSurface::fieldChangedByUi( changedField, oldValue, newValue );

    if ( changedField == &m_case || changedField == &m_sliceDirection || changedField == &m_oneBasedSliceIndex )
    {
        clearNativeGridData();
        updateSurfaceDataFromGridCase();
        updateUserDescription();

        RimSurfaceCollection* surfColl;
        this->firstAncestorOrThisOfTypeAsserted( surfColl );
        surfColl->updateViews( {this} );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::extractDataFromGrid()
{
    clearNativeGridData();

    if ( m_sliceDirection() == RiaDefines::GridCaseAxis::UNDEFINED_AXIS ) return;

    if ( m_case )
    {
        RimEclipseCase* eclCase = dynamic_cast<RimEclipseCase*>( m_case() );
        if ( eclCase && eclCase->mainGrid() )
        {
            const RigMainGrid* grid = eclCase->mainGrid();

            size_t minI = 0;
            size_t minJ = 0;
            size_t minK = 0;
            size_t maxI = grid->cellCountI();
            size_t maxJ = grid->cellCountJ();
            size_t maxK = grid->cellCountK();

            size_t zeroBasedLayerIndex = static_cast<size_t>( m_oneBasedSliceIndex - 1 );

            cvf::StructGridInterface::FaceType faceType = cvf::StructGridInterface::NO_FACE;
            {
                if ( m_sliceDirection() == RiaDefines::GridCaseAxis::AXIS_K )
                {
                    faceType = cvf::StructGridInterface::NEG_K;

                    minK = zeroBasedLayerIndex;
                    maxK = zeroBasedLayerIndex + 1;
                }
                else if ( m_sliceDirection() == RiaDefines::GridCaseAxis::AXIS_J )
                {
                    faceType = cvf::StructGridInterface::NEG_J;
                    minJ     = zeroBasedLayerIndex;
                    maxJ     = zeroBasedLayerIndex + 1;
                }
                else if ( m_sliceDirection() == RiaDefines::GridCaseAxis::AXIS_I )
                {
                    faceType = cvf::StructGridInterface::NEG_I;
                    minI     = zeroBasedLayerIndex;
                    maxI     = zeroBasedLayerIndex + 1;
                }
            }

            std::vector<unsigned>   tringleIndices;
            std::vector<cvf::Vec3d> vertices;

            for ( size_t i = minI; i < maxI; i++ )
            {
                for ( size_t j = minJ; j < maxJ; j++ )
                {
                    for ( size_t k = minK; k < maxK; k++ )
                    {
                        size_t cellIndex = grid->cellIndexFromIJK( i, j, k );

                        if ( grid->cell( cellIndex ).isInvalid() ) continue;

                        cvf::Vec3d cornerVerts[8];
                        grid->cellCornerVertices( cellIndex, cornerVerts );

                        cvf::ubyte faceConn[4];
                        grid->cellFaceVertexIndices( faceType, faceConn );

                        cvf::uint triangleIndex = static_cast<cvf::uint>( vertices.size() );

                        for ( int n = 0; n < 4; n++ )
                        {
                            vertices.push_back( cornerVerts[faceConn[n]] );
                        }

                        tringleIndices.push_back( triangleIndex + 0 );
                        tringleIndices.push_back( triangleIndex + 1 );
                        tringleIndices.push_back( triangleIndex + 2 );

                        tringleIndices.push_back( triangleIndex + 0 );
                        tringleIndices.push_back( triangleIndex + 2 );
                        tringleIndices.push_back( triangleIndex + 3 );
                    }
                }
            }

            m_vertices       = vertices;
            m_tringleIndices = tringleIndices;
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::clearNativeGridData()
{
    m_vertices.clear();
    m_tringleIndices.clear();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCaseSurface::updateUserDescription()
{
    QString name;

    auto dirValue = m_sliceDirection().value();
    switch ( dirValue )
    {
        case RiaDefines::GridCaseAxis::AXIS_I:
            name = "Surface I : ";
            break;
        case RiaDefines::GridCaseAxis::AXIS_J:
            name = "Surface J : ";
            break;
        case RiaDefines::GridCaseAxis::AXIS_K:
            name = "Surface K : ";
            break;
        case RiaDefines::GridCaseAxis::UNDEFINED_AXIS:
        default:
            name = "Surface  ";
            break;
    }

    name += QString::number( m_oneBasedSliceIndex );

    const double epsilon = 1.0e-3;
    if ( std::fabs( depthOffset() ) > epsilon )
    {
        name += ", Offset : " + QString::number( depthOffset() );
    }

    setUserDescription( name );
}

//--------------------------------------------------------------------------------------------------
/// Returns false for fatal failure
//--------------------------------------------------------------------------------------------------
bool RimGridCaseSurface::updateSurfaceDataFromGridCase()
{
    if ( m_vertices.empty() || m_tringleIndices.empty() )
    {
        extractDataFromGrid();
    }

    RigSurface* surfaceData = nullptr;

    std::vector<unsigned>   tringleIndices{m_tringleIndices};
    std::vector<cvf::Vec3d> vertices{m_vertices};

    if ( !tringleIndices.empty() )
    {
        {
            // Modify the z-value slightly to avoid geometrical numerical issues when the surface intersects
            // exactly at the cell face

            double delta = 1.0e-5;

            cvf::Vec3d offset = cvf::Vec3d::ZERO;

            if ( m_sliceDirection == RiaDefines::GridCaseAxis::AXIS_I )
            {
                offset.x() += delta;
            }
            else if ( m_sliceDirection == RiaDefines::GridCaseAxis::AXIS_J )
            {
                offset.y() += delta;
            }
            if ( m_sliceDirection == RiaDefines::GridCaseAxis::AXIS_K )
            {
                offset.z() += delta;
            }

            // Include the potential depth offset in the base class
            offset.z() += depthOffset();

            RimSurface::applyDepthOffset( offset, &vertices );
        }

        surfaceData = new RigSurface;
        surfaceData->setTriangleData( tringleIndices, vertices );
    }

    setSurfaceData( surfaceData );

    return true;
}