mirror of
https://github.com/OPM/ResInsight.git
synced 2026-08-27 05:37:21 -05:00
Lets a script attach a cell filter to a RimPerforationInterval as a typed reference so subsequent work can gate completion-export connections by the filter's cell mask. Pure metadata in this commit: no consumer of RimPerforationInterval is modified, the field exists purely as an API surface. Add a non-scriptable caf::PdmPtrField<RimCellFilter*> m_cellFilter to RimPerforationInterval with public cellFilter()/setCellFilter() accessors and a "Cell Filter" group in the property panel between the existing geometry/flow group and the Date Settings group. The field is deliberately non-scriptable: a scriptable PdmPtrField round-trips in Python as an opaque "ClassName:0xADDR" string rather than a resolved object, defeating the point. Two CAF object methods on RimcPerforationInterval expose the relationship: - AddFilter (perf.add_filter(filter)) sets the pointer; replaces any existing filter (single filter per perforation). - cell_filter (perf.cell_filter()) resolves to the referenced RimCellFilter object on read, mirroring the valve.template() pattern. Composition stays in RimCombinedFilter: a script that wants AND/OR across multiple filters attaches a combined filter as the single filter on the perforation. The Python example in PythonExamples builds a case-level AND combined filter (PERMX 100..20000 AND K=5..10), creates a modeled well path with two perforation intervals, and shares the same filter between them. test_perforation_filter.py covers single-set, replace-on-second- add, and shared-pointer round-trips.
80 lines
2.9 KiB
C++
80 lines
2.9 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2025- 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 RimValveTemplate;
|
|
|
|
//==================================================================================================
|
|
///
|
|
//==================================================================================================
|
|
class RimcPerforationInterval_addValve : public caf::PdmObjectCreationMethod
|
|
{
|
|
CAF_PDM_HEADER_INIT;
|
|
|
|
public:
|
|
RimcPerforationInterval_addValve( caf::PdmObjectHandle* self );
|
|
|
|
std::expected<caf::PdmObjectHandle*, QString> execute() override;
|
|
QString classKeywordReturnedType() const override;
|
|
|
|
private:
|
|
caf::PdmPtrField<RimValveTemplate*> m_template;
|
|
caf::PdmField<double> m_startMd;
|
|
caf::PdmField<double> m_endMd;
|
|
caf::PdmField<int> m_valveCount;
|
|
};
|
|
|
|
//==================================================================================================
|
|
/// Set the cell filter associated with this perforation interval. Replaces any existing filter.
|
|
//==================================================================================================
|
|
class RimcPerforationInterval_addFilter : public caf::PdmVoidObjectMethod
|
|
{
|
|
CAF_PDM_HEADER_INIT;
|
|
|
|
public:
|
|
RimcPerforationInterval_addFilter( caf::PdmObjectHandle* self );
|
|
|
|
std::expected<caf::PdmObjectHandle*, QString> execute() override;
|
|
|
|
private:
|
|
caf::PdmPtrField<RimCellFilter*> m_filter;
|
|
};
|
|
|
|
//==================================================================================================
|
|
/// Returns the cell filter associated with this perforation interval, or null if none.
|
|
//==================================================================================================
|
|
class RimcPerforationInterval_cellFilter : public caf::PdmObjectMethod
|
|
{
|
|
CAF_PDM_HEADER_INIT;
|
|
|
|
public:
|
|
RimcPerforationInterval_cellFilter( caf::PdmObjectHandle* self );
|
|
|
|
std::expected<caf::PdmObjectHandle*, QString> execute() override;
|
|
QString classKeywordReturnedType() const override;
|
|
};
|