Files
ResInsight/ApplicationLibCode/ProjectDataModel/RimEclipseStatisticsCaseEvaluator.cpp
T
Magne Sjaastad 56e98ba1c4 #14476 ApplicationLibCode: Replace CVF_ASSERT with CAF_ASSERT
Migrate all assert macros in ApplicationLibCode to CAF_ASSERT and remove every
use of cvfAssert.h.

CVF_ASSERT is replaced one to one. CVF_TIGHT_ASSERT is also replaced by
CAF_ASSERT, which is semantically exact: CVF_ENABLE_TIGHT_ASSERTS is 1 only
under _DEBUG, and that is what CAF_ASSERT now does. The two CVF_FAIL_MSG sites
become CAF_ASSERT( false && "message" ), preserving the message with the idiom
already used elsewhere in the code base.

Counts before and after: CVF_ASSERT 1044 to 0, CVF_TIGHT_ASSERT 66 to 0,
CVF_FAIL_MSG 2 to 0, cvfAssert.h references 154 to 0.

Include handling: files that included cvfAssert.h directly now include
cafAssert.h instead, includes left dead by the migration are removed, and files
that were relying on cvfAssert.h transitively get an explicit cafAssert.h. Files
that reach cafAssert.h through another caf header are left unchanged; a missing
include here is a compile error, not a silently disabled assert.

ResultStatisticsCache links only LibCore and therefore had no path to
cafAssert.h. Add the cafPdmCore directory as a private include path rather than
linking the library, since cafAssert.h is header only.

Note that this stops these asserts from firing in Release and RelWithDebInfo,
where CVF_ASSERT was previously active.
2026-08-07 15:05:57 +02:00

438 lines
22 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 "RimEclipseStatisticsCaseEvaluator.h"
#include "RiaLogging.h"
#include "RigActiveCellInfo.h"
#include "RigCaseCellResultsData.h"
#include "RigEclipseCaseData.h"
#include "RigEclipseResultInfo.h"
#include "RigMainGrid.h"
#include "RigResultAccessorFactory.h"
#include "RigResultModifier.h"
#include "RigResultModifierFactory.h"
#include "RigStatisticsMath.h"
#include "RimEclipseView.h"
#include "RimReservoirCellResultsStorage.h"
#include "cafProgressInfo.h"
#include <algorithm>
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimEclipseStatisticsCaseEvaluator::addNamedResult( RigCaseCellResultsData* destinationCellResults,
RiaDefines::ResultCatType resultType,
const QString& resultName,
size_t activeUnionCellCount )
{
// Use time step dates from first result in first source case
CAF_ASSERT( !m_sourceCases.empty() );
std::vector<RigEclipseResultAddress> resAddresses =
m_sourceCases[0]->results( RiaDefines::PorosityModelType::MATRIX_MODEL )->existingResults();
std::vector<RigEclipseTimeStepInfo> sourceTimeStepInfos =
m_sourceCases[0]->results( RiaDefines::PorosityModelType::MATRIX_MODEL )->timeStepInfos( resAddresses[0] );
RigEclipseResultAddress resAddr( resultType, resultName );
destinationCellResults->createResultEntry( resAddr, true );
destinationCellResults->setTimeStepInfos( resAddr, sourceTimeStepInfos );
std::vector<std::vector<double>>* dataValues = destinationCellResults->modifiableCellScalarResultTimesteps( resAddr );
size_t timeStepCount = std::max( size_t( 1 ), sourceTimeStepInfos.size() );
// Limit to one time step for static native results
if ( resultType == RiaDefines::ResultCatType::STATIC_NATIVE ) timeStepCount = 1;
dataValues->resize( timeStepCount );
// Initializes the size of the destination dataset to active union cell count
for ( size_t i = 0; i < timeStepCount; i++ )
{
dataValues->at( i ).resize( activeUnionCellCount, HUGE_VAL );
}
}
QString createResultNameMin( const QString& resultName )
{
return resultName + "_MIN";
}
QString createResultNameMax( const QString& resultName )
{
return resultName + "_MAX";
}
QString createResultNameSum( const QString& resultName )
{
return resultName + "_SUM";
}
QString createResultNameMean( const QString& resultName )
{
return resultName + "_MEAN";
}
QString createResultNameDev( const QString& resultName )
{
return resultName + "_DEV";
}
QString createResultNameRange( const QString& resultName )
{
return resultName + "_RANGE";
}
QString createResultNamePVal( const QString& resultName, double pValPos )
{
return resultName + "_P" + QString::number( pValPos );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimEclipseStatisticsCaseEvaluator::evaluateForResults( const QList<ResSpec>& resultSpecification, RimEclipseView* filterView )
{
CAF_ASSERT( m_destinationCase );
// First build the destination result data structures to receive the statistics
addNamedResults( resultSpecification );
// Start the loop that calculates the statistics
caf::ProgressInfo progressInfo( m_timeStepIndices.size(), "Computing Statistics" );
for ( size_t timeIndicesIdx = 0; timeIndicesIdx < m_timeStepIndices.size(); timeIndicesIdx++ )
{
auto timeStepIdx = m_timeStepIndices[timeIndicesIdx];
for ( size_t gridIdx = 0; gridIdx < m_destinationCase->gridCount(); gridIdx++ )
{
RigGridBase* grid = m_destinationCase->grid( gridIdx );
for ( const auto& resSpec : resultSpecification )
{
RiaDefines::PorosityModelType poroModel = resSpec.m_poroModel;
RiaDefines::ResultCatType resultType = resSpec.m_resType;
QString resultName = resSpec.m_resVarName;
size_t activeCellCount = m_destinationCase->activeCellInfo( poroModel )->reservoirActiveCellCount();
if ( activeCellCount == 0 ) continue;
auto dataAccessTimeStepIndex = static_cast<size_t>( timeStepIdx );
// Always evaluate statistics once, and always use time step index zero
if ( resultType == RiaDefines::ResultCatType::STATIC_NATIVE )
{
if ( timeIndicesIdx > 0 ) continue;
dataAccessTimeStepIndex = 0;
}
// Build data access objects for source scalar results
cvf::Collection<RigResultAccessor> sourceDataAccessList;
for ( RimEclipseCase* sourceCase : m_sourceCases )
{
// Trigger loading of dataset
// NB! Many other functions are based on loading of all time steps at the same time
// Use this concept carefully
sourceCase->results( poroModel )
->findOrLoadKnownScalarResultForTimeStep( RigEclipseResultAddress( resultType, resultName ), dataAccessTimeStepIndex );
cvf::ref<RigResultAccessor> resultAccessor =
RigResultAccessorFactory::createFromResultAddress( sourceCase->eclipseCaseData(),
gridIdx,
poroModel,
dataAccessTimeStepIndex,
RigEclipseResultAddress( resultType, resultName ) );
if ( resultAccessor.notNull() )
{
sourceDataAccessList.push_back( resultAccessor.p() );
}
}
// Build data access objects for destination scalar results
// Find the created result container, if any, and put its resultAccessor into the enum indexed
// destination collection
cvf::Collection<RigResultModifier> destinationDataAccessList;
std::vector<QString> statisticalResultNames( STAT_PARAM_COUNT );
statisticalResultNames[MIN] = createResultNameMin( resultName );
statisticalResultNames[MAX] = createResultNameMax( resultName );
statisticalResultNames[SUM] = createResultNameSum( resultName );
statisticalResultNames[RANGE] = createResultNameRange( resultName );
statisticalResultNames[MEAN] = createResultNameMean( resultName );
statisticalResultNames[STDEV] = createResultNameDev( resultName );
statisticalResultNames[PMIN] = createResultNamePVal( resultName, m_statisticsConfig.m_pMinPos );
statisticalResultNames[PMID] = createResultNamePVal( resultName, m_statisticsConfig.m_pMidPos );
statisticalResultNames[PMAX] = createResultNamePVal( resultName, m_statisticsConfig.m_pMaxPos );
for ( const auto& statisticalResultName : statisticalResultNames )
{
cvf::ref<RigResultModifier> resultModifier =
RigResultModifierFactory::createResultModifier( m_destinationCase,
grid->gridIndex(),
poroModel,
dataAccessTimeStepIndex,
RigEclipseResultAddress( resultType, statisticalResultName ) );
destinationDataAccessList.push_back( resultModifier.p() );
}
std::vector<double> statParams( STAT_PARAM_COUNT, HUGE_VAL );
std::vector<double> values( sourceDataAccessList.size(), HUGE_VAL );
auto cellCount = static_cast<int>( grid->cellCount() );
cvf::ref<cvf::UByteArray> visibility;
if ( filterView )
{
visibility = filterView->currentTotalCellVisibility();
}
auto destinationActiveCellInfo = m_destinationCase->activeCellInfo( poroModel );
auto unionActiveCells = ( poroModel == RiaDefines::PorosityModelType::MATRIX_MODEL ) ? m_unionOfMatrixActiveCells
: m_unionOfFractureActiveCells;
// Loop over the cells in the grid, get the case values, and calculate the cell statistics
#pragma omp parallel for schedule( dynamic ) firstprivate( statParams, values )
for ( int cellIdx = 0; cellIdx < cellCount; cellIdx++ )
{
size_t reservoirCellIndex = grid->reservoirCellIndex( cellIdx );
if ( visibility.notNull() && !visibility->val( reservoirCellIndex ) ) continue;
if ( destinationActiveCellInfo->isActive( ReservoirCellIndex( reservoirCellIndex ) ) )
{
// Extract the cell values from each of the cases and assemble them into one vector
bool foundAnyValidValues = false;
for ( size_t caseIdx = 0; caseIdx < sourceDataAccessList.size(); caseIdx++ )
{
double val = sourceDataAccessList.at( caseIdx )->cellScalar( cellIdx );
// Replace huge_val with zero in the statistical computation for the following case
if ( m_useZeroAsInactiveCellValue || resultName.toUpper() == "ACTNUM" )
{
if ( unionActiveCells && unionActiveCells->isActive( ReservoirCellIndex( reservoirCellIndex ) ) &&
val == HUGE_VAL )
{
val = 0.0;
}
}
values[caseIdx] = val;
if ( val != HUGE_VAL )
{
foundAnyValidValues = true;
}
}
// Do the real statistics calculations
if ( foundAnyValidValues )
{
RigStatisticsMath::calculateBasicStatistics( values,
&statParams[MIN],
&statParams[MAX],
&statParams[SUM],
&statParams[RANGE],
&statParams[MEAN],
&statParams[STDEV] );
// Calculate percentiles
if ( m_statisticsConfig.m_calculatePercentiles )
{
if ( m_statisticsConfig.m_pValMethod == RimEclipseStatisticsCase::PercentileCalcType::NEAREST_OBSERVATION )
{
std::vector<double> pValPoss;
pValPoss.push_back( m_statisticsConfig.m_pMinPos );
pValPoss.push_back( m_statisticsConfig.m_pMidPos );
pValPoss.push_back( m_statisticsConfig.m_pMaxPos );
auto resultValues =
RigStatisticsMath::calculateNearestRankPercentiles( values,
pValPoss,
RigStatisticsMath::PercentileStyle::SWITCHED );
if ( resultValues.has_value() )
{
statParams[PMIN] = ( *resultValues )[0];
statParams[PMID] = ( *resultValues )[1];
statParams[PMAX] = ( *resultValues )[2];
}
else
{
RiaLogging::warning( resultValues.error() );
}
}
else if ( m_statisticsConfig.m_pValMethod == RimEclipseStatisticsCase::PercentileCalcType::HISTOGRAM_ESTIMATED )
{
std::vector<size_t> histogram;
RigHistogramCalculator histCalc( statParams[MIN], statParams[MAX], 100, &histogram );
histCalc.addData( values );
statParams[PMIN] = histCalc.calculatePercentil( m_statisticsConfig.m_pMinPos / 100.0,
RigStatisticsMath::PercentileStyle::SWITCHED );
statParams[PMID] = histCalc.calculatePercentil( m_statisticsConfig.m_pMidPos / 100.0,
RigStatisticsMath::PercentileStyle::SWITCHED );
statParams[PMAX] = histCalc.calculatePercentil( m_statisticsConfig.m_pMaxPos / 100.0,
RigStatisticsMath::PercentileStyle::SWITCHED );
}
else if ( m_statisticsConfig.m_pValMethod ==
RimEclipseStatisticsCase::PercentileCalcType::INTERPOLATED_OBSERVATION )
{
std::vector<double> percentiles;
percentiles.push_back( m_statisticsConfig.m_pMinPos );
percentiles.push_back( m_statisticsConfig.m_pMidPos );
percentiles.push_back( m_statisticsConfig.m_pMaxPos );
auto resultValues =
RigStatisticsMath::calculateInterpolatedPercentiles( values,
percentiles,
RigStatisticsMath::PercentileStyle::SWITCHED );
if ( resultValues.has_value() )
{
statParams[PMIN] = ( *resultValues )[0];
statParams[PMID] = ( *resultValues )[1];
statParams[PMAX] = ( *resultValues )[2];
}
else
{
RiaLogging::warning( resultValues.error() );
}
}
else
{
CAF_ASSERT( false );
}
}
}
// Set the results into the results data structures
for ( size_t stIdx = 0; stIdx < statParams.size(); ++stIdx )
{
if ( destinationDataAccessList[stIdx].notNull() )
{
destinationDataAccessList[stIdx]->setCellScalar( cellIdx, statParams[stIdx] );
}
}
}
}
}
}
// When one time step is completed, free memory and clean up
// Microsoft note: On Windows, the maximum number of files open at the same time is 512
// http://msdn.microsoft.com/en-us/library/kdfaxaay%28vs.71%29.aspx
std::vector<RiaDefines::ResultCatType> categoriesToExclude;
if ( !m_clearGridCalculationMemory ) categoriesToExclude.push_back( RiaDefines::ResultCatType::GENERATED );
for ( RimEclipseCase* eclipseCase : m_sourceCases )
{
if ( eclipseCase->reservoirViews().empty() )
{
eclipseCase->results( RiaDefines::PorosityModelType::MATRIX_MODEL )->freeAllocatedResultsData( categoriesToExclude, timeStepIdx );
eclipseCase->results( RiaDefines::PorosityModelType::FRACTURE_MODEL )->freeAllocatedResultsData( categoriesToExclude, timeStepIdx );
}
}
progressInfo.setProgress( timeIndicesIdx );
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimEclipseStatisticsCaseEvaluator::addNamedResults( const QList<ResSpec>& resultSpecification )
{
for ( const auto& resSpec : resultSpecification )
{
RiaDefines::PorosityModelType poroModel = resSpec.m_poroModel;
RiaDefines::ResultCatType resultType = resSpec.m_resType;
QString resultName = resSpec.m_resVarName;
size_t activeCellCount = m_destinationCase->activeCellInfo( poroModel )->reservoirActiveCellCount();
if ( activeCellCount == 0 ) continue;
RigCaseCellResultsData* destCellResultsData = m_destinationCase->results( poroModel );
// Placeholder data used to be created here,
// this is now moved to RimIdenticalGridCaseGroup::loadMainCaseAndActiveCellInfo()
// Create new result data structures to contain the statistical values
std::vector<QString> statisticalResultNames;
statisticalResultNames.push_back( createResultNameMean( resultName ) );
statisticalResultNames.push_back( createResultNameMin( resultName ) );
statisticalResultNames.push_back( createResultNameMax( resultName ) );
statisticalResultNames.push_back( createResultNameSum( resultName ) );
statisticalResultNames.push_back( createResultNameDev( resultName ) );
statisticalResultNames.push_back( createResultNameRange( resultName ) );
if ( m_statisticsConfig.m_calculatePercentiles )
{
statisticalResultNames.push_back( createResultNamePVal( resultName, m_statisticsConfig.m_pMinPos ) );
statisticalResultNames.push_back( createResultNamePVal( resultName, m_statisticsConfig.m_pMidPos ) );
statisticalResultNames.push_back( createResultNamePVal( resultName, m_statisticsConfig.m_pMaxPos ) );
}
for ( const auto& statisticalResultName : statisticalResultNames )
{
addNamedResult( destCellResultsData, resultType, statisticalResultName, activeCellCount );
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimEclipseStatisticsCaseEvaluator::RimEclipseStatisticsCaseEvaluator( const std::vector<RimEclipseCase*>& sourceCases,
const std::vector<int>& timeStepIndices,
const RimStatisticsConfig& statisticsConfig,
RigEclipseCaseData* destinationCase,
RigActiveCellInfo* unionOfMatrixActiveCells,
RigActiveCellInfo* unionOfFractureActiveCells,
bool clearGridCalculationMemory )
: m_sourceCases( sourceCases )
, m_statisticsConfig( statisticsConfig )
, m_destinationCase( destinationCase )
, m_reservoirCellCount( 0 )
, m_timeStepIndices( timeStepIndices )
, m_unionOfMatrixActiveCells( unionOfMatrixActiveCells )
, m_unionOfFractureActiveCells( unionOfFractureActiveCells )
, m_useZeroAsInactiveCellValue( false )
, m_clearGridCalculationMemory( clearGridCalculationMemory )
{
if ( !sourceCases.empty() )
{
m_reservoirCellCount = sourceCases[0]->eclipseCaseData()->mainGrid()->totalCellCount();
}
CAF_ASSERT( m_destinationCase );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimEclipseStatisticsCaseEvaluator::useZeroAsValueForInActiveCellsBasedOnUnionOfActiveCells()
{
m_useZeroAsInactiveCellValue = true;
}