mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-24 22:27:55 -05:00
Kristian Bendiksen
4d2a868079
RigStatisticsCalculator::mobileVolumeWeightedMean() accumulated into a sum from an out-parameter that callees were not required to write. Every implementation of the per time step overload has early-return paths that leave the value untouched, as does RigWeightedMeanCalc::weightedMeanOverCells, so indeterminate stack memory could be summed and presented in the UI. Return std::optional<double> from the computation layer instead of using an out-parameter, making "value not available" explicit and impossible to ignore: - RigWeightedMeanCalc::weightedMeanOverCells - RigStatisticsCalculator::mobileVolumeWeightedMean and all overrides Time steps without a computable mean no longer contribute to the accumulated sum, and are excluded from the divisor. Previously they would either add garbage or, with a naive zero initialisation, bias the average towards zero. RigStatisticsDataCache keeps the existing HUGE_VAL marker on its public API via value_or(), so behaviour seen by RigHistogramData and the overlay info is unchanged apart from the fix. Also: - Set m_isVolumeWeightedMeanCalculated in the per time step cache, which was never assigned, so the cached value was recomputed on every call. - Remove a duplicated ensureKnownResultLoaded() call in RigEclipseNativeVisibleCellsStatCalc. Fixes #14766
135 lines
5.6 KiB
C++
135 lines
5.6 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) Statoil ASA
|
|
// Copyright (C) Ceetron Solutions 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 "RigFlowDiagStatCalc.h"
|
|
|
|
#include "RiaResultNames.h"
|
|
|
|
#include "RigCaseCellResultsData.h"
|
|
#include "RigEclipseResultAddress.h"
|
|
#include "RigFlowDiagResults.h"
|
|
#include "RigStatisticsMath.h"
|
|
#include "RigWeightedMeanCalc.h"
|
|
|
|
#include "RimEclipseResultCase.h"
|
|
|
|
#include <cmath>
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RigFlowDiagStatCalc::RigFlowDiagStatCalc( RigFlowDiagResults* flowDiagResults, const RigFlowDiagResultAddress& resVarAddr )
|
|
: m_resVarAddr( resVarAddr )
|
|
{
|
|
m_resultsData = flowDiagResults;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigFlowDiagStatCalc::minMaxCellScalarValues( size_t timeStepIndex, double& min, double& max )
|
|
{
|
|
MinMaxAccumulator minMaxCalc( min, max );
|
|
const std::vector<double>* vals = m_resultsData->resultValues( m_resVarAddr, timeStepIndex );
|
|
|
|
if ( vals ) minMaxCalc.addData( *vals );
|
|
|
|
min = minMaxCalc.min;
|
|
max = minMaxCalc.max;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigFlowDiagStatCalc::posNegClosestToZero( size_t timeStepIndex, double& pos, double& neg )
|
|
{
|
|
PosNegAccumulator posNegCalc( pos, neg );
|
|
const std::vector<double>* vals = m_resultsData->resultValues( m_resVarAddr, timeStepIndex );
|
|
|
|
if ( vals ) posNegCalc.addData( *vals );
|
|
|
|
pos = posNegCalc.pos;
|
|
neg = posNegCalc.neg;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigFlowDiagStatCalc::valueSumAndSampleCount( size_t timeStepIndex, double& valueSum, size_t& sampleCount )
|
|
{
|
|
SumCountAccumulator sumCountCalc( valueSum, sampleCount );
|
|
const std::vector<double>* vals = m_resultsData->resultValues( m_resVarAddr, timeStepIndex );
|
|
|
|
if ( vals ) sumCountCalc.addData( *vals );
|
|
|
|
valueSum = sumCountCalc.valueSum;
|
|
sampleCount = sumCountCalc.sampleCount;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigFlowDiagStatCalc::addDataToHistogramCalculator( size_t timeStepIndex, RigHistogramCalculator& histogramCalculator )
|
|
{
|
|
const std::vector<double>* vals = m_resultsData->resultValues( m_resVarAddr, timeStepIndex );
|
|
|
|
if ( vals ) histogramCalculator.addData( *vals );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigFlowDiagStatCalc::uniqueValues( size_t timeStepIndex, std::set<int>& uniqueValues )
|
|
{
|
|
const std::vector<double>* vals = m_resultsData->resultValues( m_resVarAddr, timeStepIndex );
|
|
|
|
if ( vals )
|
|
for ( double val : ( *vals ) )
|
|
uniqueValues.insert( static_cast<int>( val ) );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
size_t RigFlowDiagStatCalc::timeStepCount()
|
|
{
|
|
return m_resultsData->timeStepCount();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::optional<double> RigFlowDiagStatCalc::mobileVolumeWeightedMean( size_t timeStepIndex )
|
|
{
|
|
auto eclCase = m_resultsData->flowDiagSolution()->firstAncestorOrThisOfType<RimEclipseResultCase>();
|
|
if ( !eclCase ) return {};
|
|
|
|
RigCaseCellResultsData* caseCellResultsData = eclCase->results( RiaDefines::PorosityModelType::MATRIX_MODEL );
|
|
RigEclipseResultAddress mobPoreVolResAddr( RiaDefines::ResultCatType::STATIC_NATIVE, RiaResultNames::mobilePoreVolumeName() );
|
|
|
|
caseCellResultsData->ensureKnownResultLoaded( mobPoreVolResAddr );
|
|
|
|
const std::vector<double>& weights = caseCellResultsData->cellScalarResults( mobPoreVolResAddr, 0 );
|
|
const std::vector<double>* values = m_resultsData->resultValues( m_resVarAddr, timeStepIndex );
|
|
|
|
const RigActiveCellInfo* actCellInfo = m_resultsData->activeCellInfo( m_resVarAddr );
|
|
|
|
return RigWeightedMeanCalc::weightedMeanOverCells( &weights, values, nullptr, false, actCellInfo, true );
|
|
}
|