Reduce dependency on Rim objects from Rif objects

[magnesj]

Description

Rif (file I/O) objects currently have direct dependencies on Rim (PDM model) objects, creating unwanted coupling between the data layer and the model layer. The goal is to decouple Rif classes so they work with plain data structs or Rig (data) objects instead of Rim (model) objects.

General rule: If a Rif function only reads data from a Rim object to produce output, it should accept a plain struct. If a Rif function returns data that Rim will consume, it should return a plain struct. Rim is responsible for the translation at both ends.

Current State

21 Rif files include Rim headers, grouped into 5 coupling patterns:

Group	Files	Pattern	Fix
A — Exporters	RifStimPlanModel*Exporter (4), RifThermalFracture* (2), RifEventKeywordFormatter, RifWellIAFileWriter	Receive Rim*, call property getters only	Extract data to plain struct in Rim caller
B — Readers creating Rim objects	RifParameterXmlReader, RifInputPropertyLoader, RifEclipseInputPropertyLoader	Parse files and directly create/populate Rim objects	Return intermediate plain struct; Rim layer converts
C — Pass Rig directly	RifReaderRegularGridModel, RifRoffFileTools, RifReaderEnsembleStatisticsRft	Receive Rim objects but only need underlying Rig data	Change signatures to accept Rig types directly
D — Stored Rim pointers	RifDataSourceForRftPlt	Stores caf::PdmPointer<Rim*> for 6+ types	Replace with plain struct { SourceType, caseId, name, filePath }
E — Dynamic cast	RifMultipleSummaryReaders	Uses dynamic_cast<RimCalculatedSummaryCurveReader*>	Add virtual isCalculated() to reader interface

Steps

Group A — Exporters: extract data structs (highest impact)

• A1 RifStimPlanModelAsymmetricFrkExporter: extract { formationDip, hasBarrier, distanceToBarrier, barrierDip, wellPenetrationLayer } into struct; update caller
• A2 RifStimPlanModelDeviationFrkExporter: pass computed depth vectors instead of RimStimPlanModel* / RimWellPath*
• A3 RifStimPlanModelPerfsFrkExporter: extract { fractureOrientation, perforationLength, anchorPosition } into struct; update caller
• A4 RifStimPlanModelGeologicalFrkExporter: create StimPlanGeologicalExportData struct populated by calculator in Rim layer
• A5 RifStimPlanModelExporter: orchestrator — extract all sub-exporter inputs into structs; update dispatcher
• A6 RifThermalFractureTemplateSurfaceExporter: pass RigThermalFractureDefinition* directly instead of RimThermalFractureTemplate*
• A7 RifThermalToStimPlanFractureXmlOutput: extract { fractureGrid, resultNames, resultValues, timeStepIndex } into struct
• A8 RifEventKeywordFormatter: create RifWellEventData POD struct; Rim layer populates it from RimWellEvent* before calling formatter
• A9 RifWellIAFileWriter: extract { outputDir, parameters, modelBoxVertices } into struct; update caller in Rim layer

Group B — Readers: intermediate data model

• B1 RifParameterXmlReader: return std::vector<RifParameterDefinition> instead of creating Rim objects; add factory in Rim layer
• B2 RifInputPropertyLoader: return property metadata structs; move Rim collection insertion to caller
• B3 RifEclipseInputPropertyLoader: pass RigEclipseCaseData* and metadata directly; remove Rim property creation

Group C — Pass Rig objects directly

• C1 RifReaderRegularGridModel: change signature to accept RigEclipseCaseData* instead of RimEclipseCase*
• C2 RifRoffFileTools: pass RigEclipseCaseData* and color legend collection directly; remove RimProject::current() singleton access
• C3 RifReaderEnsembleStatisticsRft: pass vector of RFT reader interfaces instead of RimSummaryEnsemble*

Group D — RifDataSourceForRftPlt

• D1 Replace caf::PdmPointer<Rim*> members with plain struct { SourceType type; int caseId; QString name; QString filePath; }; update all callers

Group E — Dynamic cast fix (minimal)

• E1 RifMultipleSummaryReaders: add virtual isCalculated() to reader interface; remove dynamic_cast and Rim include

Links

• Upstream issue: Fails to build on Red Hat 5 OPM/ResInsight#11 (reference architecture)
• Source files: ApplicationLibCode/FileInterface/
• Related: Reduce dependency on Rim objects from Rif objects #855

[magnesj]

graph TD
    subgraph Rim["Rim Layer (PDM Model)"]
        RimCaller["Rim caller\n(e.g. RimStimPlanModel)"]
        RimFactory["Rim factory\n(converts struct → Rim object)"]
    end

    subgraph Struct["Plain Data Structs (new)"]
        ExportStruct["ExportData struct\n{ primitives, enums, vectors }"]
        ImportStruct["ImportData struct\n{ parsed metadata }"]
    end

    subgraph Rif["Rif Layer (File I/O)"]
        RifExporter["Rif Exporter\nexport(ExportData)"]
        RifReader["Rif Reader\nreturns ImportData"]
    end

    subgraph Rig["Rig Layer (Data)"]
        RigData["RigEclipseCaseData\nRigWellPath\nRigThermalFractureDefinition"]
    end

    RimCaller -->|"extracts fields into"| ExportStruct
    ExportStruct -->|"passed to"| RifExporter
    RifReader -->|"returns"| ImportStruct
    ImportStruct -->|"converted by"| RimFactory
    RifExporter -.->|"may use"| RigData
    RimCaller -.->|"may pass"| RigData

Loading

The current architecture has Rif objects reaching up into the Rim layer (bad coupling direction). After refactoring, data flows through plain structs: Rim extracts what exporters need, and readers return plain structs that Rim converts into PDM objects. Rif may still reference Rig (data) objects since those are lower-level than Rim.

[magnesj]

E1 done (commit 920ed40): Added virtual method to , overridden in . Replaced checks in and removed the include.

[magnesj]

Progress update — committed changes:

Done:

• E1 (920ed40): RifMultipleSummaryReaders — replaced dynamic_cast with virtual isCalculated()
• A6 (a85381f): RifThermalFractureTemplateSurfaceExporter — pass RigThermalFractureDefinition directly
• A1-A3+A5 (10f2609): StimPlan FRK exporters — removed RimStimPlanModel from Asymmetric/Deviation/Perfs exporters; orchestrator now extracts data
• C1 (0be98b0): RifReaderRegularGridModel — pass RigCaseCellResultsData and RigEclipseCaseData directly
• C3 (da8409c): RifReaderEnsembleStatisticsRft — store pre-collected RifReaderRftInterface* vector instead of RimSummaryEnsemble*

Deferred (too complex for minimal-diff approach):

• A4: GeologicalFrkExporter — 15+ calculator method calls; would require large data struct
• A7: ThermalToStimPlanFractureXmlOutput — createFractureGrid is a computation on Rim object
• A8: EventKeywordFormatter — Rim event object hierarchy, needs intermediate event structs
• A9: WellIAFileWriter — deep coupling to RimWellIASettings hierarchy
• B1-B3: Parameter readers — would require new intermediate data model layer and Rim factory
• C2: RifRoffFileTools — color legend creation interleaved with import; behavior change risk
• D1: RifDataSourceForRftPlt — large data-holder with many callers