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

osdu_models/masterdata/planned_cement_job/v1_2_0.py

@@ -0,0 +1,568 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/planned_cement_job/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class CementPumpSchedule(BaseModel):
+    """
+    Set of (Time / Rate / Back Pressure).
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PumpRate: float | None = Field(None, title='Pump Rate')
+    """
+    Rate fluid is pumped. 0 means it is a pause.
+    """
+    PumpVolume: float | None = Field(None, title='Pump Volume')
+    """
+    Volume pumped = eTimPump * ratePump.
+    """
+    BackPressure: float | None = Field(None, title='Back Pressure')
+    """
+    Back pressure applied during pumping stage.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    Comments and Remarks.
+    """
+
+
+class CementAdditive(BaseModel):
+    """
+    Additives used during a cement job
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    AdditiveName: str = Field(..., title='Additive Name')
+    """
+    Additive name.
+    """
+    AdditiveTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AdditiveType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Additive Type ID')
+    """
+    The liquid, solid or gaseous substance used to manipulate the function or properties of a fluid.
+    """
+    AdditiveRoleID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AdditiveRole:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Additive Role ID')
+    """
+    The chief purpose or reason for adding a substance to a fluid used in a downhole operation.
+    """
+    AdditiveFormulation: str | None = Field(None, title='Additive Formulation')
+    """
+    Wet or Dry.
+    """
+    AdditiveDensity: float | None = Field(None, title='Additive Density')
+    """
+    Additive density.
+    """
+    AdditiveAmount: float = Field(..., title='Additive Amount')
+    """
+    Additive Amount.
+    """
+    TypeConc: str = Field(..., title='Type Conc')
+    """
+    ConcentrationType: %BWOC (%By weight of Cement), %BWOB (%By weight of blend), %BWOW (%By weight of water), %BWOBF (%By weight of base fluid)
+    """
+    Concentration: float = Field(..., title='Concentration')
+    """
+    Concentration Amount: unit type depends of typeConc.
+    """
+    WtSack: float = Field(..., title='Weight Sack')
+    """
+    Concentration in terms of weight per sack.
+    """
+    VolSack: float = Field(..., title='Volume Sack')
+    """
+    Concentration in terms of volume per sack.
+    """
+
+
+class CementingFluid(BaseModel):
+    """
+    Displaced Mud, washes and spacers, cements, displacement mud.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TypeFluid: str | None = Field(None, title='Type Fluid')
+    """
+    Fluid type: Mud, Wash, Spacer, Slurry.
+    """
+    FluidIndex: float | None = Field(None, title='Fluid Index')
+    """
+    Fluid Index: 1: first fluid pumped (=original mud), 
+    					(last-1)=Tail cement, last= displacement mud
+    """
+    FluidDescription: str | None = Field(None, title='Fluid Description')
+    """
+    Fluid description.
+    """
+    Purpose: str | None = Field(None, title='Purpose')
+    """
+    Purpose description.
+    """
+    ClassSlurryDryBlend: str | None = Field(None, title='Class Slurry Dry Blend')
+    """
+    Slurry class.
+    """
+    FluidTopMeasuredDepth: float | None = Field(None, title='Fluid Top Measured Depth')
+    """
+    Estimated Measured depth at top of slurry placement.
+    """
+    FluidBaseMeasuredDepth: float | None = Field(
+        None, title='Fluid Base Measured Depth'
+    )
+    """
+    Measured depth at bottom of slurry placement.
+    """
+    WaterVolume: float | None = Field(None, title='Water Volume')
+    """
+    Water volume.
+    """
+    CementVolume: float | None = Field(None, title='Cement Volume')
+    """
+    Volume of cement.
+    """
+    RatioMixWater: float | None = Field(None, title='Ratio Mix Water')
+    """
+    Mix Water Ratio.
+    """
+    FluidVolume: float | None = Field(None, title='Fluid Volume')
+    """
+    Fluid/Slurry Volume.
+    """
+    CementPumpSchedule_1: CementPumpSchedule | None = Field(
+        None, alias='CementPumpSchedule', title='Cement Pump Schedule'
+    )
+    """
+    Set of (Time / Rate / Back Pressure).
+    """
+    ExcessPercent: float | None = Field(None, title='Excess Percent.')
+    """
+    Excess Percent.
+    """
+    YieldVolume: float | None = Field(None, title='Yield Volume')
+    """
+    Slurry Yield.
+    """
+    Density: float | None = Field(None, title='Density')
+    """
+    Fluid density.
+    """
+    PumpedVolume: float | None = Field(None, title='Pumped Vol')
+    """
+    Volume Pumped.
+    """
+    OtherVolume: float | None = Field(None, title='Other Volume')
+    """
+    Other Volume.
+    """
+    FluidRheologicalModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidRheologicalModelType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Fluid Rheological Model ID')
+    """
+    Newtonian/Bingham/Power Law/Herschel Bulkley.
+    """
+    Viscosity: float | None = Field(None, title='Viscosity')
+    """
+    Viscosity (Newtonian) or Plastic Viscosity if Bingham.
+    """
+    YieldPoint: float | None = Field(None, title='Yield Point')
+    """
+    Yield point (Bingham and Herschel Bulkley models).
+    """
+    N: float | None = Field(None, title='N')
+    """
+    Power Law index (Power Law and HB).
+    """
+    K: float | None = Field(None, title='K')
+    """
+    Consistency index (Power Law and HB).
+    """
+    Gel10SecReading: float | None = Field(None, title='Gel10 Sec Reading')
+    """
+    Gel reading after 10 seconds.
+    """
+    Gel10SecStrength: float | None = Field(None, title='Gel10 Sec Strength')
+    """
+    Gel strength after 10 seconds.
+    """
+    Gel1MinReading: float | None = Field(None, title='Gel1 Min Reading')
+    """
+    Gel reading after 1 minute.
+    """
+    Gel1MinStrength: float | None = Field(None, title='Gel1 Min Strength')
+    """
+    Gel strength after 1 minute.
+    """
+    Gel10MinReading: float | None = Field(None, title='Gel10 Min Reading')
+    """
+    Gel reading after 10 minutes.
+    """
+    Gel10MinStrength: float | None = Field(None, title='Gel10 Min Strength')
+    """
+    Gel strength after 10 minutes.
+    """
+    BaseFluidType: str | None = Field(None, title='Base Fluid Type')
+    """
+    Type of base fluid: Fresh water, Sea water, Brine, Brackish water.
+    """
+    BaseFluidDensity: float | None = Field(None, title='Base Fluid Density')
+    """
+    Density of base fluid.
+    """
+    DryBlendName: str | None = Field(None, title='Dry Blend Name')
+    """
+    Name of dry blend.
+    """
+    DryBlendDescription: str | None = Field(None, title='Dry Blend Description')
+    """
+    Description of dry blend.
+    """
+    DryBlendMass: float | None = Field(None, title='Dry Blend Mass')
+    """
+    Mass of dry blend: the blend is made of different solid additives: the volume is not constant.
+    """
+    DryBlendDensity: float | None = Field(None, title='Dry Blend Density')
+    """
+    Density of Dry blend.
+    """
+    DryBlendMassSack: float | None = Field(None, title='Dry Blend MassSack')
+    """
+    Weight of a sack of dry blend.
+    """
+    CementAdditives: list[CementAdditive] | None = Field(None, title='Cement Additives')
+    """
+    Additives can be added in slurry but also in spacers, washes, mud.
+    """
+    IsFoamUsed: bool | None = Field(None, title='Is Foam Used')
+    """
+    Foam used indicator.  Values are "true" (or "1") and "false" (or "0").
+    """
+    GasFoamType: str | None = Field(None, title='Gas Foam Type')
+    """
+    Gas type used for foam job.
+    """
+    GasFoamVol: float | None = Field(None, title='Gas Foam Vol')
+    """
+    Volume of gas used for foam job.
+    """
+    DensAtPres: float | None = Field(None, title='Density At Pressure')
+    """
+    Slurry density at pressure.
+    """
+
+
+class CementStage(BaseModel):
+    """
+    A single cement job.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StageNumber: float = Field(..., title='Stage Number')
+    """
+    Stage number.
+    """
+    StageType: str = Field(..., title='Stage Type')
+    """
+    Stage type.
+    """
+    IntervalTopMeasuredDepth: float | None = Field(
+        None, title='Interval Top Measured Depth'
+    )
+    """
+    Measured depth at top of interval. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    CementBaseMeasuredDepth: float | None = Field(
+        None, title='Cement Base Measured Depth'
+    )
+    """
+    Measured depth of base of cement. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    Excess_Volume: float | None = Field(
+        None, alias='Excess Volume', title='Excess Volume'
+    )
+    """
+    Excess volume.
+    """
+    FlowrateDisplaceAv: float | None = Field(None, title='Flowrate Displace Average')
+    """
+    Average displacement rate.
+    """
+    FlowrateDisplaceMx: float | None = Field(None, title='Flowrate Displace Maximum')
+    """
+    Maximum displacement rate.
+    """
+    PressureDisplace: float | None = Field(None, title='Pressure Displace')
+    """
+    Planned displacement pressure.
+    """
+    FlowrateMudCirc: float | None = Field(None, title='Flowrate Mud Circ')
+    """
+    Rate mud circulated during stage.
+    """
+    PresMudCirc: float | None = Field(None, title='Pres Mud Circ')
+    """
+    Mud circulation pressure.
+    """
+    FlowrateEnd: float | None = Field(None, title='Flowrate End')
+    """
+    Final displacement pump rate.
+    """
+    CementingFluid_1: CementingFluid | None = Field(
+        None, alias='CementingFluid', title='Cementing Fluid'
+    )
+    """
+    Displaced Mud, washes and spacers, cements, displacement mud.
+    """
+    SqueezeObjective: str | None = Field(None, title='Squeeze Objective')
+    """
+    Squeeze objective.
+    """
+    StringMeasuredDepth: float | None = Field(None, title='String Measured Depth')
+    """
+    Measured depth of string (multi-stage cement job). Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    ToolMeasuredDepth: float | None = Field(None, title='Tool Measured Depth')
+    """
+    Measured depth of tool (multi-stage cement job. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    CoilTubingMeasuredDepth: float | None = Field(
+        None, title='Coil Tubing Measured Depth'
+    )
+    """
+    Measured depth of CoilTubing (multi-stage cement job. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    InsideCasingVolume: float | None = Field(None, title='Inside Casing Volume')
+    """
+    Estimated volume inside casing.
+    """
+    OutsideCasingVolume: float | None = Field(None, title='Outside Casing Volume')
+    """
+    Estimated volume outside casing for this stage placement.
+    """
+    TypeOriginalMud: str | None = Field(None, title='Type Original Mud')
+    """
+    Type of mud in hole.
+    """
+    WtMud: float | None = Field(None, title='Wt Mud')
+    """
+    Mud density.
+    """
+    ViscoFunnelMud: float | None = Field(None, title='Viscosity Funnel Mud')
+    """
+    Marsh funnel viscosity measured in a conical-shaped funnel, fitted with a small-bore tube on the bottom end through which mud flows under a gravity head. It is a time measurement, i.e., the time it takes for a given volume of fluid to flow through the funnel.
+    """
+    PlasticViscoMud: float | None = Field(None, title='Plastic Viscosity Mud')
+    """
+    Plastic viscosity (in hole at start of job).
+    """
+    YieldPointMud: float | None = Field(None, title='Yield Point Mud')
+    """
+    Yield point (in hole at start of job).
+    """
+    Gel10Sec: float | None = Field(None, title='Gel10 Sec')
+    """
+    Gels-10Sec (in hole at start of job).
+    """
+    Gel10Min: float | None = Field(None, title='Gel10 Min')
+    """
+    Gels-10Min (in hole at start of job).
+    """
+    FluidDisplace: str | None = Field(None, title='Fluid Displace')
+    """
+    Displacement fluid name.
+    """
+    DensDisplaceFluid: float | None = Field(None, title='Density Displace Fluid')
+    """
+    Density of displacement fluid.
+    """
+    VolDisplaceFluid: float | None = Field(None, title='Vol Displace Fluid')
+    """
+    Volume of displacement fluid.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for PlannedCementJob 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., title='Name')
+    """
+    Human recognizable context for the cement job.
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Reference to the Wellbore
+    """
+    JobTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-CementJobType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Job Type ID')
+    """
+    Type of cement job.
+    """
+    JobConfig: str | None = Field(None, title='Job Config')
+    """
+    Job configuration.
+    """
+    NameCementedString: str = Field(..., title='Name Cemented String')
+    """
+    Name for the cemented string
+    """
+    WorkStringID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Work String ID')
+    """
+    Identifier of the TubularAssembly that describes the cement work string
+    """
+    ContractorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Contractor ID')
+    """
+    Identifier of cementing contractor.
+    """
+    IsOffshoreJob: bool | None = Field(None, title='Is Offshore Job')
+    """
+    Offshore job? Values are "true" (or "1") and "false" (or "0").
+    """
+    WaterDepth: float | None = Field(None, title='Water Depth')
+    """
+    Water depth if offshore. The distance from mean sea level to water bottom.
+    """
+    IsReturnsToSeabed: bool | None = Field(None, title='Is Returns To Seabed')
+    """
+    Returns to seabed? Values are "true" (or "1") and "false" (or "0").
+    """
+    IsReciprocating: bool | None = Field(None, title='Is Reciprocating')
+    """
+    Pipe being reciprocated.  Values are "true" (or "1") and "false" (or "0").
+    """
+    EstimatedWaitingOnCement: str | None = Field(
+        None, title='Estimated Waiting On Cement'
+    )
+    """
+    Estimated duration for waiting on cement to set.
+    """
+    EstimatedPluggedTopMeasuredDepth: float | None = Field(
+        None, title='Estimated Plugged Top Measured Depth'
+    )
+    """
+    If Plug, estimated measured depth of top of plug. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EstimatedPluggedBaseMeasuredDepth: float | None = Field(
+        None, title='Estimated Plugged Base Measured Depth'
+    )
+    """
+    If Plug,  estimated measured depth of bottom of plug. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EstimatedHoleMeasuredDepth: float | None = Field(
+        None, title='Estimated Hole Measured Depth'
+    )
+    """
+    Estimated measured depth at bottom of hole. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EstimatedPreviousShoeMeasuredDepth: float | None = Field(
+        None, title='Estimated Previous Shoe Measured Depth'
+    )
+    """
+    Estimated measured depth of previous shoe. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EstimatedPreviousShoeTrueVerticalDepth: float | None = Field(
+        None, title='Estimated Previous Shoe True Vertical Depth'
+    )
+    """
+    Estimated True Vertical Depth of previous shoe. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EstimatedStringSetMeasuredDepth: float | None = Field(
+        None, title='Estimated String Set Measured Depth'
+    )
+    """
+    Estimated measured depth of cement string shoe. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EstimatedStringSetTrueVerticalDepth: float | None = Field(
+        None, title='Estimated String Set True Vertical Depth'
+    )
+    """
+    Estimated True vertical depth of cement string shoe. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    CementStages: list[CementStage] | None = Field(None, title='Cement Stages')
+    """
+    Set of stages for the job (usually 1 or 2).
+    """
+    PlugTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-PlugType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Plug Type ID')
+    """
+    Plug type.
+    """
+    TypeSqueeze: str | None = Field(None, title='Type Squeeze')
+    """
+    Type of squeeze.
+    """
+    SqueezeMeasuredDepth: float | None = Field(None, title='Squeeze Measured Depth')
+    """
+    Measured depth of squeeze. DDepth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    IsCoilTubing: bool | None = Field(None, title='Is Coil Tubing')
+    """
+    Coiled Tubing Used (true=CTU used). Values are "true" (or "1") and "false" (or "0").
+    """
+    TubularAssemblyID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Tubular Assembly Identifier')
+    """
+    Identifier of the tubular assembly actually installed or to be installed
+    """
+    WellboreArchitectureID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellboreArchitecture:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore Architecture ID')
+    """
+    Identifier of the Wellbore Architecture describing the geometry of the installed tubular.
+    """
+    EstimatedCementTopMeasuredDepth: float | None = Field(
+        None, title='Estimated Cement Top Measured Depth'
+    )
+    """
+    The estimated Measured depth of the Top of Cement. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    CementToolTubularComponentID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularComponent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Cement Tool Tubular Component ID')
+    """
+    The identifier of the TubularComponent used for Cementing the wellbore
+    """
+    ExtensionProperties: dict[str, Any] | None = None