mirror of
https://github.com/OPM/ResInsight.git
synced 2025-01-21 22:13:25 -06:00
574 lines
21 KiB
C++
574 lines
21 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// 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.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include "RimEclipsePropertyFilter.h"
|
|
|
|
#include "RiaDefines.h"
|
|
#include "RiaFieldHandleTools.h"
|
|
|
|
#include "RigCaseCellResultsData.h"
|
|
#include "RigEclipseCaseData.h"
|
|
#include "RigFlowDiagResults.h"
|
|
#include "RigFormationNames.h"
|
|
|
|
#include "RimEclipseCase.h"
|
|
#include "RimEclipsePropertyFilterCollection.h"
|
|
#include "RimEclipseResultDefinition.h"
|
|
#include "RimEclipseView.h"
|
|
#include "RimFlowDiagSolution.h"
|
|
#include "RimReservoirCellResultsStorage.h"
|
|
#include "RimViewController.h"
|
|
|
|
#include "RiuMainWindow.h"
|
|
|
|
#include "cafPdmUiDoubleSliderEditor.h"
|
|
|
|
#include "cvfAssert.h"
|
|
#include "cvfMath.h"
|
|
|
|
#include <cmath> // Needed for HUGE_VAL on Linux
|
|
|
|
namespace caf
|
|
{ // Obsolete stuff
|
|
template<>
|
|
void caf::AppEnum<RimEclipsePropertyFilter::EvaluationRegionType>::setUp()
|
|
{
|
|
addItem(RimEclipsePropertyFilter::RANGE_FILTER_REGION, "RANGE_FILTER_REGION", "Range filter cells");
|
|
addItem(RimEclipsePropertyFilter::GLOBAL_REGION, "GLOBAL_REGION", "All cells");
|
|
setDefault(RimEclipsePropertyFilter::RANGE_FILTER_REGION);
|
|
}
|
|
} // namespace caf
|
|
|
|
CAF_PDM_SOURCE_INIT(RimEclipsePropertyFilter, "CellPropertyFilter");
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RimEclipsePropertyFilter::RimEclipsePropertyFilter()
|
|
{
|
|
CAF_PDM_InitObject("Cell Property Filter", ":/CellFilter_Values.png", "", "");
|
|
|
|
CAF_PDM_InitFieldNoDefault(&obsoleteField_evaluationRegion, "EvaluationRegion", "Evaluation Region", "", "", "");
|
|
RiaFieldhandleTools::disableWriteAndSetFieldHidden(&obsoleteField_evaluationRegion);
|
|
|
|
CAF_PDM_InitFieldNoDefault(&resultDefinition, "ResultDefinition", "Result Definition", "", "", "");
|
|
resultDefinition = new RimEclipseResultDefinition();
|
|
resultDefinition->setDiffResultOptionsEnabled(true);
|
|
|
|
// Set to hidden to avoid this item to been displayed as a child item
|
|
// Fields in this object are displayed using defineUiOrdering()
|
|
resultDefinition.uiCapability()->setUiHidden(true);
|
|
resultDefinition.uiCapability()->setUiTreeChildrenHidden(true);
|
|
|
|
CAF_PDM_InitField(&m_rangeLabelText, "Dummy_keyword", QString("Range Type"), "Range Type", "", "", "");
|
|
m_rangeLabelText.xmlCapability()->disableIO();
|
|
m_rangeLabelText.uiCapability()->setUiReadOnly(true);
|
|
|
|
CAF_PDM_InitField(&m_lowerBound, "LowerBound", 0.0, "Min", "", "", "");
|
|
m_lowerBound.uiCapability()->setUiEditorTypeName(caf::PdmUiDoubleSliderEditor::uiEditorTypeName());
|
|
|
|
CAF_PDM_InitField(&m_upperBound, "UpperBound", 0.0, "Max", "", "", "");
|
|
m_upperBound.uiCapability()->setUiEditorTypeName(caf::PdmUiDoubleSliderEditor::uiEditorTypeName());
|
|
|
|
CAF_PDM_InitField(&m_useCategorySelection, "CategorySelection", false, "Category Selection", "", "", "");
|
|
m_upperBound.uiCapability()->setUiEditorTypeName(caf::PdmUiDoubleSliderEditor::uiEditorTypeName());
|
|
|
|
updateIconState();
|
|
|
|
m_minimumResultValue = cvf::UNDEFINED_DOUBLE;
|
|
m_maximumResultValue = cvf::UNDEFINED_DOUBLE;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RimEclipsePropertyFilter::~RimEclipsePropertyFilter()
|
|
{
|
|
delete resultDefinition;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::rangeValues(double* lower, double* upper) const
|
|
{
|
|
*lower = this->m_lowerBound;
|
|
*upper = this->m_upperBound;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RimEclipsePropertyFilter::isCategorySelectionActive() const
|
|
{
|
|
if (resultDefinition->hasCategoryResult() && m_useCategorySelection)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::fieldChangedByUi(const caf::PdmFieldHandle* changedField,
|
|
const QVariant& oldValue,
|
|
const QVariant& newValue)
|
|
{
|
|
// clang-format off
|
|
if ( &m_lowerBound == changedField
|
|
|| &m_upperBound == changedField
|
|
|| &obsoleteField_evaluationRegion == changedField
|
|
|| &isActive == changedField
|
|
|| &filterMode == changedField
|
|
|| &m_selectedCategoryValues == changedField
|
|
|| &m_useCategorySelection == changedField)
|
|
{
|
|
this->resultDefinition->loadResult();
|
|
this->computeResultValueRange();
|
|
updateFilterName();
|
|
this->updateIconState();
|
|
this->uiCapability()->updateConnectedEditors();
|
|
|
|
parentContainer()->updateDisplayModelNotifyManagedViews(this);
|
|
}
|
|
// clang-format on
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RimEclipsePropertyFilterCollection* RimEclipsePropertyFilter::parentContainer()
|
|
{
|
|
RimEclipsePropertyFilterCollection* propFilterColl = nullptr;
|
|
this->firstAncestorOrThisOfTypeAsserted(propFilterColl);
|
|
|
|
return propFilterColl;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::setToDefaultValues()
|
|
{
|
|
CVF_ASSERT(parentContainer());
|
|
|
|
computeResultValueRange();
|
|
|
|
m_lowerBound = m_minimumResultValue;
|
|
m_upperBound = m_maximumResultValue;
|
|
|
|
m_selectedCategoryValues = m_categoryValues;
|
|
m_useCategorySelection = true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
|
|
{
|
|
// Fields declared in RimCellFilter
|
|
uiOrdering.add(&name);
|
|
|
|
// Fields declared in RimResultDefinition
|
|
caf::PdmUiGroup* group1 = uiOrdering.addNewGroup("Result");
|
|
resultDefinition->uiOrdering(uiConfigName, *group1);
|
|
|
|
caf::PdmUiGroup& group2 = *(uiOrdering.addNewGroup("Filter Settings"));
|
|
|
|
// Fields declared in RimCellFilter
|
|
group2.add(&filterMode);
|
|
|
|
group2.add(&m_rangeLabelText);
|
|
|
|
if (resultDefinition->hasCategoryResult())
|
|
{
|
|
group2.add(&m_useCategorySelection);
|
|
}
|
|
|
|
if (resultDefinition->hasCategoryResult() && m_useCategorySelection())
|
|
{
|
|
group2.add(&m_selectedCategoryValues);
|
|
}
|
|
else
|
|
{
|
|
group2.add(&m_lowerBound);
|
|
group2.add(&m_upperBound);
|
|
}
|
|
|
|
uiOrdering.skipRemainingFields(true);
|
|
|
|
updateReadOnlyStateOfAllFields();
|
|
updateRangeLabel();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::defineUiTreeOrdering(caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName)
|
|
{
|
|
PdmObject::defineUiTreeOrdering(uiTreeOrdering, uiConfigName);
|
|
|
|
updateActiveState();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::updateReadOnlyStateOfAllFields()
|
|
{
|
|
bool readOnlyState = isPropertyFilterControlled();
|
|
|
|
std::vector<caf::PdmFieldHandle*> objFields;
|
|
this->fields(objFields);
|
|
|
|
// Include fields declared in RimResultDefinition
|
|
objFields.push_back(&(resultDefinition->m_resultTypeUiField));
|
|
objFields.push_back(&(resultDefinition->m_porosityModelUiField));
|
|
objFields.push_back(&(resultDefinition->m_resultVariableUiField));
|
|
|
|
for (auto f : objFields)
|
|
{
|
|
if (f == &m_rangeLabelText) continue;
|
|
|
|
f->uiCapability()->setUiReadOnly(readOnlyState);
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::updateRangeLabel()
|
|
{
|
|
if (resultDefinition->isFlowDiagOrInjectionFlooding())
|
|
{
|
|
m_rangeLabelText = "Current Timestep";
|
|
}
|
|
else
|
|
{
|
|
m_rangeLabelText = "All Timesteps";
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RimEclipsePropertyFilter::isPropertyFilterControlled()
|
|
{
|
|
Rim3dView* rimView = nullptr;
|
|
firstAncestorOrThisOfTypeAsserted(rimView);
|
|
|
|
bool isPropertyFilterControlled = false;
|
|
|
|
RimViewController* vc = rimView->viewController();
|
|
if (vc && vc->isPropertyFilterOveridden())
|
|
{
|
|
isPropertyFilterControlled = true;
|
|
}
|
|
|
|
return isPropertyFilterControlled;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::setCategoriesFromTracerNames(const std::vector<QString>& tracerNames)
|
|
{
|
|
std::vector<std::pair<QString, int>> tracerNameValuesSorted;
|
|
|
|
{
|
|
std::set<std::pair<QString, int>> tracerNameSet;
|
|
|
|
for (size_t i = 0; i < tracerNames.size(); i++)
|
|
{
|
|
tracerNameSet.insert(std::make_pair(tracerNames[i], static_cast<int>(i)));
|
|
}
|
|
|
|
for (const auto& it : tracerNameSet)
|
|
{
|
|
tracerNameValuesSorted.push_back(it);
|
|
}
|
|
}
|
|
|
|
setCategoryNamesAndValues(tracerNameValuesSorted);
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::updateActiveState()
|
|
{
|
|
isActive.uiCapability()->setUiReadOnly(isPropertyFilterControlled());
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::defineEditorAttribute(const caf::PdmFieldHandle* field,
|
|
QString uiConfigName,
|
|
caf::PdmUiEditorAttribute* attribute)
|
|
{
|
|
if (m_minimumResultValue == cvf::UNDEFINED_DOUBLE || m_maximumResultValue == cvf::UNDEFINED_DOUBLE)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (field == &m_lowerBound || field == &m_upperBound)
|
|
{
|
|
caf::PdmUiDoubleSliderEditorAttribute* myAttr = dynamic_cast<caf::PdmUiDoubleSliderEditorAttribute*>(attribute);
|
|
if (!myAttr)
|
|
{
|
|
return;
|
|
}
|
|
|
|
myAttr->m_minimum = m_minimumResultValue;
|
|
myAttr->m_maximum = m_maximumResultValue;
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::computeResultValueRange()
|
|
{
|
|
CVF_ASSERT(parentContainer());
|
|
|
|
double min = HUGE_VAL;
|
|
double max = -HUGE_VAL;
|
|
|
|
clearCategories();
|
|
|
|
if (resultDefinition->isFlowDiagOrInjectionFlooding())
|
|
{
|
|
Rim3dView* view;
|
|
this->firstAncestorOrThisOfType(view);
|
|
|
|
int timeStep = 0;
|
|
if (view) timeStep = view->currentTimeStep();
|
|
RigFlowDiagResultAddress resAddr = resultDefinition->flowDiagResAddress();
|
|
if (resultDefinition->flowDiagSolution())
|
|
{
|
|
RigFlowDiagResults* results = resultDefinition->flowDiagSolution()->flowDiagResults();
|
|
results->minMaxScalarValues(resAddr, timeStep, &min, &max);
|
|
|
|
if (resultDefinition->hasCategoryResult())
|
|
{
|
|
setCategoriesFromTracerNames(resultDefinition->flowDiagSolution()->tracerNames());
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
RigEclipseResultAddress scalarIndex = resultDefinition->eclipseResultAddress();
|
|
if (scalarIndex.isValid())
|
|
{
|
|
RigCaseCellResultsData* results = resultDefinition->currentGridCellResults();
|
|
if (results)
|
|
{
|
|
results->minMaxCellScalarValues(scalarIndex, min, max);
|
|
|
|
if (resultDefinition->hasCategoryResult())
|
|
{
|
|
if (resultDefinition->resultType() == RiaDefines::FORMATION_NAMES)
|
|
{
|
|
CVF_ASSERT(parentContainer()->reservoirView()->eclipseCase()->eclipseCaseData());
|
|
CVF_ASSERT(parentContainer()->reservoirView()->eclipseCase()->eclipseCaseData()->activeFormationNames());
|
|
|
|
const std::vector<QString>& fnVector = parentContainer()
|
|
->reservoirView()
|
|
->eclipseCase()
|
|
->eclipseCaseData()
|
|
->activeFormationNames()
|
|
->formationNames();
|
|
setCategoryNames(fnVector);
|
|
}
|
|
else if (resultDefinition->resultVariable() == RiaDefines::completionTypeResultName())
|
|
{
|
|
std::vector<RiaDefines::WellPathComponentType> componentTypes = {
|
|
RiaDefines::WELL_PATH, RiaDefines::PERFORATION_INTERVAL, RiaDefines::FISHBONES, RiaDefines::FRACTURE};
|
|
std::vector<std::pair<QString, int>> ctNamesAndValues;
|
|
for (RiaDefines::WellPathComponentType type : componentTypes)
|
|
{
|
|
ctNamesAndValues.push_back(
|
|
std::make_pair(caf::AppEnum<RiaDefines::WellPathComponentType>::uiText(type), type));
|
|
}
|
|
setCategoryNamesAndValues(ctNamesAndValues);
|
|
}
|
|
else
|
|
{
|
|
setCategoryValues(results->uniqueCellScalarValues(scalarIndex));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
m_maximumResultValue = max;
|
|
m_minimumResultValue = min;
|
|
|
|
m_lowerBound.uiCapability()->setUiName(QString("Min (%1)").arg(min));
|
|
m_upperBound.uiCapability()->setUiName(QString("Max (%1)").arg(max));
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::updateFromCurrentTimeStep()
|
|
{
|
|
// Update range for flow diagnostics values when time step changes
|
|
// Range for flow is always current time step, not computed across all time steps
|
|
// If upper/lower slider is set to available extrema, the filter values will be
|
|
// updated with the min/max values for the current time step
|
|
//
|
|
// If the user manually has set a filter value, this value is left untouched
|
|
|
|
if (!resultDefinition->isFlowDiagOrInjectionFlooding())
|
|
{
|
|
return;
|
|
}
|
|
|
|
double threshold = 1e-6;
|
|
bool followMin = false;
|
|
if (fabs(m_lowerBound - m_minimumResultValue) < threshold || m_minimumResultValue == HUGE_VAL)
|
|
{
|
|
followMin = true;
|
|
}
|
|
|
|
bool followMax = false;
|
|
if (fabs(m_upperBound - m_maximumResultValue) < threshold || m_maximumResultValue == -HUGE_VAL)
|
|
{
|
|
followMax = true;
|
|
}
|
|
|
|
double min = HUGE_VAL;
|
|
double max = -HUGE_VAL;
|
|
|
|
clearCategories();
|
|
|
|
Rim3dView* view = nullptr;
|
|
this->firstAncestorOrThisOfTypeAsserted(view);
|
|
|
|
int timeStep = view->currentTimeStep();
|
|
RigFlowDiagResultAddress resAddr = resultDefinition->flowDiagResAddress();
|
|
if (resultDefinition->flowDiagSolution())
|
|
{
|
|
RigFlowDiagResults* results = resultDefinition->flowDiagSolution()->flowDiagResults();
|
|
results->minMaxScalarValues(resAddr, timeStep, &min, &max);
|
|
|
|
if (resultDefinition->hasCategoryResult())
|
|
{
|
|
setCategoriesFromTracerNames(resultDefinition->flowDiagSolution()->tracerNames());
|
|
}
|
|
}
|
|
|
|
if (min == HUGE_VAL && max == -HUGE_VAL)
|
|
{
|
|
m_lowerBound.uiCapability()->setUiName(QString("Min (inf)"));
|
|
m_upperBound.uiCapability()->setUiName(QString("Max (inf)"));
|
|
}
|
|
else
|
|
{
|
|
m_maximumResultValue = max;
|
|
m_minimumResultValue = min;
|
|
|
|
if (followMin)
|
|
{
|
|
m_lowerBound = min;
|
|
}
|
|
|
|
if (followMax)
|
|
{
|
|
m_upperBound = m_maximumResultValue;
|
|
}
|
|
|
|
m_lowerBound.uiCapability()->setUiName(QString("Min (%1)").arg(min));
|
|
m_upperBound.uiCapability()->setUiName(QString("Max (%1)").arg(max));
|
|
}
|
|
|
|
m_lowerBound.uiCapability()->updateConnectedEditors();
|
|
m_upperBound.uiCapability()->updateConnectedEditors();
|
|
|
|
updateFilterName();
|
|
this->name.uiCapability()->updateConnectedEditors();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::updateFilterName()
|
|
{
|
|
QString newFiltername = resultDefinition->resultVariableUiShortName();
|
|
|
|
if (isCategorySelectionActive())
|
|
{
|
|
if (m_categoryNames.empty())
|
|
{
|
|
newFiltername += " (";
|
|
|
|
if (!m_selectedCategoryValues().empty() && m_selectedCategoryValues().size() == m_categoryValues.size())
|
|
{
|
|
newFiltername += QString::number(m_selectedCategoryValues()[0]);
|
|
newFiltername += "..";
|
|
newFiltername += QString::number(m_selectedCategoryValues()[m_selectedCategoryValues().size() - 1]);
|
|
}
|
|
else
|
|
{
|
|
for (size_t i = 0; i < m_selectedCategoryValues().size(); i++)
|
|
{
|
|
int val = m_selectedCategoryValues()[i];
|
|
newFiltername += QString::number(val);
|
|
|
|
if (i < m_selectedCategoryValues().size() - 1)
|
|
{
|
|
newFiltername += ", ";
|
|
}
|
|
}
|
|
}
|
|
|
|
newFiltername += ")";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
newFiltername += " (" + QString::number(m_lowerBound) + " .. " + QString::number(m_upperBound) + ")";
|
|
}
|
|
|
|
this->name = newFiltername;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::initAfterRead()
|
|
{
|
|
resultDefinition->initAfterRead();
|
|
|
|
resultDefinition->setEclipseCase(parentContainer()->reservoirView()->eclipseCase());
|
|
updateIconState();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RimEclipsePropertyFilter::updateUiFieldsFromActiveResult()
|
|
{
|
|
resultDefinition->updateUiFieldsFromActiveResult();
|
|
}
|