Initial fluid contact outlines¶

This exports modelled initial fluid contact outlines from within RMS.

Each fluid contact outline corresponds to a specific zone or a group of zones that share a common fluid contact. They are polygons representing the outline of the hydrocarbon-filled zone above a specific contact.

The fluid contact types supported is

fwl (Free water level)
fgl (Free gas level)
goc (Gas-oil contact)
gwc (Gas-water contact)
owc (Oil-water contact)

Current¶
Field	Value
Version	0.1.0
Output	`share/results/maps/fluid_contact_outline/contactname/zonename.parquet`
Security classification	🟡 Internal

Requirements¶

RMS
fluid contact outlines stored in the General 2D data folder within RMS.
names of outlines defined in the stratigraphy block

A folder named fluid_contact_outlines must exist in the root of the General 2D data folder in RMS. This folder should contain at least one subfolder with a valid fluid contact name (e.g., fwl, see the list above). The export function will automatically process and export all outlines found within these subfolders.

Note

The names of the fluid contact outlines must be defined in the stratigraphy block of the global configuration to enable mapping against masterdata.

Usage¶

export_fluid_contact_outlines(project)[source]¶

Simplified interface when exporting initial fluid contact outlines 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_fluid_contact_outlines

export_results = export_fluid_contact_outlines(project)

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

Result¶

The fluid contact outlines from the General 2D data folder will be exported as to share/results/maps/fluid_contact_outline/contactname/zonename.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	fluid_contact_outline.json
Path	schemas/file_formats/0.1.0/fluid_contact_outline.json
Prod URL	https://main-fmu-schemas-prod.radix.equinor.com/schemas/file_formats/0.1.0/fluid_contact_outline.json 🔒
Dev URL	https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/fluid_contact_outline.json 🔒

JSON schema¶

The current JSON schema is embedded here.

{
  "$defs": {
    "FluidContactOutlineResultRow": {
      "description": "Represents the columns of a row in a fluid contact 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": "FluidContactOutlineResultRow",
      "type": "object"
    }
  },
  "$id": "https://main-fmu-schemas-dev.radix.equinor.com/schemas/file_formats/0.1.0/fluid_contact_outline.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Represents the resultant fluid contact 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/FluidContactOutlineResultRow"
  },
  "title": "FluidContactOutlineResult",
  "type": "array",
  "version": "0.1.0"
}