|
5 | 5 | <head> |
6 | 6 | <meta charset="utf-8" /> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
8 | | - <title>fmu.tools.nestedhybridgrid.nestedhybrid — fmu-tools 1.33.1.dev1+g31d670618.d20260818 documentation</title> |
| 8 | + <title>fmu.tools.nestedhybridgrid.nestedhybrid — fmu-tools 1.33.1.dev2+g152512869 documentation</title> |
9 | 9 | <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" /> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=9edc463e" /> |
11 | 11 |
|
12 | 12 |
|
13 | 13 | <script src="../../../../_static/jquery.js?v=5d32c60e"></script> |
14 | 14 | <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
15 | | - <script src="../../../../_static/documentation_options.js?v=41707d94"></script> |
| 15 | + <script src="../../../../_static/documentation_options.js?v=e948b068"></script> |
16 | 16 | <script src="../../../../_static/doctools.js?v=9bcbadda"></script> |
17 | 17 | <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script> |
18 | 18 | <script src="../../../../_static/js/theme.js"></script> |
@@ -110,7 +110,7 @@ <h1>Source code for fmu.tools.nestedhybridgrid.nestedhybrid</h1><div class="high |
110 | 110 |
|
111 | 111 | <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span> |
112 | 112 | <span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span> |
113 | | -<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Literal</span><span class="p">,</span> <span class="n">Self</span><span class="p">,</span> <span class="n">TypeAlias</span> |
| 113 | +<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Literal</span><span class="p">,</span> <span class="n">Self</span><span class="p">,</span> <span class="n">TypeAlias</span> |
114 | 114 |
|
115 | 115 | <span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span> |
116 | 116 | <span class="kn">import</span><span class="w"> </span><span class="nn">pandas</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pd</span> |
@@ -430,6 +430,39 @@ <h1>Source code for fmu.tools.nestedhybridgrid.nestedhybrid</h1><div class="high |
430 | 430 | <span class="bp">self</span><span class="o">.</span><span class="n">_layer_map_coarse</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_generate_layer_map_coarse</span><span class="p">()</span> |
431 | 431 | <span class="bp">self</span><span class="o">.</span><span class="n">_layer_map_refined</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_generate_layer_map_refined</span><span class="p">()</span> |
432 | 432 |
|
| 433 | +<div class="viewcode-block" id="NestedHybridGrid.from_rms"> |
| 434 | +<a class="viewcode-back" href="../../../../fmu.tools.nestedhybridgrid.html#fmu.tools.NestedHybridGrid.from_rms">[docs]</a> |
| 435 | + <span class="nd">@classmethod</span> |
| 436 | + <span class="k">def</span><span class="w"> </span><span class="nf">from_rms</span><span class="p">(</span> |
| 437 | + <span class="bp">cls</span><span class="p">,</span> |
| 438 | + <span class="n">project</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> |
| 439 | + <span class="n">grid_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| 440 | + <span class="n">region_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| 441 | + <span class="n">refinement</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="nb">int</span><span class="p">],</span> |
| 442 | + <span class="n">properties</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| 443 | + <span class="p">)</span> <span class="o">-></span> <span class="n">Self</span><span class="p">:</span> |
| 444 | +<span class="w"> </span><span class="sd">"""Create a NestedHybridGrid instance from an RMS project."""</span> |
| 445 | + |
| 446 | + <span class="n">coarse_grid</span> <span class="o">=</span> <span class="n">xtgeo</span><span class="o">.</span><span class="n">grid_from_roxar</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">grid_name</span><span class="p">)</span> |
| 447 | + <span class="n">region</span> <span class="o">=</span> <span class="n">xtgeo</span><span class="o">.</span><span class="n">gridproperty_from_roxar</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">grid_name</span><span class="p">,</span> <span class="n">region_name</span><span class="p">)</span> |
| 448 | + |
| 449 | + <span class="k">for</span> <span class="n">propname</span> <span class="ow">in</span> <span class="n">properties</span> <span class="ow">or</span> <span class="p">[]:</span> |
| 450 | + <span class="n">prop</span> <span class="o">=</span> <span class="n">xtgeo</span><span class="o">.</span><span class="n">gridproperty_from_roxar</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">grid_name</span><span class="p">,</span> <span class="n">propname</span><span class="p">)</span> |
| 451 | + <span class="n">coarse_grid</span><span class="o">.</span><span class="n">append_prop</span><span class="p">(</span><span class="n">prop</span><span class="p">)</span> |
| 452 | + |
| 453 | + <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">coarse_grid</span><span class="p">,</span> <span class="n">region</span><span class="p">,</span> <span class="n">refinement</span><span class="p">)</span></div> |
| 454 | + |
| 455 | + |
| 456 | +<div class="viewcode-block" id="NestedHybridGrid.to_rms"> |
| 457 | +<a class="viewcode-back" href="../../../../fmu.tools.nestedhybridgrid.html#fmu.tools.NestedHybridGrid.to_rms">[docs]</a> |
| 458 | + <span class="k">def</span><span class="w"> </span><span class="nf">to_rms</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">grid_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| 459 | +<span class="w"> </span><span class="sd">"""Write the nested hybrid grid and its properties to an RMS project."""</span> |
| 460 | + <span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">to_roxar</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">grid_name</span><span class="p">)</span> |
| 461 | + |
| 462 | + <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="p">:</span> |
| 463 | + <span class="n">prop</span><span class="o">.</span><span class="n">to_roxar</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">grid_name</span><span class="p">,</span> <span class="n">prop</span><span class="o">.</span><span class="n">name</span><span class="p">)</span></div> |
| 464 | + |
| 465 | + |
433 | 466 | <span class="nd">@staticmethod</span> |
434 | 467 | <span class="k">def</span><span class="w"> </span><span class="nf">_validate_inputs</span><span class="p">(</span> |
435 | 468 | <span class="n">coarse_grid</span><span class="p">:</span> <span class="n">xtgeo</span><span class="o">.</span><span class="n">Grid</span><span class="p">,</span> |
@@ -457,11 +490,11 @@ <h1>Source code for fmu.tools.nestedhybridgrid.nestedhybrid</h1><div class="high |
457 | 490 |
|
458 | 491 | <span class="k">def</span><span class="w"> </span><span class="nf">_build_nested_hybrid_grid</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">xtgeo</span><span class="o">.</span><span class="n">Grid</span><span class="p">:</span> |
459 | 492 | <span class="w"> </span><span class="sd">"""Build the nested hybrid grid."""</span> |
460 | | - |
461 | 493 | <span class="n">coarse_grid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_original_grid</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
462 | | - <span class="n">coarse_grid</span><span class="o">.</span><span class="n">append_prop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_original_region</span><span class="p">)</span> |
463 | 494 |
|
464 | 495 | <span class="n">region_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_original_region</span><span class="o">.</span><span class="n">name</span> |
| 496 | + <span class="k">if</span> <span class="n">region_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">coarse_grid</span><span class="o">.</span><span class="n">propnames</span><span class="p">:</span> |
| 497 | + <span class="n">coarse_grid</span><span class="o">.</span><span class="n">append_prop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_original_region</span><span class="p">)</span> |
465 | 498 |
|
466 | 499 | <span class="c1"># Create the refined grid, i.e. crop and refine.</span> |
467 | 500 | <span class="n">refined_grid</span> <span class="o">=</span> <span class="n">_crop_for_region</span><span class="p">(</span><span class="n">coarse_grid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_refined_bbox</span><span class="p">)</span> |
@@ -498,7 +531,7 @@ <h1>Source code for fmu.tools.nestedhybridgrid.nestedhybrid</h1><div class="high |
498 | 531 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_grid</span> |
499 | 532 |
|
500 | 533 | <span class="nd">@property</span> |
501 | | - <span class="k">def</span><span class="w"> </span><span class="nf">properties</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">xtgeo</span><span class="o">.</span><span class="n">Grid</span><span class="p">:</span> |
| 534 | + <span class="k">def</span><span class="w"> </span><span class="nf">properties</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">list</span><span class="p">[</span><span class="n">xtgeo</span><span class="o">.</span><span class="n">GridProperty</span><span class="p">]:</span> |
502 | 535 | <span class="w"> </span><span class="sd">"""The final nested hybrid grid properties."""</span> |
503 | 536 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">props</span> |
504 | 537 |
|
|
0 commit comments