Simulator fipregions mapping¶

This creates a FIPNUM property within a grid model in RMS and exports the corresponding zone / region mappings as a standard result simulator_fipregions_mapping.

The flow simulator uses FIPNUM as its standard region property to generate reports on volumes and pressures for each FIPNUM value. The FIPNUM property created by this functionality will have a unique value per zone / region combination, which is the recommended standard. Reporting at a fine resolution allows for combining data at coarser levels in analysis tools, while enabling detailed investigations at a finer level.

Hint

Use the same zone and region properties as in your volumetrics job for easy comparison of initial volumes from the dynamic simulation against static inplace volumes.

Note

Many existing workflows may have a FIPNUM definition that does not conform to the standard of having one unique value per zone / region combination. If you need to retain the current FIPNUM definition also, it should be renamed to a different FIP identifier (e.g., FIPXXX) and exported for the flow simulation.

Current¶
Field	Value
Version	NA
Output	`share/results/tables/simulator_fipregions_mapping/fipnum.parquet`
Security classification	🟡 Internal

Requirements¶

RMS
A grid model with a zone and region property

The grid model in RMS must contain a discrete zone and a region property which will be used to assign FIPNUM values. The mappings between them will be automatically exported.

Usage¶

create_fipnum_property(project, grid_name, region, zone)[source]¶

Simplified interface for creating a FIPNUM property in RMS and exporting the corresponding zone / region mappings.

The FIPNUM property will have a unique value per region / zone combination and the mapping between a FIPNUM value and the corresponding region and zone names will be exported as a standard result ‘simulator_fipregions_mapping’.

Parameters:

project (Any) – The ‘magic’ project variable in RMS.
grid_name (str) – Name of the grid in RMS.
region (str) – Name of the region property in the grid model.
zone (str) – Name of the zone property in the grid model.

Return type:

ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import create_fipnum_property

export_results = create_fipnum_property(
    project,
    grid_name="Simgrid",
    region="Region",
    zone="Zone"
)

for result in export_results.items:
    print(f"Fipnum mappings are exported to {result.absolute_path}")

Result¶

The table mapping from a unique FIPNUM value to corresponding region and zone names will be exported to share/results/tables/simulator_fipregions_mapping/fipnum.parquet.

Standard result schema¶

This standard result is made available with a validation schema that can be used by consumers. A reference to the URL where this schema is located is present within the data.standard_result key in its associated object metadata.

Field	Value
Version	0.1.0
Filename	simulator_fipregions_mapping.json
Path	schemas/file_formats/0.1.0/simulator_fipregions_mapping.json
Prod URL	https://main-fmu-schemas-prod.radix.equinor.com/schemas/file_formats/0.1.0/simulator_fipregions_mapping.json 🔒
Dev URL	https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/simulator_fipregions_mapping.json 🔒

Changelog¶

0.1.0¶

This is the initial schema version.

JSON schema¶

The current JSON schema is embedded here.

{
  "$defs": {
    "SimulatorFipregionsMappingResultRow": {
      "description": "Represents the columns of a row in a simulator fipregions mapping export.\n\nThese fields are the current agreed upon standard result. Changes to the fields or\ntheir validation should cause the version defined in the standard result schema to\nincrease the version number in a way that corresponds to the schema versioning\nspecification (i.e. they are a patch, minor, or major change).",
      "properties": {
        "FIPNUM": {
          "minimum": 0,
          "title": "Fipnum",
          "type": "integer"
        },
        "REGION": {
          "title": "Region",
          "type": "string"
        },
        "ZONE": {
          "title": "Zone",
          "type": "string"
        }
      },
      "required": [
        "FIPNUM",
        "ZONE",
        "REGION"
      ],
      "title": "SimulatorFipregionsMappingResultRow",
      "type": "object"
    }
  },
  "$id": "https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/simulator_fipregions_mapping.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Represents the resultant simulator fipregions mapping parquet file, which is\nnaturally a list of rows.\n\nConsumers who retrieve this parquet file must read it into a json-dictionary\nequivalent format to validate it against the schema.",
  "items": {
    "$ref": "#/$defs/SimulatorFipregionsMappingResultRow"
  },
  "title": "SimulatorFipregionsMappingResult",
  "type": "array",
  "version": "0.1.0"
}