Add grid properties

[dafeda]

Issue
Resolves #10909

Example of usage via API

from ert.storage import open_storage

storage_path = "/Users/FCUR/git/ert/test-data/ert/heat_equation/storage"
experiment_name = "ensemble_experiment"
with open_storage(storage_path, "r") as storage:
    experiment = storage.get_experiment_by_name(experiment_name)

experiment.parameter_configuration["COND"]

Field(type='field', name='COND', forward_init=True, update=True, nx=10, ny=10, nz=1, xlength=10.0, ylength=10.0, xinc=1.0, yinc=1.0, rotation_angle=0.0, origin=(6.123233998228043e-16, 10.0), file_format=<FieldFileFormat.BGRDECL: 'bgrdecl'>, output_transformation=None, input_transformation=None, truncation_min=None, truncation_max=None, forward_init_file='cond.bgrdecl', output_file=PosixPath('cond.bgrdecl'), grid_file='/Users/FCUR/git/ert/test-data/ert/heat_equation/CASE.EGRID', mask_file=PosixPath('/Users/FCUR/git/ert/test-data/ert/heat_equation/storage/experiments/f094b1d1-de8d-4dff-aaa3-2503bd2626d1/grid_mask.npy'))

Performance (ran locally on my mac)

Drogon (approx 900k parameters):

Time to load grid and calculate ertbox params: 0.0660250186920166s
ErtboxParameters(nx=92, ny=146, nz=66, xlength=92.0, ylength=146.0, xinc=1.0, yinc=1.0, rotation_angle=0.0, origin=(0.0, 146.0))

10mill parameters:
Time to load grid and calculate ertbox params: 1.0769238471984863s
ErtboxParameters(nx=1000, ny=100, nz=100, xlength=1000.0, ylength=100.0, xinc=1.0, yinc=1.0, rotation_angle=0.0, origin=(0.0, 100.0))

• PR title captures the intent of the changes, and is fitting for release notes.
• Added appropriate release note label
• Commit history is consistent and clean, in line with the contribution guidelines.
• Make sure unit tests pass locally after every commit (git rebase -i main --exec 'just rapid-tests')

When applicable

• When there are user facing changes: Updated documentation
• New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
• Large PR: Prepare changes in small commits for more convenient review
• Bug fix: Add regression test for the bug
• Bug fix: Add backport label to latest release (format: 'backport release-branch-name')

[codspeed-hq]

CodSpeed Performance Report

Merging #11851 will not alter performance

_{Comparing dafeda:add-grid-properties (f6b566e) with main (f7c488d)¹}

Summary

✅ 22 untouched

Footnotes

1. No successful run was found on main (c2a7edc) during the generation of this report, so f7c488d was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

[xjules]

Could maybe all this grid relates parsing and loading be in the field config as classmethods?

[xjules]

you can move this assert before line == 128 and just do assert global_grid_file_path is not None

[xjules]

Could these 2 asserts be removed now?

[dafeda]

I think I still need both asserts.

[xjules]

I have a very naive question :) The cells start with (1,1,1) and not (0,0,0) ?

[dafeda]

It's best if @oddvarlia answers this I think.

[xjules]

Suggestion with vectorize approach:

coords = [np.array(grid.get_xyz_cell_corners(ijk=idx, activeonly=False)).reshape(8, 3)
          for idx in corner_indices]
if left_handed:
    origin = coords[0][0, :2] 
    xdir   = coords[1][1, :2] 
    ydir   = coords[2][2, :2] 
else:
    origin = coords[0][2, :2]
    xdir   = coords[1][3, :2]
    ydir   = coords[2][0, :2]

xlength = np.linalg.norm(xdir - origin)
ylength = np.linalg.norm(ydir - origin)
xinc = xlength / nx
yinc = ylength / ny

[xjules]

Nice PR @dafeda !
As discussed about the commit message content:

• localization params introduction via xtgeo (more verbose) and it's called ertbox
• maybe something on ertbox?
• storage migration to14 with some test modification