Field outline¶

This exports the modelled field outline from within RMS. This field outline is a polygon representing the outline of the hydrocarbon-filled reservoir under initial conditions.

The field outline is typically calculated as the intersection between the modelled top reservoir surface (in depth) and the fluid contact surface. Some assets may choose to further refine the outline by limiting it to areas with net reservoir properties. It is up to each asset to decide which definition best suits their field.

The primary use case for the field outline is visualization. Unlike the deterministic outlines from NPD, it is derived directly from the reservoir model, providing greater precision, alignment with recent data, and adaptability to the unique structure and fluid contact of each realization.

Note

It is only possible to export one field outline object per model workflow. For exporting outlines specific to different fluid types and zones, the fluid_contact_outline standard result should be used instead.

Current¶
Field	Value
Version	0.1.0
Output	`share/results/polygons/field_outline/field_outline.parquet`
Security classification	🟡 Internal

Requirements¶

RMS
a field outline polygon stored in the General 2D data folder within RMS.

The field outline polygon object must be named field_outline and be located within the root of the General 2D data folder in RMS.

The export function will ensure that the polygon object consists of closed polygons before proceeding with the export.

Usage¶

export_field_outline(project)[source]¶

Simplified interface when exporting field outline from RMS.

Parameters:: project (Any) – The ‘magic’ project variable in RMS.
Return type:: ExportResult

Examples

Example usage in an RMS script:

from fmu.dataio.export.rms import export_field_outline

export_results = export_field_outline(project)

for result in export_results.items:
    print(f"Output field outline polygon to {result.absolute_path}")

Result¶

The result file will be share/results/polygons/field_outline/field_outline.parquet.

This is a tabular file on .parquet format. It contains the following columns with types validated as indicated.

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	field_outline.json
Path	schemas/file_formats/0.1.0/field_outline.json
Prod URL	https://main-fmu-schemas-prod.radix.equinor.com/schemas/file_formats/0.1.0/field_outline.json 🔒
Dev URL	https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/field_outline.json 🔒

JSON schema¶

The current JSON schema is embedded here.

{
  "$defs": {
    "FieldOutlineResultRow": {
      "description": "Represents the columns of a row in a field outline 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": {
        "POLY_ID": {
          "minimum": 0,
          "title": "Poly Id",
          "type": "integer"
        },
        "X_UTME": {
          "title": "X Utme",
          "type": "number"
        },
        "Y_UTMN": {
          "title": "Y Utmn",
          "type": "number"
        },
        "Z_TVDSS": {
          "title": "Z Tvdss",
          "type": "number"
        }
      },
      "required": [
        "X_UTME",
        "Y_UTMN",
        "Z_TVDSS",
        "POLY_ID"
      ],
      "title": "FieldOutlineResultRow",
      "type": "object"
    }
  },
  "$id": "https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/field_outline.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Represents the resultant field outline 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/FieldOutlineResultRow"
  },
  "title": "FieldOutlineResult",
  "type": "array",
  "version": "0.1.0"
}