ResInsight/ApplicationLibCode/ProjectDataModel/Rim3dWellLogRftCurve.cpp

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

#include "RiaQDateTimeTools.h"

#include "RifReaderEclipseRft.h"

#include "RigWellLogCurveData.h"

#include "RimEclipseResultCase.h"
#include "RimTools.h"
#include "RimWellLogCurve.h"
#include "RimWellLogRftCurveNameConfig.h"
#include "RimWellPath.h"

//==================================================================================================
///
///
//==================================================================================================

CAF_PDM_SOURCE_INIT( Rim3dWellLogRftCurve, "Rim3dWellLogRftCurve" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
Rim3dWellLogRftCurve::Rim3dWellLogRftCurve()
{
    CAF_PDM_InitObject( "3d Well Log RFT Curve", ":/WellLogCurve16x16.png", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_eclipseResultCase, "eclipseResultCase", "", "", "", "" );
    CAF_PDM_InitFieldNoDefault( &m_timeStep, "timeStep", "", "", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_wellLogChannelName, "wellLogChannelName", "", "", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_2dWellLogRftCurve, "my2dWellLogRftCurve", "", "", "", "" );

    m_2dWellLogRftCurve = new RimWellLogRftCurve();
    m_2dWellLogRftCurve.xmlCapability()->disableIO();

    CAF_PDM_InitFieldNoDefault( &m_nameConfig, "NameConfig", "", "", "", "" );
    m_nameConfig = new RimWellLogRftCurveNameConfig();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
Rim3dWellLogRftCurve::~Rim3dWellLogRftCurve()
{
    delete m_nameConfig;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void Rim3dWellLogRftCurve::curveValuesAndMds( std::vector<double>* values, std::vector<double>* measuredDepthValues ) const
{
    if ( m_2dWellLogRftCurve->wellName() == QString() )
    {
        m_2dWellLogRftCurve->setDefaultAddress( wellName() );
    }

    const RigWellLogCurveData* curveData = m_2dWellLogRftCurve->curveData();

    // These values are for a simulation well
    *values              = curveData->xValues();
    *measuredDepthValues = curveData->depths( RiaDefines::DepthTypeEnum::MEASURED_DEPTH );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString Rim3dWellLogRftCurve::resultPropertyString() const
{
    return caf::AppEnum<RifEclipseRftAddress::RftWellLogChannelType>::uiText( m_wellLogChannelName() );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString Rim3dWellLogRftCurve::name() const
{
    return m_nameConfig->name();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString Rim3dWellLogRftCurve::createAutoName() const
{
    QStringList name;

    if ( !wellName().isEmpty() )
    {
        name.push_back( wellName() );
    }

    name.push_back( "RFT" );

    if ( m_eclipseResultCase )
    {
        name.push_back( m_eclipseResultCase->caseUserDescription() );
    }
    if ( m_wellLogChannelName().text() !=
         caf::AppEnum<RifEclipseRftAddress::RftWellLogChannelType>::text( RifEclipseRftAddress::NONE ) )
    {
        RifEclipseRftAddress::RftWellLogChannelType channelNameEnum = m_wellLogChannelName();
        name.push_back( caf::AppEnum<RifEclipseRftAddress::RftWellLogChannelType>::uiText( channelNameEnum ) );
    }
    if ( !m_timeStep().isNull() )
    {
        name.push_back( m_timeStep().toString( RiaQDateTimeTools::dateFormatString() ) );
    }

    return name.join( ", " );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* Rim3dWellLogRftCurve::userDescriptionField()
{
    return m_nameConfig()->nameField();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void Rim3dWellLogRftCurve::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
                                             const QVariant&            oldValue,
                                             const QVariant&            newValue )
{
    if ( changedField == &m_wellLogChannelName || changedField == &m_timeStep )
    {
        this->resetMinMaxValues();
        this->updateConnectedEditors();
    }
    Rim3dWellLogCurve::fieldChangedByUi( changedField, oldValue, newValue );
}

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

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

        options.push_front( caf::PdmOptionItemInfo( "None", nullptr ) );
    }
    else if ( fieldNeedingOptions == &m_wellLogChannelName )
    {
        if ( m_eclipseResultCase )
        {
            RifReaderEclipseRft* reader = m_eclipseResultCase()->rftReader();
            if ( reader )
            {
                for ( const RifEclipseRftAddress::RftWellLogChannelType& channelName :
                      reader->availableWellLogChannels( wellName() ) )
                {
                    options.push_back(
                        caf::PdmOptionItemInfo( caf::AppEnum<RifEclipseRftAddress::RftWellLogChannelType>::uiText(
                                                    channelName ),
                                                channelName ) );
                }
            }
            if ( options.empty() )
            {
                options.push_back( caf::PdmOptionItemInfo( caf::AppEnum<RifEclipseRftAddress::RftWellLogChannelType>::uiText(
                                                               RifEclipseRftAddress::NONE ),
                                                           RifEclipseRftAddress::NONE ) );
            }
        }
    }
    else if ( fieldNeedingOptions == &m_timeStep )
    {
        if ( m_eclipseResultCase )
        {
            RifReaderEclipseRft* reader = m_eclipseResultCase()->rftReader();
            if ( reader )
            {
                QString             dateFormat = "dd MMM yyyy";
                std::set<QDateTime> timeStamps = reader->availableTimeSteps( wellName(), m_wellLogChannelName() );
                for ( const QDateTime& dt : timeStamps )
                {
                    QString dateString = RiaQDateTimeTools::toStringUsingApplicationLocale( dt, dateFormat );

                    options.push_back( caf::PdmOptionItemInfo( dateString, dt ) );
                }
            }

            options.push_back( caf::PdmOptionItemInfo( "None", QDateTime() ) );
        }
    }
    return options;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void Rim3dWellLogRftCurve::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
    caf::PdmUiGroup* curveDataGroup = uiOrdering.addNewGroup( "Curve Data" );
    curveDataGroup->add( &m_eclipseResultCase );
    curveDataGroup->add( &m_wellLogChannelName );
    curveDataGroup->add( &m_timeStep );

    Rim3dWellLogCurve::configurationUiOrdering( uiOrdering );

    caf::PdmUiGroup* nameGroup = uiOrdering.addNewGroup( "Curve Name" );
    m_nameConfig->uiOrdering( uiConfigName, *nameGroup );

    uiOrdering.skipRemainingFields( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString Rim3dWellLogRftCurve::wellName() const
{
    RimWellPath* wellPath = nullptr;
    firstAncestorOrThisOfType( wellPath );

    return wellPath->name();
}