ResInsight/ApplicationLibCode/ProjectDataModel/RimSimWellInViewCollection.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2011-     Statoil ASA
//  Copyright (C) 2013-     Ceetron Solutions AS
//  Copyright (C) 2011-2012 Ceetron 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 "cafAppEnum.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmFieldCvfColor.h" // Include to make Pdm work for cvf::Color
#include "cafPdmObject.h"
#include "cafPdmPtrField.h"
#include "cafTristate.h"

class RimEclipseView;
class RimSimWellInView;
class RimWellDiskConfig;
class RimSummaryCase;

//==================================================================================================
///
///
//==================================================================================================
class RimSimWellInViewCollection : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    RimSimWellInViewCollection();

    void setReservoirView( RimEclipseView* ownerReservoirView );

    enum WellVisibilityType
    {
        PIPES_FORCE_ALL_OFF,
        PIPES_INDIVIDUALLY,
        PIPES_OPEN_IN_VISIBLE_CELLS,
        PIPES_FORCE_ALL_ON
    };
    using WellVisibilityEnum = caf::AppEnum<RimSimWellInViewCollection::WellVisibilityType>;

    enum WellCellsRangeFilterType
    {
        RANGE_ADD_ALL,
        RANGE_ADD_INDIVIDUAL,
        RANGE_ADD_NONE
    };
    using WellCellsRangeFilterEnum = caf::AppEnum<RimSimWellInViewCollection::WellCellsRangeFilterType>;

    enum WellFenceType
    {
        K_DIRECTION,
        J_DIRECTION,
        I_DIRECTION
    };
    using WellFenceEnum = caf::AppEnum<RimSimWellInViewCollection::WellFenceType>;

    enum WellHeadPositionType
    {
        WELLHEAD_POS_ACTIVE_CELLS_BB,
        WELLHEAD_POS_TOP_COLUMN
    };
    using WellHeadPositionEnum = caf::AppEnum<RimSimWellInViewCollection::WellHeadPositionType>;

    enum WellPipeCoordType
    {
        WELLPIPE_CELLCENTER,
        WELLPIPE_INTERPOLATED
    };

    using WellPipeCoordEnum = caf::AppEnum<RimSimWellInViewCollection::WellPipeCoordType>;

    enum WellPipeColors
    {
        WELLPIPE_COLOR_UNIQUE,
        WELLPIPE_COLOR_UNIFORM
    };

    enum WellDiskPropertyType
    {
        PROPERTY_TYPE_PREDEFINED,
        PROPERTY_TYPE_SINGLE
    };

    enum WellDiskPropertyConfigType
    {
        PRODUCTION_RATES,
        INJECTION_RATES,
        CUMULATIVE_PRODUCTION_RATES,
        CUMULATIVE_INJECTION_RATES,
        PRODUCTION_INJECTION_RATES,
        CUMULATIVE_PRODUCTION_INJECTION_RATES
    };

    using WellPipeColorsEnum = caf::AppEnum<RimSimWellInViewCollection::WellPipeColors>;

    caf::PdmField<bool> isActive;
    caf::PdmField<bool> showWellsIntersectingVisibleCells;

    caf::PdmField<double> wellHeadScaleFactor;
    caf::PdmField<double> wellHeadPositionScaleFactor;
    caf::PdmField<double> pipeScaleFactor;
    caf::PdmField<double> spheresScaleFactor;

    caf::PdmField<cvf::Color3f> wellLabelColor;
    caf::PdmField<bool>         showConnectionStatusColors;

    void setShowWellCellsState( bool enable );
    bool showWellCells();

    bool showWellCommunicationLines() { return m_showWellCommunicationLines(); }
    bool showOnlyActiveWells() const { return m_showOnlyActiveWells(); }

    caf::PdmField<WellFenceEnum> wellCellFenceType;
    caf::PdmField<double>        wellCellTransparencyLevel;

    caf::PdmField<int>               pipeCrossSectionVertexCount;
    caf::PdmField<WellPipeCoordEnum> wellPipeCoordType;

    caf::PdmField<WellHeadPositionEnum> wellHeadPosition;

    caf::PdmField<bool> isAutoDetectingBranches;

    QString wellDiskPropertyUiText() const;
    bool    isWellDisksVisible() const;
    bool    showWellDiskLabelBackground() const;
    bool    showWellDiskQuantityLables() const;

    caf::PdmChildArrayField<RimSimWellInView*> wells;

    RimSimWellInView* findWell( QString name );
    bool              hasVisibleWellCells();
    bool              hasVisibleWellPipes();
    void              sortWellsByName();

    const std::vector<cvf::ubyte>& resultWellGeometryVisibilities( size_t frameIndex );
    void                           scheduleIsWellPipesVisibleRecalculation();
    void                           updateStateForVisibilityCheckboxes();

    void assignDefaultWellColors();

    static void updateWellAllocationPlots();

    void   setDefaultSourceCaseForWellDisks();
    void   scaleWellDisks();
    double wellDiskScaleFactor() const;

    bool showValves() const;

    caf::PdmField<cvf::Color3f> wellDiskColor;

protected:
    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;

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

    QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions ) override;

    void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName = "" ) override;

    caf::PdmFieldHandle* objectToggleField() override;

private:
    void              calculateWellGeometryVisibility( size_t frameIndex );
    void              updateStateFromEnabledChildCount( size_t showLabelCount, caf::PdmField<caf::Tristate>* fieldToUpdate );
    void              scaleWellDisksFromConfig( const RimWellDiskConfig& wellDiskConfig );
    RimWellDiskConfig getActiveWellDiskConfig() const;

private:
    RimEclipseView*                      m_reservoirView;
    std::vector<std::vector<cvf::ubyte>> m_framesOfResultWellPipeVisibilities;

    // Fields
    caf::PdmField<cvf::Color3f>       m_defaultWellPipeColor;
    caf::PdmField<WellPipeColorsEnum> m_wellPipeColors;

    caf::PdmField<caf::Tristate> m_showWellLabel;
    caf::PdmField<caf::Tristate> m_showWellHead;
    caf::PdmField<caf::Tristate> m_showWellPipe;
    caf::PdmField<caf::Tristate> m_showWellSpheres;
    caf::PdmField<caf::Tristate> m_showWellDisks;
    caf::PdmField<caf::Tristate> m_showWellCells;
    caf::PdmField<caf::Tristate> m_showWellCellFence;

    caf::PdmField<bool> m_showWellValves;
    caf::PdmField<bool> m_showWellCommunicationLines;
    caf::PdmField<bool> m_showOnlyActiveWells;

    // Well Discs
    caf::PdmField<caf::AppEnum<WellDiskPropertyType>>       m_wellDiskPropertyType;
    caf::PdmField<caf::AppEnum<WellDiskPropertyConfigType>> m_wellDiskPropertyConfigType;
    caf::PdmPtrField<RimSummaryCase*>                       m_wellDiskSummaryCase;
    caf::PdmField<QString>                                  m_wellDiskQuantity;
    caf::PdmField<bool>                                     m_wellDiskShowQuantityLabels;
    caf::PdmField<bool>                                     m_wellDiskshowLabelsBackground;
    caf::PdmField<double>                                   m_wellDiskScaleFactor;
};