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
176 lines
7.4 KiB
C++
176 lines
7.4 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2015- Statoil ASA
|
|
// Copyright (C) 2015- 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 "RigEclipseNativeVisibleCellsStatCalc.h"
|
|
|
|
#include "RiaLogging.h"
|
|
#include "RiaResultNames.h"
|
|
|
|
#include "RigActiveCellInfo.h"
|
|
#include "RigCaseCellResultsData.h"
|
|
#include "RigStatisticsMath.h"
|
|
#include "RigWeightedMeanCalc.h"
|
|
|
|
#include <cmath>
|
|
#include <format>
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RigEclipseNativeVisibleCellsStatCalc::RigEclipseNativeVisibleCellsStatCalc( RigCaseCellResultsData* cellResultsData,
|
|
const RigEclipseResultAddress& scalarResultIndex,
|
|
const cvf::UByteArray* cellVisibilities )
|
|
: m_caseData( cellResultsData )
|
|
, m_resultAddress( scalarResultIndex )
|
|
, m_cellVisibilities( cellVisibilities )
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::minMaxCellScalarValues( size_t timeStepIndex, double& min, double& max )
|
|
{
|
|
MinMaxAccumulator acc( min, max );
|
|
traverseCells( acc, timeStepIndex );
|
|
min = acc.min;
|
|
max = acc.max;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RigEclipseNativeVisibleCellsStatCalc::hasPreciseP10p90() const
|
|
{
|
|
return true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::p10p90CellScalarValues( double& p10, double& p90 )
|
|
{
|
|
PercentilAccumulator acc;
|
|
|
|
for ( size_t timeStepIndex = 0; timeStepIndex < timeStepCount(); timeStepIndex++ )
|
|
{
|
|
traverseCells( acc, timeStepIndex );
|
|
}
|
|
|
|
acc.computep10p90( p10, p90 );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::p10p90CellScalarValues( size_t timeStepIndex, double& p10, double& p90 )
|
|
{
|
|
PercentilAccumulator acc;
|
|
traverseCells( acc, timeStepIndex );
|
|
acc.computep10p90( p10, p90 );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::posNegClosestToZero( size_t timeStepIndex, double& pos, double& neg )
|
|
{
|
|
PosNegAccumulator acc( pos, neg );
|
|
traverseCells( acc, timeStepIndex );
|
|
pos = acc.pos;
|
|
neg = acc.neg;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::valueSumAndSampleCount( size_t timeStepIndex, double& valueSum, size_t& sampleCount )
|
|
{
|
|
SumCountAccumulator acc( valueSum, sampleCount );
|
|
traverseCells( acc, timeStepIndex );
|
|
valueSum = acc.valueSum;
|
|
sampleCount = acc.sampleCount;
|
|
|
|
RiaLogging::debug( std::format( "Visible cells statistics for '{}', time step {}: sum = {}, number of values used = {}",
|
|
m_resultAddress.resultName().toStdString(),
|
|
timeStepIndex,
|
|
valueSum,
|
|
sampleCount ) );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::addDataToHistogramCalculator( size_t timeStepIndex, RigHistogramCalculator& histogramCalculator )
|
|
{
|
|
traverseCells( histogramCalculator, timeStepIndex );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RigEclipseNativeVisibleCellsStatCalc::uniqueValues( size_t timeStepIndex, std::set<int>& values )
|
|
{
|
|
UniqueValueAccumulator acc;
|
|
traverseCells( acc, timeStepIndex );
|
|
values = acc.uniqueValues;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
size_t RigEclipseNativeVisibleCellsStatCalc::timeStepCount()
|
|
{
|
|
if ( !m_caseData ) return 0;
|
|
|
|
return m_caseData->timeStepCount( m_resultAddress );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::optional<double> RigEclipseNativeVisibleCellsStatCalc::mobileVolumeWeightedMean( size_t timeStepIndex )
|
|
{
|
|
if ( !m_caseData ) return {};
|
|
|
|
RigEclipseResultAddress mobPorvAddress( RiaDefines::ResultCatType::STATIC_NATIVE, RiaResultNames::mobilePoreVolumeName() );
|
|
|
|
// For statistics result cases, the pore volume is not available, as
|
|
// RigCaseCellResultsData::createPlaceholderResultEntries has not been executed
|
|
if ( !m_caseData->ensureKnownResultLoaded( mobPorvAddress ) )
|
|
{
|
|
return {};
|
|
}
|
|
|
|
if ( !m_caseData->hasResultEntry( m_resultAddress ) ) return {};
|
|
if ( m_caseData->timeStepCount( m_resultAddress ) == 0 ) return {};
|
|
|
|
const std::vector<double>& weights = m_caseData->cellScalarResults( mobPorvAddress, 0 );
|
|
const std::vector<double>& values = m_caseData->cellScalarResults( m_resultAddress, timeStepIndex );
|
|
|
|
const RigActiveCellInfo* actCellInfo = m_caseData->activeCellInfo();
|
|
|
|
return RigWeightedMeanCalc::weightedMeanOverCells( &weights,
|
|
&values,
|
|
m_cellVisibilities.p(),
|
|
true,
|
|
actCellInfo,
|
|
m_caseData->isUsingGlobalActiveIndex( m_resultAddress ) );
|
|
}
|