///////////////////////////////////////////////////////////////////////////////// // // Copyright (C) 2011-2012 Statoil ASA, 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 // for more details. // ///////////////////////////////////////////////////////////////////////////////// #include "RiaStdInclude.h" #include "RimStatisticsCase.h" #include "RimReservoirView.h" #include "cafPdmUiOrdering.h" #include "RimIdenticalGridCaseGroup.h" #include "RigCaseData.h" #include "RigCaseCellResultsData.h" #include "RimStatisticsCaseEvaluator.h" #include "RigMainGrid.h" #include "cafPdmUiTextEditor.h" #include "cafPdmUiLineEditor.h" #include "cafPdmUiPushButtonEditor.h" namespace caf { template<> void caf::AppEnum::setUp() { addItem(RimStatisticsCase::NEAREST_OBSERVATION, "NearestObservationPercentile", "Nearest Observation"); addItem(RimStatisticsCase::HISTOGRAM_ESTIMATED, "HistogramEstimatedPercentile", "Histogram based estimate"); setDefault(RimStatisticsCase::NEAREST_OBSERVATION); } } namespace caf { template<> void caf::AppEnum::setUp() { addItem(RimStatisticsCase::CALCULATED, "CALCULATED", "OK"); addItem(RimStatisticsCase::NOT_CALCULATED, "NOT_CALCULATED", "Needs Calculation"); setDefault(RimStatisticsCase::NOT_CALCULATED); } } CAF_PDM_SOURCE_INIT(RimStatisticsCase, "RimStatisticalCalculation"); //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- RimStatisticsCase::RimStatisticsCase() : RimCase() { CAF_PDM_InitObject("Case Group Statistics", ":/Histogram16x16.png", "", ""); CAF_PDM_InitFieldNoDefault(&m_calculationStatus, "CalcStatus", "Status", "", "", ""); m_calculationStatus.setIOWritable(false); m_calculationStatus.setIOReadable(false); m_calculationStatus.setUiReadOnly(true); m_calculationStatus.setUiEditorTypeName(caf::PdmUiLineEditor::uiEditorTypeName()); CAF_PDM_InitFieldNoDefault(&m_editingAllowed, "m_editingAllowed", "Editing Locked", "", "", ""); m_editingAllowed.setIOWritable(false); m_editingAllowed.setIOReadable(false); m_editingAllowed.setUiEditorTypeName(caf::PdmUiPushButtonEditor::uiEditorTypeName()); m_editingAllowed = "UNLOCK"; CAF_PDM_InitField(&m_selectionSummary, "SelectionSummary", QString(""), "Selected Properties", "", "", ""); m_selectionSummary.setIOWritable(false); m_selectionSummary.setIOReadable(false); m_selectionSummary.setUiReadOnly(true); m_selectionSummary.setUiEditorTypeName(caf::PdmUiTextEditor::uiEditorTypeName()); m_selectionSummary.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); CAF_PDM_InitFieldNoDefault(&m_resultType, "ResultType", "Result Type", "", "", ""); m_resultType.setIOWritable(false); CAF_PDM_InitFieldNoDefault(&m_porosityModel, "PorosityModel", "Porosity Model", "", "", ""); m_porosityModel.setIOWritable(false); CAF_PDM_InitFieldNoDefault(&m_selectedDynamicProperties, "DynamicPropertiesToCalculate", "Dyn Prop", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedStaticProperties, "StaticPropertiesToCalculate", "Stat Prop", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedGeneratedProperties, "GeneratedPropertiesToCalculate", "", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedInputProperties, "InputPropertiesToCalculate", "", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedFractureDynamicProperties, "FractureDynamicPropertiesToCalculate", "", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedFractureStaticProperties, "FractureStaticPropertiesToCalculate", "", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedFractureGeneratedProperties, "FractureGeneratedPropertiesToCalculate", "", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_selectedFractureInputProperties, "FractureInputPropertiesToCalculate", "", "", "", ""); m_selectedDynamicProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedStaticProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedGeneratedProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedInputProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedFractureDynamicProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedFractureStaticProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedFractureGeneratedProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); m_selectedFractureInputProperties.setUiLabelPosition(caf::PdmUiItemInfo::HIDDEN); CAF_PDM_InitField(&m_calculatePercentiles, "CalculatePercentiles", true, "Calculate Percentiles", "", "", ""); CAF_PDM_InitFieldNoDefault(&m_percentileCalculationType, "PercentileCalculationType", "Method", "", "", ""); CAF_PDM_InitField(&m_lowPercentile, "LowPercentile", 10.0, "Low", "", "", ""); CAF_PDM_InitField(&m_midPercentile, "MidPercentile", 50.0, "Mid", "", "", ""); CAF_PDM_InitField(&m_highPercentile, "HighPercentile", 90.0, "High", "", "", ""); updateSelectionListVisibilities(); updateSelectionSummaryLabel(); updatePercentileUiVisibility(); } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- RimStatisticsCase::~RimStatisticsCase() { } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::setMainGrid(RigMainGrid* mainGrid) { CVF_ASSERT(mainGrid); CVF_ASSERT(this->reservoirData()); reservoirData()->setMainGrid(mainGrid); } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- bool RimStatisticsCase::openEclipseGridFile() { if (this->reservoirData()) return true; cvf::ref eclipseCase = new RigCaseData; CVF_ASSERT(parentStatisticsCaseCollection()); RimIdenticalGridCaseGroup* gridCaseGroup = parentStatisticsCaseCollection()->parentCaseGroup(); CVF_ASSERT(gridCaseGroup); RigMainGrid* mainGrid = gridCaseGroup->mainGrid(); eclipseCase->setMainGrid(mainGrid); eclipseCase->setActiveCellInfo(RifReaderInterface::MATRIX_RESULTS, gridCaseGroup->unionOfActiveCells(RifReaderInterface::MATRIX_RESULTS)); eclipseCase->setActiveCellInfo(RifReaderInterface::FRACTURE_RESULTS, gridCaseGroup->unionOfActiveCells(RifReaderInterface::FRACTURE_RESULTS)); this->setReservoirData( eclipseCase.p() ); return true; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- RimCaseCollection* RimStatisticsCase::parentStatisticsCaseCollection() { std::vector parentObjects; this->parentObjectsOfType(parentObjects); if (parentObjects.size() > 0) { return parentObjects[0]; } return NULL; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::computeStatistics() { if (this->reservoirData() == NULL) { openEclipseGridFile(); } RimIdenticalGridCaseGroup* gridCaseGroup = caseGroup(); CVF_ASSERT(gridCaseGroup); gridCaseGroup->computeUnionOfActiveCells(); std::vector sourceCases; getSourceCases(sourceCases); if (sourceCases.size() == 0) { return; } // The first source has been read completely from disk, and contains grid and meta data // Use this information for all cases in the case group size_t timeStepCount = sourceCases.at(0)->results(RifReaderInterface::MATRIX_RESULTS)->cellResults()->maxTimeStepCount(); RimStatisticsConfig statisticsConfig; statisticsConfig.m_calculatePercentiles = m_calculatePercentiles(); statisticsConfig.m_pMaxPos = m_highPercentile(); statisticsConfig.m_pMidPos = m_midPercentile(); statisticsConfig.m_pMinPos = m_lowPercentile(); statisticsConfig.m_pValMethod = m_percentileCalculationType(); std::vector timeStepIndices; for (size_t i = 0; i < timeStepCount; i++) { timeStepIndices.push_back(i); } RigCaseData* resultCase = reservoirData(); QList resultSpecification; for(size_t pIdx = 0; pIdx < m_selectedDynamicProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::MATRIX_RESULTS, RimDefines::DYNAMIC_NATIVE, m_selectedDynamicProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedStaticProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::MATRIX_RESULTS, RimDefines::STATIC_NATIVE, m_selectedStaticProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedGeneratedProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::MATRIX_RESULTS, RimDefines::GENERATED, m_selectedGeneratedProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedInputProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::MATRIX_RESULTS, RimDefines::INPUT_PROPERTY, m_selectedInputProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedFractureDynamicProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::FRACTURE_RESULTS, RimDefines::DYNAMIC_NATIVE, m_selectedFractureDynamicProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedFractureStaticProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::FRACTURE_RESULTS, RimDefines::STATIC_NATIVE, m_selectedFractureStaticProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedFractureGeneratedProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::FRACTURE_RESULTS, RimDefines::GENERATED, m_selectedFractureGeneratedProperties()[pIdx])); } for(size_t pIdx = 0; pIdx < m_selectedFractureInputProperties().size(); ++pIdx) { resultSpecification.append(RimStatisticsCaseEvaluator::ResSpec(RifReaderInterface::FRACTURE_RESULTS, RimDefines::INPUT_PROPERTY, m_selectedFractureInputProperties()[pIdx])); } RimStatisticsCaseEvaluator stat(sourceCases, timeStepIndices, statisticsConfig, resultCase); stat.evaluateForResults(resultSpecification); // Todo: Is this really the time and place to do the following ? JJS for (size_t i = 0; i < reservoirViews().size(); i++) { RimReservoirView* reservoirView = reservoirViews()[i]; CVF_ASSERT(reservoirView); reservoirView->scheduleGeometryRegen(RivReservoirViewPartMgr::ACTIVE); reservoirView->createDisplayModelAndRedraw(); } m_calculationStatus = CALCULATED; m_calculationStatus.updateConnectedEditors(); m_editingAllowed = "UNLOCK"; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::getSourceCases(std::vector& sourceCases) { RimIdenticalGridCaseGroup* gridCaseGroup = caseGroup(); if (gridCaseGroup) { size_t caseCount = gridCaseGroup->caseCollection->reservoirs.size(); for (size_t i = 0; i < caseCount; i++) { CVF_ASSERT(gridCaseGroup->caseCollection); CVF_ASSERT(gridCaseGroup->caseCollection->reservoirs[i]); CVF_ASSERT(gridCaseGroup->caseCollection->reservoirs[i]->reservoirData()); RimCase* sourceCase = gridCaseGroup->caseCollection->reservoirs[i]; sourceCases.push_back(sourceCase); } } } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- RimIdenticalGridCaseGroup* RimStatisticsCase::caseGroup() { RimCaseCollection* parentCollection = parentStatisticsCaseCollection(); if (parentCollection) { return parentCollection->parentCaseGroup(); } return NULL; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) const { uiOrdering.add(&caseName); uiOrdering.add(&m_calculationStatus); uiOrdering.add(&m_editingAllowed); caf::PdmUiGroup * group = uiOrdering.addNewGroup("Property Selection"); group->add(&m_selectionSummary); group->add(&m_resultType); group->add(&m_porosityModel); group->add(&m_selectedDynamicProperties); group->add(&m_selectedStaticProperties); group->add(&m_selectedGeneratedProperties); group->add(&m_selectedInputProperties); group->add(&m_selectedFractureDynamicProperties); group->add(&m_selectedFractureStaticProperties); group->add(&m_selectedFractureGeneratedProperties); group->add(&m_selectedFractureInputProperties); group = uiOrdering.addNewGroup("Percentiles"); group->add(&m_calculatePercentiles); group->add(&m_percentileCalculationType); group->add(&m_lowPercentile); group->add(&m_midPercentile); group->add(&m_highPercentile); } QList toOptionList(const QStringList& varList) { QList optionList; int i; for (i = 0; i < varList.size(); ++i) { optionList.push_back(caf::PdmOptionItemInfo( varList[i], varList[i])); } return optionList; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- QList RimStatisticsCase::calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions, bool * useOptionsOnly) { QList options; if (useOptionsOnly) *useOptionsOnly = true; RimIdenticalGridCaseGroup* idgcg = caseGroup(); if (!(caseGroup() && caseGroup()->mainCase() && caseGroup()->mainCase()->reservoirData())) { return options; } RigCaseData* caseData = idgcg->mainCase()->reservoirData(); if (&m_selectedDynamicProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::MATRIX_RESULTS)->resultNames(RimDefines::DYNAMIC_NATIVE); return toOptionList(varList); } else if (&m_selectedStaticProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::MATRIX_RESULTS)->resultNames(RimDefines::STATIC_NATIVE); return toOptionList(varList); } else if (&m_selectedGeneratedProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::MATRIX_RESULTS)->resultNames(RimDefines::GENERATED); return toOptionList(varList); } else if (&m_selectedInputProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::MATRIX_RESULTS)->resultNames(RimDefines::INPUT_PROPERTY); return toOptionList(varList); } else if (&m_selectedFractureDynamicProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::FRACTURE_RESULTS)->resultNames(RimDefines::DYNAMIC_NATIVE); return toOptionList(varList); } else if (&m_selectedFractureStaticProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::FRACTURE_RESULTS)->resultNames(RimDefines::STATIC_NATIVE); return toOptionList(varList); } else if (&m_selectedFractureGeneratedProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::FRACTURE_RESULTS)->resultNames(RimDefines::GENERATED); return toOptionList(varList); } else if (&m_selectedFractureInputProperties == fieldNeedingOptions) { QStringList varList = caseData->results(RifReaderInterface::FRACTURE_RESULTS)->resultNames(RimDefines::INPUT_PROPERTY); return toOptionList(varList); } return options; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue) { if (&m_resultType == changedField || &m_porosityModel == changedField) { updateSelectionListVisibilities(); } if (&m_editingAllowed == changedField) { clearComputedStatistics(); m_calculationStatus = NOT_CALCULATED; m_editingAllowed.setUiHidden(true); } updateSelectionSummaryLabel(); updatePercentileUiVisibility(); } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::updateSelectionListVisibilities() { m_selectedDynamicProperties.setUiHidden( !(m_porosityModel() == RimDefines::MATRIX_MODEL && m_resultType() == RimDefines::DYNAMIC_NATIVE)); m_selectedStaticProperties.setUiHidden( !(m_porosityModel() == RimDefines::MATRIX_MODEL && m_resultType() == RimDefines::STATIC_NATIVE)); m_selectedGeneratedProperties.setUiHidden( !(m_porosityModel() == RimDefines::MATRIX_MODEL && m_resultType() == RimDefines::GENERATED)); m_selectedInputProperties.setUiHidden( !(m_porosityModel() == RimDefines::MATRIX_MODEL && m_resultType() == RimDefines::INPUT_PROPERTY)); m_selectedFractureDynamicProperties.setUiHidden( !(m_porosityModel() == RimDefines::FRACTURE_MODEL && m_resultType() == RimDefines::DYNAMIC_NATIVE)); m_selectedFractureStaticProperties.setUiHidden( !(m_porosityModel() == RimDefines::FRACTURE_MODEL && m_resultType() == RimDefines::STATIC_NATIVE)); m_selectedFractureGeneratedProperties.setUiHidden( !(m_porosityModel() == RimDefines::FRACTURE_MODEL && m_resultType() == RimDefines::GENERATED)); m_selectedFractureInputProperties.setUiHidden( !(m_porosityModel() == RimDefines::FRACTURE_MODEL && m_resultType() == RimDefines::INPUT_PROPERTY)); } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::updateSelectionSummaryLabel() { QString html; html += ""; if (m_selectedDynamicProperties().size()) { html += "

Dynamic properties:

"; for (size_t pIdx = 0; pIdx < m_selectedDynamicProperties().size(); ++pIdx) { html += "" + m_selectedDynamicProperties()[pIdx] + "
"; } html += "

"; } if (m_selectedStaticProperties().size()) { html += "Static properties:

"; for (size_t pIdx = 0; pIdx < m_selectedStaticProperties().size(); ++pIdx) { html += " " + m_selectedStaticProperties()[pIdx] + "
"; } html += "

"; } if (m_selectedGeneratedProperties().size()) { html += "Generated properties:

"; for (size_t pIdx = 0; pIdx < m_selectedGeneratedProperties().size(); ++pIdx) { html += " " + m_selectedGeneratedProperties()[pIdx] + "
"; } html += "

"; } if (m_selectedInputProperties().size()) { html += "Input properties:

"; for (size_t pIdx = 0; pIdx < m_selectedInputProperties().size(); ++pIdx) { html += " " + m_selectedInputProperties()[pIdx] + "
"; } html += "

"; } m_selectionSummary = html; } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::defineEditorAttribute(const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute * attribute) { if (&m_selectionSummary == field) { caf::PdmUiTextEditorAttribute* textEditAttrib = dynamic_cast (attribute); textEditAttrib->textMode = caf::PdmUiTextEditorAttribute::HTML; } } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::updatePercentileUiVisibility() { m_percentileCalculationType.setUiHidden( !m_calculatePercentiles()); m_lowPercentile .setUiHidden( !m_calculatePercentiles()); m_midPercentile .setUiHidden( !m_calculatePercentiles()); m_highPercentile.setUiHidden( !m_calculatePercentiles()); } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- bool RimStatisticsCase::hasComputedStatistics() { if ( reservoirData()->results(RifReaderInterface::MATRIX_RESULTS)->resultCount() || reservoirData()->results(RifReaderInterface::FRACTURE_RESULTS)->resultCount()) { return true; } else { return false; } } //-------------------------------------------------------------------------------------------------- /// //-------------------------------------------------------------------------------------------------- void RimStatisticsCase::clearComputedStatistics() { reservoirData()->results(RifReaderInterface::MATRIX_RESULTS)->clearAllResults(); reservoirData()->results(RifReaderInterface::FRACTURE_RESULTS)->clearAllResults(); }