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
97 lines
4.3 KiB
C++
97 lines
4.3 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.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#pragma once
|
|
|
|
//==================================================================================================
|
|
///
|
|
//==================================================================================================
|
|
#include "RigStatisticsCalculator.h"
|
|
|
|
#include "RigActiveCellInfo.h"
|
|
#include "RigCaseCellResultsData.h"
|
|
#include "RigEclipseResultAddress.h"
|
|
|
|
#include "cvfArray.h"
|
|
|
|
#include "cafAssert.h"
|
|
|
|
class RigEclipseNativeVisibleCellsStatCalc : public RigStatisticsCalculator
|
|
{
|
|
public:
|
|
RigEclipseNativeVisibleCellsStatCalc( RigCaseCellResultsData* cellResultsData,
|
|
const RigEclipseResultAddress& scalarResultIndex,
|
|
const cvf::UByteArray* cellVisibilities );
|
|
|
|
bool hasPreciseP10p90() const override;
|
|
void p10p90CellScalarValues( double& min, double& max ) override;
|
|
void p10p90CellScalarValues( size_t timeStepIndex, double& min, double& max ) override;
|
|
void minMaxCellScalarValues( size_t timeStepIndex, double& min, double& max ) override;
|
|
void posNegClosestToZero( size_t timeStepIndex, double& pos, double& neg ) override;
|
|
void valueSumAndSampleCount( size_t timeStepIndex, double& valueSum, size_t& sampleCount ) override;
|
|
void addDataToHistogramCalculator( size_t timeStepIndex, RigHistogramCalculator& histogramCalculator ) override;
|
|
void uniqueValues( size_t timeStepIndex, std::set<int>& values ) override;
|
|
size_t timeStepCount() override;
|
|
std::optional<double> mobileVolumeWeightedMean( size_t timeStepIndex ) override;
|
|
|
|
private:
|
|
RigCaseCellResultsData* m_caseData;
|
|
RigEclipseResultAddress m_resultAddress;
|
|
cvf::cref<cvf::UByteArray> m_cellVisibilities;
|
|
|
|
template <typename StatisticsAccumulator>
|
|
void traverseCells( StatisticsAccumulator& accumulator, size_t timeStepIndex )
|
|
{
|
|
if ( !m_caseData ) return;
|
|
if ( !m_caseData->hasResultEntry( m_resultAddress ) ) return;
|
|
if ( m_caseData->timeStepCount( m_resultAddress ) == 0 ) return;
|
|
|
|
size_t clampedTimeStepIndex = std::min( timeStepIndex, m_caseData->timeStepCount( m_resultAddress ) - 1 );
|
|
const std::vector<double>& values = m_caseData->cellScalarResults( m_resultAddress, clampedTimeStepIndex );
|
|
|
|
if ( values.empty() )
|
|
{
|
|
// Can happen if values do not exist for the current time step index.
|
|
return;
|
|
}
|
|
|
|
const RigActiveCellInfo* actCellInfo = m_caseData->activeCellInfo();
|
|
size_t cellCount = actCellInfo->reservoirCellCount();
|
|
bool isUsingGlobalActiveIndex = m_caseData->isUsingGlobalActiveIndex( m_resultAddress );
|
|
|
|
CAF_ASSERT( cellCount == m_cellVisibilities->size() );
|
|
|
|
for ( size_t cIdx = 0; cIdx < cellCount; ++cIdx )
|
|
{
|
|
if ( !( *m_cellVisibilities )[cIdx] ) continue;
|
|
|
|
size_t cellResultIndex = cIdx;
|
|
if ( isUsingGlobalActiveIndex )
|
|
{
|
|
cellResultIndex = actCellInfo->cellResultIndex( ReservoirCellIndex( cIdx ) ).value();
|
|
}
|
|
|
|
if ( cellResultIndex != cvf::UNDEFINED_SIZE_T && cellResultIndex < values.size() )
|
|
{
|
|
accumulator.addValue( values[cellResultIndex] );
|
|
}
|
|
}
|
|
}
|
|
};
|