ResInsight/ApplicationLibCode/ProjectDataModelCommands/RimcWellPath.cpp

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

#include "FractureCommands/RicNewWellPathFractureFeature.h"
#include "FractureCommands/RicPlaceThermalFractureUsingTemplateDataFeature.h"

#include "RiaApplication.h"
#include "RiaKeyValueStoreUtil.h"
#include "RiaLogging.h"
#include "RiaQStringFormatter.h"

#include "RimEclipseCase.h"
#include "RimEclipseCaseTools.h"
#include "RimFishbones.h"
#include "RimFishbonesCollection.h"
#include "RimFishbonesDefines.h"
#include "RimImportedWellLog.h"
#include "RimImportedWellLogData.h"
#include "RimMswCompletionParameters.h"
#include "RimPerforationCollection.h"
#include "RimPerforationInterval.h"
#include "RimStimPlanFractureTemplate.h"
#include "RimStimPlanModel.h"
#include "RimThermalFractureTemplate.h"
#include "RimValveCollection.h"
#include "RimWellPath.h"
#include "RimWellPathCollection.h"
#include "RimWellPathCompletionSettings.h"
#include "RimWellPathFracture.h"
#include "RimWellPathTieIn.h"
#include "RimWellPathValve.h"

#include "RigDoglegTools.h"
#include "RigStimPlanModelTools.h"
#include "Well/RigWellPath.h"
#include "Well/RigWellPathGeometryExporter.h"
#include "Well/RigWellPathGeometryTools.h"

#include "cafPdmAbstractFieldScriptingCapability.h"
#include "cafPdmFieldScriptingCapability.h"
#include "cvfMath.h"
#include "cvfVector3.h"

#include <numbers>

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_addFracture, "AddFracture" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_addFracture::RimcWellPath_addFracture( caf::PdmObjectHandle* self )
    : caf::PdmObjectCreationMethod( self )
{
    CAF_PDM_InitObject( "Add StimPlan Fracture", "", "", "Add StimPlan Fracture" );

    CAF_PDM_InitScriptableField( &m_md, "MeasuredDepth", 0.0, "Measured Depth" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_stimPlanFractureTemplate, "StimPlanFractureTemplate", "", "", "", "StimPlan Fracture Template" );
    CAF_PDM_InitScriptableField( &m_alignDip, "AlignDip", false, "Align Dip" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_eclipseCase, "EclipseCase", "", "", "", "Eclipse Case" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_addFracture::execute()
{
    auto wellPath = self<RimWellPath>();

    RimWellPathFracture* wellPathFracture = RicNewWellPathFractureFeature::addFracture( wellPath, m_md() );

    if ( m_stimPlanFractureTemplate ) wellPathFracture->setFractureTemplate( m_stimPlanFractureTemplate() );

    if ( m_alignDip )
    {
        if ( m_eclipseCase && m_eclipseCase->eclipseCaseData() )
        {
            RiaLogging::info( "Computing formation dip for fracture alignment" );

            double boundingBoxHorizontal = 50.0;
            double boundingBoxVertical   = 100.0;

            cvf::Vec3d position  = wellPathFracture->anchorPosition();
            cvf::Vec3d direction = RigStimPlanModelTools::calculateTSTDirection( m_eclipseCase->eclipseCaseData(),
                                                                                 position,
                                                                                 boundingBoxHorizontal,
                                                                                 boundingBoxVertical );
            RiaLogging::info( std::format( "Direction: {} {} {}", direction.x(), direction.y(), direction.z() ) );
            cvf::Vec3d fractureDirectionNormal = wellPathFracture->computeFractureDirectionNormal();

            cvf::Vec3d formationDirection = RimStimPlanModel::projectVectorIntoFracturePlane( position, fractureDirectionNormal, direction );
            if ( !formationDirection.isUndefined() )
            {
                double formationDip =
                    RigStimPlanModelTools::calculateFormationDipAlignedToAzimuth( formationDirection, wellPathFracture->azimuth() );
                RiaLogging::info( std::format( "Computed formation dip: {}", formationDip ) );

                wellPathFracture->setDip( formationDip );
            }
        }
        else
        {
            RiaLogging::error( "No eclipse case found. Fracture not aligned with formation dip." );
        }
    }

    return wellPathFracture;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_addFracture::classKeywordReturnedType() const
{
    return RimWellPathFracture::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_addThermalFracture, "AddThermalFracture" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_addThermalFracture::RimcWellPath_addThermalFracture( caf::PdmObjectHandle* self )
    : caf::PdmObjectCreationMethod( self )
{
    CAF_PDM_InitObject( "Add Thermal Fracture", "", "", "Add Thermal Fracture" );

    CAF_PDM_InitScriptableField( &m_md, "MeasuredDepth", 0.0, "Measured Depth" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_fractureTemplate, "FractureTemplate", "", "", "", "Thermal Fracture Template" );
    CAF_PDM_InitScriptableField( &m_placeUsingTemplateData, "PlaceUsingTemplateData", true, "Place using template data" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_addThermalFracture::execute()
{
    auto wellPath = self<RimWellPath>();

    RimWellPathFracture* wellPathFracture = RicNewWellPathFractureFeature::addFracture( wellPath, m_md() );

    if ( m_fractureTemplate )
    {
        wellPathFracture->setFractureTemplate( m_fractureTemplate() );
    }

    if ( m_placeUsingTemplateData )
    {
        RicPlaceThermalFractureUsingTemplateDataFeature::placeUsingTemplateData( wellPathFracture );
    }

    return wellPathFracture;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_addThermalFracture::classKeywordReturnedType() const
{
    return RimWellPathFracture::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_appendPerforationInterval, "AppendPerforationInterval" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_appendPerforationInterval::RimcWellPath_appendPerforationInterval( caf::PdmObjectHandle* self )
    : caf::PdmObjectCreationMethod( self )
{
    CAF_PDM_InitObject( "Append Perforation Interval", "", "", "Append Perforation Interval" );

    CAF_PDM_InitScriptableField( &m_startMD, "StartMd", 0.0, "", "", "", "Start Measured Depth" );
    CAF_PDM_InitScriptableField( &m_endMD, "EndMd", 0.0, "", "", "", "End Measured Depth" );
    CAF_PDM_InitScriptableField( &m_diameter, "Diameter", 0.0, "", "", "", "Diameter" );
    CAF_PDM_InitScriptableField( &m_skinFactor, "SkinFactor", 0.0, "", "", "", "Skin Factor" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_appendPerforationInterval::execute()
{
    auto wellPath = self<RimWellPath>();

    auto perforationInterval = new RimPerforationInterval;
    perforationInterval->setStartAndEndMD( m_startMD, m_endMD );
    perforationInterval->setSkinFactor( m_skinFactor );
    perforationInterval->setDiameter( m_diameter );

    wellPath->perforationIntervalCollection()->appendPerforation( perforationInterval );

    auto* wellPathCollection = RimWellPathCollection::instance();

    wellPathCollection->uiCapability()->updateConnectedEditors();
    wellPathCollection->scheduleRedrawAffectedViews();

    return perforationInterval;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_appendPerforationInterval::classKeywordReturnedType() const
{
    return RimPerforationInterval::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_multiSegmentWellSettings, "MswSettings" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_multiSegmentWellSettings::RimcWellPath_multiSegmentWellSettings( caf::PdmObjectHandle* self )
    : PdmObjectMethod( self, PdmObjectMethod::NullPointerType::NULL_IS_VALID, PdmObjectMethod::ResultType::PERSISTENT_TRUE )
{
    CAF_PDM_InitObject( "MSW Settings", "", "", "Multi Segment Well Settings" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_multiSegmentWellSettings::execute()
{
    auto wellPath = self<RimWellPath>();

    // RimMswCompletionParameters is a child object of RimWellPathCompletionSettings. To simplify the Python API, we return
    // RimMswCompletionParameters directly from a well path object in Python. Two parameters are already exposed as part of the completion
    // settings object, see RimWellPathCompletionSettings and the proxy fields liner_diameter and roughness. These fields are kept to
    // ensure backward compatibility with existing scripts.
    //
    // https://github.com/OPM/ResInsight/issues/11901

    if ( auto completionSettings = wellPath->completionSettings() )
    {
        return completionSettings->mswCompletionParameters();
    }
    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_multiSegmentWellSettings::classKeywordReturnedType() const
{
    return RimMswCompletionParameters::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_appendFishbones, "AppendFishbones" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_appendFishbones::RimcWellPath_appendFishbones( caf::PdmObjectHandle* self )
    : PdmObjectMethod( self, PdmObjectMethod::NullPointerType::NULL_IS_VALID, PdmObjectMethod::ResultType::PERSISTENT_TRUE )
{
    CAF_PDM_InitObject( "Append Fishbones", "", "", "Append Fishbones" );

    CAF_PDM_InitScriptableFieldNoDefault( &m_subLocations, "SubLocations", "SubLocations" );
    auto defaultDrillingType = RimFishbonesDefines::DrillingType::STANDARD;
    CAF_PDM_InitScriptableField( &m_drillingType, "DrillingType", defaultDrillingType, "DrillingType" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_appendFishbones::execute()
{
    auto wellPath = self<RimWellPath>();

    if ( m_subLocations().empty() )
    {
        RiaLogging::error(
            "Sub locations are empty, expected list of float values defining measured depths. Cannot create fishbones object." );
        return nullptr;
    }

    if ( auto fishbonesCollection = wellPath->fishbonesCollection() )
    {
        auto* fishbonesObject = fishbonesCollection->appendFishbonesSubsAtLocations( m_subLocations(), m_drillingType() );

        wellPath->updateAllRequiredEditors();

        return fishbonesObject;
    }

    RiaLogging::error( "No fishbones collection object found, cannot create fishbones object." );

    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_appendFishbones::classKeywordReturnedType() const
{
    return RimFishbones::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_extractWellPathPropertiesInternal, "ExtractWellPathPropertiesInternal" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_extractWellPathPropertiesInternal::RimcWellPath_extractWellPathPropertiesInternal( caf::PdmObjectHandle* self )
    : caf::PdmVoidObjectMethod( self )
{
    CAF_PDM_InitObject( "Extract Well Path Properties", "", "", "Extract Well Path Properties" );

    CAF_PDM_InitScriptableField( &m_resamplingInterval, "ResamplingInterval", 10.0, "ResamplingInterval" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_coordinateX, "CoordinateX", "CoordinateX" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_coordinateY, "CoordinateY", "CoordinateY" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_coordinateZ, "CoordinateZ", "CoordinateZ" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_measuredDepth, "MeasuredDepth", "MeasuredDepth" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_azimuth, "Azimuth", "Azimuth" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_inclination, "Inclination", "Inclination" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_dogleg, "Dogleg", "Dogleg" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_extractWellPathPropertiesInternal::execute()
{
    auto wellPath = self<RimWellPath>();

    std::vector<double> xValues;
    std::vector<double> yValues;
    std::vector<double> tvdValues;
    std::vector<double> mdValues;

    auto wellPathGeom = wellPath->wellPathGeometry();
    if ( !wellPathGeom ) return std::unexpected( QString( "Well path has no geometry" ) );

    double mdStepSize = m_resamplingInterval();
    CAF_ASSERT( mdStepSize > 0.0 );
    double rkbOffset = 0.0;
    RigWellPathGeometryExporter::computeWellPathDataForExport( *wellPathGeom, mdStepSize, rkbOffset, xValues, yValues, tvdValues, mdValues );

    auto convertToCharViaFloat = []( const std::vector<double>& doubles ) -> std::vector<char>
    {
        std::vector<float> f;
        for ( const double& v : doubles )
            f.push_back( static_cast<float>( v ) );
        return RiaKeyValueStoreUtil::convertToByteVector( f );
    };

    RiaApplication::instance()->keyValueStore()->set( m_coordinateX().toStdString(), convertToCharViaFloat( xValues ) );
    RiaApplication::instance()->keyValueStore()->set( m_coordinateY().toStdString(), convertToCharViaFloat( yValues ) );
    RiaApplication::instance()->keyValueStore()->set( m_coordinateZ().toStdString(), convertToCharViaFloat( tvdValues ) );
    RiaApplication::instance()->keyValueStore()->set( m_measuredDepth().toStdString(), convertToCharViaFloat( mdValues ) );

    std::vector<double> azimuthValues;
    std::vector<double> inclinationValues;
    for ( const double& md : mdValues )
    {
        auto [azimuth, inclination] = RigWellPathGeometryTools::calculateAzimuthAndInclinationAtMd( md, wellPathGeom );

        if ( azimuth < 0.0 )
        {
            // Straight atan2 gives angle from -PI to PI yielding angles from -180 to 180
            // where the negative angles are counter clockwise.
            // To get all positive clockwise angles, we add 360 degrees to negative angles.
            azimuth = azimuth + std::numbers::pi * 2.0;
        }

        azimuthValues.push_back( cvf::Math::toDegrees( azimuth ) );
        inclinationValues.push_back( cvf::Math::toDegrees( inclination ) );
    }

    RiaApplication::instance()->keyValueStore()->set( m_azimuth().toStdString(), convertToCharViaFloat( azimuthValues ) );
    RiaApplication::instance()->keyValueStore()->set( m_inclination().toStdString(), convertToCharViaFloat( inclinationValues ) );

    std::vector<RigDoglegTools::WellSurveyPoint> surveyPoints;
    for ( size_t i = 0; i < xValues.size(); i++ )
    {
        surveyPoints.push_back( { .inclination = inclinationValues[i], .azimuth = azimuthValues[i], .measuredDepth = mdValues[i] } );
    }

    // TODO: normalization length is meter. Maybe make it settable?
    std::vector<double> doglegs = RigDoglegTools::calculateTrajectoryDogleg( surveyPoints, 30 );
    RiaApplication::instance()->keyValueStore()->set( m_dogleg().toStdString(), convertToCharViaFloat( doglegs ) );

    return nullptr;
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_addWellLogInternal, "AddWellLogInternal" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_addWellLogInternal::RimcWellPath_addWellLogInternal( caf::PdmObjectHandle* self )
    : caf::PdmObjectCreationMethod( self )
{
    CAF_PDM_InitObject( "Add Well Log", "", "", "Add Well Log" );

    CAF_PDM_InitScriptableFieldNoDefault( &m_name, "Name", "Name" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_measuredDepthKey, "MeasuredDepthKey", "Measured Depth Key" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_channelKeysCsv, "ChannelKeysCsv", "Channel Keys CSV" );
    CAF_PDM_InitScriptableField( &m_tvdMslKey, "TvdMslKey", QString(), "TVD MSL Key" );
    CAF_PDM_InitScriptableField( &m_tvdRkbKey, "TvdRkbKey", QString(), "TVD RKB Key" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_addWellLogInternal::execute()
{
    auto wellPath = self<RimWellPath>();

    if ( m_name().isEmpty() )
    {
        return std::unexpected( "Well log name cannot be empty" );
    }

    if ( m_measuredDepthKey().isEmpty() )
    {
        return std::unexpected( "Measured depth key cannot be empty" );
    }

    if ( m_channelKeysCsv().isEmpty() )
    {
        return std::unexpected( "Channel keys CSV cannot be empty" );
    }

    auto keyValueStore = RiaApplication::instance()->keyValueStore();

    // Retrieve measured depth values from key-value store
    auto measuredDepthData = keyValueStore->get( m_measuredDepthKey().toStdString() );
    if ( !measuredDepthData.has_value() )
    {
        return std::unexpected( "Failed to retrieve measured depth from key-value store" );
    }

    std::vector<float> measuredDepthFloat = RiaKeyValueStoreUtil::convertToFloatVector( measuredDepthData );
    if ( measuredDepthFloat.empty() )
    {
        return std::unexpected( "Measured depth array cannot be empty" );
    }

    // Convert to double
    std::vector<double> measuredDepth;
    for ( float value : measuredDepthFloat )
    {
        measuredDepth.push_back( static_cast<double>( value ) );
    }

    // Handle optional TVD MSL
    std::vector<double> tvdMslValues;
    if ( !m_tvdMslKey().isEmpty() )
    {
        auto tvdMslData = keyValueStore->get( m_tvdMslKey().toStdString() );
        if ( !tvdMslData.has_value() )
        {
            return std::unexpected( "Failed to retrieve TVD MSL from key-value store" );
        }

        std::vector<float> tvdMslFloat = RiaKeyValueStoreUtil::convertToFloatVector( tvdMslData );
        if ( tvdMslFloat.size() != measuredDepth.size() )
        {
            return std::unexpected(
                QString( "TVD MSL has %1 values but measured depth has %2 values" ).arg( tvdMslFloat.size() ).arg( measuredDepth.size() ) );
        }

        for ( float value : tvdMslFloat )
        {
            tvdMslValues.push_back( static_cast<double>( value ) );
        }
    }

    // Handle optional TVD RKB
    std::vector<double> tvdRkbValues;
    if ( !m_tvdRkbKey().isEmpty() )
    {
        auto tvdRkbData = keyValueStore->get( m_tvdRkbKey().toStdString() );
        if ( !tvdRkbData.has_value() )
        {
            return std::unexpected( "Failed to retrieve TVD RKB from key-value store" );
        }

        std::vector<float> tvdRkbFloat = RiaKeyValueStoreUtil::convertToFloatVector( tvdRkbData );
        if ( tvdRkbFloat.size() != measuredDepth.size() )
        {
            return std::unexpected(
                QString( "TVD RKB has %1 values but measured depth has %2 values" ).arg( tvdRkbFloat.size() ).arg( measuredDepth.size() ) );
        }

        for ( float value : tvdRkbFloat )
        {
            tvdRkbValues.push_back( static_cast<double>( value ) );
        }
    }

    // Parse channel keys CSV (format: "channel1:key1,channel2:key2,...")
    QString channelKeysStr = m_channelKeysCsv();
    if ( channelKeysStr.isEmpty() )
    {
        return std::unexpected( "Channel keys cannot be empty" );
    }

    QStringList channelMappings = channelKeysStr.split( ",", Qt::SkipEmptyParts );
    if ( channelMappings.isEmpty() )
    {
        return std::unexpected( "Channel data cannot be empty" );
    }

    QMap<QString, QString> channelKeysMap;
    for ( const QString& mapping : channelMappings )
    {
        QStringList parts = mapping.split( ":", Qt::SkipEmptyParts );
        if ( parts.size() != 2 )
        {
            return std::unexpected( QString( "Invalid channel mapping format: %1" ).arg( mapping ) );
        }
        QString channelName = parts[0];
        QString channelKey  = parts[1];

        if ( channelName.isEmpty() || channelKey.isEmpty() )
        {
            return std::unexpected( QString( "Empty channel name or key in mapping: %1" ).arg( mapping ) );
        }

        channelKeysMap[channelName] = channelKey;
    }

    // Create PDM well log data for project file persistence
    auto pdmWellLogData = new RimImportedWellLogData();
    pdmWellLogData->setDepthValues( measuredDepth );

    // Set optional TVD data
    if ( !tvdMslValues.empty() )
    {
        pdmWellLogData->setTvdMslValues( tvdMslValues );
    }
    if ( !tvdRkbValues.empty() )
    {
        pdmWellLogData->setTvdRkbValues( tvdRkbValues );
    }

    // Retrieve and set channel data
    QStringList keysToCleanup;
    keysToCleanup.append( m_measuredDepthKey() );
    if ( !m_tvdMslKey().isEmpty() ) keysToCleanup.append( m_tvdMslKey() );
    if ( !m_tvdRkbKey().isEmpty() ) keysToCleanup.append( m_tvdRkbKey() );

    for ( auto it = channelKeysMap.begin(); it != channelKeysMap.end(); ++it )
    {
        QString channelName = it.key();
        QString channelKey  = it.value();

        keysToCleanup.append( channelKey );

        // Retrieve channel values from key-value store
        auto channelData = keyValueStore->get( channelKey.toStdString() );
        if ( !channelData.has_value() )
        {
            return std::unexpected( QString( "Failed to retrieve channel '%1' from key-value store" ).arg( channelName ) );
        }

        std::vector<float> channelValuesFloat = RiaKeyValueStoreUtil::convertToFloatVector( channelData );
        if ( channelValuesFloat.size() != measuredDepth.size() )
        {
            return std::unexpected( QString( "Channel '%1' has %2 values but measured depth has %3 values" )
                                        .arg( channelName )
                                        .arg( channelValuesFloat.size() )
                                        .arg( measuredDepth.size() ) );
        }

        // Convert to double
        std::vector<double> channelValues;
        for ( float value : channelValuesFloat )
        {
            channelValues.push_back( static_cast<double>( value ) );
        }

        pdmWellLogData->setChannelData( channelName, channelValues );
    }

    // Create well log object
    auto importedWellLog = new RimImportedWellLog();
    importedWellLog->setName( m_name() );
    importedWellLog->setWellLogData( pdmWellLogData );

    // Add to well path
    wellPath->addWellLog( importedWellLog );

    // Clean up key-value store
    for ( const QString& keyToCleanup : keysToCleanup )
    {
        keyValueStore->remove( keyToCleanup.toStdString() );
    }

    wellPath->updateConnectedEditors();

    return importedWellLog;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_addWellLogInternal::classKeywordReturnedType() const
{
    return RimImportedWellLog::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_appendLateralFromGeometry, "AppendLateralFromGeometry" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_appendLateralFromGeometry::RimcWellPath_appendLateralFromGeometry( caf::PdmObjectHandle* self )
    : caf::PdmVoidObjectMethod( self )
{
    CAF_PDM_InitObject( "Append Well Path Lateral" );

    CAF_PDM_InitScriptableFieldNoDefault( &m_lateral, "WellPathLateral", "", "", "", "Well Path Lateral" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_appendLateralFromGeometry::execute()
{
    auto wellPath = self<RimWellPath>();

    const auto mainWellPathGeometry = wellPath->wellPathGeometry();
    if ( !mainWellPathGeometry )
    {
        QString txt = "No geometry available for main well path. Cannot append lateral to main well path.";
        return std::unexpected( txt );
    }

    if ( !m_lateral )
    {
        QString txt = "No lateral specified. Cannot append lateral to well path.";
        return std::unexpected( txt );
    }

    auto lateralGeometry = m_lateral->wellPathGeometry();
    if ( !lateralGeometry )
    {
        QString txt = "No geometry available for lateral. Cannot append lateral to main well path.";
        return std::unexpected( txt );
    }

    auto connectLateralToWellPath = []( RimWellPath* mainWell, RimWellPath* lateral, double measuredDepth )
    {
        if ( !mainWell || !lateral ) return;

        lateral->connectWellPaths( mainWell, measuredDepth );

        auto wellPathCollection = RimWellPathCollection::instance();
        wellPathCollection->rebuildWellPathNodes();

        mainWell->updateAllRequiredEditors();
    };

    const double sharedWellPathLength = lateralGeometry->identicalTubeLength( *mainWellPathGeometry );
    const double epsilon              = 1.0e-8;
    if ( sharedWellPathLength > epsilon )
    {
        connectLateralToWellPath( wellPath, m_lateral, sharedWellPathLength );

        return nullptr;
    }

    if ( lateralGeometry->wellPathPoints().empty() )
    {
        QString txt = "No points available for lateral. Cannot append lateral to main well path.";
        return std::unexpected( txt );
    }

    auto lateralStartPoint   = lateralGeometry->wellPathPoints().front();
    auto closestMdOnMainWell = mainWellPathGeometry->closestMeasuredDepth( lateralStartPoint );
    if ( closestMdOnMainWell < 0.0 )
    {
        QString txt = "Failed to find closest point on main well path. Cannot append lateral to main well path.";
        return std::unexpected( txt );
    }

    connectLateralToWellPath( wellPath, m_lateral, closestMdOnMainWell );

    return nullptr;
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_parentBranch, "ParentBranch" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_parentBranch::RimcWellPath_parentBranch( caf::PdmObjectHandle* self )
    : PdmObjectMethod( self, PdmObjectMethod::NullPointerType::NULL_IS_VALID, PdmObjectMethod::ResultType::PERSISTENT_TRUE )
{
    CAF_PDM_InitObject( "Parent Branch", "", "", "Parent Branch" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_parentBranch::execute()
{
    auto wellPath = self<RimWellPath>();

    if ( wellPath->isTopLevelWellPath() ) return nullptr;

    if ( wellPath->wellPathTieIn() ) return wellPath->wellPathTieIn()->parentWell();

    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_parentBranch::classKeywordReturnedType() const
{
    return RimWellPath::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_enableOutletValve, "EnableOutletValve" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_enableOutletValve::RimcWellPath_enableOutletValve( caf::PdmObjectHandle* self )
    : PdmObjectMethod( self, PdmObjectMethod::NullPointerType::NULL_IS_VALID, PdmObjectMethod::ResultType::PERSISTENT_TRUE )
{
    CAF_PDM_InitObject( "Enable Outlet Valve", "", "", "Enable Outlet Valve" );

    CAF_PDM_InitScriptableFieldNoDefault( &m_enabled, "Enable", "Enable" );
    CAF_PDM_InitScriptableFieldNoDefault( &m_template, "IcvTemplate", "IcvTemplate" );
    CAF_PDM_InitScriptableField( &m_useCustomMd, "UseCustomValveMd", false, "Use Custom Valve Md" );
    CAF_PDM_InitScriptableField( &m_customMd, "CustomValveMd", 0.0, "Outlet Valve Custom Md" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_enableOutletValve::execute()
{
    auto              wellPath = self<RimWellPath>();
    RimWellPathValve* valve    = nullptr;

    if ( wellPath->isTopLevelWellPath() ) return nullptr;

    if ( auto tieIn = wellPath->wellPathTieIn() )
    {
        tieIn->setEnableBranchValveAtConnection( m_enabled() );
        if ( m_enabled() )
        {
            if ( m_useCustomMd() )
            {
                tieIn->setBranchValveMeasuredDepth( m_customMd() );
            }
            else
            {
                tieIn->useDefaultBranchValveMeasuredDepth();
            }

            if ( m_template() and ( m_template->type() == RiaDefines::WellPathComponentType::ICV ) )
            {
                tieIn->setBranchValveTemplate( m_template() );
            }

            valve = tieIn->outletValve();
        }

        tieIn->updateConnectedEditors();
    }

    return valve;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_enableOutletValve::classKeywordReturnedType() const
{
    return RimWellPathValve::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_tieIn, "TieIn" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimcWellPath_tieIn::RimcWellPath_tieIn( caf::PdmObjectHandle* self )
    : PdmObjectMethod( self, PdmObjectMethod::NullPointerType::NULL_IS_VALID, PdmObjectMethod::ResultType::PERSISTENT_TRUE )
{
    CAF_PDM_InitObject( "Well Path Tie-In", "", "", "Well Path Tie-In Settings" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_tieIn::execute()
{
    if ( auto wellPath = self<RimWellPath>() )
    {
        return wellPath->wellPathTieIn();
    }

    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_tieIn::classKeywordReturnedType() const
{
    return RimWellPathTieIn::classKeywordStatic();
}

CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimWellPath, RimcWellPath_addIcvValve, "AddIcvValve" );

//--------------------------------------------------------------------------------------------------
//
//--------------------------------------------------------------------------------------------------
RimcWellPath_addIcvValve::RimcWellPath_addIcvValve( caf::PdmObjectHandle* self )
    : caf::PdmObjectCreationMethod( self )
{
    CAF_PDM_InitObject( "Add ICV Valve", "", "", "Add ICV Valve" );
    CAF_PDM_InitScriptableField( &m_measuredDepth, "MeasuredDepth", 0.0, "Measured Depth" );
}

//--------------------------------------------------------------------------------------------------
//
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimcWellPath_addIcvValve::execute()
{
    if ( auto wellPath = self<RimWellPath>() )
    {
        auto valve = wellPath->valveCollection()->addIcvValve( m_measuredDepth );

        if ( valve )
        {
            if ( auto wellPathCollection = RimWellPathCollection::instance() )
            {
                wellPathCollection->updateConnectedEditors();
                wellPathCollection->scheduleRedrawAffectedViews();
            }

            return valve;
        }
    }
    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimcWellPath_addIcvValve::classKeywordReturnedType() const
{
    return RimWellPathValve::classKeywordStatic();
}