Grid model static

This exports a static grid model with standard properties from within RMS.

The following properties will be included in the exported grid model:

  • zonation

  • regions

  • porosity

  • permeability

  • saturation_water

  • fluid_indicator

  • bulk_volume_oil and/or bulk_volume_gas

The following properties can optionally be included:

  • facies

  • net_to_gross

  • permeability_vertical

  • volume_shale

Note

It is possible to omit one of bulk_volume_oil or bulk_volume_gas if that fluid is not present in the field.

Current

Field

Value

Version

NA

Output

share/results/grids/grid_model_static/gridname.roff
share/results/grids/grid_model_static/gridname--propertyname.roff

Security classification

🟡 Internal

Requirements

  • RMS

  • grid model in RMS containing standard properties

  • bulk volume fluid properties with names Oil_bulk and/or Gas_bulk (as applicable)

  • fluid indicator property with name Discrete_fluid

The grid model needs to be located in RMS and contain standard properties.

For most properties, the RMS property name is provided as function input. The bulk_volume_oil, bulk_volume_gas, and fluid_indicator properties are however detected automatically and must exist in the grid with these exact RMS names: Oil_bulk, Gas_bulk and Discrete_fluid.

This export function will validate that the properties are of expected type and have values within expected ranges e.g. a porosity property must have values between 0 and 1.

Tip

The easiest way to produce the bulk_volume_oil or bulk_volume_gas properties is to enable Parameter output from Bulk in the volumetrics job in RMS. The Discrete_fluid property can be output from the same job by enabling the Create discrete fluid parameter.

Usage

export_grid_model_static(project, gridname, zonation, regions, porosity, permeability, saturation_water, facies=None, net_to_gross=None, volume_shale=None, permeability_vertical=None)[source]

Simplified interface when exporting a grid model with common properties from RMS.

Parameters:
  • project (Any) – The ‘magic’ project variable in RMS.

  • gridname (str) – Name of the grid model.

  • zonation (str) – Name of the zone property.

  • regions (str) – Name of the regions property.

  • porosity (str) – Name of the porosity property.

  • permeability (str) – Name of the permeability property.

  • saturation_water (str) – Name of the water saturation property.

  • facies (str | None) – Name of the facies property.

  • net_to_gross (str | None) – Name of the net to gross property.

  • volume_shale (str | None) – Name of the volume shale property.

  • permeability_vertical (str | None) – Name of the vertical permeability property.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_grid_model_static

export_results = export_grid_model_static(
    project,
    gridname="Geogrid",
    zonation="Zone",
    regions="Region",
    porosity="PHIT",
    permeability="KLOGH",
    saturation_water="SW",
    facies="FACIES",
    )

for result in export_results.items:
    print(f"Exported item to {result.absolute_path}")

Result

The grid and its properties will be exported as separate files of type ‘roff’ to share/results/grids/grid_model_static/gridname.roff and gridname--propertyname.roff.

Standard result schema

This standard result is not presented in a tabular format; therefore, no validation schema exists.