Export to OPM Flow #155

djmaxus · 2025-11-19T11:37:42Z

Closes #156

Instead, just use capillary pressure data from KRNUM. Move `write_mappings` to a new directory with common export functions.

Splits export functions into common and PFLOTRAN-OGS groups. Organizes export-related utilities by separating shared and simulator-specific logic, improving code clarity and maintainability.

Copilot

Pull Request Overview

Copilot reviewed 8 out of 15 changed files in this pull request and generated 7 comments.

Comments suppressed due to low confidence (1)

src/export/common/write_mappings.m:1

The function lacks documentation. Consider adding a help comment block describing:

Purpose of the function
What each parameter represents
What files are generated
Example usage

This would improve maintainability and help users understand how to use the function.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-19T12:30:12Z

src/export/opm_export.m

+    "INCLUDE"
+    "JFUNC.inc /"
+    };
+grid_fid = fopen([output_prefix,'GRID.inc'],'wb','native','UTF-8');


No error handling is performed after fopen. If the file cannot be opened, grid_fid will be -1, and subsequent operations will fail silently. Consider adding error checking or using a helper function with proper error handling.

Copilot · 2025-11-19T12:30:12Z

src/export/opm_export.m

+    strata_trapped.porosity,...
+    strata_trapped.permeability);
+
+sgwfn_fid = fopen([prefix,'SGWFN.inc'],'wb','native','UTF-8');


No error handling is performed after fopen. If the file cannot be opened, sgwfn_fid will be -1, and subsequent operations will fail silently. Consider adding error checking or using a helper function with proper error handling.

Suggested change

sgwfn_fid = fopen([prefix,'SGWFN.inc'],'wb','native','UTF-8');

sgwfn_fid = fopen([prefix,'SGWFN.inc'],'wb','native','UTF-8');

if sgwfn_fid == -1

error('Failed to open file for writing: %sSGWFN.inc', prefix);

end

Copilot · 2025-11-19T12:30:12Z

src/export/opm_export.m

+function [] = opm_export(strata_trapped, output_folder)
+arguments
+    strata_trapped (1,1) struct
+    output_folder  char   = 'opm'
+end


The function lacks documentation. Consider adding a help comment block describing:

Purpose of the function

Expected structure/fields of strata_trapped parameter

Description of the output_folder parameter

What files are generated and their purpose

Example usage

This would improve maintainability and help users understand how to use the function.

Copilot · 2025-11-19T12:30:13Z

src/export/opm_export.m

+dir_label = ['X','Y','Z'];
+for cell_index = 1:length(idx)
+    sw = saturations;
+    sg = 1 - sw;
+    krg_cell = squeeze(krg(cell_index,direction,:))';
+    krw_cell  = squeeze(krw(cell_index,direction,:))';
+    jfunc = leverett_j(cell_index,:);
+    data = [sg;krg_cell;krw_cell;jfunc];
+    data = data(:,end:-1:1);
+
+    fprintf(file_id,'%e\t%e\t%e\t%e\n',data);
+    fprintf(file_id,'/ -- KRNUM%s cell %u\n',dir_label(direction),idx(cell_index));
+end
+end


This function write_tables_for_direction has significant code duplication with a similarly named function in src/export/ogs/generate_sfn.m (lines 28-59). Both functions iterate over cells, format relative permeability data, and write tables. Consider refactoring common logic into a shared utility function to improve maintainability and reduce duplication.

Suggested change

dir_label = ['X','Y','Z'];

for cell_index = 1:length(idx)

sw = saturations;

sg = 1 - sw;

krg_cell = squeeze(krg(cell_index,direction,:))';

krw_cell = squeeze(krw(cell_index,direction,:))';

jfunc = leverett_j(cell_index,:);

data = [sg;krg_cell;krw_cell;jfunc];

data = data(:,end:-1:1);

fprintf(file_id,'%e\t%e\t%e\t%e\n',data);

fprintf(file_id,'/ -- KRNUM%s cell %u\n',dir_label(direction),idx(cell_index));

end

end

dir_label = ['X','Y','Z'];

write_rel_perm_table(file_id, idx, krw, krg, saturations, leverett_j, direction, dir_label);

end

function write_rel_perm_table(file_id, idx, krw, krg, saturations, leverett_j, direction, dir_label)

for cell_index = 1:length(idx)

sw = saturations;

sg = 1 - sw;

krg_cell = squeeze(krg(cell_index,direction,:))';

krw_cell = squeeze(krw(cell_index,direction,:))';

jfunc = leverett_j(cell_index,:);

data = [sg;krg_cell;krw_cell;jfunc];

data = data(:,end:-1:1);

fprintf(file_id,'%e\t%e\t%e\t%e\n',data);

fprintf(file_id,'/ -- KRNUM%s cell %u\n',dir_label(direction),idx(cell_index));

end

end

Copilot · 2025-11-19T12:30:13Z

src/export/opm_export.m

+mult = strata_trapped.params.cap_pressure.mult / (dyne / centi / meter);
+jfunc_line = sprintf("'WATER' 0.0 %f * * XY /", mult); % TODO: generalize 'XY'
+jfunc_str = {"JFUNC",jfunc_line};
+jfunc_fid = fopen([output_prefix,'JFUNC.inc'],'wb','native','UTF-8');


No error handling is performed after fopen. If the file cannot be opened, jfunc_fid will be -1, and subsequent operations will fail silently. Consider adding error checking or using a helper function with proper error handling.

Copilot · 2025-11-19T12:30:13Z

src/export/opm_export.m

+    "INCLUDE"
+    "KRNUMZ.inc /"
+    };
+regions_fid = fopen([output_prefix,'REGIONS.inc'],'wb','native','UTF-8');


No error handling is performed after fopen. If the file cannot be opened, regions_fid will be -1, and subsequent operations will fail silently. Consider adding error checking or using a helper function with proper error handling.

Suggested change

regions_fid = fopen([output_prefix,'REGIONS.inc'],'wb','native','UTF-8');

regions_fid = fopen([output_prefix,'REGIONS.inc'],'wb','native','UTF-8');

if regions_fid == -1

error('Failed to open file: %s', [output_prefix,'REGIONS.inc']);

end

Copilot · 2025-11-19T12:30:14Z

src/Params.m

                params.cap_pressure.leverett_j.func(sw));
            fclose(chc_file);
        end
+


The new export_opm function lacks documentation. Consider adding a comment block describing:

Purpose of the function

What the sw parameter represents

What format/structure the returned string has

How it differs from export_ogs

This would improve maintainability and help users understand how to use the function.

Suggested change

% EXPORT_OPM Export saturation/relative permeability/capillary pressure data in OPM format.

%

% Parameters:

% params - Params object containing krw, krg, and cap_pressure properties.

% sw - Vector of water saturation values (fractional, between 0 and 1).

%

% Returns:

% export_str - String with tab-separated columns: sg, krg, krw, jfunc (one row per sw value).

%

% Differences from export_ogs:

% - Returns a formatted string instead of writing to a file.

% - Uses OPM format: columns are sg, krg, krw, jfunc, tab-separated.

djmaxus self-assigned this Nov 19, 2025

Copilot AI review requested due to automatic review settings November 19, 2025 11:37

djmaxus added bug Something isn't working feature Adding a new functionality, small or large labels Nov 19, 2025

Copilot started reviewing on behalf of djmaxus November 19, 2025 11:38 View session

fix: 🦺 ensure non-negative upscaled permeability

fb52b4a

Copilot finished reviewing on behalf of djmaxus November 19, 2025 11:42

This comment was marked as outdated.

Sign in to view

djmaxus added 2 commits November 19, 2025 12:46

fix(export): 🔥 do not export SATNUM

5fa2410

Instead, just use capillary pressure data from KRNUM. Move `write_mappings` to a new directory with common export functions.

chore(export): 🚚 split functions into common and simulator-specific

793e653

Splits export functions into common and PFLOTRAN-OGS groups. Organizes export-related utilities by separating shared and simulator-specific logic, improving code clarity and maintainability.

djmaxus force-pushed the export-opm-flow branch from e0fa030 to 45e4495 Compare November 19, 2025 12:05

djmaxus linked an issue Nov 19, 2025 that may be closed by this pull request

Export to OPM Flow #156

Closed

djmaxus requested a review from Copilot November 19, 2025 12:07

Copilot started reviewing on behalf of djmaxus November 19, 2025 12:07 View session

Copilot finished reviewing on behalf of djmaxus November 19, 2025 12:11

This comment was marked as outdated.

Sign in to view

djmaxus added 5 commits November 19, 2025 13:16

fix(export): 🩹 ogs_export exports to ogs/ by default

44e67c4

feat(export): ✨ export to OPM Flow simulator

9ced576

chore: 🙈 ignore default export directories

5aedcdd

chore: 🙈 gitignore OS-specific files

88d77a8

test(export): ✅ export to OPM in demo

541cbd8

djmaxus force-pushed the export-opm-flow branch from 45e4495 to da7976b Compare November 19, 2025 12:17

docs: 📝 update README to include OPM Flow export functionality

65e4572

djmaxus force-pushed the export-opm-flow branch from da7976b to 65e4572 Compare November 19, 2025 12:18

djmaxus requested a review from Copilot November 19, 2025 12:24

Copilot started reviewing on behalf of djmaxus November 19, 2025 12:24 View session

Copilot finished reviewing on behalf of djmaxus November 19, 2025 12:28

djmaxus merged commit 5d840f7 into main Nov 19, 2025
15 checks passed

djmaxus deleted the export-opm-flow branch November 19, 2025 12:30

Copilot AI reviewed Nov 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Export to OPM Flow #155

Export to OPM Flow #155

Uh oh!

djmaxus commented Nov 19, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

+        % EXPORT_OPM Export saturation/relative permeability/capillary pressure data in OPM format.
+        %
+        % Parameters:
+        %   params - Params object containing krw, krg, and cap_pressure properties.
+        %   sw     - Vector of water saturation values (fractional, between 0 and 1).
+        %
+        % Returns:
+        %   export_str - String with tab-separated columns: sg, krg, krw, jfunc (one row per sw value).
+        %
+        % Differences from export_ogs:
+        %   - Returns a formatted string instead of writing to a file.
+        %   - Uses OPM format: columns are sg, krg, krw, jfunc, tab-separated.

Export to OPM Flow #155

Export to OPM Flow #155

Uh oh!

Conversation

djmaxus commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

djmaxus commented Nov 19, 2025 •

edited

Loading