4.3.1.9. PipelineSpec (PV)

Warning

PipelineSpec is identified as Partially Validated.

4.3.1.9.1. Example PipelineSpec

{
  "pdef_id": "b8eb8702-ff4f-4afd-ba95-caccde5a806c",
  "pdef_type": "pipeline_spec",
  "meta_data": {},
  "additional_data": {},
  "battery_limits": "This is a description of the battery limit for pipeline_spec_1",
  "design_code": "DNV",
  "design_life": {
    "val": 15.0,
    "unit": "y"
  },
  "system": "production",
  "service": "sour",
  "tag": "PR_10",
  "ohtc_max_specified": {
    "val": 0.9,
    "unit": "W.m^-2.K^-1",
    "ref": "ID"
  },
  "min_no_touch_time": {
    "val": 4.0,
    "unit": "hr"
  },
  "min_cool_down_time": {
    "val": 4.0,
    "unit": "hr"
  },
  "max_water_condensation_rate": {
    "val": 0.9,
    "unit": ""
  },
  "related_route": [
    "ae0df9c9-cf1a-4c51-99ae-ce8640fa4161"
  ],
  "related_section_single_pipe_spec": [
    "d9089a04-b901-4047-919d-26d1093ba3db",
    "6f074dd9-763b-4bef-be94-b388ce212c17"
  ],
  "related_assembly_single_pipe_spec": null,
  "orientation_assembly_single_pipe": null,
  "related_field_joint_coating_spec": [
    "0d998e30-1168-4af0-919f-e4768b43a6ad"
  ],
  "related_weld_spec": [
    "910dd480-7aeb-4bb4-8987-e6733c32e045"
  ]
}

4.3.1.9.2. Schema PipelineSpec

pdef.model.pipeline_spec.PipelineSpec

Pipeline Spec object stores data related to one pipeline.

Show JSON schema
{
   "title": "PipelineSpec",
   "description": "Pipeline Spec object stores data related to one pipeline.",
   "type": "object",
   "properties": {
      "pdef_id": {
         "title": "PDEF id",
         "description": ":ref:`pdef_id` is the unique identifier for the object.",
         "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3",
         "type": "string"
      },
      "pdef_type": {
         "title": "Pdef Type",
         "const": "pipeline_spec",
         "type": "string"
      },
      "meta_data": {
         "title": "Metadata",
         "description": "Optional user free structured :ref:`Metadata` object.",
         "example": "{'created':'2021-09-03'}",
         "allOf": [
            {
               "$ref": "#/definitions/MetaData"
            }
         ]
      },
      "additional_data": {
         "title": "Additional Data",
         "description": "Optional user free structured :ref:`Additional Data` object.",
         "example": "{'color':'grey'}",
         "allOf": [
            {
               "$ref": "#/definitions/AdditionalData"
            }
         ]
      },
      "battery_limits": {
         "title": "Battery Limit",
         "description": "Description of the battery limits considered in the definition of the pipeline.",
         "maxLength": 1000,
         "example": "from PLET-18 to ILT-01",
         "type": "string"
      },
      "design_code": {
         "title": "Design Code",
         "description": "The main design code used for this pipeline.",
         "example": "DNV",
         "enum": [
            "API",
            "DNV",
            "ISO"
         ],
         "type": "string"
      },
      "design_life": {
         "title": "Design Life",
         "description": "The design life :ref:`Duration`.",
         "examples": {
            "val": 15.0,
            "uom": "y"
         },
         "allOf": [
            {
               "$ref": "#/definitions/Duration"
            }
         ]
      },
      "system": {
         "title": "System",
         "description": "Related functional system.",
         "example": "gas export",
         "enum": [
            "gas export",
            "gas injection",
            "gas lift",
            "oil export",
            "offloading",
            "production",
            "water alternate gas (WAG)",
            "water injection"
         ],
         "type": "string"
      },
      "service": {
         "title": "Service",
         "description": "Functional service rating.",
         "examples": [
            "sweet",
            "sour"
         ],
         "enum": [
            "sweet",
            "sour"
         ],
         "type": "string"
      },
      "tag": {
         "title": "Tag",
         "description": "Component tag for the pipeline.",
         "maxLength": 256,
         "example": "PR16",
         "type": "string"
      },
      "ohtc_max_specified": {
         "title": "Specified Max OHTC",
         "description": "Specified maximum Overall Heat Transfer Coefficient (:ref:`OHTC`).",
         "example": {
            "val": 0.9,
            "uom": "W.m^-2.K^-1",
            "ref": "ID"
         },
         "allOf": [
            {
               "$ref": "#/definitions/OHTC"
            }
         ]
      },
      "min_no_touch_time": {
         "title": "Minimum No Touch Time",
         "description": "Minimum :ref:`Duration` during which the pipeline can be left without hydrate mitigation.",
         "example": {
            "val": 4,
            "uom": "hr"
         },
         "allOf": [
            {
               "$ref": "#/definitions/Duration"
            }
         ]
      },
      "min_cool_down_time": {
         "title": "Minimum Cool Down Time",
         "description": "Minimum :ref:`Duration` during which the pipeline can be left to cooldown.",
         "example": {
            "val": 4,
            "uom": "hr"
         },
         "allOf": [
            {
               "$ref": "#/definitions/Duration"
            }
         ]
      },
      "max_water_condensation_rate": {
         "title": "Maximum Water Condensate Rate",
         "description": "WIP : description and example needed.",
         "example": {
            "val": 0.9,
            "uom": ""
         },
         "allOf": [
            {
               "$ref": "#/definitions/UnitLess"
            }
         ]
      },
      "related_route": {
         "title": "Relations to Routes",
         "description": "Related instances of :ref:`Route`, provided as array of :ref:`pdef_id`.",
         "example": [
            "37e682a2-e4e5-497a-b252-ea4b4ea54bc0",
            "93b73ef3-cf5a-445e-a162-68fa6f246faa"
         ],
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "related_section_single_pipe_spec": {
         "title": "Relations to Section Single Pipe Spec",
         "description": "Related instances of :ref:`SectionSinglePipeSpec`, provided as array of :ref:`pdef_id`.",
         "example": [
            "37e682a2-e4e5-497a-b252-ea4b4ea54bc0",
            "93b73ef3-cf5a-445e-a162-68fa6f246faa"
         ],
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "related_assembly_single_pipe_spec": {
         "title": "Relations to Assembly Single Pipe Spec",
         "description": "Related instances of :ref:`AssemblySinglePipeSpec`, provided as array of :ref:`pdef_id`.",
         "example": [
            "37e682a2-e4e5-497a-b252-ea4b4ea54bc0",
            "93b73ef3-cf5a-445e-a162-68fa6f246faa"
         ],
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "orientation_assembly_single_pipe": {
         "title": "Orientation Assembly Single Pipe",
         "description": "Orientation assembly single pipe, list of boolean. ",
         "example": [
            true,
            false,
            true,
            true
         ],
         "type": "array",
         "items": {
            "type": "boolean"
         }
      },
      "related_field_joint_coating_spec": {
         "title": "Relations to Field Joint Coating Spec",
         "description": "Related instances of :ref:`FieldJointCoatingSpec`, provided as array of :ref:`pdef_id`.",
         "example": [
            "37e682a2-e4e5-497a-b252-ea4b4ea54bc0",
            "93b73ef3-cf5a-445e-a162-68fa6f246faa"
         ],
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "related_weld_spec": {
         "title": "Relations to Weld Spec",
         "description": "Related instances of :ref:`WeldSpec`, provided as array of :ref:`pdef_id`.",
         "example": [
            "37e682a2-e4e5-497a-b252-ea4b4ea54bc0",
            "93b73ef3-cf5a-445e-a162-68fa6f246faa"
         ],
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "additionalProperties": false,
   "definitions": {
      "MetaData": {
         "title": "MetaData",
         "description": "Optional base JSON-fragment used to report meta data. User free structure.",
         "type": "object",
         "properties": {}
      },
      "AdditionalData": {
         "title": "AdditionalData",
         "description": "Optional base JSON-fragment used to report additional user specific data. User free structure.",
         "type": "object",
         "properties": {}
      },
      "Duration": {
         "title": "Duration",
         "description": ":ref:`Measure` of a duration",
         "type": "object",
         "properties": {
            "val": {
               "title": "Value",
               "description": "The value taken by the Measure.",
               "examples": [
                  1.0,
                  -25.1,
                  1000000.0
               ],
               "type": "number"
            },
            "unit": {
               "title": "unit of measure",
               "description": "Unit of measure.",
               "enum": [
                  "s",
                  "mn",
                  "hr",
                  "d",
                  "mth",
                  "y"
               ],
               "type": "string"
            }
         },
         "required": [
            "val",
            "unit"
         ],
         "additionalProperties": false
      },
      "OHTC": {
         "title": "OHTC",
         "description": ":ref:`Measure` of Overall Heat Transfer Coefficient (u-value).",
         "type": "object",
         "properties": {
            "val": {
               "title": "Value",
               "description": "The value taken by the Measure.",
               "examples": [
                  1.0,
                  -25.1,
                  1000000.0
               ],
               "type": "number"
            },
            "unit": {
               "title": "unit of measure",
               "description": "Unit of measure.",
               "enum": [
                  "W.m^-2.K^-1"
               ],
               "type": "string"
            },
            "ref": {
               "title": "OHTC Diameter Reference",
               "description": "The reference diameter used to specify the OHTC.",
               "default": "ID",
               "examples": [
                  "ID",
                  "OD"
               ],
               "enum": [
                  "ID",
                  "OD"
               ],
               "type": "string"
            }
         },
         "required": [
            "val",
            "unit"
         ],
         "additionalProperties": false
      },
      "UnitLess": {
         "title": "UnitLess",
         "description": ":ref:`Measure` for dimensionless ratios.",
         "type": "object",
         "properties": {
            "val": {
               "title": "Value",
               "description": "The value taken by the Measure.",
               "examples": [
                  1.0,
                  -25.1,
                  1000000.0
               ],
               "type": "number"
            },
            "unit": {
               "title": "unit of measure",
               "description": "Unit of measure.",
               "anyOf": [
                  {
                     "type": "null"
                  },
                  {
                     "enum": [
                        "ppb",
                        "%",
                        "ppm",
                        "ppt",
                        "ppq",
                        "N/A",
                        ""
                     ],
                     "type": "string"
                  }
               ]
            }
         },
         "required": [
            "val",
            "unit"
         ],
         "additionalProperties": false
      }
   }
}

Config
  • extra: str = forbid

battery_limits: Optional[str] = PydanticUndefined

Description of the battery limits considered in the definition of the pipeline.

Constraints and examples:
  • maxLength = 1000

  • example = from PLET-18 to ILT-01

design_code: Optional[Literal[API, DNV, ISO]] = PydanticUndefined

The main design code used for this pipeline.

Constraints and examples:
  • example = DNV

design_life: Optional[pdef.model.measure.Duration] = PydanticUndefined

The design life Duration.

Constraints and examples:
  • examples = {‘val’: 15.0, ‘uom’: ‘y’}

max_water_condensation_rate: Optional[pdef.model.measure.UnitLess] = PydanticUndefined

WIP : description and example needed.

Constraints and examples:
  • example = {‘val’: 0.9, ‘uom’: ‘’}

min_cool_down_time: Optional[pdef.model.measure.Duration] = PydanticUndefined

Minimum Duration during which the pipeline can be left to cooldown.

Constraints and examples:
  • example = {‘val’: 4, ‘uom’: ‘hr’}

min_no_touch_time: Optional[pdef.model.measure.Duration] = PydanticUndefined

Minimum Duration during which the pipeline can be left without hydrate mitigation.

Constraints and examples:
  • example = {‘val’: 4, ‘uom’: ‘hr’}

ohtc_max_specified: Optional[pdef.model.measure.OHTC] = PydanticUndefined

Specified maximum Overall Heat Transfer Coefficient (OHTC).

Constraints and examples:
  • example = {‘val’: 0.9, ‘uom’: ‘W.m^-2.K^-1’, ‘ref’: ‘ID’}

orientation_assembly_single_pipe: Optional[List[bool]] = PydanticUndefined

Orientation assembly single pipe, list of boolean.

Constraints and examples:
  • example = [True, False, True, True]

pdef_type: str = 'pipeline_spec'
Constraints and examples:
  • const = pipeline_spec

related_assembly_single_pipe_spec: Optional[List[str]] = PydanticUndefined

Related instances of AssemblySinglePipeSpec (PV), provided as array of pdef_id.

Constraints and examples:
  • example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, ‘93b73ef3-cf5a-445e-a162-68fa6f246faa’]

related_field_joint_coating_spec: Optional[List[str]] = PydanticUndefined

Related instances of FieldJointCoatingSpec (PV), provided as array of pdef_id.

Constraints and examples:
  • example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, ‘93b73ef3-cf5a-445e-a162-68fa6f246faa’]

related_route: Optional[List[str]] = PydanticUndefined

Related instances of Route (FV), provided as array of pdef_id.

Constraints and examples:
  • example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, ‘93b73ef3-cf5a-445e-a162-68fa6f246faa’]

related_section_single_pipe_spec: Optional[List[str]] = PydanticUndefined

Related instances of SectionSinglePipeSpec (PV), provided as array of pdef_id.

Constraints and examples:
  • example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, ‘93b73ef3-cf5a-445e-a162-68fa6f246faa’]

related_weld_spec: Optional[List[str]] = PydanticUndefined

Related instances of WeldSpec (PV), provided as array of pdef_id.

Constraints and examples:
  • example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, ‘93b73ef3-cf5a-445e-a162-68fa6f246faa’]

service: Optional[Literal[sweet, sour]] = PydanticUndefined

Functional service rating.

Constraints and examples:
  • examples = [‘sweet’, ‘sour’]

system: Optional[Literal[gas export, gas injection, gas lift, oil export, offloading, production, water alternate gas (WAG), water injection]] = PydanticUndefined

Related functional system.

Constraints and examples:
  • example = gas export

tag: Optional[str] = PydanticUndefined

Component tag for the pipeline.

Constraints and examples:
  • maxLength = 256

  • example = PR16

4.3.1.9.3. List PipelineSpec

Pipeline Spec Variables

Variable

Type

Description

pdef_id

<class ‘str’>

pdef_id is the unique identifier for the object.

pdef_type

<class ‘str’>

meta_data

<class ‘pdef.model.metadata.MetaData’>

Optional user free structured MetaData object.

additional_data

<class ‘pdef.model.additional_data.AdditionalData’>

Optional user free structured Additional Data object.

battery_limits

<class ‘pdef.model.pipeline_spec.ConstrainedStrValue’>

Description of the battery limits considered in the definition of the pipeline.

design_code

typing.Literal[‘API’, ‘DNV’, ‘ISO’]

The main design code used for this pipeline.

design_life

<class ‘pdef.model.measure.Duration’>

The design life Duration.

system

typing.Literal[‘gas export’, ‘gas injection’, ‘gas lift’, ‘oil export’, ‘offloading’, ‘production’, ‘water alternate gas (WAG)’, ‘water injection’]

Related functional system.

service

typing.Literal[‘sweet’, ‘sour’]

Functional service rating.

tag

<class ‘pdef.model.pipeline_spec.ConstrainedStrValue’>

Component tag for the pipeline.

ohtc_max_specified

<class ‘pdef.model.measure.OHTC’>

Specified maximum Overall Heat Transfer Coefficient (OHTC).

min_no_touch_time

<class ‘pdef.model.measure.Duration’>

Minimum Duration during which the pipeline can be left without hydrate mitigation.

min_cool_down_time

<class ‘pdef.model.measure.Duration’>

Minimum Duration during which the pipeline can be left to cooldown.

max_water_condensation_rate

<class ‘pdef.model.measure.UnitLess’>

WIP : description and example needed.

related_route

<class ‘str’>

Related instances of Route (FV), provided as array of pdef_id.

related_section_single_pipe_spec

<class ‘str’>

Related instances of SectionSinglePipeSpec (PV), provided as array of pdef_id.

related_assembly_single_pipe_spec

<class ‘str’>

Related instances of AssemblySinglePipeSpec (PV), provided as array of pdef_id.

orientation_assembly_single_pipe

<class ‘bool’>

Orientation assembly single pipe, list of boolean.

related_field_joint_coating_spec

<class ‘str’>

Related instances of FieldJointCoatingSpec (PV), provided as array of pdef_id.

related_weld_spec

<class ‘str’>

Related instances of WeldSpec (PV), provided as array of pdef_id.