mirror of
https://github.com/OPM/ResInsight.git
synced 2026-10-25 06:38:13 -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
86 lines
3.0 KiB
C++
86 lines
3.0 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2017- Statoil ASA
|
|
//
|
|
// 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 "RigWeightedMeanCalc.h"
|
|
|
|
#include "RiaDefines.h"
|
|
|
|
#include "RigActiveCellInfo.h"
|
|
#include "RigFlowDiagResults.h"
|
|
|
|
#include <cmath> // Needed for HUGE_VAL on Linux
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::optional<double> RigWeightedMeanCalc::weightedMeanOverCells( const std::vector<double>* weights,
|
|
const std::vector<double>* values,
|
|
const cvf::UByteArray* cellVisibilities,
|
|
bool isUsingVisibleCells,
|
|
const RigActiveCellInfo* actCellInfo,
|
|
bool isUsingActiveIndex )
|
|
{
|
|
if ( !( weights && values ) ) return {};
|
|
if ( !cellVisibilities && isUsingVisibleCells ) return {};
|
|
if ( !actCellInfo && isUsingActiveIndex ) return {};
|
|
|
|
if ( weights->empty() || values->empty() ) return {};
|
|
|
|
double weightedSum = 0.0;
|
|
double weightSum = 0.0;
|
|
|
|
for ( size_t cIdx = 0; cIdx < actCellInfo->reservoirCellCount(); ++cIdx )
|
|
{
|
|
if ( isUsingVisibleCells )
|
|
{
|
|
if ( !( *cellVisibilities )[cIdx] ) continue;
|
|
}
|
|
|
|
size_t cellResultIndex = actCellInfo->cellResultIndex( ReservoirCellIndex( cIdx ) ).value();
|
|
if ( cellResultIndex == cvf::UNDEFINED_SIZE_T || cellResultIndex > weights->size() )
|
|
{
|
|
continue;
|
|
}
|
|
|
|
double value;
|
|
|
|
if ( isUsingActiveIndex )
|
|
{
|
|
value = ( *values )[cellResultIndex];
|
|
}
|
|
else
|
|
{
|
|
value = ( *values )[cIdx];
|
|
}
|
|
|
|
double weight = ( *weights )[cellResultIndex];
|
|
|
|
if ( weight == HUGE_VAL || value == HUGE_VAL )
|
|
{
|
|
continue;
|
|
}
|
|
|
|
weightedSum += weight * value;
|
|
weightSum += weight;
|
|
}
|
|
|
|
if ( weightSum == 0.0 ) return {};
|
|
|
|
return weightedSum / weightSum;
|
|
}
|