ResInsight/ApplicationCode/Commands/RicWellLogTools.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 "RicWellLogTools.h"

#include "RiaGuiApplication.h"

#include "Rim3dView.h"
#include "RimCase.h"
#include "RimEclipseResultCase.h"
#include "RimProject.h"
#include "RimSimWellInView.h"
#include "RimWellLogExtractionCurve.h"
#include "RimWellLogFile.h"
#include "RimWellLogFileChannel.h"
#include "RimWellLogFileCurve.h"
#include "RimWellLogRftCurve.h"
#include "RimWellLogTrack.h"
#include "RimWellPath.h"

#include "RifReaderEclipseRft.h"

#include "Riu3dSelectionManager.h"
#include "RiuPlotMainWindowTools.h"

#include "WellLogCommands/RicWellLogPlotCurveFeatureImpl.h"

#include "cafSelectionManager.h"

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimSimWellInView* RicWellLogTools::selectedSimulationWell( int* branchIndex )
{
    RiuSelectionItem* selItem = Riu3dSelectionManager::instance()->selectedItem( Riu3dSelectionManager::RUI_TEMPORARY );
    RiuSimWellSelectionItem* simWellSelItem = dynamic_cast<RiuSimWellSelectionItem*>( selItem );
    if ( simWellSelItem )
    {
        ( *branchIndex ) = static_cast<int>( simWellSelItem->m_branchIndex );
        return simWellSelItem->m_simWell;
    }
    else
    {
        std::vector<RimSimWellInView*> selection;
        caf::SelectionManager::instance()->objectsByType( &selection );
        ( *branchIndex ) = 0;
        return selection.size() > 0 ? selection[0] : nullptr;
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RicWellLogTools::wellHasRftData( const QString& wellName )
{
    RimEclipseResultCase* resultCase;
    std::vector<RimCase*> cases;
    RiaApplication::instance()->project()->allCases( cases );

    for ( RimCase* rimCase : cases )
    {
        if ( resultCase = dynamic_cast<RimEclipseResultCase*>( rimCase ) )
        {
            if ( resultCase->rftReader() )
            {
                return resultCase->rftReader()->wellHasRftData( wellName );
            }
        }
    }

    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RicWellLogTools::isWellPathOrSimWellSelectedInView()
{
    Riu3dSelectionManager* riuSelManager = Riu3dSelectionManager::instance();
    RiuSelectionItem*      selItem       = riuSelManager->selectedItem( Riu3dSelectionManager::RUI_TEMPORARY );

    RiuSimWellSelectionItem* simWellSelectionItem = dynamic_cast<RiuSimWellSelectionItem*>( selItem );
    if ( simWellSelectionItem ) return true;

    RiuWellPathSelectionItem* wellPathSelectionItem = dynamic_cast<RiuWellPathSelectionItem*>( selItem );
    if ( wellPathSelectionItem ) return true;

    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicWellLogTools::addWellLogChannelsToPlotTrack( RimWellLogTrack*                           plotTrack,
                                                     const std::vector<RimWellLogFileChannel*>& wellLogFileChannels )
{
    for ( size_t cIdx = 0; cIdx < wellLogFileChannels.size(); cIdx++ )
    {
        RimWellLogFileCurve* plotCurve = RicWellLogTools::addFileCurve( plotTrack );

        RimWellPath*    wellPath;
        RimWellLogFile* wellLogFile;
        wellLogFileChannels[cIdx]->firstAncestorOrThisOfType( wellPath );
        wellLogFileChannels[cIdx]->firstAncestorOrThisOfType( wellLogFile );

        if ( wellPath )
        {
            if ( wellLogFile ) plotCurve->setWellLogFile( wellLogFile );

            plotCurve->setWellPath( wellPath );
            plotCurve->setWellLogChannelName( wellLogFileChannels[cIdx]->name() );
            plotCurve->loadDataAndUpdate( true );
            plotCurve->updateConnectedEditors();
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellPath* RicWellLogTools::selectedWellPathWithLogFile()
{
    std::vector<RimWellPath*> selection;
    caf::SelectionManager::instance()->objectsByType( &selection );
    if ( selection.size() > 0 )
    {
        RimWellPath* wellPath = selection[0];
        if ( wellPath->wellLogFiles().size() > 0 )
        {
            return wellPath;
        }
    }

    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellPath* RicWellLogTools::findWellPathWithLogFileFromSelection()
{
    RimWellPath* wellPath = caf::SelectionManager::instance()->selectedItemAncestorOfType<RimWellPath>();
    if ( wellPath->wellLogFiles().size() > 0 )
    {
        return wellPath;
    }
    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellLogExtractionCurve* RicWellLogTools::addExtractionCurve( RimWellLogTrack*        plotTrack,
                                                                Rim3dView*              view,
                                                                RimWellPath*            wellPath,
                                                                const RimSimWellInView* simWell,
                                                                int                     branchIndex,
                                                                bool                    useBranchDetection,
                                                                bool                    showPlotWindow )
{
    CVF_ASSERT( plotTrack );
    RimWellLogExtractionCurve* curve = new RimWellLogExtractionCurve();

    cvf::Color3f curveColor = RicWellLogPlotCurveFeatureImpl::curveColorFromTable( plotTrack->curveCount() );
    curve->setColor( curveColor );
    if ( wellPath )
    {
        curve->setWellPath( wellPath );
        plotTrack->setFormationWellPath( wellPath );
        plotTrack->setFormationTrajectoryType( RimWellLogTrack::WELL_PATH );
    }
    if ( simWell )
    {
        curve->setFromSimulationWellName( simWell->name(), branchIndex, useBranchDetection );
        plotTrack->setFormationSimWellName( simWell->name() );
        plotTrack->setFormationBranchIndex( branchIndex );
        plotTrack->setFormationTrajectoryType( RimWellLogTrack::SIMULATION_WELL );
    }

    if ( view )
    {
        plotTrack->setFormationCase( view->ownerCase() );
    }

    curve->setPropertiesFromView( view );

    plotTrack->addCurve( curve );

    plotTrack->updateConnectedEditors();

    RiaApplication::instance()->project()->updateConnectedEditors();
    RiaGuiApplication::instance()->getOrCreateMainPlotWindow();
    RiuPlotMainWindowTools::selectAsCurrentItem( curve );

    if ( showPlotWindow )
    {
        // Make sure the summary plot window is visible
        RiuPlotMainWindowTools::showPlotMainWindow();
    }

    return curve;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellLogRftCurve*
    RicWellLogTools::addRftCurve( RimWellLogTrack* plotTrack, const RimSimWellInView* simWell, bool showPlotWindow )
{
    CVF_ASSERT( plotTrack );

    RimWellLogRftCurve* curve = new RimWellLogRftCurve();

    RimEclipseResultCase* resultCase = nullptr;

    std::vector<RimCase*> cases;
    RiaApplication::instance()->project()->allCases( cases );

    for ( RimCase* rimCase : cases )
    {
        if ( resultCase = dynamic_cast<RimEclipseResultCase*>( rimCase ) )
        {
            break;
        }
    }

    if ( simWell && resultCase )
    {
        curve->setEclipseResultCase( resultCase );
        curve->setDefaultAddress( simWell->name() );

        plotTrack->setFormationCase( resultCase );
        plotTrack->setFormationSimWellName( simWell->name() );
    }

    cvf::Color3f curveColor = RicWellLogPlotCurveFeatureImpl::curveColorFromTable( plotTrack->curveCount() );
    curve->setColor( curveColor );

    plotTrack->addCurve( curve );
    plotTrack->setFormationTrajectoryType( RimWellLogTrack::SIMULATION_WELL );
    plotTrack->updateConnectedEditors();

    RiaApplication::instance()->project()->updateConnectedEditors();
    RiaGuiApplication::instance()->getOrCreateMainPlotWindow();
    RiuPlotMainWindowTools::selectAsCurrentItem( curve );

    if ( showPlotWindow )
    {
        // Make sure the summary plot window is visible
        RiuPlotMainWindowTools::showPlotMainWindow();
    }

    return curve;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellLogFileCurve* RicWellLogTools::addFileCurve( RimWellLogTrack* plotTrack, bool showPlotWindow )
{
    CVF_ASSERT( plotTrack );

    RimWellLogFileCurve* curve = new RimWellLogFileCurve();

    cvf::Color3f curveColor = RicWellLogPlotCurveFeatureImpl::curveColorFromTable( plotTrack->curveCount() );
    curve->setColor( curveColor );

    plotTrack->addCurve( curve );

    plotTrack->updateConnectedEditors();

    RiaApplication::instance()->project()->updateConnectedEditors();
    RiaGuiApplication::instance()->getOrCreateMainPlotWindow();
    RiuPlotMainWindowTools::selectAsCurrentItem( curve );

    if ( showPlotWindow )
    {
        // Make sure the summary plot window is visible
        RiuPlotMainWindowTools::showPlotMainWindow();
    }

    return curve;
}