Source code for fmu.dataio._models.fmu_results.specification

from __future__ import annotations

from typing import List, Optional, Union

from pydantic import BaseModel, Field

from . import enums


class RowColumn(BaseModel):
    """Specifies the number of rows and columns in a regular surface object."""

    nrow: int = Field(ge=0)
    """The number of rows."""

    ncol: int = Field(ge=0)
    """The number of columns."""


class RowColumnLayer(RowColumn):
    """Specifies the number of rows, columns, and layers in grid object."""

    nlay: int = Field(ge=0)
    """The number of layers."""




class SurfaceSpecification(RowColumn):
    """Specifies relevant values describing a regular surface object."""

    rotation: float = Field(allow_inf_nan=False)
    """Rotation angle in degrees."""

    undef: float = Field(allow_inf_nan=False)
    """Value representing undefined data."""

    xinc: float = Field(ge=0, allow_inf_nan=False)
    """Increment along the x-axis."""

    yinc: float = Field(ge=0, allow_inf_nan=False)
    """Increment along the y-axis."""

    xori: float = Field(allow_inf_nan=False)
    """Origin along the x-axis."""

    yflip: enums.AxisOrientation
    """Flip along the y-axis, -1 or 1."""

    yori: float = Field(allow_inf_nan=False)
    """Origin along the y-axis."""





class PointSpecification(BaseModel):
    """Specifies relevant values describing an xyz points object."""

    attributes: Optional[List[str]] = Field(default=None)
    """List of columns present in a table."""

    size: int = Field(ge=0, examples=[1, 9999])
    """Size of data object."""





class TableSpecification(BaseModel):
    """Specifies relevant values describing a generic tabular data object."""

    columns: List[str]
    """List of columns present in a table."""

    num_columns: int = Field(ge=0, examples=[1, 9999])
    """The number of columns in a table."""

    num_rows: int = Field(ge=0, examples=[1, 9999])
    """The number of rows in a table.."""

    size: int = Field(ge=0, examples=[1, 9999])
    """The total size of the table, i.e. `rows x cols`."""





class CPGridSpecification(RowColumnLayer):
    """Specifies relevant values describing a corner point grid object."""

    xshift: float = Field(allow_inf_nan=False)
    """Shift along the x-axis."""

    yshift: float = Field(allow_inf_nan=False)
    """Shift along the y-axis."""

    zshift: float = Field(allow_inf_nan=False)
    """Shift along the z-axis."""

    xscale: float = Field(allow_inf_nan=False)
    """Scaling factor for the x-axis."""

    yscale: float = Field(allow_inf_nan=False)
    """Scaling factor for the y-axis."""

    zscale: float = Field(allow_inf_nan=False)
    """Scaling factor for the z-axis."""

    zonation: Optional[List[ZoneDefinition]] = Field(default=None)
    """
    Zone names and corresponding layer index ranges. The list is ordered from
    shallowest to deepest zone. Note the layer indices are zero-based; add 1 to
    convert to corresponding layer number.
    """



class ZoneDefinition(BaseModel):
    """Zone name and corresponding layer index min/max"""

    name: str
    """Name of zone"""

    min_layer_idx: int = Field(ge=0)
    """Minimum layer index for the zone"""

    max_layer_idx: int = Field(ge=0)
    """Maximum layer index for the zone"""




class CPGridPropertySpecification(RowColumnLayer):
    """Specifies relevant values describing a corner point grid property object."""





class PolygonsSpecification(BaseModel):
    """Specifies relevant values describing a polygon object."""

    npolys: int = Field(ge=0)
    """The number of individual polygons in the data object."""





class FaultRoomSurfaceSpecification(BaseModel):
    """Specifies relevant values describing a Faultroom surface object."""

    horizons: List[str]
    """List of horizon names."""

    faults: List[str]
    """Names of faults."""

    juxtaposition_hw: List[str]
    """List of zones included in hangingwall juxtaposition."""

    juxtaposition_fw: List[str]
    """List of zones included in footwall juxtaposition."""

    properties: List[str]
    """List of properties along fault plane."""

    name: str
    """A name id of the faultroom usage."""





class CubeSpecification(SurfaceSpecification):
    """Specifies relevant values describing a cube object, i.e. a seismic cube."""

    nlay: int = Field(ge=0)
    """The number of layers."""

    xinc: float = Field(ge=0, allow_inf_nan=False)
    """Increment along the x-axis."""

    yinc: float = Field(ge=0, allow_inf_nan=False)
    """Increment along the y-axis."""

    zinc: float = Field(ge=0, allow_inf_nan=False)
    """Increment along the z-axis."""

    xori: float = Field(allow_inf_nan=False)
    """Origin along the x-axis."""

    yori: float = Field(allow_inf_nan=False)
    """Origin along the y-axis."""

    zori: float = Field(allow_inf_nan=False)
    """Origin along the z-axis."""

    yflip: enums.AxisOrientation
    """Flip along the y-axis, -1 or 1."""

    zflip: enums.AxisOrientation
    """Flip along the z-axis, -1 or 1."""

    rotation: float = Field(allow_inf_nan=False)
    """Rotation angle in degrees."""

    undef: float
    """Value representing undefined data."""



AnySpecification = Union[
    CPGridPropertySpecification,
    CPGridSpecification,
    FaultRoomSurfaceSpecification,
    PointSpecification,
    CubeSpecification,
    PolygonsSpecification,
    SurfaceSpecification,
    TableSpecification,
]