ResInsight/ApplicationCode/ProjectDataModel/RimEclipseStatisticsCaseEvaluator.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 "RiaDefines.h"
#include "RimEclipseStatisticsCase.h"

#include <vector>
#include <cmath>


class RimEclipseCase;
class RigEclipseCaseData;
class RigCaseCellResultsData;


class RimStatisticsConfig
{
public:
    RimStatisticsConfig()
        : m_calculatePercentiles(true),
        m_pMinPos(10.0),
        m_pMidPos(50.0),
        m_pMaxPos(90.0),
        m_pValMethod(RimEclipseStatisticsCase::INTERPOLATED_OBSERVATION)
    {
    }

public:
    bool    m_calculatePercentiles;
    double  m_pMinPos;
    double  m_pMidPos;
    double  m_pMaxPos;
    RimEclipseStatisticsCase::PercentileCalcType m_pValMethod;
};


class RimEclipseStatisticsCaseEvaluator
{
public:
    RimEclipseStatisticsCaseEvaluator(const std::vector<RimEclipseCase*>& sourceCases,
                               const std::vector<size_t>& timeStepIndices,
                               const RimStatisticsConfig& statisticsConfig,
                               RigEclipseCaseData* destinationCase,
                               RimIdenticalGridCaseGroup* identicalGridCaseGroup);

    struct ResSpec 
    {
        ResSpec() : m_resType(RiaDefines::DYNAMIC_NATIVE), m_poroModel(RiaDefines::MATRIX_MODEL) {}
        ResSpec( RiaDefines::PorosityModelType poroModel,
                 RiaDefines::ResultCatType                   resType,
                 QString                                     resVarName) : m_poroModel(poroModel), m_resType(resType), m_resVarName(resVarName) {}

        RiaDefines::PorosityModelType m_poroModel;
        RiaDefines::ResultCatType                   m_resType;
        QString                                     m_resVarName;
    };

    void useZeroAsValueForInActiveCellsBasedOnUnionOfActiveCells();

    void evaluateForResults(const QList<ResSpec >& resultSpecification);

private:
    void addNamedResult(RigCaseCellResultsData* cellResults, RiaDefines::ResultCatType resultType, const QString& resultName, size_t activeCellCount);
    void buildSourceMetaData(RiaDefines::PorosityModelType poroModel, RiaDefines::ResultCatType resultType, const QString& resultName);

    enum StatisticsParamType { MIN, MAX, SUM, RANGE, MEAN, STDEV, PMIN, PMID, PMAX, STAT_PARAM_COUNT };

private:
    std::vector<RimEclipseCase*>  m_sourceCases;
    std::vector<size_t>    m_timeStepIndices;

    size_t                 m_reservoirCellCount;
    RimStatisticsConfig    m_statisticsConfig;
    RigEclipseCaseData*           m_destinationCase;
    RimIdenticalGridCaseGroup* m_identicalGridCaseGroup;
    bool                    m_useZeroAsInactiveCellValue;
};