ResInsight/ApplicationLibCode/FileInterface/RifStimPlanModelPerfsFrkExporter.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 "RifStimPlanModelPerfsFrkExporter.h"

#include "RiaEclipseUnitTools.h"
#include "RiaLogging.h"

#include "RimStimPlanModel.h"
#include "RimWellPath.h"

#include "Well/RigWellPath.h"
#include "Well/RigWellPathGeometryTools.h"

#include "caf.h"

#include <QFile>
#include <QTextStream>

#include <vector>

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RifStimPlanModelPerfsFrkExporter::writeToFile( RimStimPlanModel* stimPlanModel, const QString& filepath )
{
    RimWellPath* wellPath = stimPlanModel->wellPath();
    if ( !wellPath )
    {
        return false;
    }

    QFile data( filepath );
    if ( !data.open( QFile::WriteOnly | QFile::Truncate ) )
    {
        return false;
    }

    QTextStream stream( &data );
    appendHeaderToStream( stream );

    bool isTransverse = ( stimPlanModel->fractureOrientation() == RimStimPlanModel::FractureOrientation::TRANSVERSE_WELL_PATH ||
                          stimPlanModel->fractureOrientation() == RimStimPlanModel::FractureOrientation::AZIMUTH );

    appendFractureOrientationToStream( stream, isTransverse );

    // Unit: meter
    auto [topMD, bottomMD] = calculateTopAndBottomMeasuredDepth( stimPlanModel, wellPath );
    appendPerforationToStream( stream, 1, RiaEclipseUnitTools::meterToFeet( topMD ), RiaEclipseUnitTools::meterToFeet( bottomMD ) );

    appendFooterToStream( stream );

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifStimPlanModelPerfsFrkExporter::appendHeaderToStream( QTextStream& stream )
{
    stream << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" << '\n' << "<perfs>" << caf::endl;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifStimPlanModelPerfsFrkExporter::appendFractureOrientationToStream( QTextStream& stream, bool isTransverse )
{
    stream << "<transverse>" << '\n' << static_cast<int>( isTransverse ) << '\n' << "</transverse>" << caf::endl;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifStimPlanModelPerfsFrkExporter::appendPerforationToStream( QTextStream& stream, int index, double topMD, double bottomMD )
{
    stream << "<perf frac=\"" << index << "\">" << caf::endl
           << "<topMD>" << caf::endl
           << topMD << caf::endl
           << "</topMD>" << caf::endl
           << "<bottomMD>" << caf::endl
           << bottomMD << caf::endl
           << "</bottomMD>" << caf::endl
           << "</perf>" << caf::endl;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifStimPlanModelPerfsFrkExporter::appendFooterToStream( QTextStream& stream )
{
    stream << "</perfs>" << caf::endl;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
double RifStimPlanModelPerfsFrkExporter::computeMeasuredDepthForPosition( const RimWellPath* wellPath, const cvf::Vec3d& position )
{
    const RigWellPath* wellPathGeometry = wellPath->wellPathGeometry();

    const std::vector<double>& mdValuesOfWellPath  = wellPathGeometry->measuredDepths();
    const std::vector<double>& tvdValuesOfWellPath = wellPathGeometry->trueVerticalDepths();
    const double               targetTvd           = -position.z();

    std::vector<double> tvDepthValues;
    size_t              index   = 0;
    bool                isAdded = false;
    for ( size_t i = 0; i < tvdValuesOfWellPath.size(); i++ )
    {
        double currentTvd = tvdValuesOfWellPath[i];
        double prevTvd    = 0.0;
        if ( i > 0 ) prevTvd = tvdValuesOfWellPath[i - 1];

        if ( !isAdded && targetTvd > prevTvd && targetTvd <= currentTvd )
        {
            // Insert the anchor position at correct order in well depths
            index   = i;
            isAdded = true;
            tvDepthValues.push_back( targetTvd );
        }

        tvDepthValues.push_back( currentTvd );
    }

    // Generate MD data by interpolation
    std::vector<double> measuredDepthValues =
        RigWellPathGeometryTools::interpolateMdFromTvd( mdValuesOfWellPath, tvdValuesOfWellPath, tvDepthValues );

    if ( index < measuredDepthValues.size() )
        return measuredDepthValues[index];
    else
    {
        RiaLogging::error( "Unable to compute measured depth from well path data." );
        return -1.0;
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<double, double> RifStimPlanModelPerfsFrkExporter::calculateTopAndBottomMeasuredDepth( RimStimPlanModel* stimPlanModel,
                                                                                                RimWellPath*      wellPath )
{
    double perforationLength = stimPlanModel->perforationLength();

    double anchorPositionMD = computeMeasuredDepthForPosition( wellPath, stimPlanModel->anchorPosition() );
    double topMD            = anchorPositionMD - ( perforationLength / 2.0 );
    double bottomMD         = anchorPositionMD + ( perforationLength / 2.0 );

    return std::make_pair( topMD, bottomMD );
}