Streamlines: New generator and UI usability improvements (#7424)

Co-authored-by: jonjenssen <jonjenssen@users.noreply.github.com> Co-authored-by: Magne Sjaastad <magne.sjaastad@ceetronsolutions.com>
2025-02-25 18:55:39 -06:00 · 2021-02-25 16:38:56 +01:00
parent f7a5f18e7f
commit 9bd0a9ebac
34 changed files with 3338 additions and 34 deletions
--- a/ApplicationLibCode/ProjectDataModel/Streamlines/RimStreamlineInViewCollection.h
+++ b/ApplicationLibCode/ProjectDataModel/Streamlines/RimStreamlineInViewCollection.h
@@ -0,0 +1,138 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  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.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "RiaDefines.h"
+
+#include "cafPdmChildArrayField.h"
+#include "cafPdmChildField.h"
+#include "cafPdmField.h"
+#include "cafPdmObject.h"
+
+#include <list>
+#include <set>
+#include <vector>
+
+class RimStreamline;
+class RimEclipseCase;
+class RimRegularLegendConfig;
+
+class RigTracer;
+class RigCell;
+
+class RiuViewer;
+
+class RimStreamlineInViewCollection : public caf::PdmObject
+{
+    CAF_PDM_HEADER_INIT;
+
+public:
+    enum class VisualizationMode
+    {
+        ANIMATION = 0,
+        MANUAL,
+        VECTORS
+    };
+    using VisualizationModeEnum = caf::AppEnum<VisualizationMode>;
+
+    enum class StreamlinePhaseType
+    {
+        OIL,
+        GAS,
+        WATER,
+        COMBINED
+    };
+    using StreamlinePhaseTypeEnum = caf::AppEnum<StreamlinePhaseType>;
+
+public:
+    RimStreamlineInViewCollection();
+    ~RimStreamlineInViewCollection() override;
+
+    void            setEclipseCase( RimEclipseCase* reservoir );
+    RimEclipseCase* eclipseCase() const;
+
+    std::list<RiaDefines::PhaseType> phases() const;
+
+    VisualizationMode visualizationMode() const;
+    size_t            animationSpeed() const;
+    size_t            animationIndex() const;
+    double            scaleFactor() const;
+    size_t            tracerLength() const;
+    size_t            injectionDeltaTime() const;
+
+    bool isActive() const;
+
+    void refresh();
+
+    const std::list<RigTracer>& tracers();
+
+    const RimRegularLegendConfig* legendConfig() const;
+    void                          mappingRange( double& min, double& max ) const;
+    void updateLegendRangesTextAndVisibility( RiuViewer* nativeOrOverrideViewer, bool isUsingOverrideViewer );
+    void updateFromCurrentTimeStep( int timeStep );
+
+protected:
+    caf::PdmFieldHandle* objectToggleField() override;
+    void                 updateStreamlines();
+    void                 initAfterRead() override;
+
+private:
+    void findStartCells( int                                       timeIdx,
+                         std::vector<std::pair<QString, RigCell>>& outInjectorCells,
+                         std::vector<std::pair<QString, RigCell>>& outProducerCells );
+
+    void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
+    void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;
+    void defineEditorAttribute( const caf::PdmFieldHandle* field,
+                                QString                    uiConfigName,
+                                caf::PdmUiEditorAttribute* attribute ) override;
+    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
+
+    void outputSummary() const;
+
+private:
+    caf::PdmField<bool>                     m_isActive;
+    caf::PdmField<QString>                  m_collectionName;
+    caf::PdmField<double>                   m_lengthThreshold;
+    caf::PdmField<double>                   m_flowThreshold;
+    caf::PdmField<double>                   m_resolution;
+    caf::PdmField<double>                   m_maxDays;
+    caf::PdmField<bool>                     m_useProducers;
+    caf::PdmField<bool>                     m_useInjectors;
+    caf::PdmPointer<RimEclipseCase>         m_eclipseCase;
+    caf::PdmChildArrayField<RimStreamline*> m_streamlines;
+    caf::PdmField<StreamlinePhaseTypeEnum>  m_phases;
+    caf::PdmField<VisualizationModeEnum>    m_visualizationMode;
+    caf::PdmField<size_t>                   m_animationSpeed;
+    caf::PdmField<size_t>                   m_animationIndex;
+    caf::PdmField<double>                   m_scaleFactor;
+    caf::PdmField<size_t>                   m_tracerLength;
+    caf::PdmField<size_t>                   m_injectionDeltaTime;
+
+    size_t m_maxAnimationIndex;
+
+    bool m_shouldGenerateTracers;
+    int  m_currentTimestep;
+
+    std::list<RigTracer> m_activeTracers;
+
+    std::set<size_t> m_wellCellIds;
+
+    caf::PdmChildField<RimRegularLegendConfig*> m_legendConfig;
+};