ResInsight/ApplicationCode/ProjectDataModel/Flow/RimWellAllocationPlot.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017     Statoil 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 "RimViewWindow.h"

#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmPtrField.h"

#include <QPointer>

class RimEclipseResultCase;
class RimEclipseWell;
class RimFlowDiagSolution;
class RimTotalWellAllocationPlot;
class RimWellAllocationPlotLegend;
class RimWellLogPlot;
class RiuWellAllocationPlot;
class RimWellLogTrack;
class RimTofAccumulatedPhaseFractionsPlot;
class RigSingleWellResultsData;

namespace cvf {
    class Color3f;
}

namespace caf {
    class PdmOptionItemInfo;
}


//==================================================================================================
///  
///  
//==================================================================================================
class RimWellAllocationPlot : public RimViewWindow
{
    CAF_PDM_HEADER_INIT;
public:
    enum FlowType { ACCUMULATED, INFLOW};

public:
    RimWellAllocationPlot();
    virtual ~RimWellAllocationPlot();

    void                                            setFromSimulationWell(RimEclipseWell* simWell);

    void                                            setDescription(const QString& description);
    QString                                         description() const;

    virtual void                                    loadDataAndUpdate() override;

    virtual QWidget*                                viewWidget() override;
    virtual void                                    zoomAll() override;

    RimWellLogPlot*                                 accumulatedWellFlowPlot();
    RimTotalWellAllocationPlot*                     totalWellFlowPlot();
    RimTofAccumulatedPhaseFractionsPlot*            tofAccumulatedPhaseFractionsPlot();
    caf::PdmObject*                                 plotLegend();
    RimEclipseResultCase*                           rimCase();
    int                                             timeStep();

    QString                                         wellName() const;

    void                                            removeFromMdiAreaAndDeleteViewWidget();

    void                                            showPlotLegend(bool doShow);
protected:
    // Overridden PDM methods
    virtual caf::PdmFieldHandle*                    userDescriptionField() { return &m_userName; }
    virtual void                                    fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue) override;

    std::set<QString>                               findSortedWellNames();

    virtual QList<caf::PdmOptionItemInfo>           calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions, bool * useOptionsOnly) override;

    virtual QImage                                  snapshotWindowContent() override;


    virtual void                                    defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) override;

private:
    void                                            updateFromWell();

    std::map<QString, const std::vector<double> *>  findRelevantTracerCellFractions(const RigSingleWellResultsData* wellResults);

    void                                            updateWellFlowPlotXAxisTitle(RimWellLogTrack* plotTrack);

    void                                            addStackedCurve(const QString& tracerName, 
                                                                    const std::vector<double>& depthValues, 
                                                                    const std::vector<double>& accFlow, 
                                                                    RimWellLogTrack* plotTrack);
    
    void                                            updateWidgetTitleWindowTitle();
    static QString                                  wellStatusTextForTimeStep(const QString& wellName, const RimEclipseResultCase* eclipseResultCase, size_t timeStep);

    // RimViewWindow overrides

    virtual QWidget*                                createViewWidget(QWidget* mainWindowParent) override; 
    virtual void                                    deleteViewWidget() override; 

    cvf::Color3f                                    getTracerColor(const QString& tracerName);

private:
    caf::PdmField<bool>                             m_showPlotTitle;
    caf::PdmField<QString>                          m_userName;

    caf::PdmPtrField<RimEclipseResultCase*>         m_case;
    caf::PdmField<QString>                          m_wellName;
    caf::PdmField<int>                              m_timeStep;
    caf::PdmPtrField<RimFlowDiagSolution*>          m_flowDiagSolution;
    caf::PdmField<bool>                             m_groupSmallContributions;
    caf::PdmField<double>                           m_smallContributionsThreshold;
    caf::PdmField<caf::AppEnum<FlowType> >          m_flowType;

    QPointer<RiuWellAllocationPlot>                 m_wellAllocationPlotWidget;

    caf::PdmChildField<RimWellLogPlot*>             m_accumulatedWellFlowPlot;
    caf::PdmChildField<RimTotalWellAllocationPlot*> m_totalWellAllocationPlot;
    caf::PdmChildField<RimWellAllocationPlotLegend*> m_wellAllocationPlotLegend;
    caf::PdmChildField<RimTofAccumulatedPhaseFractionsPlot*> m_tofAccumulatedPhaseFractionsPlot;
};