ResInsight/ApplicationLibCode/ProjectDataModel/AnalysisPlots/RimAnalysisPlotCollection.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 "RimAnalysisPlotCollection.h"

#include "RimAnalysisPlot.h"
#include "RimPlotDataFilterCollection.h"
#include "RimProject.h"
#include "RimSummaryCase.h"

CAF_PDM_SOURCE_INIT( RimAnalysisPlotCollection, "AnalysisPlotCollection" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimAnalysisPlotCollection::RimAnalysisPlotCollection()
{
    CAF_PDM_InitObject( "Analysis Plots", ":/AnalysisPlots16x16.png", "", "" );

    CAF_PDM_InitFieldNoDefault( &m_analysisPlots, "AnalysisPlots", "Analysis Plots", "", "", "" );
    m_analysisPlots.uiCapability()->setUiHidden( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimAnalysisPlotCollection::~RimAnalysisPlotCollection()
{
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimAnalysisPlot* RimAnalysisPlotCollection::createAnalysisPlot()
{
    RimAnalysisPlot* plot = new RimAnalysisPlot();
    plot->setAsPlotMdiWindow();

    if ( firstEnsemble() )
    {
        applyFirstEnsembleFieldAddressesToPlot( plot, "FOPT" );
    }
    else if ( firstSummaryCaseCollection() )
    {
        applyFirstSummaryCaseCollectionAndFieldAddressesToPlot( plot, "FOPT" );
    }
    else
    {
        applyAllSummaryCasesAndFieldAddressesToPlot( plot, "FOPT" );
    }

    // plot->enableAutoPlotTitle( true );
    addPlot( plot );

    plot->loadDataAndUpdate();

    auto filter = plot->plotDataFilterCollection()->addFilter();
    filter->updateMaxMinAndDefaultValues( true );

    plot->loadDataAndUpdate();
    plot->updateConnectedEditors();

    return plot;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimAnalysisPlot* RimAnalysisPlotCollection::createAnalysisPlot( RimSummaryCaseCollection* ensemble,
                                                                const QString&            quantityName,
                                                                std::time_t               timeStep )
{
    RimAnalysisPlot* plot = new RimAnalysisPlot();
    plot->setAsPlotMdiWindow();

    applySummaryCaseCollectionAndFieldAddressToPlot( plot, ensemble, quantityName.toStdString() );
    plot->setTimeSteps( { timeStep } );

    // plot->enableAutoPlotTitle( true );
    addPlot( plot );

    plot->loadDataAndUpdate();

    auto filter = plot->plotDataFilterCollection()->addFilter();
    filter->updateMaxMinAndDefaultValues( true );

    plot->loadDataAndUpdate();
    plot->updateConnectedEditors();

    return plot;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::updateSummaryNameHasChanged()
{
    for ( RimAnalysisPlot* plot : m_analysisPlots )
    {
        plot->updateCaseNameHasChanged();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<RimAnalysisPlot*> RimAnalysisPlotCollection::plots() const
{
    return m_analysisPlots.childObjects();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
size_t RimAnalysisPlotCollection::plotCount() const
{
    return m_analysisPlots.size();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::applyFirstEnsembleFieldAddressesToPlot( RimAnalysisPlot*   plot,
                                                                        const std::string& quantityName )
{
    auto ensemble = firstSummaryCaseCollection();
    if ( ensemble )
    {
        applySummaryCaseCollectionAndFieldAddressToPlot( plot, ensemble, quantityName );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::applyFirstSummaryCaseCollectionAndFieldAddressesToPlot( RimAnalysisPlot* plot,
                                                                                        const std::string& quantityName /*= "" */ )
{
    auto summaryCaseCollection = firstSummaryCaseCollection();
    if ( summaryCaseCollection )
    {
        applySummaryCaseCollectionAndFieldAddressToPlot( plot, summaryCaseCollection, quantityName );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::applyAllSummaryCasesAndFieldAddressesToPlot( RimAnalysisPlot*   plot,
                                                                             const std::string& quantityName /*= "" */ )
{
    std::vector<RimSummaryCase*> allSummaryCases;
    RimProject::current()->descendantsOfType( allSummaryCases );

    if ( !allSummaryCases.empty() )
    {
        std::vector<RiaSummaryCurveDefinition> curveDefs;

        for ( auto summaryCase : allSummaryCases )
        {
            curveDefs.push_back(
                RiaSummaryCurveDefinition( summaryCase, RifEclipseSummaryAddress::fieldAddress( quantityName ), false ) );
        }

        plot->setCurveDefinitions( curveDefs );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::applySummaryCaseCollectionAndFieldAddressToPlot( RimAnalysisPlot*          plot,
                                                                                 RimSummaryCaseCollection* summaryCaseCollection,
                                                                                 const std::string& quantityName )
{
    if ( summaryCaseCollection )
    {
        std::set<RifEclipseSummaryAddress>     allAddresses = summaryCaseCollection->ensembleSummaryAddresses();
        std::vector<RiaSummaryCurveDefinition> curveDefs;
        if ( allAddresses.empty() )
        {
            for ( auto summaryCase : summaryCaseCollection->allSummaryCases() )
            {
                curveDefs.push_back( RiaSummaryCurveDefinition( summaryCase,
                                                                RifEclipseSummaryAddress::fieldAddress( quantityName ),
                                                                false ) );
            }
        }
        else
        {
            for ( auto address : allAddresses )
            {
                if ( address.category() == RifEclipseSummaryAddress::SUMMARY_FIELD )
                {
                    if ( quantityName.empty() || quantityName == address.quantityName() )
                    {
                        for ( auto summaryCase : summaryCaseCollection->allSummaryCases() )
                        {
                            curveDefs.push_back( RiaSummaryCurveDefinition( summaryCase, address, false ) );
                        }
                    }
                }
            }
        }
        plot->setCurveDefinitions( curveDefs );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimSummaryCaseCollection* RimAnalysisPlotCollection::firstEnsemble() const
{
    std::vector<RimSummaryCaseCollection*> allSummaryCaseCollections;
    RimProject::current()->descendantsOfType( allSummaryCaseCollections );
    for ( auto summaryCaseCollection : allSummaryCaseCollections )
    {
        if ( summaryCaseCollection->isEnsemble() ) return summaryCaseCollection;
    }
    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimSummaryCaseCollection* RimAnalysisPlotCollection::firstSummaryCaseCollection() const
{
    std::vector<RimSummaryCaseCollection*> allSummaryCaseCollections;
    RimProject::current()->descendantsOfType( allSummaryCaseCollections );

    if ( !allSummaryCaseCollections.empty() ) return allSummaryCaseCollections.front();

    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::insertPlot( RimAnalysisPlot* analysisPlot, size_t index )
{
    m_analysisPlots.insert( index, analysisPlot );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimAnalysisPlotCollection::removePlot( RimAnalysisPlot* analysisPlot )
{
    m_analysisPlots.removeChildObject( analysisPlot );
    updateAllRequiredEditors();
}