ResInsight/ApplicationLibCode/ProjectDataModel/RimIdenticalGridCaseGroup.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 "RiaPorosityModel.h"
#include "RimReservoirGridEnsembleBase.h"

#include "cafPdmChildField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"

#include "cvfObject.h"

class RigActiveCellInfo;
class RigMainGrid;

class RimCaseCollection;
class RimEclipseCase;
class RimEclipseStatisticsCase;

//==================================================================================================
//
//
//
//==================================================================================================
class RimIdenticalGridCaseGroup : public caf::PdmObject, public RimReservoirGridEnsembleBase
{
    CAF_PDM_HEADER_INIT;

public:
    RimIdenticalGridCaseGroup();
    ~RimIdenticalGridCaseGroup() override;

    caf::PdmField<QString>                 name;
    caf::PdmField<int>                     groupId;
    caf::PdmChildField<RimCaseCollection*> caseCollection;

    void addCase( RimEclipseCase* reservoir ) override;
    void removeCase( RimEclipseCase* reservoir ) override;

    bool contains( RimEclipseCase* reservoir ) const;

    RimEclipseStatisticsCase* createAndAppendEmptyStatisticsCase();

    RimEclipseCase*    mainCase() override;
    RimCaseCollection* statisticsCaseCollection() const override;
    void               loadMainCaseAndActiveCellInfo();

    RigMainGrid* mainGrid() override;

    std::vector<RimEclipseCase*> sourceCases() const override;

    RigActiveCellInfo* unionOfActiveCells( RiaDefines::PorosityModelType porosityType ) override;
    void               computeUnionOfActiveCells() override;

    GridModeType gridMode() const override;
    QString      ensembleName() const override;

    static bool isStatisticsCaseCollection( RimCaseCollection* rimCaseCollection );

protected:
    caf::PdmFieldHandle* userDescriptionField() override;

private:
    void updateMainGridAndActiveCellsForStatisticsCases();
    void clearStatisticsResults();
    void clearActiveCellUnions();

private:
    caf::PdmChildField<RimCaseCollection*> m_statisticsCaseCollection;

    RigMainGrid* m_mainGrid;

    cvf::ref<RigActiveCellInfo> m_unionOfMatrixActiveCells;
    cvf::ref<RigActiveCellInfo> m_unionOfFractureActiveCells;
};