Files
ResInsight/ApplicationLibCode/ProjectDataModelCommands/RimcEclipseCase.h
T
Kristian Bendiksen ddcfef736b Python: Add filtered_cells API for evaluating a data filter on a case
Adds case.filtered_cells(filter, time_step, grid_index) which applies any
RimCellFilter to an Eclipse case and returns a per-cell 0/1 mask. The mask
length and ordering match case.grid_property(..., grid_index), so callers
can combine the two vectors element-wise.

Implemented as a scriptable Rimc method (PdmVoidObjectMethod) on
RimEclipseCase that writes the mask via the existing key-value store, with
a thin Python wrapper mirroring the visible_cells() pattern. No proto or
gRPC service changes.
2026-05-15 08:37:46 +02:00

140 lines
4.8 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2020- Equinor 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.
//
/////////////////////////////////////////////////////////////////////////////////
#pragma once
#include "cafPdmField.h"
#include "cafPdmObjectHandle.h"
#include "cafPdmObjectMethod.h"
#include "cafPdmPtrField.h"
#include <QString>
class RimCellFilter;
//==================================================================================================
///
//==================================================================================================
class RimcEclipseCase_importProperties : public caf::PdmObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcEclipseCase_importProperties( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
QString classKeywordReturnedType() const override;
private:
caf::PdmField<std::vector<QString>> m_fileNames;
};
//==================================================================================================
///
//==================================================================================================
class RimcEclipseCase_exportValuesInternal : public caf::PdmVoidObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcEclipseCase_exportValuesInternal( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
private:
caf::PdmField<QString> m_coordinateX;
caf::PdmField<QString> m_coordinateY;
caf::PdmField<QString> m_coordinateZ;
caf::PdmField<QString> m_propertyType;
caf::PdmField<QString> m_propertyName;
caf::PdmField<int> m_timeStep;
caf::PdmField<QString> m_porosityModel;
caf::PdmField<QString> m_resultKey;
};
//==================================================================================================
///
//==================================================================================================
class RimcEclipseCase_exportCornerPointGridInternal : public caf::PdmVoidObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcEclipseCase_exportCornerPointGridInternal( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
private:
caf::PdmField<QString> m_zcornKey;
caf::PdmField<QString> m_coordKey;
caf::PdmField<QString> m_actnumKey;
};
//==================================================================================================
///
//==================================================================================================
class RimcEclipseCase_addResultAlias : public caf::PdmVoidObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcEclipseCase_addResultAlias( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
private:
caf::PdmField<QString> m_resultName;
caf::PdmField<QString> m_aliasName;
};
//==================================================================================================
///
//==================================================================================================
class RimcEclipseCase_clearResultAliases : public caf::PdmVoidObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcEclipseCase_clearResultAliases( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
};
//==================================================================================================
/// Apply a cell filter to this case for a given grid + time step and write a per-cell 0/1 mask
/// (1 = passes the filter, 0 = filtered out) to the key-value store under m_maskKey. The vector
/// length and ordering match case.grid_property(..., grid_index) so the two can be combined
/// element-wise.
//==================================================================================================
class RimcEclipseCase_filteredCellsInternal : public caf::PdmVoidObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimcEclipseCase_filteredCellsInternal( caf::PdmObjectHandle* self );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
private:
caf::PdmPtrField<RimCellFilter*> m_filter;
caf::PdmField<QString> m_maskKey;
caf::PdmField<int> m_timeStep;
caf::PdmField<int> m_gridIndex;
};