mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-27 07:30:20 -05:00
Magne Sjaastad
93bd0b9c9d
* Refactor well log track settings into modular classes Major refactoring of RimWellLogTrack to delegate property axis, formation, region annotation, and well path attribute settings to dedicated settings classes. Introduces RimWellLogPropertyAxisSettings, RimWellLogFormationSettings, RimWellLogRegionAnnotationSettings, and RimWellLogWellPathAttributeSettings, each encapsulating related fields, UI logic, and option handling. Old fields are retained for migration and backward compatibility. Updates enums and signatures for consistency.
391 lines
17 KiB
C++
391 lines
17 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2015- Statoil ASA
|
|
// Copyright (C) 2015- Ceetron Solutions AS
|
|
//
|
|
// 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.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#pragma once
|
|
|
|
#include "RiaWellLogTrackDefines.h"
|
|
#include "RimWellLogPlot.h"
|
|
|
|
#include "RiaPlotDefines.h"
|
|
|
|
#include "Well/RigWellPathFormations.h"
|
|
|
|
#include "RimPlot.h"
|
|
|
|
#include "RiuPlotAxis.h"
|
|
|
|
#include "cafPdmChildArrayField.h"
|
|
#include "cafPdmChildField.h"
|
|
#include "cafPdmField.h"
|
|
#include "cafPdmObject.h"
|
|
#include "cafPdmPtrField.h"
|
|
|
|
#include <QPointer>
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
class RigWellPath;
|
|
class RimCase;
|
|
class RimWellPathAttributeCollection;
|
|
class RimWellFlowRateCurve;
|
|
class RimWellLogCurve;
|
|
class RimWellPath;
|
|
class RimDepthTrackPlot;
|
|
class RiuWellPathComponentPlotItem;
|
|
class RiuWellLogTrack;
|
|
class RigEclipseWellLogExtractor;
|
|
class RimWellLogPlotCollection;
|
|
class RigGeoMechWellLogExtractor;
|
|
class RigResultAccessor;
|
|
class RigFemResultAddress;
|
|
class RigWellLogExtractor;
|
|
class RimEclipseResultDefinition;
|
|
class RimColorLegend;
|
|
class RimEnsembleWellLogCurveSet;
|
|
class RimWellLogPropertyAxisSettings;
|
|
class RimWellLogFormationSettings;
|
|
class RimWellLogRegionAnnotationSettings;
|
|
class RimWellLogWellPathAttributeSettings;
|
|
class RiuPlotAnnotationTool;
|
|
|
|
struct CurveSamplingPointData
|
|
{
|
|
std::vector<double> data;
|
|
std::vector<double> md;
|
|
std::vector<double> tvd;
|
|
|
|
double rkbDiff;
|
|
};
|
|
|
|
//==================================================================================================
|
|
///
|
|
///
|
|
//==================================================================================================
|
|
class RimWellLogTrack : public RimPlot
|
|
{
|
|
CAF_PDM_HEADER_INIT;
|
|
|
|
public:
|
|
using RegionAnnotationTypeEnum = caf::AppEnum<RiaDefines::RegionAnnotationType>;
|
|
using RegionAnnotationDisplayEnum = caf::AppEnum<RiaDefines::RegionDisplay>;
|
|
|
|
public:
|
|
RimWellLogTrack();
|
|
~RimWellLogTrack() override;
|
|
|
|
QWidget* viewWidget() override;
|
|
RiuQwtPlotWidget* viewer();
|
|
RiuPlotWidget* plotWidget() override;
|
|
QImage snapshotWindowContent() override;
|
|
void zoomAll() override;
|
|
|
|
QString description() const override;
|
|
void setDescription( const QString& description );
|
|
|
|
void addCurve( RimWellLogCurve* curve );
|
|
void insertCurve( RimWellLogCurve* curve, size_t index );
|
|
void removeCurve( RimWellLogCurve* curve );
|
|
void deleteAllCurves();
|
|
|
|
size_t curveIndex( RimWellLogCurve* curve );
|
|
size_t curveCount() { return m_curves.size(); }
|
|
|
|
void setPropertyValueAxisTitle( const QString& text );
|
|
QString depthAxisTitle() const;
|
|
|
|
void setFormationWellPath( RimWellPath* wellPath );
|
|
RimWellPath* formationWellPath() const;
|
|
void setFormationSimWellName( const QString& simWellName );
|
|
QString formationSimWellName() const;
|
|
void setFormationBranchDetection( bool branchDetection );
|
|
bool formationBranchDetection() const;
|
|
void setFormationBranchIndex( int branchIndex );
|
|
int formationBranchIndex() const;
|
|
void setFormationCase( RimCase* rimCase );
|
|
RimCase* formationCase() const;
|
|
void setFormationTrajectoryType( RiaDefines::WellLogTrackTrajectoryType trajectoryType );
|
|
RiaDefines::WellLogTrackTrajectoryType formationTrajectoryType() const;
|
|
void setRegionPropertyResultType( RiaDefines::ResultCatType resultCatType, const QString& resultVariable );
|
|
|
|
void detachAllCurves() override;
|
|
void reattachAllCurves() override;
|
|
|
|
void setAndUpdateWellPathFormationNamesData( RimCase* rimCase, RimWellPath* wellPath );
|
|
|
|
void setAndUpdateSimWellFormationNamesAndBranchData( RimCase* rimCase, const QString& simWellName, int branchIndex, bool useBranchDetection );
|
|
void setAndUpdateSimWellFormationNamesData( RimCase* rimCase, const QString& simWellName );
|
|
|
|
[[deprecated( "Use setAutoScalePropertyValuesEnabled() instead." )]] void setAutoScaleXEnabled( bool enabled ) override;
|
|
[[deprecated( "Use setAutoScaleDepthValuesEnabled() instead." )]] void setAutoScaleYEnabled( bool enabled ) override;
|
|
|
|
void setAutoScalePropertyValuesEnabled( bool enabled );
|
|
void setAutoScaleDepthValuesEnabled( bool enabled );
|
|
void setAutoScalePropertyValuesIfNecessary();
|
|
|
|
void availablePropertyValueRange( double* minX, double* maxX );
|
|
void availableDepthRange( double* minimumDepth, double* maximumDepth );
|
|
|
|
void visiblePropertyValueRange( double* minX, double* maxX );
|
|
void visibleDepthRange( double* minimumDepth, double* maximumDepth );
|
|
|
|
void setVisiblePropertyValueRange( double minValue, double maxValue );
|
|
void setVisibleDepthRange( double minValue, double maxValue );
|
|
|
|
void updatePlotWidgetFromAxisRanges() override;
|
|
void updateAxisRangesFromPlotWidget() override;
|
|
|
|
void updateParentPlotZoom();
|
|
|
|
void updateEditors();
|
|
|
|
void setTickIntervals( double majorTickInterval, double minorTickInterval );
|
|
void setMinAndMaxTicksOnly( bool enable );
|
|
void setPropertyValueAxisGridVisibility( RimWellLogPlot::AxisGridVisibility gridLines );
|
|
|
|
void setAnnotationType( RiaDefines::RegionAnnotationType annotationType );
|
|
void setAnnotationDisplay( RiaDefines::RegionDisplay annotationDisplay );
|
|
void setAnnotationTransparency( int percent );
|
|
void setColorShadingLegend( RimColorLegend* colorLegend );
|
|
|
|
RiaDefines::RegionAnnotationType annotationType() const;
|
|
RiaDefines::RegionDisplay annotationDisplay() const;
|
|
|
|
bool showFormations() const;
|
|
|
|
void setShowRegionLabels( bool on );
|
|
|
|
bool showWellPathAttributes() const;
|
|
void setShowWellPathAttributes( bool on );
|
|
void setShowWellPathAttributesInLegend( bool on );
|
|
void setShowWellPathCompletionsInLegend( bool on );
|
|
void setShowBothSidesOfWell( bool on );
|
|
void setWellPathAttributesSource( RimWellPath* wellPath );
|
|
|
|
void setOverburdenHeight( double overburdenHeight );
|
|
void setUnderburdenHeight( double underburdenHeight );
|
|
|
|
RimWellPath* wellPathAttributeSource() const;
|
|
|
|
void setLogarithmicScale( bool enable );
|
|
bool isLogarithmicScale() const;
|
|
|
|
std::map<int, std::vector<RimWellLogCurve*>> visibleStackedCurves();
|
|
|
|
std::vector<RimWellLogCurve*> curves() const;
|
|
std::vector<RimWellLogCurve*> visibleCurves() const;
|
|
|
|
void uiOrderingForRftPltFormations( caf::PdmUiOrdering& uiOrdering );
|
|
void uiOrderingForPropertyAxisSettings( caf::PdmUiOrdering& uiOrdering );
|
|
void enablePropertyAxis( bool enable );
|
|
bool isPropertyAxisEnabled() const;
|
|
|
|
void setFormationsForCaseWithSimWellOnly( bool caseWithSimWellOnly );
|
|
void updatePropertyValueAxisAndGridTickIntervals();
|
|
|
|
void updateLegend() override;
|
|
|
|
QString asciiDataForPlotExport() const override;
|
|
|
|
void onAxisSelected( RiuPlotAxis axis, bool toggle ) override;
|
|
void onChildDeleted( caf::PdmChildArrayFieldHandle* childArray, std::vector<caf::PdmObjectHandle*>& referringObjects ) override;
|
|
|
|
void updateAxes() override;
|
|
|
|
static CurveSamplingPointData curveSamplingPointData( RigEclipseWellLogExtractor* extractor, RigResultAccessor* resultAccessor );
|
|
static CurveSamplingPointData curveSamplingPointData( RigGeoMechWellLogExtractor* extractor, const RigFemResultAddress& resultAddress );
|
|
|
|
static void findRegionNamesToPlot( const CurveSamplingPointData& curveData,
|
|
const std::vector<QString>& formationNamesVector,
|
|
RimWellLogPlot::DepthTypeEnum depthType,
|
|
std::vector<QString>* formationNamesToPlot,
|
|
std::vector<std::pair<double, double>>* yValues );
|
|
|
|
static std::vector<QString> formationNamesVector( RimCase* rimCase );
|
|
void updateStackedCurveData();
|
|
|
|
static void addOverburden( std::vector<QString>& namesVector, CurveSamplingPointData& curveData, double height );
|
|
static void addUnderburden( std::vector<QString>& namesVector, CurveSamplingPointData& curveData, double height );
|
|
|
|
void setCurvesTreeVisibility( bool isVisible );
|
|
|
|
void setEnsembleWellLogCurveSet( RimEnsembleWellLogCurveSet* curveSet );
|
|
void updateAxesVisibility( RiaDefines::Orientation orientation, bool isFirstTrack, bool isLastTrack );
|
|
void updateDepthMarkerLine();
|
|
|
|
void setAutoCheckStateBasedOnCurveData( bool enable );
|
|
void updateCheckStateBasedOnCurveData();
|
|
|
|
protected:
|
|
// RimViewWindow overrides
|
|
void deleteViewWidget() override;
|
|
void onLoadDataAndUpdate() override;
|
|
void onChildrenUpdated( caf::PdmChildArrayFieldHandle* childArray, std::vector<caf::PdmObjectHandle*>& updatedObjects ) override;
|
|
|
|
private:
|
|
RiuPlotWidget* doCreatePlotViewWidget( QWidget* mainWindowParent = nullptr ) override;
|
|
|
|
void cleanupBeforeClose();
|
|
void detachAllPlotItems();
|
|
void calculatePropertyValueZoomRange();
|
|
void calculateDepthZoomRange();
|
|
|
|
void updatePropertyValueZoom();
|
|
void updateDepthZoom();
|
|
|
|
RiuPlotAxis depthAxis() const;
|
|
RiuPlotAxis valueAxis() const;
|
|
|
|
int axisFontSize() const;
|
|
|
|
void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
|
|
void curveDataChanged( const caf::SignalEmitter* emitter );
|
|
void curveVisibilityChanged( const caf::SignalEmitter* emitter, bool visible );
|
|
void curveAppearanceChanged( const caf::SignalEmitter* emitter );
|
|
void curveStackingChanged( const caf::SignalEmitter* emitter, bool stacked );
|
|
|
|
QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;
|
|
|
|
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
|
|
void initAfterRead() override;
|
|
|
|
caf::PdmFieldHandle* userDescriptionField() override;
|
|
|
|
void computeAndSetPropertyValueRangeMinForLogarithmicScale();
|
|
|
|
static void simWellOptionItems( QList<caf::PdmOptionItemInfo>* options, RimCase* eclCase );
|
|
|
|
static RigEclipseWellLogExtractor* createSimWellExtractor( RimWellLogPlotCollection* wellLogCollection,
|
|
RimCase* rimCase,
|
|
const QString& simWellName,
|
|
int branchIndex,
|
|
bool useBranchDetection );
|
|
|
|
void updateRegionAnnotationsOnPlot();
|
|
void updateFormationNamesOnPlot();
|
|
void updateResultPropertyNamesOnPlot();
|
|
void updateCurveDataRegionsOnPlot();
|
|
void updateWellPathAttributesOnPlot();
|
|
void removeRegionAnnotations();
|
|
void updateAxisScaleEngine();
|
|
|
|
std::pair<double, double> adjustXRange( double minValue, double maxValue, double tickInterval );
|
|
|
|
std::pair<double, double> extendMinMaxRange( double minValue, double maxValue, double factor );
|
|
|
|
void updateWellPathAttributesCollection();
|
|
|
|
RimDepthTrackPlot* parentWellLogPlot() const;
|
|
|
|
void handleWheelEvent( QWheelEvent* event ) override;
|
|
void doUpdateLayout() override;
|
|
|
|
std::vector<std::pair<double, double>> waterAndRockRegions( RiaDefines::DepthType depthType,
|
|
const RigGeoMechWellLogExtractor* extractor ) const;
|
|
|
|
void connectCurveSignals( RimWellLogCurve* curve );
|
|
bool isEmptyVisiblePropertyRange() const;
|
|
|
|
private:
|
|
caf::PdmField<QString> m_description;
|
|
caf::PdmChildArrayField<RimWellLogCurve*> m_curves;
|
|
|
|
// Property value axis settings
|
|
caf::PdmChildField<RimWellLogPropertyAxisSettings*> m_propertyAxisSettings;
|
|
|
|
// Formation settings
|
|
caf::PdmChildField<RimWellLogFormationSettings*> m_formationSettings;
|
|
|
|
// Region annotation settings
|
|
caf::PdmChildField<RimWellLogRegionAnnotationSettings*> m_regionAnnotationSettings;
|
|
|
|
// Well path attribute settings
|
|
caf::PdmChildField<RimWellLogWellPathAttributeSettings*> m_wellPathAttributeSettings;
|
|
|
|
// OBSOLETE: Property value axis fields (migrated to RimWellLogPropertyAxisSettings)
|
|
caf::PdmField<bool> m_isPropertyAxisEnabled_OBSOLETE;
|
|
caf::PdmField<double> m_visiblePropertyValueRangeMin_OBSOLETE;
|
|
caf::PdmField<double> m_visiblePropertyValueRangeMax_OBSOLETE;
|
|
caf::PdmField<bool> m_isAutoScalePropertyValuesEnabled_OBSOLETE;
|
|
caf::PdmField<bool> m_isPropertyLogarithmicScaleEnabled_OBSOLETE;
|
|
caf::PdmField<bool> m_invertPropertyValueAxis_OBSOLETE;
|
|
caf::PdmField<RimWellLogPlot::AxisGridEnum> m_propertyValueAxisGridVisibility_OBSOLETE;
|
|
caf::PdmField<bool> m_propertyAxisMinAndMaxTicksOnly_OBSOLETE;
|
|
caf::PdmField<bool> m_explicitTickIntervalsPropertyValueAxis_OBSOLETE;
|
|
caf::PdmField<double> m_majorTickIntervalPropertyAxis_OBSOLETE;
|
|
caf::PdmField<double> m_minorTickIntervalPropertyAxis_OBSOLETE;
|
|
|
|
// Depth axis
|
|
caf::PdmField<double> m_visibleDepthRangeMin;
|
|
caf::PdmField<double> m_visibleDepthRangeMax;
|
|
|
|
RimFontSizeField m_axisFontSize;
|
|
|
|
// OBSOLETE: Region annotation fields (migrated to RimWellLogRegionAnnotationSettings)
|
|
caf::PdmField<RegionAnnotationTypeEnum> m_regionAnnotationType_OBSOLETE;
|
|
caf::PdmField<RegionAnnotationDisplayEnum> m_regionAnnotationDisplay_OBSOLETE;
|
|
caf::PdmPtrField<RimColorLegend*> m_colorShadingLegend_OBSOLETE;
|
|
caf::PdmField<int> m_colorShadingTransparency_OBSOLETE;
|
|
caf::PdmField<bool> m_showRegionLabels_OBSOLETE;
|
|
RimFontSizeField m_regionLabelFontSize_OBSOLETE;
|
|
|
|
// OBSOLETE: Formation fields (migrated to RimWellLogFormationSettings)
|
|
caf::PdmField<caf::AppEnum<RiaDefines::WellLogTrackFormationSource>> m_formationSource_OBSOLETE;
|
|
caf::PdmPtrField<RimCase*> m_formationCase_OBSOLETE;
|
|
caf::PdmField<caf::AppEnum<RiaDefines::WellLogTrackTrajectoryType>> m_formationTrajectoryType_OBSOLETE;
|
|
caf::PdmPtrField<RimWellPath*> m_formationWellPathForSourceCase_OBSOLETE;
|
|
caf::PdmPtrField<RimWellPath*> m_formationWellPathForSourceWellPath_OBSOLETE;
|
|
caf::PdmField<QString> m_formationSimWellName_OBSOLETE;
|
|
caf::PdmField<int> m_formationBranchIndex_OBSOLETE;
|
|
caf::PdmField<caf::AppEnum<RiaDefines::WellLogTrackFormationLevel>> m_formationLevel_OBSOLETE;
|
|
caf::PdmField<bool> m_showformationFluids_OBSOLETE;
|
|
caf::PdmField<bool> m_formationBranchDetection_OBSOLETE;
|
|
|
|
// OBSOLETE: Well path attribute fields (migrated to RimWellLogWellPathAttributeSettings)
|
|
caf::PdmField<bool> m_showWellPathAttributes_OBSOLETE;
|
|
caf::PdmField<bool> m_showWellPathCompletions_OBSOLETE;
|
|
caf::PdmField<bool> m_showWellPathComponentsBothSides_OBSOLETE;
|
|
caf::PdmField<bool> m_showWellPathComponentLabels_OBSOLETE;
|
|
caf::PdmField<bool> m_wellPathAttributesInLegend_OBSOLETE;
|
|
caf::PdmField<bool> m_wellPathCompletionsInLegend_OBSOLETE;
|
|
caf::PdmPtrField<RimWellPath*> m_wellPathComponentSource_OBSOLETE;
|
|
caf::PdmPtrField<RimWellPathAttributeCollection*> m_wellPathAttributeCollection_OBSOLETE;
|
|
caf::PdmField<double> m_overburdenHeight_OBSOLETE;
|
|
caf::PdmField<double> m_underburdenHeight_OBSOLETE;
|
|
|
|
caf::PdmChildField<RimEclipseResultDefinition*> m_resultDefinition;
|
|
caf::PdmChildField<RimEnsembleWellLogCurveSet*> m_ensembleWellLogCurveSet;
|
|
|
|
caf::PdmField<bool> m_autoCheckStateBasedOnCurveData;
|
|
|
|
std::vector<std::unique_ptr<RiuWellPathComponentPlotItem>> m_wellPathAttributePlotObjects;
|
|
|
|
bool m_formationsForCaseWithSimWellOnly;
|
|
|
|
QPointer<RiuWellLogTrack> m_plotWidget;
|
|
std::unique_ptr<RiuPlotAnnotationTool> m_annotationTool;
|
|
|
|
QString m_propertyValueAxisTitle;
|
|
double m_availablePropertyValueRangeMin;
|
|
double m_availablePropertyValueRangeMax;
|
|
double m_availableDepthRangeMin;
|
|
double m_availableDepthRangeMax;
|
|
};
|