osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/workproductcomponent/reservoir_simulation_equilibrium_model/v1_0_0.py

@@ -0,0 +1,397 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_simulation_equilibrium_model/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class FluidContact(BaseModel):
+    """
+    Description of an individual fluid contact within a reservoir unit
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidContactTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidContactType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Fluid Contact Type ID')
+    """
+    Identifies the type of a fluid boundary such as oil/water contact.
+    """
+    FluidContactTVD: float | None = Field(None, title='Fluid Contact TVD')
+    """
+    The true vertical depth from the Vertical CRS to the fluid contact.
+    """
+    CapillaryPressure: float | None = Field(None, title='Capillary Pressure')
+    """
+    Capillary pressure at the contact defined by the Fluid Contact Type.
+    """
+    ReferenceFluidContactID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(work-product-component\-\-FluidBoundaryInterpretation|work-product-component\-\-WellboreMarkerSet):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reference Fluid Contact ID')
+    """
+    Identifier of the fluid contact interpretation data record used as an input in deriving the fluid contact TVD.
+    """
+
+
+class DissolvedGasRatiosUndersaturatedOilVsDepth(BaseModel):
+    """
+    A table showing how gas-oil ratio (Rs) OR a bubble point pressure (Pb) changes by depth. Dissolved gas ratios in undersaturated oil for black oil models are calculated from either gas-oil ratio (Rs) versus depth table OR a bubble point pressure (Pb) versus depth table.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Temperatures: list[float] | None = Field(None, title='Temperatures')
+    """
+    Array of Temperature Values at a given Depth. The usage of Temperature against Depth is mutually exclusive with the usage of any other property
+    """
+    APIGravityValues: list[float] | None = Field(None, title='API Gravity Values')
+    """
+    Array of API Gravity Values at a given Depth. The usage of API Gravity against Depth is mutually exclusive with the usage of any other property.
+    """
+    BubblePointPressures: list[float] | None = Field(
+        None, title='Bubble Point Pressures'
+    )
+    """
+    Array of Bubble Point Pressure Values (Pb) at a given True Vertical Depth (TVD). The usage of Bubble Point Pressure against TVD is mutually exclusive with the usage of any other property.
+    """
+    SolutionGasOilRatios: list[float] | None = Field(
+        None, title='Solution Gas Oil Ratios'
+    )
+    """
+    Array of Gas Oil Ratios in Solution Values (Rs) at a given Depth. The usage of Gas Oil Ratios in Solution against Depth is mutually exclusive with the usage of any other property.
+    """
+    DewPointPressures: list[float] | None = Field(None, title='Dew Point Pressures')
+    """
+    Array of Dew Point Pressure Values (Pd) at a given True Vertical Depth (TVD). The usage of Dew Point Pressure against TVD  is mutually exclusive with the usage of any other property.
+    """
+    VaporizedOilRatios: list[float] | None = Field(None, title='Vaporized Oil Ratios')
+    """
+    Array of Vaporized Oil Ratio Values (Rv) at a given Depth. The usage of Vaporized Oil Ratio against Depth is mutually exclusive with the usage of any other property.
+    """
+    TrueVerticalDepths: list[float] | None = Field(None, title='True Vertical Depths')
+    """
+    Array of True Vertical Depth (TVD) Values to be used as a reference for any other property mapped against depth. This column is required if any other property is populated.
+    """
+
+
+class VaporizedOilRatiosUndersaturatedGasVsDepth(BaseModel):
+    """
+    A table showing how vaporized oil ratio (Rv) or a dew point pressure (Pd) changes by depth. Vaporized oil ratios in undersaturated gas for black oil models with wet gas are calculated from either vaporized oil ratio (Rv) versus depth table OR a dew point pressure (Pd) versus depth table.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Temperatures: list[float] | None = Field(None, title='Temperatures')
+    """
+    Array of Temperature Values at a given Depth. The usage of Temperature against Depth is mutually exclusive with the usage of any other property
+    """
+    APIGravityValues: list[float] | None = Field(None, title='API Gravity Values')
+    """
+    Array of API Gravity Values at a given Depth. The usage of API Gravity against Depth is mutually exclusive with the usage of any other property.
+    """
+    BubblePointPressures: list[float] | None = Field(
+        None, title='Bubble Point Pressures'
+    )
+    """
+    Array of Bubble Point Pressure Values (Pb) at a given True Vertical Depth (TVD). The usage of Bubble Point Pressure against TVD is mutually exclusive with the usage of any other property.
+    """
+    SolutionGasOilRatios: list[float] | None = Field(
+        None, title='Solution Gas Oil Ratios'
+    )
+    """
+    Array of Gas Oil Ratios in Solution Values (Rs) at a given Depth. The usage of Gas Oil Ratios in Solution against Depth is mutually exclusive with the usage of any other property.
+    """
+    DewPointPressures: list[float] | None = Field(None, title='Dew Point Pressures')
+    """
+    Array of Dew Point Pressure Values (Pd) at a given True Vertical Depth (TVD). The usage of Dew Point Pressure against TVD  is mutually exclusive with the usage of any other property.
+    """
+    VaporizedOilRatios: list[float] | None = Field(None, title='Vaporized Oil Ratios')
+    """
+    Array of Vaporized Oil Ratio Values (Rv) at a given Depth. The usage of Vaporized Oil Ratio against Depth is mutually exclusive with the usage of any other property.
+    """
+    TrueVerticalDepths: list[float] | None = Field(None, title='True Vertical Depths')
+    """
+    Array of True Vertical Depth (TVD) Values to be used as a reference for any other property mapped against depth. This column is required if any other property is populated.
+    """
+
+
+class FineScaleEquilibration(BaseModel):
+    """
+    Cohesive set of attributes describing the details of the fine scale equilibration. Expectation is to fill out this attribute if the EnableFineScaleEquilibration is set to true.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    InitialFluidsInPlaceCalculationAccuracy: int | None = Field(
+        None, title='Initial Fluids In-Place Calculation Accuracy'
+    )
+    """
+    This is a number that controls the vertical resolution by subdividing the cell, often used as an input to an equation used by the simulator.
+    """
+    EnableTiltedBlockEquilibration: bool | None = Field(
+        None, title='Enable Tilted-Block Equilibration'
+    )
+    """
+    This indicates whether or not the subdivision should be made parallel to the tilted cell structure in place (true) or purely horizontally (false).
+    """
+    IsQuiescenceActive: bool | None = Field(None, title='Is Quiescence Active')
+    """
+    If true, the quiescence option computes a modification to the pressure field such that the reservoir is in hydrostatic equilibrium with respect to the saturations. The pressure modifications are then applied during the rest of the simulation.
+    """
+    RefinementRange: float | None = Field(None, title='Refinement Range')
+    """
+    Defines the interval distance both above and below the fluid contacts within which the fine scale equilibrium calculation will be performed.
+    """
+    RefinementDepthStep: float | None = Field(None, title='Refinement Depth Step')
+    """
+    Defines the maximum subdivision used in the fine scale equilibrium calculation.
+    """
+
+
+class APIGravityVsDepth(BaseModel):
+    """
+    A table showing how API Gravity changes by depth.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Temperatures: list[float] | None = Field(None, title='Temperatures')
+    """
+    Array of Temperature Values at a given Depth. The usage of Temperature against Depth is mutually exclusive with the usage of any other property
+    """
+    APIGravityValues: list[float] | None = Field(None, title='API Gravity Values')
+    """
+    Array of API Gravity Values at a given Depth. The usage of API Gravity against Depth is mutually exclusive with the usage of any other property.
+    """
+    BubblePointPressures: list[float] | None = Field(
+        None, title='Bubble Point Pressures'
+    )
+    """
+    Array of Bubble Point Pressure Values (Pb) at a given True Vertical Depth (TVD). The usage of Bubble Point Pressure against TVD is mutually exclusive with the usage of any other property.
+    """
+    SolutionGasOilRatios: list[float] | None = Field(
+        None, title='Solution Gas Oil Ratios'
+    )
+    """
+    Array of Gas Oil Ratios in Solution Values (Rs) at a given Depth. The usage of Gas Oil Ratios in Solution against Depth is mutually exclusive with the usage of any other property.
+    """
+    DewPointPressures: list[float] | None = Field(None, title='Dew Point Pressures')
+    """
+    Array of Dew Point Pressure Values (Pd) at a given True Vertical Depth (TVD). The usage of Dew Point Pressure against TVD  is mutually exclusive with the usage of any other property.
+    """
+    VaporizedOilRatios: list[float] | None = Field(None, title='Vaporized Oil Ratios')
+    """
+    Array of Vaporized Oil Ratio Values (Rv) at a given Depth. The usage of Vaporized Oil Ratio against Depth is mutually exclusive with the usage of any other property.
+    """
+    TrueVerticalDepths: list[float] | None = Field(None, title='True Vertical Depths')
+    """
+    Array of True Vertical Depth (TVD) Values to be used as a reference for any other property mapped against depth. This column is required if any other property is populated.
+    """
+
+
+class TemperatureVsDepth(BaseModel):
+    """
+    A table showing how temperature changes by depth.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Temperatures: list[float] | None = Field(None, title='Temperatures')
+    """
+    Array of Temperature Values at a given Depth. The usage of Temperature against Depth is mutually exclusive with the usage of any other property
+    """
+    APIGravityValues: list[float] | None = Field(None, title='API Gravity Values')
+    """
+    Array of API Gravity Values at a given Depth. The usage of API Gravity against Depth is mutually exclusive with the usage of any other property.
+    """
+    BubblePointPressures: list[float] | None = Field(
+        None, title='Bubble Point Pressures'
+    )
+    """
+    Array of Bubble Point Pressure Values (Pb) at a given True Vertical Depth (TVD). The usage of Bubble Point Pressure against TVD is mutually exclusive with the usage of any other property.
+    """
+    SolutionGasOilRatios: list[float] | None = Field(
+        None, title='Solution Gas Oil Ratios'
+    )
+    """
+    Array of Gas Oil Ratios in Solution Values (Rs) at a given Depth. The usage of Gas Oil Ratios in Solution against Depth is mutually exclusive with the usage of any other property.
+    """
+    DewPointPressures: list[float] | None = Field(None, title='Dew Point Pressures')
+    """
+    Array of Dew Point Pressure Values (Pd) at a given True Vertical Depth (TVD). The usage of Dew Point Pressure against TVD  is mutually exclusive with the usage of any other property.
+    """
+    VaporizedOilRatios: list[float] | None = Field(None, title='Vaporized Oil Ratios')
+    """
+    Array of Vaporized Oil Ratio Values (Rv) at a given Depth. The usage of Vaporized Oil Ratio against Depth is mutually exclusive with the usage of any other property.
+    """
+    TrueVerticalDepths: list[float] | None = Field(None, title='True Vertical Depths')
+    """
+    Array of True Vertical Depth (TVD) Values to be used as a reference for any other property mapped against depth. This column is required if any other property is populated.
+    """
+
+
+class CompositionsAtDepthItem(BaseModel):
+    """
+    Description of the composition of a mixed fluid at a single depth
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CompositionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirComponentCompositionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Composition Type ID')
+    """
+    Indicating that the table consists of phase component mole fractions versus depth. (Total, Liquid, Vapor, Aqueous, Residual Oil, Solid)
+    """
+    Depth: float | None = Field(None, title='Depth')
+    """
+    A depth (TVD) value at which the component mole fractions will be specified
+    """
+    ComponentMoleFractions: list[float] | None = Field(
+        None, title='Component Mole Fractions'
+    )
+    """
+    A list of component mole fractions at the designated depth corresponding to the appropriate component id (e.g. 0.0121, 0.0194, etc.). These values should sum up to one.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for ReservoirSimulationEquilibriumModel 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PressureAtDatum: float | None = Field(None, title='Pressure At Datum')
+    """
+    Hydrostatic Pressure at the Pressure Datum TVD
+    """
+    PressureDatumTVD: float | None = Field(None, title='Pressure Datum TVD')
+    """
+    True Vertical Depth from the Vertical CRS to the datum used for pressure. This is further qualified by associated VerticalCRS property. If no VerticalCRS is populated, assume MSL, and therefore "TVD Subsea". The Vertical CRS of the Datum must be consistent with one defined for the reservoir simulation model.
+    """
+    VerticalCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Vertical Coordinate Reference System ID')
+    """
+    The Vertical Coordinate Reference System defining the origin (i.e., zero point) for the vertical measurements on this data record (e.g. PressureDatum and TopDepth). The most common Vertical CRS in this context is Mean Sea Level. Populating this attribute is especially important when the Vertical CRS is not Mean Sea Level but rather a local alternative like Caspian height or a custom Vertical CRS.
+    """
+    VerticalDatumOffsetToMeanSeaLevel: float | None = Field(
+        None, title='Vertical Datum Offset To Mean Sea Level'
+    )
+    """
+    If the the vertical measurements on this data record (e.g. PressureDatum and TopDepth) were not referenced from Mean Sea Level, this attribute can capture the difference between the selected Vertical CRS and Mean Sea Level.
+    """
+    FluidContacts: list[FluidContact] | None = Field(None, title='Fluid Contacts')
+    """
+    List of individual fluid contacts such as gas/oil contact or oil/water contact, with associated parameters.
+    """
+    DissolvedGasRatiosUndersaturatedOilVsDepth_1: (
+        DissolvedGasRatiosUndersaturatedOilVsDepth | None
+    ) = Field(
+        None,
+        alias='DissolvedGasRatiosUndersaturatedOilVsDepth',
+        title='Dissolved Gas Ratios Undersaturated Oil Versus Depth',
+    )
+    """
+    A table showing how gas-oil ratio (Rs) OR a bubble point pressure (Pb) changes by depth. Dissolved gas ratios in undersaturated oil for black oil models are calculated from either gas-oil ratio (Rs) versus depth table OR a bubble point pressure (Pb) versus depth table.
+    """
+    VaporizedOilRatiosUndersaturatedGasVsDepth_1: (
+        VaporizedOilRatiosUndersaturatedGasVsDepth | None
+    ) = Field(
+        None,
+        alias='VaporizedOilRatiosUndersaturatedGasVsDepth',
+        title='Vaporized Oil Ratios Undersaturated Gas Versus Depth',
+    )
+    """
+    A table showing how vaporized oil ratio (Rv) or a dew point pressure (Pd) changes by depth. Vaporized oil ratios in undersaturated gas for black oil models with wet gas are calculated from either vaporized oil ratio (Rv) versus depth table OR a dew point pressure (Pd) versus depth table.
+    """
+    EnableFineScaleEquilibration: bool | None = Field(
+        None, title='Enable Fine Scale Equilibration'
+    )
+    """
+    If false, fluid saturation is calculated at the center of the block. If true, the block is subdivided based on the value defined by FineScaleEquilibration.InitialFluidsInPlaceCalculationAccuracy.
+    """
+    FineScaleEquilibration_1: FineScaleEquilibration | None = Field(
+        None, alias='FineScaleEquilibration', title='Fine-Scale Equilibration'
+    )
+    """
+    Cohesive set of attributes describing the details of the fine scale equilibration. Expectation is to fill out this attribute if the EnableFineScaleEquilibration is set to true.
+    """
+    ReservoirSimulationInitialisationDataTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSimulationInitialisationDataType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Simulation Initialization Data Type ID')
+    """
+    Indicates whether (i) gas-oil contact and composition data, or (ii) Pressure at datum and composition data is the most relevant data to be honored during the initialization process, or whether simulator should analyze the model to determine this.
+    """
+    FluidModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-FluidModel:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Fluid Model ID')
+    """
+    Identifies the Fluid Model used for the equilibration
+    """
+    EquilibriumModelSaturationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EquilibriumModelSaturationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Equilibrium Model Saturation Type ID')
+    """
+    Identifies the type of saturation system the model was built for, such as a bubble point or a dew point fluid system.
+    """
+    APIGravityVsDepth_1: APIGravityVsDepth | None = Field(
+        None, alias='APIGravityVsDepth', title='API Gravity Versus Depth'
+    )
+    """
+    A table showing how API Gravity changes by depth.
+    """
+    TemperatureVsDepth_1: TemperatureVsDepth | None = Field(
+        None, alias='TemperatureVsDepth', title='Temperature Versus Depth'
+    )
+    """
+    A table showing how temperature changes by depth.
+    """
+    CompositionsAtDepth: list[CompositionsAtDepthItem] | None = Field(
+        None, title='Compositions At Depth'
+    )
+    """
+    Array defining the equilibrated compositions at given depths; Also known as a compositional model table
+    """
+    ComponentNames: list[str] | None = Field(None, title='Component Names')
+    """
+    Identifies the compositional components at the designated depth (e.g. C1, C2, etc.)
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_simulation_model/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/workproductcomponent/reservoir_simulation_model/v1_0_0.py

@@ -0,0 +1,230 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_simulation_model/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class ReservoirSimulationPropertySet(BaseModel):
+    """
+    Identifies a grid property from the associated 3D geologic model that is an input to the reservoir simulation.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PropertyIndex: int = Field(..., title='Property Index')
+    """
+    Incremental Number identifying the property in this specific Simulation Model Array
+    """
+    ReservoirSimulationPropertyTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSimulationPropertyType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Reservoir Simulation Property Type ID')
+    """
+    Identifies the specific type of modelling this property is capturing.
+    """
+    PropertyID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-GenericProperty:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Property ID')
+    """
+    Identifies the generic property capturing the region split of this specific property.
+    """
+
+
+class RockModelAssignment(BaseModel):
+    """
+    Describes the association between one rock model component (e.g. rock physics model, saturation functions) and its corresponding allocated region(s) in the 3D static model.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PropertyIndex: int = Field(..., title='Property Index')
+    """
+    Index of the property, in the property array, this assignment is describing.
+    """
+    RegionCodes: list[int] = Field(..., title='Region Codes')
+    """
+    Code or set of codes defining the region(s) to be assigned - in the corresponding 3D Property - with this specific rock model.
+    """
+    ModelID: constr(
+        pattern=r'^[\w\-\.]+:(work-product-component\-\-ReservoirModelRockPhysicsModel|work-product-component\-\-SaturationFunctionSet):[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Model ID')
+    """
+    Identifies the rock model associated to the specific region(s).
+    """
+    MappingTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSimulationRockModelMappingType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Mapping Type ID')
+    """
+    Identifies the subset of the Rock Model this mapping is describing
+    """
+
+
+class FluidModelAssignment(BaseModel):
+    """
+    Describes the association between one fluid model and its corresponding allocated region(s) in the 3D static model.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PropertyIndex: int = Field(..., title='Property Index')
+    """
+    Index of the property, in the property array, this assignment is describing.
+    """
+    RegionCodes: list[int] = Field(..., title='Region Codes')
+    """
+    Code or set of codes defining the region(s) to be assigned with this specific fluid model.
+    """
+    ModelID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-FluidModel:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Model ID')
+    """
+    Identifies the fluid model associated to the specific region(s).
+    """
+
+
+class EquilibriumModelAssignment(BaseModel):
+    """
+    Describes the association between one equilibrium model and its corresponding allocated region(s) in the 3D static model.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PropertyIndex: int = Field(..., title='Property Index')
+    """
+    Index of the property, in the property array, this assignment is describing.
+    """
+    RegionCodes: list[int] = Field(..., title='Region Codes')
+    """
+    Code or set of codes defining the region(s) to be assigned with this specific equilibrium model.
+    """
+    ModelID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-ReservoirSimulationEquilibriumModel:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Model ID')
+    """
+    Identifies the equilibrium model associated to the specific region(s).
+    """
+
+
+class BasisOfModelling(BaseModel):
+    """
+    This set of attributes represents the context surrounding the processes used in running through model characterization.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    InputDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Input Data Collection ID')
+    """
+    Identifies the Persisted Collection containing relevant data used to derive this model.
+    """
+    ModellingApplicationsUsed: list[str] | None = Field(
+        None, title='Modelling Applications Used'
+    )
+    """
+    The software applications used in creating this data. Best practice is to also capture the application version.
+    """
+    IntendedWorkflowUsageIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WorkflowUsageType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Intended Workflow Usage IDs')
+    """
+    Identifies the subsequent business workflows for which this data is intended to be used.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for ReservoirSimulationModel 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    GridID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(work-product-component\-\-IjkGridRepresentation|work-product-component\-\-UnstructuredGrid|work-product-component\-\-UnstructuredColumnLayerGridRepresentation|work-product-component\-\-GpGridRepresentation):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Grid ID')
+    """
+    Identifies the specific 3D grid from the earth model/static geologic model, which is used in this reservoir simulation. This grid will define both the horizontal and vertical C.R.S.
+    """
+    ReservoirSimulationInitialisationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSimulationInitialisationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Simulation Initialisation Type ID')
+    """
+    Identifies the initialisation method used for this reservoir simulation, whether enumeration, equilibrium, or mixed.
+    """
+    ReservoirSimulationPropertySets: list[ReservoirSimulationPropertySet] | None = (
+        Field(None, title='Reservoir Simulation Property Sets')
+    )
+    """
+    Identifies the grid properties within the associated 3D geologic model that are inputs to the reservoir simulation.
+    """
+    RockModelAssignments: list[RockModelAssignment] | None = Field(
+        None, title='Rock Model Assignments'
+    )
+    """
+    Identifies the rock model components (e.g. rock physics model, saturation functions) used as inputs to reservoir simulation and mapped to 3D model regions.
+    """
+    FluidModelAssignments: list[FluidModelAssignment] | None = Field(
+        None, title='Fluid Model Assignments'
+    )
+    """
+    Identifies the fluid models (e.g. black oil, compositional) used as inputs to reservoir simulation and mapped to 3D model regions.
+    """
+    EquilibriumModelAssignments: list[EquilibriumModelAssignment] | None = Field(
+        None, title='Equilibrium Model Assignments'
+    )
+    """
+    Identifies the reservoir equilibrium models used as inputs to reservoir simulation and mapped to 3D model regions.
+    """
+    EarthModelInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-EarthModelInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Earth Model Interpretation ID')
+    """
+    Identifies the Earth Model Interpretation holding the geological model and its whole set of representations. This direct relationship to Earth Model is not always necessary, but may be useful in rare cases where a gridless model is used or to more quickly navigate to a version of the 3D Grid at a different resolution.
+    """
+    ReservoirSimulationTypeTagIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSimulationTypeTag:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Reservoir Simulation Type Tag IDs')
+    """
+    List of higher level grouping terms that are used to search for reservoir simulation models, based on various aspects of model type, such as purpose of the model, model scale, and more.
+    """
+    BasisOfModelling_1: BasisOfModelling | None = Field(
+        None, alias='BasisOfModelling', title='Basis Of Modelling'
+    )
+    """
+    This set of attributes represents the context surrounding the processes used in running through model characterization.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_simulation_rock_physics_model/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4