Petroleum Calcs data contract | PatchOps Knowledge

Provenance

PublisherPetroleum Calcs

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationNo credentials required

Methods (565)

pvt_bubblePoint

unknown

Oil bubble-point pressure (Standing or Vasquez-Beggs).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number",
      "examples": [
        500
      ]
    },
    "gasGravity": {
      "type": "number",
      "examples": [
        0.8
      ]
    },
    "apiGravity": {
      "type": "number",
      "examples": [
        35
      ]
    },
    "tempF": {
      "type": "number",
      "examples": [
        180
      ]
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "standing"
          ]
        },
        {
          "type": "string",
          "enum": [
            "vasquezBeggs"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gasGravity",
    "apiGravity",
    "tempF"
  ]
}

Inputs: Rs, gasGravity, apiGravity, tempF, correlation. -> pb_psia.

pvt_solutionGOR

unknown

Solution GOR Rs at pressure (Standing or Vasquez-Beggs).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "P": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "apiGravity": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "standing"
          ]
        },
        {
          "type": "string",
          "enum": [
            "vasquezBeggs"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "P",
    "gasGravity",
    "apiGravity",
    "tempF"
  ]
}

Inputs: P, gasGravity, apiGravity, tempF, correlation. -> rs_scf_stb.

pvt_oilFVF

unknown

Saturated oil FVF Bo (Standing or Vasquez-Beggs).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "apiGravity": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "standing"
          ]
        },
        {
          "type": "string",
          "enum": [
            "vasquezBeggs"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gasGravity",
    "apiGravity",
    "tempF"
  ]
}

Inputs: Rs, gasGravity, apiGravity, tempF, correlation. -> bo_rb_stb.

pvt_deadOilViscosity

unknown

Dead-oil viscosity, Beggs-Robinson (1975), cp.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "apiGravity": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "apiGravity",
    "tempF"
  ]
}

Inputs: apiGravity, tempF. Returns mu_od_cp.

pvt_oilViscosity

unknown

Live oil viscosity (Beggs-Robinson; undersaturated via Vasquez).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "apiGravity": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "pressure": {
      "type": "number"
    },
    "bubblePoint": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "apiGravity",
    "tempF"
  ]
}

Inputs: Rs, apiGravity, tempF; +pressure & bubblePoint for P>Pb.

pvt_gasPseudoCriticals

unknown

Gas pseudo-criticals Ppc/Tpc from gravity, Sutton (1985).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "gasGravity": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "gasGravity"
  ]
}

Inputs: gasGravity. Returns ppc_psia, tpc_R.

pvt_gasZ

unknown

Gas Z-factor, Dranchuk-Abou-Kassem (1975) + Sutton criticals.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "P": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "P",
    "tempF",
    "gasGravity"
  ]
}

Inputs: P, tempF, gasGravity. Returns z.

pvt_gasFVF

unknown

Gas formation volume factor Bg (rcf/scf) from DAK Z.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "P": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "P",
    "tempF",
    "gasGravity"
  ]
}

Inputs: P, tempF, gasGravity. Returns bg_rcf_scf.

pvt_gasViscosity

unknown

Gas viscosity, Lee-Gonzalez-Eakin (1966), cp.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "P": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "P",
    "tempF",
    "gasGravity"
  ]
}

Inputs: P, tempF, gasGravity. Returns mu_g_cp.

dca_arpsRate

unknown

Arps (1945) decline rate q(t): exponential/hyperbolic/harmonic.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number",
      "examples": [
        1000
      ]
    },
    "Di": {
      "type": "number",
      "examples": [
        0.6
      ]
    },
    "b": {
      "type": "number",
      "examples": [
        0.9
      ]
    },
    "t": {
      "type": "number",
      "examples": [
        2
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Di",
    "b",
    "t"
  ]
}

Inputs: qi, Di, b (0..1), t. b=0 exp, b=1 harmonic.

dca_arpsCum

unknown

Arps (1945) cumulative production Np(t).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Di": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Di",
    "b",
    "t"
  ]
}

Inputs: qi, Di, b (0..1), t. Returns np.

dca_arpsEUR

unknown

Arps EUR to an economic-limit rate qLimit.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Di": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "qLimit": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Di",
    "b",
    "qLimit"
  ]
}

Inputs: qi, Di, b, qLimit. Returns eur.

dca_arpsFit

unknown

Fit Arps qi/Di/b to rate-time data by least squares.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q"
  ]
}

Inputs: t[], q[] (>=3 pts). Returns qi, Di, b, rmse, r2.

dca_modHypRate

unknown

Modified-hyperbolic (Robertson) rate with terminal exponential.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Di": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "Dlim": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Di",
    "b",
    "Dlim",
    "t"
  ]
}

Inputs: qi, Di, b, Dlim (<Di), t. Returns q, segment, tLim.

dca_modHypEUR

unknown

Modified-hyperbolic EUR to an economic-limit rate qLimit.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Di": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "Dlim": {
      "type": "number"
    },
    "qLimit": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Di",
    "b",
    "Dlim",
    "qLimit"
  ]
}

Inputs: qi, Di, b, Dlim, qLimit. Returns eur.

dca_duongRate

unknown

Duong (2011) rate for fracture-dominated shale decline.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "q1": {
      "type": "number"
    },
    "a": {
      "type": "number"
    },
    "m": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q1",
    "a",
    "m",
    "t"
  ]
}

Inputs: q1, a, m, t. Returns q.

dca_forecastScore

unknown

Score production forecasts with MAE, RMSE, MAPE, sMAPE, bias, cumulative error, and SPEE.

Required paramsactualforecast

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "actual": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 0
          },
          {
            "type": "null"
          }
        ]
      },
      "minItems": 1,
      "maxItems": 10000
    },
    "forecast": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 0
          },
          {
            "type": "null"
          }
        ]
      },
      "minItems": 1,
      "maxItems": 10000
    },
    "phase": {
      "type": "string",
      "examples": [
        "oil"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "unknown"
          ]
        },
        {
          "type": "string",
          "enum": [
            "oil"
          ]
        },
        {
          "type": "string",
          "enum": [
            "gas"
          ]
        },
        {
          "type": "string",
          "enum": [
            "water"
          ]
        }
      ],
      "enum": [
        "oil",
        "gas",
        "water",
        "unknown"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "actual",
    "forecast"
  ]
}

Null means unreported, never zero. Cumulative metrics use aligned pairs only.

dca_probabilisticScore

unknown

Score production quantiles: pinball loss, calibration, interval coverage, and crossings.

Required paramsactualquantiles

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "actual": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 0
          },
          {
            "type": "null"
          }
        ]
      },
      "minItems": 1,
      "maxItems": 10000
    },
    "quantiles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quantile": {
            "type": "number",
            "exclusiveMinimum": 0,
            "exclusiveMaximum": 1
          },
          "forecast": {
            "type": "array",
            "minItems": 1,
            "maxItems": 10000,
            "items": {
              "anyOf": [
                {
                  "type": "number",
                  "minimum": 0
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        "required": [
          "quantile",
          "forecast"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 99
    },
    "phase": {
      "type": "string",
      "examples": [
        "oil"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "unknown"
          ]
        },
        {
          "type": "string",
          "enum": [
            "oil"
          ]
        },
        {
          "type": "string",
          "enum": [
            "gas"
          ]
        },
        {
          "type": "string",
          "enum": [
            "water"
          ]
        }
      ],
      "enum": [
        "oil",
        "gas",
        "water",
        "unknown"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "actual",
    "quantiles"
  ]
}

Quantiles are in (0,1); forecast arrays align with actual. Null means missing.

dca_hindcastBenchmark

unknown

Fit DCA models before a cutoff, score the holdout without leakage, and rank them.

Required paramstqcutoffhorizon

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "minItems": 4,
      "maxItems": 600
    },
    "q": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "number",
            "minimum": 0
          },
          {
            "type": "null"
          }
        ]
      },
      "minItems": 4,
      "maxItems": 600
    },
    "cutoff": {
      "type": "integer",
      "examples": [
        4
      ],
      "minimum": 3,
      "maximum": 599
    },
    "horizon": {
      "type": "integer",
      "examples": [
        2
      ],
      "minimum": 1,
      "maximum": 120
    },
    "phase": {
      "type": "string",
      "examples": [
        "oil"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "unknown"
          ]
        },
        {
          "type": "string",
          "enum": [
            "oil"
          ]
        },
        {
          "type": "string",
          "enum": [
            "gas"
          ]
        },
        {
          "type": "string",
          "enum": [
            "water"
          ]
        }
      ],
      "enum": [
        "oil",
        "gas",
        "water",
        "unknown"
      ]
    },
    "timeUnit": {
      "type": "string",
      "examples": [
        "months"
      ],
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "days"
          ]
        },
        {
          "type": "string",
          "enum": [
            "months"
          ]
        },
        {
          "type": "string",
          "enum": [
            "years"
          ]
        }
      ],
      "enum": [
        "days",
        "months",
        "years"
      ]
    },
    "models": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "arps",
          "modified_hyperbolic",
          "duong",
          "sedm",
          "ple",
          "lgm"
        ]
      },
      "minItems": 1,
      "maxItems": 6,
      "uniqueItems": true
    },
    "terminalAnnualDecline": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 10
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q",
    "cutoff",
    "horizon"
  ]
}

Six models; missing rates stay null and skipped or failed runs include reasons.

pvt_water_fvf_mccain

unknown

Water formation volume factor Bw (McCain 1990).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "T"
  ]
}

Inputs: p, T.

pvt_water_rsw_mccain

unknown

Solution gas-water ratio Rsw (McCain 1990), scf/bbl.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "salinity_wt": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "T"
  ]
}

Inputs: p, T, salinity_wt?.

pvt_water_compressibility_undersaturated_mccain

unknown

Water isothermal compressibility - gas-free (undersaturated) (McCain 1990), 1/psi.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "salinity_mgL": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "T"
  ]
}

Inputs: p, T, salinity_mgL?.

pvt_water_compressibility_saturated_mccain

unknown

Water isothermal compressibility - gas-saturated (McCain 1990), 1/psi.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "cw_gasfree": {
      "type": "number"
    },
    "Rsw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "cw_gasfree",
    "Rsw"
  ]
}

Inputs: cw_gasfree, Rsw.

pvt_water_viscosity_mccain

unknown

Brine (water) viscosity (McCain 1990), cp.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "salinity_wt": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "T"
  ]
}

Inputs: p, T, salinity_wt?.

pvt_water_density_mccain

unknown

Brine density at reservoir conditions (McCain 1990), lb/ft³.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "salinity_wt": {
      "type": "number"
    },
    "Bw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "salinity_wt",
    "Bw"
  ]
}

Inputs: salinity_wt, Bw.

pvt_ift_gas_oil_baker_swerdloff

unknown

Dead-oil gas-oil interfacial tension (Baker & Swerdloff, 1956), dynes/cm.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "p": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "API",
    "T",
    "p"
  ]
}

Inputs: API, T, p.

pvt_ift_gas_oil_abdul_majeed

unknown

Gas-oil interfacial tension (Abdul-Majeed & Abu Al-Soof, 2000), dynes/cm.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "Rs": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "API",
    "T",
    "Rs"
  ]
}

Inputs: API, T, Rs.

pvt_wichert_aziz_correction

unknown

Wichert-Aziz (1972) non-hydrocarbon (H2S/CO2) correction to pseudo-criticals.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Tpc": {
      "type": "number"
    },
    "Ppc": {
      "type": "number"
    },
    "yCO2": {
      "type": "number"
    },
    "yH2S": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Tpc",
    "Ppc"
  ]
}

Inputs: Tpc, Ppc, yCO2?, yH2S?.

pvt_bubble_point_glaso

unknown

Glaso (1980) bubble-point pressure, psia.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_bubble_point_al_marhoun

unknown

Al-Marhoun (1988) bubble-point pressure, psia (Saudi/Middle-East crudes).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_bubble_point_petrosky_farshad

unknown

Petrosky-Farshad (1993) bubble-point pressure, psia (Gulf of Mexico).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_solution_gor_glaso

unknown

Glaso (1980) solution GOR Rs at p ≤ Pb, scf/STB (inverse of the Pb form).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: p, gas_sg, API, T.

pvt_oil_fvf_glaso

unknown

Glaso (1980) oil formation volume factor Bo at/below Pb, rb/STB.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_oil_fvf_al_marhoun

unknown

Al-Marhoun (1988) oil formation volume factor Bo, rb/STB.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_oil_fvf_petrosky_farshad

unknown

Petrosky-Farshad (1993) oil formation volume factor Bo, rb/STB (GOM).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_bubble_point_dindoruk_christman

unknown

Dindoruk-Christman (2004) bubble-point pressure, psia (GOM crudes).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rs": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rs",
    "gas_sg",
    "API",
    "T"
  ]
}

Inputs: Rs, gas_sg, API, T.

pvt_oil_compressibility_undersaturated_vasquez_beggs

unknown

Undersaturated oil isothermal compressibility (Vasquez-Beggs, 1980), 1/psi.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Rsb": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "gas_sg": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "p": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Rsb",
    "T",
    "gas_sg",
    "API",
    "p"
  ]
}

Inputs: Rsb, T, gas_sg, API, p.

pvt_oil_compressibility_saturated_villena_lanzi

unknown

Saturated (below-Pb) oil isothermal compressibility.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "API": {
      "type": "number"
    },
    "Rsb": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "T",
    "API",
    "Rsb"
  ]
}

Inputs: p, T, API, Rsb.

pvt_dead_oil_viscosity_glaso

unknown

Glaso (1980) dead-oil viscosity, cp.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "API",
    "T"
  ]
}

Inputs: API, T.

pvt_dead_oil_viscosity_egbogah

unknown

Egbogah-Jack (1990) dead-oil viscosity, cp (Egbogah-Ng modified Beggs-Robinson).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "API": {
      "type": "number"
    },
    "T": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "API",
    "T"
  ]
}

Inputs: API, T.

mbe_pz

unknown

Gas material balance p/z plotting variable for reservoir depletion analysis. [Craft & Hawkins Ch.6]

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "z"
  ]
}

Inputs: p, z.

mbe_ogip_from_pz

unknown

OGIP from p/z material balance: G = Gp/(1 - (p/z)/(p_i/z_i)). [Craft & Hawkins Ch.6]

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p_i": {
      "type": "number"
    },
    "z_i": {
      "type": "number"
    },
    "p": {
      "type": "number"
    },
    "z": {
      "type": "number"
    },
    "Gp": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p_i",
    "z_i",
    "p",
    "z",
    "Gp"
  ]
}

Inputs: p_i, z_i, p, z, Gp.

mbe_pz_geopressured

unknown

Modified p/z for geopressured gas (Ramagost & Farshad, SPE 10125).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "z": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "c_w": {
      "type": "number"
    },
    "c_f": {
      "type": "number"
    },
    "S_wi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p",
    "z",
    "p_i",
    "c_w",
    "c_f",
    "S_wi"
  ]
}

Inputs: p, z, p_i, c_w, c_f, S_wi.

mbe_gas_Gp_at_pressure

unknown

Predict Gp at pressure (volumetric gas): Gp = G*(1 - (p/z)/(p_i/z_i)).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "G": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "z_i": {
      "type": "number"
    },
    "p": {
      "type": "number"
    },
    "z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "G",
    "p_i",
    "z_i",
    "p",
    "z"
  ]
}

Inputs: G, p_i, z_i, p, z.

mbe_gas_pressure_at_Gp

unknown

Predict pressure at Gp (volumetric gas): p/z = (p_i/z_i)*(1 - Gp/G).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "G": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "z_i": {
      "type": "number"
    },
    "Gp": {
      "type": "number"
    },
    "z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "G",
    "p_i",
    "z_i",
    "Gp"
  ]
}

Inputs: G, p_i, z_i, Gp, z?.

mbe_gas_recovery_factor

unknown

Ultimate gas recovery factor at abandonment: RF = 1 - (p_a/z_a)/(p_i/z_i).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p_i": {
      "type": "number"
    },
    "z_i": {
      "type": "number"
    },
    "p_a": {
      "type": "number"
    },
    "z_a": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p_i",
    "z_i",
    "p_a",
    "z_a"
  ]
}

Inputs: p_i, z_i, p_a, z_a.

mbe_Bt

unknown

Two-phase FVF Bt = Bo + (Rs_i - Rs)*Bg.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Bo": {
      "type": "number"
    },
    "Bg": {
      "type": "number"
    },
    "Rs_i": {
      "type": "number"
    },
    "Rs": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Bo",
    "Bg",
    "Rs_i",
    "Rs"
  ]
}

Inputs: Bo, Bg, Rs_i, Rs.

mbe_withdrawal_F

unknown

Underground withdrawal F (Havlena-Odeh): F = Np*[Bo+(Rp-Rs)*Bg]+Wp*Bw, Rp=Gp/Np.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Np": {
      "type": "number"
    },
    "Gp": {
      "type": "number"
    },
    "Bo": {
      "type": "number"
    },
    "Bg": {
      "type": "number"
    },
    "Rs": {
      "type": "number"
    },
    "Wp": {
      "type": "number"
    },
    "Bw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Np",
    "Gp",
    "Bo",
    "Bg",
    "Rs"
  ]
}

Inputs: Np, Gp, Bo, Bg, Rs, Wp?, Bw?.

mbe_Eo

unknown

Oil + dissolved-gas expansion Eo = (Bo-Bo_i)+(Rs_i-Rs)*Bg.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Bo": {
      "type": "number"
    },
    "Bo_i": {
      "type": "number"
    },
    "Bg": {
      "type": "number"
    },
    "Rs_i": {
      "type": "number"
    },
    "Rs": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Bo",
    "Bo_i",
    "Bg",
    "Rs_i",
    "Rs"
  ]
}

Inputs: Bo, Bo_i, Bg, Rs_i, Rs.

mbe_Eg

unknown

Gas-cap expansion Eg = Bt_i*(Bg/Bg_i - 1).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Bt_i": {
      "type": "number"
    },
    "Bg": {
      "type": "number"
    },
    "Bg_i": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Bt_i",
    "Bg",
    "Bg_i"
  ]
}

Inputs: Bt_i, Bg, Bg_i.

mbe_Efw

unknown

Material balance formation and connate water expansion term Efw (MBE).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "m": {
      "type": "number"
    },
    "Bt_i": {
      "type": "number"
    },
    "c_w": {
      "type": "number"
    },
    "c_f": {
      "type": "number"
    },
    "S_wi": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "p": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "m",
    "Bt_i",
    "c_w",
    "c_f",
    "S_wi",
    "p_i",
    "p"
  ]
}

Inputs: m, Bt_i, c_w, c_f, S_wi, p_i, p.

mbe_co_undersaturated

unknown

Undersaturated oil compressibility: c_o = -(Bo-Bo_i)/(Bo_i*(p-p_i)).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Bo_i": {
      "type": "number"
    },
    "Bo": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "p": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Bo_i",
    "Bo",
    "p_i",
    "p"
  ]
}

Inputs: Bo_i, Bo, p_i, p.

mbe_cg

unknown

Real-gas compressibility: c_g = 1/p - (1/z)*(dz/dp) (or 1/p ideal).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p": {
      "type": "number"
    },
    "z": {
      "type": "number"
    },
    "dz_dp": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p"
  ]
}

Inputs: p, z?, dz_dp?.

mbe_ct_total

unknown

Total system compressibility: c_t = c_o*S_o + c_w*S_w + c_g*S_g + c_f.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "c_o": {
      "type": "number"
    },
    "S_o": {
      "type": "number"
    },
    "c_w": {
      "type": "number"
    },
    "S_w": {
      "type": "number"
    },
    "c_g": {
      "type": "number"
    },
    "S_g": {
      "type": "number"
    },
    "c_f": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "c_o",
    "S_o",
    "c_w",
    "S_w",
    "c_f"
  ]
}

Inputs: c_o, S_o, c_w, S_w, c_g?, S_g?, c_f.

mbe_ce_undersaturated

unknown

Effective undersaturated-oil compressibility: c_e = (c_o*S_o+c_w*S_wi+c_f)/(1-S_wi).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "c_o": {
      "type": "number"
    },
    "S_o": {
      "type": "number"
    },
    "c_w": {
      "type": "number"
    },
    "S_wi": {
      "type": "number"
    },
    "c_f": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "c_o",
    "S_o",
    "c_w",
    "S_wi",
    "c_f"
  ]
}

Inputs: c_o, S_o, c_w, S_wi, c_f.

mbe_fetkovich_J_radial

unknown

Fetkovich radial J = 0.00708*k*h*f/(mu_w*(ln(r_aR)-0.75)).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "mu_w": {
      "type": "number"
    },
    "r_aR": {
      "type": "number"
    },
    "f": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "k",
    "h",
    "mu_w",
    "r_aR"
  ]
}

Inputs: k, h, mu_w, r_aR, f?.

mbe_fetkovich_J_linear

unknown

Fetkovich linear J = 0.001127*k*w*h/(mu_w*L).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "w": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "mu_w": {
      "type": "number"
    },
    "L": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "k",
    "w",
    "h",
    "mu_w",
    "L"
  ]
}

Inputs: k, w, h, mu_w, L.

mbe_fetkovich_Wei

unknown

Fetkovich max encroachable water Wei = c_t*W_i*p_i.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "c_t": {
      "type": "number"
    },
    "W_i": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "c_t",
    "W_i",
    "p_i"
  ]
}

Inputs: c_t, W_i, p_i.

mbe_fetkovich_Wi_radial

unknown

Fetkovich initial aquifer water volume (radial): W_i = (pi/5.615)*(r_a^2-r_o^2)*h*phi*f.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "r_a": {
      "type": "number"
    },
    "r_o": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "f": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "r_a",
    "r_o",
    "h",
    "phi"
  ]
}

Inputs: r_a, r_o, h, phi, f?.

mbe_fetkovich_avg_pressure

unknown

Fetkovich average aquifer pressure: p_aq = p_i*(1 - We/Wei).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p_i": {
      "type": "number"
    },
    "We": {
      "type": "number"
    },
    "Wei": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p_i",
    "We",
    "Wei"
  ]
}

Inputs: p_i, We, Wei.

mbe_fetkovich_influx_step

unknown

Fetkovich incremental influx step: dWe = (Wei/p_i)*(p_a_prev - p_R)*[1-exp(-J*p_i*dt/Wei)].

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Wei": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "p_a_prev": {
      "type": "number"
    },
    "p_R": {
      "type": "number"
    },
    "J": {
      "type": "number"
    },
    "dt": {
      "type": "number"
    },
    "We_prev": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Wei",
    "p_i",
    "p_a_prev",
    "p_R",
    "J",
    "dt"
  ]
}

Inputs: Wei, p_i, p_a_prev, p_R, J, dt, We_prev?.

mbe_schilthuis_rate

unknown

Schilthuis steady-state rate: q_w = C*(p_i - p).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "C": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "p": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "C",
    "p_i",
    "p"
  ]
}

Inputs: C, p_i, p.

mbe_schilthuis_We

unknown

Schilthuis cumulative influx: We = C*Σ(p_i - p_j)*dt_j.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "C": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "pressures": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "dt": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "C",
    "p_i",
    "pressures",
    "dt"
  ]
}

Inputs: C, p_i, pressures, dt.

mbe_veh_dimensionless

unknown

van Everdingen-Hurst dimensionless r_D, t_D (t in days), aquifer constant U.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "r_a": {
      "type": "number"
    },
    "r_o": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "mu_w": {
      "type": "number"
    },
    "c_t": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "f": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "r_a",
    "r_o",
    "k",
    "t",
    "phi",
    "mu_w",
    "c_t",
    "h"
  ]
}

Inputs: r_a, r_o, k, t, phi, mu_w, c_t, h, f?.

mbe_veh_We

unknown

vEH water influx (single Δp step): We = U*Δp*Q(t_D).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "U": {
      "type": "number"
    },
    "dp": {
      "type": "number"
    },
    "Q_tD": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "U",
    "dp",
    "Q_tD"
  ]
}

Inputs: U, dp, Q_tD.

mbe_pot_aquifer

unknown

Pot aquifer: pore volume W_aq and instantaneous influx We = (c_w+c_f)*W_aq*(p_i-p).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "r_a": {
      "type": "number"
    },
    "r_o": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "c_w": {
      "type": "number"
    },
    "c_f": {
      "type": "number"
    },
    "p_i": {
      "type": "number"
    },
    "p": {
      "type": "number"
    },
    "f": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "r_a",
    "r_o",
    "h",
    "phi",
    "c_w",
    "c_f",
    "p_i",
    "p"
  ]
}

Inputs: r_a, r_o, h, phi, c_w, c_f, p_i, p, f?.

scal_brooksCoreyPc

unknown

Brooks-Corey capillary pressure from water saturation (drainage).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sw": {
      "type": "number"
    },
    "Swi": {
      "type": "number"
    },
    "Pd": {
      "type": "number"
    },
    "lambda": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sw",
    "Swi",
    "Pd",
    "lambda"
  ]
}

Inputs: Sw, Swi, Pd, lambda.

scal_brooksCoreySw

unknown

Brooks-Corey water saturation from capillary pressure (inverse).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Pc": {
      "type": "number"
    },
    "Swi": {
      "type": "number"
    },
    "Pd": {
      "type": "number"
    },
    "lambda": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Pc",
    "Swi",
    "Pd",
    "lambda"
  ]
}

Inputs: Pc, Swi, Pd, lambda.

scal_vanGenuchtenPc

unknown

van Genuchten capillary pressure from water saturation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sw": {
      "type": "number"
    },
    "Swr": {
      "type": "number"
    },
    "alpha": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "m": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sw",
    "Swr",
    "alpha",
    "n"
  ]
}

Inputs: Sw, Swr, alpha, n, m?.

scal_vanGenuchtenSw

unknown

van Genuchten water saturation from capillary pressure (inverse).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Pc": {
      "type": "number"
    },
    "Swr": {
      "type": "number"
    },
    "alpha": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "m": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Pc",
    "Swr",
    "alpha",
    "n"
  ]
}

Inputs: Pc, Swr, alpha, n, m?.

scal_leverettJ

unknown

Leverett J-function from capillary pressure.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Pc": {
      "type": "number"
    },
    "sigma": {
      "type": "number"
    },
    "theta": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "constant": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Pc",
    "sigma",
    "theta",
    "k",
    "phi"
  ]
}

Inputs: Pc, sigma, theta, k, phi, constant?.

scal_leverettPc

unknown

Capillary pressure from Leverett J-function (inverse).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "J": {
      "type": "number"
    },
    "sigma": {
      "type": "number"
    },
    "theta": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "constant": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "J",
    "sigma",
    "theta",
    "k",
    "phi"
  ]
}

Inputs: J, sigma, theta, k, phi, constant?.

scal_normalizedWaterSaturation

unknown

Normalized water saturation (Corey/effective saturation) for a water-oil system.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sw": {
      "type": "number"
    },
    "Swc": {
      "type": "number"
    },
    "Sorw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sw",
    "Swc",
    "Sorw"
  ]
}

Inputs: Sw, Swc, Sorw.

scal_coreyKrw

unknown

Corey water relative permeability (water-oil system).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sw": {
      "type": "number"
    },
    "Swc": {
      "type": "number"
    },
    "Sorw": {
      "type": "number"
    },
    "nw": {
      "type": "number"
    },
    "krwMax": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sw",
    "Swc",
    "Sorw",
    "nw"
  ]
}

Inputs: Sw, Swc, Sorw, nw, krwMax?.

scal_coreyKro

unknown

Corey oil relative permeability (water-oil system).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sw": {
      "type": "number"
    },
    "Swc": {
      "type": "number"
    },
    "Sorw": {
      "type": "number"
    },
    "no": {
      "type": "number"
    },
    "kroMax": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sw",
    "Swc",
    "Sorw",
    "no"
  ]
}

Inputs: Sw, Swc, Sorw, no, kroMax?.

scal_coreyKrg

unknown

Corey gas relative permeability (gas-oil / gas-liquid system, drainage).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sg": {
      "type": "number"
    },
    "Sgc": {
      "type": "number"
    },
    "Sorg": {
      "type": "number"
    },
    "Swc": {
      "type": "number"
    },
    "ng": {
      "type": "number"
    },
    "krgMax": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sg",
    "Sgc",
    "Sorg",
    "Swc",
    "ng"
  ]
}

Inputs: Sg, Sgc, Sorg, Swc, ng, krgMax?.

scal_newmanCfSandstone

unknown

Newman (1973) pore-volume compressibility - consolidated sandstone correlation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "phi"
  ]
}

Inputs: phi.

scal_newmanCfLimestone

unknown

Newman (1973) pore-volume compressibility - consolidated limestone correlation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "phi"
  ]
}

Inputs: phi.

scal_hallCf

unknown

Hall (1953) pore-volume (formation) compressibility correlation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "phi"
  ]
}

Inputs: phi.

scal_amottHarveyIndex

unknown

Amott-Harvey wettability index.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Vwsp": {
      "type": "number"
    },
    "Vwf": {
      "type": "number"
    },
    "Vosp": {
      "type": "number"
    },
    "Vof": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Vwsp",
    "Vwf",
    "Vosp",
    "Vof"
  ]
}

Inputs: Vwsp, Vwf, Vosp, Vof.

scal_oilSaturation

unknown

Total saturation closure check / oil saturation helper.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Sw": {
      "type": "number"
    },
    "Sg": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Sw"
  ]
}

Inputs: Sw, Sg?.

frac_plane_strain_modulus

unknown

Plane-strain modulus E' = E/(1-nu^2). [Economides & Nolte, Reservoir Stimulation 3rd ed.]

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "E": {
      "type": "number"
    },
    "nu": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "E",
    "nu"
  ]
}

Inputs: E, nu.

frac_pkn_width_wellbore

unknown

PKN wellbore (max) fracture width.

Entitiescalculation, frac_job, completion, well

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    },
    "Eprime": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "mu",
    "xf",
    "Eprime"
  ]
}

Inputs: q, mu, xf, Eprime.

frac_pkn_width_average

unknown

PKN average fracture width. w_avg = (pi/4)*(4/5)*w_w ≈ 0.628*w_w.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    },
    "Eprime": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "mu",
    "xf",
    "Eprime"
  ]
}

Inputs: q, mu, xf, Eprime.

frac_pkn_net_pressure

unknown

PKN net (treating) pressure at wellbore.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "Eprime": {
      "type": "number"
    },
    "width_ft": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Eprime",
    "width_ft",
    "hf"
  ]
}

Inputs: Eprime, width_ft, hf.

frac_pkn_volume

unknown

PKN fracture volume (one wing pair, two wings, total) using ellipsoidal cross-section.

Entitiescalculation, production, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "xf": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "xf",
    "hf",
    "width_avg_ft"
  ]
}

Inputs: xf, hf, width_avg_ft.

frac_pkn_halflength_noleakoff

unknown

PKN fracture half-length WITHOUT leakoff (efficiency = 1): all injected fluid stored.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "t",
    "hf",
    "width_avg_ft"
  ]
}

Inputs: q, t, hf, width_avg_ft.

frac_pkn_halflength_leakoff

unknown

PKN fracture half-length WITH Carter leakoff (Carter 1957 area-balance, approximate).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    },
    "CL": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "t",
    "hf",
    "width_avg_ft",
    "CL"
  ]
}

Inputs: q, t, hf, width_avg_ft, CL.

frac_kgd_width_wellbore

unknown

KGD wellbore (max) width.

Entitiescalculation, frac_job, completion, well

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "Eprime": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "mu",
    "xf",
    "hf",
    "Eprime"
  ]
}

Inputs: q, mu, xf, hf, Eprime.

frac_kgd_width_average

unknown

KGD average width. w_avg = (pi/4)*w_w (elliptical horizontal cross-section).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "Eprime": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "mu",
    "xf",
    "hf",
    "Eprime"
  ]
}

Inputs: q, mu, xf, hf, Eprime.

frac_kgd_net_pressure

unknown

KGD net pressure. p_net = E'*w_w/(2*x_f) (plane-strain in horizontal plane).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "Eprime": {
      "type": "number"
    },
    "width_ft": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Eprime",
    "width_ft",
    "xf"
  ]
}

Inputs: Eprime, width_ft, xf.

frac_kgd_volume

unknown

KGD fracture volume. V_f = 2*x_f*h_f*w_avg [ft^3]. [volume balance]

Entitiescalculation, production, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "xf": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "xf",
    "hf",
    "width_avg_ft"
  ]
}

Inputs: xf, hf, width_avg_ft.

frac_kgd_halflength_noleakoff

unknown

KGD half-length WITHOUT leakoff. x_f = q*t/(2*h_f*w_avg) [ft]. [volume balance]

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "t",
    "hf",
    "width_avg_ft"
  ]
}

Inputs: q, t, hf, width_avg_ft.

frac_kgd_halflength_leakoff

unknown

KGD half-length WITH Carter leakoff (area balance, approximate).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "hf": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    },
    "CL": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "t",
    "hf",
    "width_avg_ft",
    "CL"
  ]
}

Inputs: q, t, hf, width_avg_ft, CL.

frac_radial_width_wellbore

unknown

Radial (penny-shaped) wellbore (max) width.

Entitiescalculation, frac_job, completion, well

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "R": {
      "type": "number"
    },
    "Eprime": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "mu",
    "R",
    "Eprime"
  ]
}

Inputs: q, mu, R, Eprime.

frac_radial_width_average

unknown

Radial average width. w_avg = (8/(3*pi))*w_w ≈ 0.849*w_w (Sneddon penny crack).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "R": {
      "type": "number"
    },
    "Eprime": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "mu",
    "R",
    "Eprime"
  ]
}

Inputs: q, mu, R, Eprime.

frac_radial_net_pressure

unknown

Radial net pressure. p_net = (pi/2)*E'*w_w/(4*R) ≈ Sneddon penny-crack relation.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "Eprime": {
      "type": "number"
    },
    "width_ft": {
      "type": "number"
    },
    "R": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Eprime",
    "width_ft",
    "R"
  ]
}

Inputs: Eprime, width_ft, R.

frac_radial_volume

unknown

Radial fracture volume. V_f = (2/3)*pi*R^2*w_w (penny-shaped, Sneddon ellipsoidal)

Entitiescalculation, production, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "R": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "R",
    "width_avg_ft"
  ]
}

Inputs: R, width_avg_ft.

frac_radial_radius_noleakoff

unknown

Radial fracture radius WITHOUT leakoff. q*t = pi*R^2*w_avg -> R = sqrt(q*t/(pi*w_avg)).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "t",
    "width_avg_ft"
  ]
}

Inputs: q, t, width_avg_ft.

frac_radial_radius_leakoff

unknown

Radial fracture radius WITH Carter leakoff (area balance, approximate).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "width_avg_ft": {
      "type": "number"
    },
    "CL": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "t",
    "width_avg_ft",
    "CL"
  ]
}

Inputs: q, t, width_avg_ft, CL.

frac_leakoff_Cv

unknown

Viscosity-controlled leakoff coefficient C_v (filtrate invasion, Carter region I).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "dp": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "k",
    "phi",
    "dp",
    "mu"
  ]
}

Inputs: k, phi, dp, mu.

frac_leakoff_Cc

unknown

Compressibility-controlled (reservoir) leakoff coefficient C_c (Carter region III).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "dp": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "ct": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "dp",
    "k",
    "phi",
    "ct",
    "mu"
  ]
}

Inputs: dp, k, phi, ct, mu.

frac_leakoff_combined

unknown

Combined Carter leakoff coefficient from series resistances.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "Cv": {
      "type": "number"
    },
    "Cc": {
      "type": "number"
    },
    "Cw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Cv",
    "Cc"
  ]
}

Inputs: Cv, Cc, Cw?.

frac_leakoff_velocity

unknown

Carter leakoff velocity at exposure time tau: u_L = C_L / sqrt(tau) [ft/min].

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "CL": {
      "type": "number"
    },
    "tau": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "CL",
    "tau"
  ]
}

Inputs: CL, tau.

frac_leakoff_volume

unknown

Cumulative Carter leakoff volume per unit fracture area exposed for time t.

Entitiescalculation, production, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "CL": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "area": {
      "type": "number"
    },
    "Sp": {
      "type": "number"
    },
    "faces": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "CL",
    "t",
    "area"
  ]
}

Inputs: CL, t, area, Sp?, faces?.

frac_fluid_efficiency

unknown

Fluid efficiency eta = V_fracture / V_injected (stored fraction).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "V_fracture": {
      "type": "number"
    },
    "V_injected": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "V_fracture",
    "V_injected"
  ]
}

Inputs: V_fracture, V_injected.

frac_proppant_stokes_velocity

unknown

Stokes terminal (single-particle) settling velocity in laminar regime (Re<1).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "dp_in": {
      "type": "number"
    },
    "rho_p": {
      "type": "number"
    },
    "rho_f": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "dp_in",
    "rho_p",
    "rho_f",
    "mu"
  ]
}

Inputs: dp_in, rho_p, rho_f, mu.

frac_proppant_hindered_velocity

unknown

Hindered settling (Richardson & Zaki 1954): v_h = v_s * (1 - C)^n.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "vs": {
      "type": "number"
    },
    "C": {
      "type": "number"
    },
    "n": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "vs",
    "C"
  ]
}

Inputs: vs, C, n?.

frac_proppant_reynolds

unknown

Particle Reynolds number Re_p = rho_f * v * d_p / mu (dimensionless).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "rho_f": {
      "type": "number"
    },
    "v_ft_s": {
      "type": "number"
    },
    "dp_in": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "rho_f",
    "v_ft_s",
    "dp_in",
    "mu"
  ]
}

Inputs: rho_f, v_ft_s, dp_in, mu.

frac_proppant_transport_ratio

unknown

Transport (placement) ratio = horizontal slurry velocity / settling velocity.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "v_horizontal": {
      "type": "number"
    },
    "v_settling": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "v_horizontal",
    "v_settling"
  ]
}

Inputs: v_horizontal, v_settling.

frac_proppant_wall_correction

unknown

Wall (channel) correction factor for settling between parallel fracture faces.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "dp_in": {
      "type": "number"
    },
    "width_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "dp_in",
    "width_in"
  ]
}

Inputs: dp_in, width_in.

frac_dimensionless_conductivity

unknown

Dimensionless fracture conductivity C_fd = (k_f * w) / (k * x_f).

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "kf": {
      "type": "number"
    },
    "w_ft": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "kf",
    "w_ft",
    "k",
    "xf"
  ]
}

Inputs: kf, w_ft, k, xf.

frac_equivalent_skin

unknown

Equivalent skin factor of a fractured vertical well.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "Cfd": {
      "type": "number"
    },
    "xf": {
      "type": "number"
    },
    "rw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Cfd",
    "xf",
    "rw"
  ]
}

Inputs: Cfd, xf, rw.

sf_chokeCriticalPressure

unknown

Critical-flow wellhead pressure upstream of a bean choke.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "liquidRate": {
      "type": "number"
    },
    "gasLiquidRatio": {
      "type": "number"
    },
    "beanSize64": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "gilbert"
          ]
        },
        {
          "type": "string",
          "enum": [
            "ros"
          ]
        },
        {
          "type": "string",
          "enum": [
            "baxendell"
          ]
        },
        {
          "type": "string",
          "enum": [
            "achong"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "liquidRate",
    "gasLiquidRatio",
    "beanSize64"
  ]
}

sf_chokeCriticalRate

unknown

Liquid rate through a bean in critical flow, inverted from.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "wellheadPressure": {
      "type": "number"
    },
    "gasLiquidRatio": {
      "type": "number"
    },
    "beanSize64": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "gilbert"
          ]
        },
        {
          "type": "string",
          "enum": [
            "ros"
          ]
        },
        {
          "type": "string",
          "enum": [
            "baxendell"
          ]
        },
        {
          "type": "string",
          "enum": [
            "achong"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "wellheadPressure",
    "gasLiquidRatio",
    "beanSize64"
  ]
}

sf_chokeCriticalBean

unknown

Bean size (64ths-inch) needed to pass a target rate at a given wellhead.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "wellheadPressure": {
      "type": "number"
    },
    "liquidRate": {
      "type": "number"
    },
    "gasLiquidRatio": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "gilbert"
          ]
        },
        {
          "type": "string",
          "enum": [
            "ros"
          ]
        },
        {
          "type": "string",
          "enum": [
            "baxendell"
          ]
        },
        {
          "type": "string",
          "enum": [
            "achong"
          ]
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "wellheadPressure",
    "liquidRate",
    "gasLiquidRatio"
  ]
}

sf_sonicGasChokeRate

unknown

Sonic (critical) gas rate through a choke, field units. From the standard.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "upstreamPressure": {
      "type": "number"
    },
    "upstreamTempF": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "beanSize64": {
      "type": "number"
    },
    "dischargeCoeff": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "upstreamPressure",
    "upstreamTempF",
    "gasGravity",
    "beanSize64"
  ]
}

sf_subcriticalLiquidChoke

unknown

Subcritical (incompressible) liquid flow through a choke/bean using the.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pressureDrop": {
      "type": "number"
    },
    "liquidRate": {
      "type": "number"
    },
    "beanSize64": {
      "type": "number"
    },
    "liquidSG": {
      "type": "number"
    },
    "dischargeCoeff": {
      "type": "number"
    },
    "solveFor": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "rate"
          ]
        },
        {
          "type": "string",
          "enum": [
            "pressureDrop"
          ]
        },
        {
          "type": "string",
          "enum": [
            "bean"
          ]
        }
      ]
    },
    "targetRate": {
      "type": "number"
    },
    "targetDrop": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "beanSize64",
    "liquidSG"
  ]
}

sf_sachdevaCriticalBoundary

unknown

Sachdeva et al. (1986) two-phase critical pressure ratio y_c, solved by.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "gasMassFraction": {
      "type": "number"
    },
    "gasDensityUpstream": {
      "type": "number"
    },
    "liquidDensity": {
      "type": "number"
    },
    "liquidSpecificHeat": {
      "type": "number"
    },
    "gasCv": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "gasMassFraction",
    "gasDensityUpstream",
    "liquidDensity"
  ]
}

sf_sachdevaRate

unknown

Sachdeva et al. (1986) two-phase mass flux + rate through a choke (SPE 15657).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "upstreamPressure": {
      "type": "number"
    },
    "downstreamPressure": {
      "type": "number"
    },
    "k": {
      "type": "number"
    },
    "gasMassFraction": {
      "type": "number"
    },
    "gasDensityUpstream": {
      "type": "number"
    },
    "liquidDensity": {
      "type": "number"
    },
    "beanSize64": {
      "type": "number"
    },
    "dischargeCoeff": {
      "type": "number"
    },
    "liquidSpecificHeat": {
      "type": "number"
    },
    "gasCv": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "upstreamPressure",
    "downstreamPressure",
    "gasMassFraction",
    "gasDensityUpstream",
    "liquidDensity",
    "beanSize64"
  ]
}

sf_gasPipelineRate

unknown

Gas pipeline flow rate from inlet & outlet pressures.

Entitiescalculation, pipeline

Input schema

{
  "type": "object",
  "properties": {
    "outletPressure": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "weymouth"
          ]
        },
        {
          "type": "string",
          "enum": [
            "panhandleA"
          ]
        },
        {
          "type": "string",
          "enum": [
            "panhandleB"
          ]
        }
      ]
    },
    "inletPressure": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "length": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "avgTempF": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    },
    "baseTempR": {
      "type": "number"
    },
    "basePressure": {
      "type": "number"
    },
    "efficiency": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "outletPressure",
    "inletPressure",
    "diameter",
    "length",
    "gasGravity",
    "avgTempF"
  ]
}

sf_gasPipelineOutletPressure

unknown

Gas pipeline outlet pressure from a known flow rate.

Entitiescalculation, pipeline

Input schema

{
  "type": "object",
  "properties": {
    "gasRate": {
      "type": "number"
    },
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "weymouth"
          ]
        },
        {
          "type": "string",
          "enum": [
            "panhandleA"
          ]
        },
        {
          "type": "string",
          "enum": [
            "panhandleB"
          ]
        }
      ]
    },
    "inletPressure": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "length": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "avgTempF": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    },
    "baseTempR": {
      "type": "number"
    },
    "basePressure": {
      "type": "number"
    },
    "efficiency": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "gasRate",
    "inletPressure",
    "diameter",
    "length",
    "gasGravity",
    "avgTempF"
  ]
}

sf_gasDensity

unknown

Gas density at flowing pipeline conditions, real-gas law (field units)

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pressure": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pressure",
    "tempF",
    "gasGravity"
  ]
}

sf_gasVelocity

unknown

Actual gas velocity in a pipe, field units. Convert standard rate to actual.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "gasRate": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "pressure": {
      "type": "number"
    },
    "tempF": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    },
    "baseTempR": {
      "type": "number"
    },
    "basePressure": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "gasRate",
    "diameter",
    "pressure",
    "tempF"
  ]
}

sf_gasReynolds

unknown

Gas Reynolds number, field units (dimensionless). Standard pipeline form.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "gasRate": {
      "type": "number"
    },
    "gasGravity": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "viscosity": {
      "type": "number"
    },
    "baseTempR": {
      "type": "number"
    },
    "basePressure": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "gasRate",
    "gasGravity",
    "diameter",
    "viscosity"
  ]
}

sf_liquidVelocity

unknown

Liquid velocity in a pipe, field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "liquidRate": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "liquidRate",
    "diameter"
  ]
}

sf_liquidReynolds

unknown

Liquid Reynolds number, field units (dimensionless)

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "liquidRate": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "liquidSG": {
      "type": "number"
    },
    "viscosity": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "liquidRate",
    "diameter",
    "liquidSG",
    "viscosity"
  ]
}

sf_liquidPressureDrop

write

Single-phase liquid frictional pressure drop in a horizontal pipe via.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "liquidRate": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "length": {
      "type": "number"
    },
    "liquidSG": {
      "type": "number"
    },
    "viscosity": {
      "type": "number"
    },
    "roughness": {
      "type": "number"
    },
    "frictionFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "liquidRate",
    "diameter",
    "length",
    "liquidSG",
    "viscosity"
  ]
}

sf_liquidOutletPressure

unknown

Liquid pipeline outlet pressure = inlet - frictional ΔP.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "inletPressure": {
      "type": "number"
    },
    "liquidRate": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "length": {
      "type": "number"
    },
    "liquidSG": {
      "type": "number"
    },
    "viscosity": {
      "type": "number"
    },
    "roughness": {
      "type": "number"
    },
    "frictionFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "inletPressure",
    "liquidRate",
    "diameter",
    "length",
    "liquidSG",
    "viscosity"
  ]
}

sf_liquidInletPressure

unknown

Liquid pipeline inlet pressure = outlet + frictional ΔP.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "outletPressure": {
      "type": "number"
    },
    "liquidRate": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "length": {
      "type": "number"
    },
    "liquidSG": {
      "type": "number"
    },
    "viscosity": {
      "type": "number"
    },
    "roughness": {
      "type": "number"
    },
    "frictionFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "outletPressure",
    "liquidRate",
    "diameter",
    "length",
    "liquidSG",
    "viscosity"
  ]
}

sf_liquidRateFromPressureDrop

write

Liquid flow rate from a known frictional ΔP. Because the Moody friction.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pressureDrop": {
      "type": "number"
    },
    "diameter": {
      "type": "number"
    },
    "length": {
      "type": "number"
    },
    "liquidSG": {
      "type": "number"
    },
    "viscosity": {
      "type": "number"
    },
    "roughness": {
      "type": "number"
    },
    "maxIter": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pressureDrop",
    "diameter",
    "length",
    "liquidSG",
    "viscosity"
  ]
}

ipr_vogel

unknown

Vogel (1968) two-phase IPR forward rate from pwf given qmax (or a test point).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    },
    "qmax": {
      "type": "number"
    },
    "qTest": {
      "type": "number"
    },
    "pwfTest": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pr",
    "pwf"
  ]
}

Inputs: pr, pwf, qmax?, qTest?, pwfTest?.

ipr_vogelQmax

unknown

Vogel (1968) qmax (AOF) from a single (q,pwf,pr) test point below bubble point.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pr": {
      "type": "number"
    },
    "q": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pr",
    "q",
    "pwf"
  ]
}

Inputs: pr, q, pwf.

ipr_productivityIndex

unknown

Straight-line productivity index J = q/(pr - pwf) (single-phase, pwf > pb).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "q": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q",
    "pr",
    "pwf"
  ]
}

Inputs: q, pr, pwf.

ipr_straightLineRate

unknown

Straight-line rate q = J(pr - pwf) for undersaturated single-phase flow.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "J": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "J",
    "pr",
    "pwf"
  ]
}

Inputs: J, pr, pwf.

ipr_compositeIPR

unknown

Composite IPR: straight-line above pb + Vogel below pb, using J at bubble point.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "J": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pb": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "J",
    "pr",
    "pb",
    "pwf"
  ]
}

Inputs: J, pr, pb, pwf.

ipr_fetkovich

unknown

Fetkovich (1973) forward rate q = C(pr^2 - pwf^2)^n given C and n.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "C": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "C",
    "n",
    "pr",
    "pwf"
  ]
}

Inputs: C, n, pr, pwf.

ipr_fetkovichCn

unknown

Fetkovich (1973) C,n fit from >=2 flow-after-flow test points (log-log regression).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pr": {
      "type": "number"
    },
    "points": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "q": {
            "type": "number"
          },
          "pwf": {
            "type": "number"
          }
        },
        "required": [
          "q",
          "pwf"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "pr",
    "points"
  ]
}

Inputs: pr, points, pwf.

ipr_standingModifiedVogel

unknown

Standing (1970) Vogel extension using flow efficiency FE (damaged/stimulated).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    },
    "FE": {
      "type": "number"
    },
    "qmaxFE1": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pr",
    "pwf",
    "FE",
    "qmaxFE1"
  ]
}

Inputs: pr, pwf, FE, qmaxFE1.

ipr_wigginsThreePhase

unknown

Wiggins (1993) three-phase oil IPR (generalized Vogel coefficients).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    },
    "qmax": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pr",
    "pwf",
    "qmax"
  ]
}

Inputs: pr, pwf, qmax.

ipr_jonesEquation

unknown

Jones (1976) quadratic IPR rate from pr - pwf = a*q + b*q^2 (Darcy + turbulence).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "a",
    "b",
    "pr",
    "pwf"
  ]
}

Inputs: a, b, pr, pwf.

ipr_jonesFit

unknown

Jones (1976) a,b fit from >=2 test points: (pr - pwf)/q = a + b*q (linear).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pr": {
      "type": "number"
    },
    "points": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "q": {
            "type": "number"
          },
          "pwf": {
            "type": "number"
          }
        },
        "required": [
          "q",
          "pwf"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "pr",
    "points"
  ]
}

Inputs: pr, points, pwf.

ipr_darcyRadialOil

unknown

Darcy semi-steady-state radial oil rate (field units), STB/d.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "Bo": {
      "type": "number"
    },
    "re": {
      "type": "number"
    },
    "rw": {
      "type": "number"
    },
    "s": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "k",
    "h",
    "pr",
    "pwf",
    "mu",
    "Bo",
    "re",
    "rw"
  ]
}

Inputs: k, h, pr, pwf, mu, Bo, re, rw, s?.

ipr_darcyRadialGas

unknown

Darcy pseudo-steady-state radial gas rate (field units), Mscf/d.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "z": {
      "type": "number"
    },
    "T": {
      "type": "number"
    },
    "re": {
      "type": "number"
    },
    "rw": {
      "type": "number"
    },
    "s": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "k",
    "h",
    "pr",
    "pwf",
    "mu",
    "z",
    "T",
    "re",
    "rw"
  ]
}

Inputs: k, h, pr, pwf, mu, z, T, re, rw, s?.

ipr_joshiHorizontal

unknown

Joshi (1988) horizontal-well steady-state oil rate (field units), STB/d.

Entitiescalculation, formation

Input schema

{
  "type": "object",
  "properties": {
    "k": {
      "type": "number"
    },
    "kv": {
      "type": "number"
    },
    "h": {
      "type": "number"
    },
    "L": {
      "type": "number"
    },
    "reH": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    },
    "pwf": {
      "type": "number"
    },
    "mu": {
      "type": "number"
    },
    "Bo": {
      "type": "number"
    },
    "rw": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "k",
    "h",
    "L",
    "reH",
    "pr",
    "pwf",
    "mu",
    "Bo",
    "rw"
  ]
}

Inputs: k, kv?, h, L, reH, pr, pwf, mu, Bo, rw.

ipr_absoluteOpenFlow

unknown

Absolute open flow (AOF) at pwf=0 for Vogel and Fetkovich IPR forms.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "form": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "vogel"
          ]
        },
        {
          "type": "string",
          "enum": [
            "fetkovich"
          ]
        }
      ]
    },
    "qmax": {
      "type": "number"
    },
    "C": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "pr": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "form"
  ]
}

Inputs: form, qmax?, C?, n?, pr?.

fa_co2PartialPressure

unknown

CO2 partial pressure from gas composition: pCO2 = y_CO2 * P_total.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "co2MoleFraction": {
      "type": "number"
    },
    "totalPressure_psia": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "co2MoleFraction",
    "totalPressure_psia"
  ]
}

fa_deWaardMilliams1991

unknown

de Waard-Milliams-Lotz (1991) CO2 corrosion rate (mm/yr) of carbon steel.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "temperature_C": {
      "type": "number"
    },
    "pCO2_bar": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "temperature_C",
    "pCO2_bar"
  ]
}

fa_deWaardMilliams1975

unknown

de Waard-Milliams (1975) ORIGINAL nomogram CO2 corrosion rate (mm/yr).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "temperature_C": {
      "type": "number"
    },
    "pCO2_bar": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "temperature_C",
    "pCO2_bar"
  ]
}

fa_co2Fugacity

unknown

CO2 fugacity correction for high pressure (de Waard et al.). Above ~250 bar.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pCO2_bar": {
      "type": "number"
    },
    "totalPressure_bar": {
      "type": "number"
    },
    "temperature_C": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "pCO2_bar",
    "totalPressure_bar",
    "temperature_C"
  ]
}

fa_corrosionRiskCategory

unknown

Classify a corrosion rate (mm/yr) into NACE-style severity bands.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "corrosionRate_mm_yr": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "corrosionRate_mm_yr"
  ]
}

fa_apiRP14E_erosionalVelocity

unknown

API RP 14E erosional (limiting) velocity: Ve = C / sqrt(rho_mix) [ft/s].

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mixtureDensity_lb_ft3": {
      "type": "number"
    },
    "cFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "mixtureDensity_lb_ft3"
  ]
}

fa_erosionalVelocityLimit

unknown

Check an operating velocity against the API RP 14E erosional limit. Reports.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mixtureVelocity_ft_s": {
      "type": "number"
    },
    "mixtureDensity_lb_ft3": {
      "type": "number"
    },
    "cFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "mixtureVelocity_ft_s",
    "mixtureDensity_lb_ft3"
  ]
}

fa_minPipeDiameterForErosion

unknown

Minimum pipe internal diameter (in) to keep the mixture velocity at or below.

Entitiescalculation, facility

Input schema

{
  "type": "object",
  "properties": {
    "totalRate_ft3_s": {
      "type": "number"
    },
    "mixtureDensity_lb_ft3": {
      "type": "number"
    },
    "cFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "totalRate_ft3_s",
    "mixtureDensity_lb_ft3"
  ]
}

fa_mixtureDensity

unknown

No-slip two-phase mixture density (lb/ft3)

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "liquidRate_ft3_s": {
      "type": "number"
    },
    "gasRate_ft3_s": {
      "type": "number"
    },
    "liquidDensity_lb_ft3": {
      "type": "number"
    },
    "gasDensity_lb_ft3": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "liquidRate_ft3_s",
    "gasRate_ft3_s",
    "liquidDensity_lb_ft3",
    "gasDensity_lb_ft3"
  ]
}

fa_mixtureVelocity

unknown

Actual mixture (superficial) velocity in a pipe.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "totalRate_ft3_s": {
      "type": "number"
    },
    "pipeID_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "totalRate_ft3_s",
    "pipeID_in"
  ]
}

fa_hammerschmidtDepression

unknown

Hammerschmidt (1934) hydrate-temperature depression (deg F)

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "inhibitorWtPct": {
      "type": "number"
    },
    "inhibitor": {
      "type": "string"
    },
    "kFactor": {
      "type": "number"
    },
    "molarMass": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "inhibitorWtPct"
  ]
}

fa_hydrateInhibitorConcentration

unknown

Required inhibitor concentration (wt% in the aqueous phase) to achieve a.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "targetDepression_F": {
      "type": "number"
    },
    "inhibitor": {
      "type": "string"
    },
    "kFactor": {
      "type": "number"
    },
    "molarMass": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "targetDepression_F"
  ]
}

fa_methanolInjectionRate

unknown

Required METHANOL injection rate (mass and volume) to dose the free water to.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "methanolDensity_lb_gal": {
      "type": "number"
    },
    "waterRate_bbl_d": {
      "type": "number"
    },
    "requiredWtPct": {
      "type": "number"
    },
    "lossFraction": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "waterRate_bbl_d",
    "requiredWtPct"
  ]
}

fa_megInjectionRate

unknown

Required MEG (monoethylene glycol) injection rate (mass and volume) to dose.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "megDensity_lb_gal": {
      "type": "number"
    },
    "waterRate_bbl_d": {
      "type": "number"
    },
    "requiredWtPct": {
      "type": "number"
    },
    "lossFraction": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "waterRate_bbl_d",
    "requiredWtPct"
  ]
}

fa_subcooling

unknown

Hydrate subcooling (driving force), deg F.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "hydrateEquilibriumTemp_F": {
      "type": "number"
    },
    "operatingTemp_F": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "hydrateEquilibriumTemp_F",
    "operatingTemp_F"
  ]
}

dca_sedmRate

unknown

SEDM rate q(t) = qi * exp(-(t/tau)^n). Field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "tau": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "tau",
    "n",
    "t"
  ]
}

Inputs: qi, tau, n, t.

dca_sedmCum

unknown

SEDM cumulative Q(t) = (qi*tau/n) * gamma(1/n, (t/tau)^n), lower incomplete gamma.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "tau": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "tau",
    "n",
    "t"
  ]
}

Inputs: qi, tau, n, t.

dca_sedmEUR

unknown

SEDM ultimate recovery (t -> infinity) = qi*tau*Gamma(1+1/n) = (qi*tau/n)*Gamma(1/n).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "tau": {
      "type": "number"
    },
    "n": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "tau",
    "n"
  ]
}

Inputs: qi, tau, n.

dca_sedmFit

unknown

Fit SEDM (qi, tau, n) to rate-time data by least squares (grid then refine).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q"
  ]
}

Inputs: t, q.

dca_pleRate

unknown

PLE rate q(t) = qi * exp(-Dinf*t - D1*t^n). Field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Dinf": {
      "type": "number"
    },
    "D1": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Dinf",
    "D1",
    "n",
    "t"
  ]
}

Inputs: qi, Dinf, D1, n, t.

dca_pleCum

unknown

PLE cumulative Q(t) = integral(0..t) qi*exp(-Dinf*s - D1*s^n) ds (Simpson, no closed form).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Dinf": {
      "type": "number"
    },
    "D1": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    },
    "panels": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Dinf",
    "D1",
    "n",
    "t"
  ]
}

Inputs: qi, Dinf, D1, n, t, panels?.

dca_pleFit

unknown

Fit PLE (qi, Dinf, D1, n) to rate-time data by least squares (grid then refine).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q"
  ]
}

Inputs: t, q.

dca_lgmCum

unknown

LGM cumulative Q(t) = K * t^n / (a + t^n). Field units; K = carrying capacity = EUR.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "K": {
      "type": "number"
    },
    "a": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "K",
    "a",
    "n",
    "t"
  ]
}

Inputs: K, a, n, t.

dca_lgmRate

unknown

LGM rate q(t) = dQ/dt = K*a*n*t^(n-1) / (a + t^n)^2. Field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "K": {
      "type": "number"
    },
    "a": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "K",
    "a",
    "n",
    "t"
  ]
}

Inputs: K, a, n, t.

dca_lgmRateFromCum

unknown

LGM instantaneous rate as the analytic derivative of cumulative q = dQ/dt (alias of dca_lgmRate).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "K": {
      "type": "number"
    },
    "a": {
      "type": "number"
    },
    "n": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "K",
    "a",
    "n",
    "t"
  ]
}

Inputs: K, a, n, t.

dca_lgmEUR

unknown

LGM EUR = K (the carrying capacity; cumulative as t -> infinity).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "K": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "K"
  ]
}

Inputs: K.

dca_lgmFit

unknown

Fit LGM (K, a, n) to cumulative-time data by least squares (grid then refine).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "Q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "Q"
  ]
}

Inputs: t, Q.

dca_duongCum

unknown

Duong cumulative Q(t) = q(t) / (a * t^(-m)), the closed-form integral of the Duong rate.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "q1": {
      "type": "number"
    },
    "a": {
      "type": "number"
    },
    "m": {
      "type": "number"
    },
    "t": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q1",
    "a",
    "m",
    "t"
  ]
}

Inputs: q1, a, m, t.

dca_duongEUR

unknown

Duong EUR to an economic-limit rate qLimit: solve q(t)=qLimit for t.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "q1": {
      "type": "number"
    },
    "a": {
      "type": "number"
    },
    "m": {
      "type": "number"
    },
    "qLimit": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "q1",
    "a",
    "m",
    "qLimit"
  ]
}

Inputs: q1, a, m, qLimit.

dca_duongFit

unknown

Fit Duong (a, m, q1) to rate-time data. For candidate (a,m) the points line up.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q"
  ]
}

Inputs: t, q.

dca_effectiveFromNominal

unknown

Effective (secant) decline from nominal (instantaneous) decline.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Dnom": {
      "type": "number"
    },
    "b": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Dnom"
  ]
}

Inputs: Dnom, b?.

dca_nominalFromEffective

unknown

Nominal (instantaneous) decline from effective (secant) decline.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Deff": {
      "type": "number"
    },
    "b": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Deff"
  ]
}

Inputs: Deff, b?.

dca_bFactorFromRates

unknown

Instantaneous Arps b-factor from three (t,q) points: b = d(1/D)/dt, with the.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q"
  ]
}

Inputs: t, number, number], q, number, number].

dca_betaDerivative

unknown

Beta-derivative diagnostic beta = t * (d ln q / d t), the log-log slope of rate.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "t": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "q": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "at": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "t",
    "q",
    "at"
  ]
}

Inputs: t, q, at.

dca_eurFromArpsToHyperbolicSwitch

unknown

EUR for an Arps-hyperbolic that switches to terminal exponential at decline Dlim.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "qi": {
      "type": "number"
    },
    "Di": {
      "type": "number"
    },
    "b": {
      "type": "number"
    },
    "Dlim": {
      "type": "number"
    },
    "qLimit": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "qi",
    "Di",
    "b",
    "Dlim",
    "qLimit"
  ]
}

Inputs: qi, Di, b, Dlim, qLimit.

eos_cubicAB

unknown

Calculates pure-component PR or SRK cubic EOS A, B, a, and b.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "Tc_degR": {
      "type": "number"
    },
    "Pc_psia": {
      "type": "number"
    },
    "omega": {
      "type": "number"
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "Tc_degR",
    "Pc_psia",
    "omega",
    "T_degR",
    "P_psia"
  ]
}

Inputs: eos, Tc_degR, Pc_psia, omega, T_degR, P_psia.

eos_zFactor

unknown

Solves the PR or SRK cubic EOS compressibility-factor equation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "A_dimless": {
      "type": "number"
    },
    "B_dimless": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "A_dimless",
    "B_dimless"
  ]
}

Inputs: eos, A_dimless, B_dimless.

eos_fugacityCoefficient

unknown

Calculates pure-component fugacity coefficient from PR or SRK Z, A, and B.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "Z": {
      "type": "number"
    },
    "A_dimless": {
      "type": "number"
    },
    "B_dimless": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "Z",
    "A_dimless",
    "B_dimless"
  ]
}

Inputs: eos, Z, A_dimless, B_dimless.

eos_molarVolume

unknown

Calculates gas or liquid molar volume from Z, T, and P in field units.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "Z": {
      "type": "number"
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Z",
    "T_degR",
    "P_psia"
  ]
}

Inputs: Z, T_degR, P_psia.

eos_massDensity

unknown

Calculates mass density from Z, T, P, and molar mass in field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Z": {
      "type": "number"
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    },
    "molarMass_lb_per_lbmol": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "Z",
    "T_degR",
    "P_psia",
    "molarMass_lb_per_lbmol"
  ]
}

Inputs: Z, T_degR, P_psia, molarMass_lb_per_lbmol.

eos_departureEnthalpy

unknown

Calculates pure-component cubic-EOS residual enthalpy departure.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "Tc_degR": {
      "type": "number"
    },
    "Pc_psia": {
      "type": "number"
    },
    "omega": {
      "type": "number"
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "Tc_degR",
    "Pc_psia",
    "omega",
    "T_degR",
    "P_psia",
    "Z"
  ]
}

Inputs: eos, Tc_degR, Pc_psia, omega, T_degR, P_psia, Z.

eos_departureEntropy

unknown

Calculates pure-component cubic-EOS residual entropy departure.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "Tc_degR": {
      "type": "number"
    },
    "Pc_psia": {
      "type": "number"
    },
    "omega": {
      "type": "number"
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    },
    "Z": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "Tc_degR",
    "Pc_psia",
    "omega",
    "T_degR",
    "P_psia",
    "Z"
  ]
}

Inputs: eos, Tc_degR, Pc_psia, omega, T_degR, P_psia, Z.

eos_isothermalCompressibility

unknown

Calculates isothermal compressibility from a cubic EOS Z root.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "Z": {
      "type": "number"
    },
    "A_dimless": {
      "type": "number"
    },
    "B_dimless": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "Z",
    "A_dimless",
    "B_dimless",
    "P_psia"
  ]
}

Inputs: eos, Z, A_dimless, B_dimless, P_psia.

eos_wilsonK

unknown

Estimates Wilson K-values for a multicomponent feed.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Tc_degR": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "Pc_psia": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "omega": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    },
    "componentNames": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "Tc_degR",
    "Pc_psia",
    "omega",
    "T_degR",
    "P_psia"
  ]
}

Inputs: Tc_degR, Pc_psia, omega, T_degR, P_psia, componentNames?.

eos_rachfordRice

unknown

Solves Rachford-Rice vapor fraction and phase compositions.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "z": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "K": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "tolerance": {
      "type": "number"
    },
    "maxIter": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "z",
    "K"
  ]
}

Inputs: z, K, tolerance?, maxIter?.

eos_flashTwoPhase

unknown

Runs an approximate two-phase PR or SRK flash by successive substitution.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "eos": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "pr"
          ]
        },
        {
          "type": "string",
          "enum": [
            "srk"
          ]
        }
      ]
    },
    "z": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "Tc_degR": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "Pc_psia": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "omega": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "T_degR": {
      "type": "number"
    },
    "P_psia": {
      "type": "number"
    },
    "kij": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "number"
        }
      }
    },
    "componentNames": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tolerance": {
      "type": "number"
    },
    "maxIter": {
      "type": "number"
    },
    "rrTolerance": {
      "type": "number"
    },
    "rrMaxIter": {
      "type": "number"
    },
    "damping": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "eos",
    "z",
    "Tc_degR",
    "Pc_psia",
    "omega",
    "T_degR",
    "P_psia"
  ]
}

Inputs: eos, z, Tc_degR, Pc_psia, omega, T_degR, P_psia, kij?, componentNames?,…

esp_totalDynamicHead

unknown

Computes ESP total dynamic head from lift, friction, and wellhead pressure.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "netVerticalLift_ft": {
      "type": "number"
    },
    "wellheadPressure_psia": {
      "type": "number"
    },
    "fluidGradient_psiPerFt": {
      "type": "number"
    },
    "referencePressure_psia": {
      "type": "number"
    },
    "tubingFrictionHead_ft": {
      "type": "number"
    },
    "flowRate_bpd": {
      "type": "number"
    },
    "tubingId_in": {
      "type": "number"
    },
    "tubingLength_ft": {
      "type": "number"
    },
    "hazenWilliamsC": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "netVerticalLift_ft",
    "wellheadPressure_psia",
    "fluidGradient_psiPerFt"
  ]
}

Inputs: netVerticalLift_ft, wellheadPressure_psia, fluidGradient_psiPerFt, refe…

esp_stagesRequired

unknown

Computes the integer ESP stage count required to develop a target head.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "totalDynamicHead_ft": {
      "type": "number"
    },
    "headPerStage_ft": {
      "type": "number"
    },
    "stageSafetyFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "totalDynamicHead_ft",
    "headPerStage_ft"
  ]
}

Inputs: totalDynamicHead_ft, headPerStage_ft, stageSafetyFactor?.

esp_affinityLaws

unknown

Applies centrifugal-pump affinity laws for speed and impeller trim changes.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "baseFlowRate_bpd": {
      "type": "number"
    },
    "baseHead_ft": {
      "type": "number"
    },
    "baseBrakeHorsepower_hp": {
      "type": "number"
    },
    "baseSpeed": {
      "type": "number"
    },
    "newSpeed": {
      "type": "number"
    },
    "baseDiameter_in": {
      "type": "number"
    },
    "newDiameter_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "baseFlowRate_bpd",
    "baseHead_ft",
    "baseBrakeHorsepower_hp",
    "baseSpeed",
    "newSpeed"
  ]
}

Inputs: baseFlowRate_bpd, baseHead_ft, baseBrakeHorsepower_hp, baseSpeed, newSp…

esp_brakeHorsepower

unknown

Computes ESP brake horsepower by hydraulic power or stage horsepower.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_bpd": {
      "type": "number"
    },
    "totalDynamicHead_ft": {
      "type": "number"
    },
    "fluidSpecificGravity": {
      "type": "number"
    },
    "pumpEfficiency": {
      "type": "number"
    },
    "horsepowerPerStage_hp": {
      "type": "number"
    },
    "stages": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

Inputs: flowRate_bpd?, totalDynamicHead_ft?, fluidSpecificGravity?, pumpEfficie…

esp_npshAvailable

unknown

Computes available NPSH at an ESP intake from pressure head above vapor.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "intakePressure_psia": {
      "type": "number"
    },
    "vaporPressure_psia": {
      "type": "number"
    },
    "fluidGradient_psiPerFt": {
      "type": "number"
    },
    "staticHeadAtIntake_ft": {
      "type": "number"
    },
    "velocityHead_ft": {
      "type": "number"
    },
    "suctionFrictionLoss_ft": {
      "type": "number"
    },
    "npshRequired_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "intakePressure_psia",
    "vaporPressure_psia",
    "fluidGradient_psiPerFt"
  ]
}

Inputs: intakePressure_psia, vaporPressure_psia, fluidGradient_psiPerFt, static…

esp_motorLoading

unknown

Computes ESP motor loading from required brake horsepower and nameplate hp.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "requiredBrakeHorsepower_hp": {
      "type": "number"
    },
    "motorNameplateHorsepower_hp": {
      "type": "number"
    },
    "motorServiceFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "requiredBrakeHorsepower_hp",
    "motorNameplateHorsepower_hp"
  ]
}

Inputs: requiredBrakeHorsepower_hp, motorNameplateHorsepower_hp, motorServiceFa…

rod_pumpDisplacement

unknown

Computes sucker-rod pump displacement from speed, plunger size, and stroke.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "strokesPerMinute_spm": {
      "type": "number"
    },
    "plungerDiameter_in": {
      "type": "number"
    },
    "effectivePlungerStroke_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "strokesPerMinute_spm",
    "plungerDiameter_in",
    "effectivePlungerStroke_in"
  ]
}

Inputs: strokesPerMinute_spm, plungerDiameter_in, effectivePlungerStroke_in.

rod_plungerStroke

unknown

Computes effective plunger stroke from elastic stroke losses and overtravel.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "polishedRodStroke_in": {
      "type": "number"
    },
    "rodStretch_in": {
      "type": "number"
    },
    "tubingStretch_in": {
      "type": "number"
    },
    "overtravel_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "polishedRodStroke_in",
    "rodStretch_in",
    "tubingStretch_in"
  ]
}

Inputs: polishedRodStroke_in, rodStretch_in, tubingStretch_in, overtravel_in?.

rod_rodStretch

unknown

Computes rod-string elastic stretch under fluid load by Hooke's law.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "fluidLoad_lbf": {
      "type": "number"
    },
    "rodLength_ft": {
      "type": "number"
    },
    "rodDiameter_in": {
      "type": "number"
    },
    "rodArea_in2": {
      "type": "number"
    },
    "modulusElasticity_psi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "fluidLoad_lbf",
    "rodLength_ft"
  ]
}

Inputs: fluidLoad_lbf, rodLength_ft, rodDiameter_in?, rodArea_in2?, modulusElas…

rod_peakPolishedRodLoad

unknown

Computes peak polished-rod load using the Mills acceleration approximation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "fluidLoad_lbf": {
      "type": "number"
    },
    "rodStringWeight_lbf": {
      "type": "number"
    },
    "polishedRodStroke_in": {
      "type": "number"
    },
    "pumpingSpeed_spm": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "fluidLoad_lbf",
    "rodStringWeight_lbf",
    "polishedRodStroke_in",
    "pumpingSpeed_spm"
  ]
}

Inputs: fluidLoad_lbf, rodStringWeight_lbf, polishedRodStroke_in, pumpingSpeed_…

rod_minPolishedRodLoad

unknown

Computes minimum polished-rod load using the Mills acceleration approximation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "rodStringWeight_lbf": {
      "type": "number"
    },
    "polishedRodStroke_in": {
      "type": "number"
    },
    "pumpingSpeed_spm": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "rodStringWeight_lbf",
    "polishedRodStroke_in",
    "pumpingSpeed_spm"
  ]
}

Inputs: rodStringWeight_lbf, polishedRodStroke_in, pumpingSpeed_spm.

rod_counterbalanceEffect

unknown

Computes approximate ideal counterbalance effect from polished-rod loads.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "peakPolishedRodLoad_lbf": {
      "type": "number"
    },
    "minimumPolishedRodLoad_lbf": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "peakPolishedRodLoad_lbf",
    "minimumPolishedRodLoad_lbf"
  ]
}

Inputs: peakPolishedRodLoad_lbf, minimumPolishedRodLoad_lbf.

rod_polishedRodHorsepower

unknown

Computes polished-rod horsepower from an approximate rectangular card area.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "peakPolishedRodLoad_lbf": {
      "type": "number"
    },
    "minimumPolishedRodLoad_lbf": {
      "type": "number"
    },
    "polishedRodStroke_in": {
      "type": "number"
    },
    "pumpingSpeed_spm": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "peakPolishedRodLoad_lbf",
    "minimumPolishedRodLoad_lbf",
    "polishedRodStroke_in",
    "pumpingSpeed_spm"
  ]
}

Inputs: peakPolishedRodLoad_lbf, minimumPolishedRodLoad_lbf, polishedRodStroke_…

rod_pumpVolumetricEfficiency

unknown

Computes rod-pump volumetric efficiency from actual rate and displacement.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "actualLiquidRate_bpd": {
      "type": "number"
    },
    "pumpDisplacement_bpd": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "actualLiquidRate_bpd",
    "pumpDisplacement_bpd"
  ]
}

Inputs: actualLiquidRate_bpd, pumpDisplacement_bpd.

gaslift_injectionGasGradient

unknown

Computes static injection-gas pressure gradient over a gas-lift annulus.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "surfaceInjectionPressure_psia": {
      "type": "number"
    },
    "depth_ft": {
      "type": "number"
    },
    "gasSpecificGravity": {
      "type": "number"
    },
    "averageTemperature_R": {
      "type": "number"
    },
    "zFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "surfaceInjectionPressure_psia",
    "depth_ft",
    "gasSpecificGravity",
    "averageTemperature_R",
    "zFactor"
  ]
}

Inputs: surfaceInjectionPressure_psia, depth_ft, gasSpecificGravity, averageTem…

gaslift_casingPressureAtDepth

unknown

Computes casing pressure at depth for a static gas-lift gas column.

Entitiescalculation, completion

Input schema

{
  "type": "object",
  "properties": {
    "surfaceCasingPressure_psia": {
      "type": "number"
    },
    "depth_ft": {
      "type": "number"
    },
    "gasSpecificGravity": {
      "type": "number"
    },
    "averageTemperature_R": {
      "type": "number"
    },
    "zFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "surfaceCasingPressure_psia",
    "depth_ft",
    "gasSpecificGravity",
    "averageTemperature_R",
    "zFactor"
  ]
}

Inputs: surfaceCasingPressure_psia, depth_ft, gasSpecificGravity, averageTemper…

gaslift_valveOpeningPressure

unknown

Computes IPO gas-lift valve opening pressure from dome and tubing pressure.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "domePressureAtDepth_psia": {
      "type": "number"
    },
    "tubingPressureAtDepth_psia": {
      "type": "number"
    },
    "portToBellowsAreaRatio": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "domePressureAtDepth_psia",
    "tubingPressureAtDepth_psia",
    "portToBellowsAreaRatio"
  ]
}

Inputs: domePressureAtDepth_psia, tubingPressureAtDepth_psia, portToBellowsArea…

gaslift_unloadingGradient

unknown

Computes a straight-line gas-lift unloading gradient between two pressures.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "surfacePressure_psia": {
      "type": "number"
    },
    "transferPressureAtDepth_psia": {
      "type": "number"
    },
    "valveDepth_ft": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "surfacePressure_psia",
    "transferPressureAtDepth_psia",
    "valveDepth_ft"
  ]
}

Inputs: surfacePressure_psia, transferPressureAtDepth_psia, valveDepth_ft.

gaslift_requiredInjectionGLR

unknown

Computes required injected gas-liquid ratio from target and formation GLR.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "targetTotalGLR_scfPerSTB": {
      "type": "number"
    },
    "formationGLR_scfPerSTB": {
      "type": "number"
    },
    "liquidRate_STBPerD": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "targetTotalGLR_scfPerSTB",
    "formationGLR_scfPerSTB"
  ]
}

Inputs: targetTotalGLR_scfPerSTB, formationGLR_scfPerSTB, liquidRate_STBPerD?.

gaslift_powerForCompression

unknown

Computes gas-lift compression horsepower with a polytropic ideal-gas form.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "injectionGasRate_MscfPerD": {
      "type": "number"
    },
    "suctionPressure_psia": {
      "type": "number"
    },
    "dischargePressure_psia": {
      "type": "number"
    },
    "suctionTemperature_R": {
      "type": "number"
    },
    "zFactor": {
      "type": "number"
    },
    "polytropicExponent": {
      "type": "number"
    },
    "polytropicEfficiency": {
      "type": "number"
    },
    "mechanicalEfficiency": {
      "type": "number"
    },
    "maxCompressionRatioPerStage": {
      "type": "number"
    },
    "maxStages": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "injectionGasRate_MscfPerD",
    "suctionPressure_psia",
    "dischargePressure_psia",
    "suctionTemperature_R"
  ]
}

Inputs: injectionGasRate_MscfPerD, suctionPressure_psia, dischargePressure_psia…

pta_exponentialIntegral

unknown

Computes the line-source well function W(u) = -Ei(-u).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "u": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "u"
  ]
}

Inputs: u.

pta_dimensionlessTime

unknown

Computes radial and drainage-area dimensionless time in field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "kMd": {
      "type": "number"
    },
    "tHours": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "rwFt": {
      "type": "number"
    },
    "rFt": {
      "type": "number"
    },
    "drainageAreaAcres": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "kMd",
    "tHours",
    "phi",
    "muCp",
    "ctPerPsi",
    "rwFt"
  ]
}

Inputs: kMd, tHours, phi, muCp, ctPerPsi, rwFt, rFt?, drainageAreaAcres?.

pta_dimensionlessPressure

unknown

Computes semilog line-source dimensionless pressure for tD above about 100.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "tD": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "tD"
  ]
}

Inputs: tD.

pta_lineSourcePressure

unknown

Computes infinite-acting line-source pressure at radius and time.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "initialPressurePsi": {
      "type": "number"
    },
    "qStbd": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "BoRbPerStb": {
      "type": "number"
    },
    "kMd": {
      "type": "number"
    },
    "hFt": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "rFt": {
      "type": "number"
    },
    "tHours": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "initialPressurePsi",
    "qStbd",
    "muCp",
    "BoRbPerStb",
    "kMd",
    "hFt",
    "phi",
    "ctPerPsi",
    "rFt",
    "tHours"
  ]
}

Inputs: initialPressurePsi, qStbd, muCp, BoRbPerStb, kMd, hFt, phi, ctPerPsi, r…

pta_drawdownSemilog

unknown

Computes permeability and skin from MDH drawdown semilog slope.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "slopePsiPerCycle": {
      "type": "number"
    },
    "qStbd": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "BoRbPerStb": {
      "type": "number"
    },
    "hFt": {
      "type": "number"
    },
    "p1hrPsi": {
      "type": "number"
    },
    "pwf0Psi": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "rwFt": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "slopePsiPerCycle",
    "qStbd",
    "muCp",
    "BoRbPerStb",
    "hFt",
    "p1hrPsi",
    "pwf0Psi",
    "phi",
    "ctPerPsi",
    "rwFt"
  ]
}

Inputs: slopePsiPerCycle, qStbd, muCp, BoRbPerStb, hFt, p1hrPsi, pwf0Psi, phi,…

pta_hornerTime

unknown

Computes Horner buildup time ratio and its base-10 plotting coordinate.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "producingTimeHours": {
      "type": "number"
    },
    "shutInTimeHours": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "producingTimeHours",
    "shutInTimeHours"
  ]
}

Inputs: producingTimeHours, shutInTimeHours.

pta_hornerBuildup

unknown

Computes permeability, skin, and p-star from a Horner buildup semilog line.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "slopePsiPerCycle": {
      "type": "number"
    },
    "qStbd": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "BoRbPerStb": {
      "type": "number"
    },
    "hFt": {
      "type": "number"
    },
    "p1hrPsi": {
      "type": "number"
    },
    "pwfAtShutInPsi": {
      "type": "number"
    },
    "producingTimeHours": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "rwFt": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "slopePsiPerCycle",
    "qStbd",
    "muCp",
    "BoRbPerStb",
    "hFt",
    "p1hrPsi",
    "pwfAtShutInPsi",
    "producingTimeHours",
    "phi",
    "ctPerPsi",
    "rwFt"
  ]
}

Inputs: slopePsiPerCycle, qStbd, muCp, BoRbPerStb, hFt, p1hrPsi, pwfAtShutInPsi…

pta_skinFactor

unknown

Computes skin factor from the standard semilog 1-hour pressure relation.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "p1hrPsi": {
      "type": "number"
    },
    "referencePressurePsi": {
      "type": "number"
    },
    "slopePsiPerCycle": {
      "type": "number"
    },
    "kMd": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "rwFt": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "p1hrPsi",
    "referencePressurePsi",
    "slopePsiPerCycle",
    "kMd",
    "phi",
    "muCp",
    "ctPerPsi",
    "rwFt"
  ]
}

Inputs: p1hrPsi, referencePressurePsi, slopePsiPerCycle, kMd, phi, muCp, ctPerP…

pta_pressureDropDueToSkin

write

Computes pressure drop attributable to skin from semilog slope and skin.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "slopePsiPerCycle": {
      "type": "number"
    },
    "skin": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "slopePsiPerCycle",
    "skin"
  ]
}

Inputs: slopePsiPerCycle, skin.

pta_flowEfficiency

unknown

Computes flow efficiency from total drawdown and skin pressure drop.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "averageReservoirPressurePsi": {
      "type": "number"
    },
    "flowingBottomholePressurePsi": {
      "type": "number"
    },
    "pressureDropDueToSkinPsi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "averageReservoirPressurePsi",
    "flowingBottomholePressurePsi",
    "pressureDropDueToSkinPsi"
  ]
}

Inputs: averageReservoirPressurePsi, flowingBottomholePressurePsi, pressureDrop…

pta_radiusOfInvestigation

unknown

Computes line-source radius of investigation in field units.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "kMd": {
      "type": "number"
    },
    "tHours": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "kMd",
    "tHours",
    "phi",
    "muCp",
    "ctPerPsi"
  ]
}

Inputs: kMd, tHours, phi, muCp, ctPerPsi.

pta_wellboreStorageCoefficient

unknown

Computes wellbore storage coefficient from volume or unit-slope data.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "volumeUnderCompressionBbl": {
      "type": "number"
    },
    "fluidDensityLbPerFt3": {
      "type": "number"
    },
    "qStbd": {
      "type": "number"
    },
    "BoRbPerStb": {
      "type": "number"
    },
    "pressureRatePsiPerHour": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

Inputs: volumeUnderCompressionBbl?, fluidDensityLbPerFt3?, qStbd?, BoRbPerStb?,…

pta_dimensionlessWellboreStorage

unknown

Computes dimensionless wellbore storage coefficient.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "storageCoefficientBblPerPsi": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "hFt": {
      "type": "number"
    },
    "rwFt": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "storageCoefficientBblPerPsi",
    "phi",
    "ctPerPsi",
    "hFt",
    "rwFt"
  ]
}

Inputs: storageCoefficientBblPerPsi, phi, ctPerPsi, hFt, rwFt.

pta_endOfWellboreStorage

unknown

Estimates end of wellbore storage from the common semilog rule.

Entitiescalculation, well

Input schema

{
  "type": "object",
  "properties": {
    "storageCoefficientBblPerPsi": {
      "type": "number"
    },
    "kMd": {
      "type": "number"
    },
    "hFt": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "skin": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "storageCoefficientBblPerPsi",
    "kMd",
    "hFt",
    "muCp",
    "skin"
  ]
}

Inputs: storageCoefficientBblPerPsi, kMd, hFt, muCp, skin.

pta_dietzShapeFactor

unknown

Looks up a Dietz shape factor for common closed drainage areas.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "shape": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "shape"
  ]
}

Inputs: shape.

pta_pseudosteadyStatePressure

unknown

Computes pseudosteady-state pressure drop using Dietz shape factor CA.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "initialPressurePsi": {
      "type": "number"
    },
    "qStbd": {
      "type": "number"
    },
    "muCp": {
      "type": "number"
    },
    "BoRbPerStb": {
      "type": "number"
    },
    "kMd": {
      "type": "number"
    },
    "hFt": {
      "type": "number"
    },
    "phi": {
      "type": "number"
    },
    "ctPerPsi": {
      "type": "number"
    },
    "rwFt": {
      "type": "number"
    },
    "tHours": {
      "type": "number"
    },
    "drainageAreaAcres": {
      "type": "number"
    },
    "skin": {
      "type": "number"
    },
    "shape": {
      "type": "string"
    },
    "shapeFactorCA": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "initialPressurePsi",
    "qStbd",
    "muCp",
    "BoRbPerStb",
    "kMd",
    "hFt",
    "phi",
    "ctPerPsi",
    "rwFt",
    "tHours",
    "drainageAreaAcres"
  ]
}

Inputs: initialPressurePsi, qStbd, muCp, BoRbPerStb, kMd, hFt, phi, ctPerPsi, r…

pta_bourdetDerivative

unknown

Computes Bourdet pressure derivative from time-pressure arrays.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "timesHours": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "pressuresPsi": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "smoothingLogCycles": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "timesHours",
    "pressuresPsi"
  ]
}

Inputs: timesHours, pressuresPsi, smoothingLogCycles?.

vfp_hydrostaticGradient

unknown

Computes hydrostatic pressure gradient from fluid density.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "density_lbPerFt3": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "density_lbPerFt3"
  ]
}

Inputs: density_lbPerFt3.

vfp_frictionGradient

unknown

Computes Darcy-Weisbach friction gradient with Chen explicit friction factor.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "density_lbPerFt3": {
      "type": "number"
    },
    "velocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "viscosity_cp": {
      "type": "number"
    },
    "roughness_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "density_lbPerFt3",
    "velocity_ftPerS",
    "pipeId_in",
    "viscosity_cp"
  ]
}

Inputs: density_lbPerFt3, velocity_ftPerS, pipeId_in, viscosity_cp, roughness_i…

vfp_reynolds

unknown

Computes Reynolds number in field units for internal pipe flow.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "density_lbPerFt3": {
      "type": "number"
    },
    "velocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "viscosity_cp": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "density_lbPerFt3",
    "velocity_ftPerS",
    "pipeId_in",
    "viscosity_cp"
  ]
}

Inputs: density_lbPerFt3, velocity_ftPerS, pipeId_in, viscosity_cp.

vfp_superficialVelocities

unknown

Computes liquid and gas superficial velocities from field rates.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "liquidRate_STBPerD": {
      "type": "number"
    },
    "gasRate_Mscfd": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "pressure_psia": {
      "type": "number"
    },
    "temperature_degR": {
      "type": "number"
    },
    "gasZFactor": {
      "type": "number"
    },
    "liquidFormationVolumeFactor_rbPerSTB": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "liquidRate_STBPerD",
    "gasRate_Mscfd",
    "pipeId_in",
    "pressure_psia",
    "temperature_degR",
    "gasZFactor"
  ]
}

Inputs: liquidRate_STBPerD, gasRate_Mscfd, pipeId_in, pressure_psia, temperatur…

vfp_mixtureVelocity

unknown

Computes mixture superficial velocity as vsl plus vsg.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS.

vfp_noSlipHoldup

unknown

Computes no-slip liquid holdup from superficial velocities.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS.

vfp_gasStaticBHP

unknown

Computes static gas bottomhole pressure using average T and z.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "wellheadPressure_psia": {
      "type": "number"
    },
    "trueVerticalDepth_ft": {
      "type": "number"
    },
    "gasSpecificGravity": {
      "type": "number"
    },
    "averageTemperature_degR": {
      "type": "number"
    },
    "averageZFactor": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "wellheadPressure_psia",
    "trueVerticalDepth_ft",
    "gasSpecificGravity",
    "averageTemperature_degR",
    "averageZFactor"
  ]
}

Inputs: wellheadPressure_psia, trueVerticalDepth_ft, gasSpecificGravity, averag…

vfp_gasFlowingBHP

unknown

Computes flowing gas bottomhole pressure with gas friction in tubing.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "wellheadPressure_psia": {
      "type": "number"
    },
    "measuredDepth_ft": {
      "type": "number"
    },
    "trueVerticalDepth_ft": {
      "type": "number"
    },
    "gasSpecificGravity": {
      "type": "number"
    },
    "gasRate_Mscfd": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "gasViscosity_cp": {
      "type": "number"
    },
    "averageTemperature_degR": {
      "type": "number"
    },
    "averageZFactor": {
      "type": "number"
    },
    "roughness_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "wellheadPressure_psia",
    "measuredDepth_ft",
    "gasSpecificGravity",
    "gasRate_Mscfd",
    "pipeId_in",
    "gasViscosity_cp",
    "averageTemperature_degR",
    "averageZFactor"
  ]
}

Inputs: wellheadPressure_psia, measuredDepth_ft, trueVerticalDepth_ft?, gasSpec…

vfp_flowPatternBeggsBrill

unknown

Classifies Beggs-Brill horizontal flow pattern from lambda and Froude number.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "noSlipLiquidHoldup_fraction": {
      "type": "number"
    },
    "froudeNumber": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "noSlipLiquidHoldup_fraction",
    "froudeNumber"
  ]
}

Inputs: noSlipLiquidHoldup_fraction, froudeNumber.

vfp_holdupBeggsBrill

unknown

Computes Beggs-Brill liquid holdup with inclination correction.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "liquidDensity_lbPerFt3": {
      "type": "number"
    },
    "surfaceTension_dynesPerCm": {
      "type": "number"
    },
    "angleFromHorizontal_deg": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS",
    "pipeId_in",
    "liquidDensity_lbPerFt3",
    "surfaceTension_dynesPerCm",
    "angleFromHorizontal_deg"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…

vfp_gradientBeggsBrill

unknown

Computes full Beggs-Brill pressure gradient with elevation, friction, acceleration.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "liquidDensity_lbPerFt3": {
      "type": "number"
    },
    "gasDensity_lbPerFt3": {
      "type": "number"
    },
    "liquidViscosity_cp": {
      "type": "number"
    },
    "gasViscosity_cp": {
      "type": "number"
    },
    "pressure_psia": {
      "type": "number"
    },
    "surfaceTension_dynesPerCm": {
      "type": "number"
    },
    "angleFromHorizontal_deg": {
      "type": "number"
    },
    "roughness_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS",
    "pipeId_in",
    "liquidDensity_lbPerFt3",
    "gasDensity_lbPerFt3",
    "liquidViscosity_cp",
    "gasViscosity_cp",
    "pressure_psia",
    "surfaceTension_dynesPerCm",
    "angleFromHorizontal_deg"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…

vfp_holdupHagedornBrown

unknown

Computes Hagedorn-Brown holdup using digitized-chart polynomial fits.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "liquidDensity_lbPerFt3": {
      "type": "number"
    },
    "liquidViscosity_cp": {
      "type": "number"
    },
    "pressure_psia": {
      "type": "number"
    },
    "surfaceTension_dynesPerCm": {
      "type": "number"
    },
    "applyGriffithBubbleCorrection": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS",
    "pipeId_in",
    "liquidDensity_lbPerFt3",
    "liquidViscosity_cp",
    "pressure_psia",
    "surfaceTension_dynesPerCm"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…

vfp_gradientHagedornBrown

unknown

Computes Hagedorn-Brown pressure gradient with chart-fit holdup.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "liquidDensity_lbPerFt3": {
      "type": "number"
    },
    "gasDensity_lbPerFt3": {
      "type": "number"
    },
    "liquidViscosity_cp": {
      "type": "number"
    },
    "gasViscosity_cp": {
      "type": "number"
    },
    "pressure_psia": {
      "type": "number"
    },
    "surfaceTension_dynesPerCm": {
      "type": "number"
    },
    "deviationFromVertical_deg": {
      "type": "number"
    },
    "roughness_in": {
      "type": "number"
    },
    "applyGriffithBubbleCorrection": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS",
    "pipeId_in",
    "liquidDensity_lbPerFt3",
    "gasDensity_lbPerFt3",
    "liquidViscosity_cp",
    "gasViscosity_cp",
    "pressure_psia",
    "surfaceTension_dynesPerCm"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…

vfp_gradientGray

unknown

Computes Gray wet-gas vertical pressure gradient in closed form.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "superficialLiquidVelocity_ftPerS": {
      "type": "number"
    },
    "superficialGasVelocity_ftPerS": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "liquidDensity_lbPerFt3": {
      "type": "number"
    },
    "gasDensity_lbPerFt3": {
      "type": "number"
    },
    "liquidViscosity_cp": {
      "type": "number"
    },
    "gasViscosity_cp": {
      "type": "number"
    },
    "surfaceTension_dynesPerCm": {
      "type": "number"
    },
    "deviationFromVertical_deg": {
      "type": "number"
    },
    "roughness_in": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "superficialLiquidVelocity_ftPerS",
    "superficialGasVelocity_ftPerS",
    "pipeId_in",
    "liquidDensity_lbPerFt3",
    "gasDensity_lbPerFt3",
    "liquidViscosity_cp",
    "gasViscosity_cp",
    "surfaceTension_dynesPerCm"
  ]
}

Inputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…

vfp_pressureTraverse

unknown

Marches a pressure traverse down the well using Beggs-Brill or Gray.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "correlation": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "beggsBrill"
          ]
        },
        {
          "type": "string",
          "enum": [
            "gray"
          ]
        }
      ]
    },
    "wellheadPressure_psia": {
      "type": "number"
    },
    "measuredDepth_ft": {
      "type": "number"
    },
    "trueVerticalDepth_ft": {
      "type": "number"
    },
    "pipeId_in": {
      "type": "number"
    },
    "liquidRate_STBPerD": {
      "type": "number"
    },
    "gasRate_Mscfd": {
      "type": "number"
    },
    "liquidDensity_lbPerFt3": {
      "type": "number"
    },
    "gasSpecificGravity": {
      "type": "number"
    },
    "liquidViscosity_cp": {
      "type": "number"
    },
    "gasViscosity_cp": {
      "type": "number"
    },
    "surfaceTension_dynesPerCm": {
      "type": "number"
    },
    "surfaceTemperature_degR": {
      "type": "number"
    },
    "bottomholeTemperature_degR": {
      "type": "number"
    },
    "gasZFactor": {
      "type": "number"
    },
    "liquidFormationVolumeFactor_rbPerSTB": {
      "type": "number"
    },
    "roughness_in": {
      "type": "number"
    },
    "segments": {
      "type": "number"
    },
    "maxIterations": {
      "type": "number"
    },
    "tolerance_psia": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "correlation",
    "wellheadPressure_psia",
    "measuredDepth_ft",
    "pipeId_in",
    "liquidRate_STBPerD",
    "gasRate_Mscfd",
    "liquidDensity_lbPerFt3",
    "gasSpecificGravity",
    "liquidViscosity_cp",
    "gasViscosity_cp",
    "surfaceTension_dynesPerCm",
    "surfaceTemperature_degR",
    "bottomholeTemperature_degR",
    "gasZFactor"
  ]
}

Inputs: correlation, wellheadPressure_psia, measuredDepth_ft, trueVerticalDepth…

wellpath_minimumCurvature
unknown
Wellbore trajectory from a deviation survey by minimum curvature: TVD, northing, easting, dogleg.
Entitiescalculation, trajectory, well
Input schema
```
{
  "type": "object",
  "properties": {
    "stations": {
      "type": "array"
    },
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "stations"
  ]
}
```
Inputs: stations [{md,inc,azi}] degrees, units 'ft'|'m'. Origin = 1st station.

wellpath_interpolate

unknown

Interpolate a wellbore survey at any measured depth on the minimum curvature arc.

Entitiescalculation, trajectory, well

Input schema

{
  "type": "object",
  "properties": {
    "stations": {},
    "md": {
      "type": "integer",
      "examples": [
        750
      ]
    },
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "stations",
    "md"
  ]
}

Inputs: stations, md, units. Returns inc/azi/TVD/N/E at md.

wellpath_doglegSeverity

unknown

Dogleg severity between two wellbore survey stations, per 100 ft or 30 m.

Entitiescalculation, trajectory, well

Input schema

{
  "type": "object",
  "properties": {
    "md1": {
      "type": "integer",
      "examples": [
        1000
      ]
    },
    "inc1": {
      "type": "integer",
      "examples": [
        10
      ]
    },
    "azi1": {
      "type": "integer",
      "examples": [
        40
      ]
    },
    "md2": {
      "type": "integer",
      "examples": [
        1100
      ]
    },
    "inc2": {
      "type": "integer",
      "examples": [
        13
      ]
    },
    "azi2": {
      "type": "integer",
      "examples": [
        44
      ]
    },
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "md1",
    "inc1",
    "azi1",
    "md2",
    "inc2",
    "azi2"
  ]
}

Inputs: md1,inc1,azi1,md2,inc2,azi2, units.

wellpath_verticalSection

unknown

Vertical section projection of a wellbore survey onto a target azimuth plane.

Entitiescalculation, trajectory, well

Input schema

{
  "type": "object",
  "properties": {
    "stations": {},
    "vsAzimuth": {
      "type": "integer",
      "examples": [
        225
      ]
    },
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "stations",
    "vsAzimuth"
  ]
}

Inputs: stations, vsAzimuth deg, units.

wellpath_closure
unknown
Closure distance and azimuth from surface to bottomhole for a deviation survey.
Entitiescalculation, trajectory, well
Input schema
```
{
  "type": "object",
  "properties": {
    "stations": {},
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "stations"
  ]
}
```
Inputs: stations, units.
wellpath_buildTurnRates
unknown
Build and turn rates between survey stations of a wellbore trajectory.
Entitiescalculation, trajectory, well
Input schema
```
{
  "type": "object",
  "properties": {
    "stations": {},
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "stations"
  ]
}
```
Inputs: stations, units. Rates per 100 ft / 30 m.

wellpath_positionUncertainty

unknown

Wellbore position uncertainty, ISCWSA MWD error model (Rev5.11 default or Rev4): sigma N/E/V.

Entitiescalculation, trajectory, well

Input schema

{
  "type": "object",
  "properties": {
    "stations": {},
    "bTotal": {
      "type": "integer",
      "examples": [
        48919
      ]
    },
    "dip": {
      "type": "number",
      "examples": [
        61.9
      ]
    },
    "declination": {
      "type": "number",
      "examples": [
        3.2
      ]
    },
    "units": {
      "type": "string",
      "examples": [
        "ft"
      ]
    },
    "errorModel": {}
  },
  "additionalProperties": false,
  "required": [
    "stations",
    "bTotal",
    "dip",
    "declination"
  ]
}

Inputs: stations, bTotal (nT), dip, declination, units, errorModel rev4|rev5.

wellpath_separationFactor

unknown

Anti-collision separation factor between two wells: ISCWSA pedal-curve, Rev5.11 default or Rev4.

Entitiescalculation, trajectory, well

Input schema

{
  "type": "object",
  "properties": {
    "referenceStations": {},
    "offsetStations": {},
    "offsetStartNev": {},
    "bTotal": {
      "type": "integer",
      "examples": [
        48919
      ]
    },
    "dip": {
      "type": "number",
      "examples": [
        61.9
      ]
    },
    "declination": {
      "type": "number",
      "examples": [
        3.2
      ]
    },
    "units": {
      "type": "string",
      "examples": [
        "ft"
      ]
    },
    "errorModel": {}
  },
  "additionalProperties": false,
  "required": [
    "referenceStations",
    "offsetStations",
    "bTotal",
    "dip",
    "declination"
  ]
}

Inputs: reference/offsetStations, bTotal, dip, declination, units, errorModel.

wellpath_subsurfaceView
read
Build a 3D subsurface trajectory map payload from deviation surveys, for patchops_render.
Entitiescalculation, trajectory, well
Input schema
```
{
  "type": "object",
  "properties": {
    "wells": {
      "type": "array"
    },
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "wells"
  ]
}
```
wells [{stations, surfaceLat, surfaceLon, name?, color?}], units. Out: mapSpec.

wellpath_toGeoJSON

unknown

Wellbore trajectory as GeoJSON for map rendering, from a survey and surface location.

Entitiescalculation, trajectory, well

Input schema

{
  "type": "object",
  "properties": {
    "stations": {},
    "surfaceLat": {
      "type": "number",
      "examples": [
        31.9
      ]
    },
    "surfaceLon": {
      "type": "number",
      "examples": [
        -102.1
      ]
    },
    "units": {}
  },
  "additionalProperties": false,
  "required": [
    "stations",
    "surfaceLat",
    "surfaceLon"
  ]
}

First station anchored at surfaceLat/Lon. Depth = negative altitude.

units_ftToM

unknown

Convert feet (ft) to meters (m). Factor: 1 ft = 0.3048 m. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_mToFt

unknown

Convert meters (m) to feet (ft). Factor: 1 m = 1/0.3048 ft. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_inToCm

unknown

Convert inches (in) to centimeters (cm). Factor: 1 in = 2.54 cm. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_cmToIn

unknown

Convert centimeters (cm) to inches (in). Factor: 1 cm = 1/2.54 in. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_miToKm

unknown

Convert miles (mi) to kilometers (km). Factor: 1 mi = 1.609344 km. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_kmToMi
unknown
Convert kilometers (km) to miles (mi). Factor: 1 km = 1/1.609344 mi. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_ftToIn

unknown

Convert feet (ft) to inches (in). Factor: 1 ft = 12 in. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_inToFt

unknown

Convert inches (in) to feet (ft). Factor: 1 in = 1/12 ft. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_acreToFt2
unknown
Convert acres (acre) to square feet (ft2). Factor: 1 acre = 43560 ft2. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_ft2ToAcre
unknown
Convert square feet (ft2) to acres (acre). Factor: 1 ft2 = 1/43560 acre. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_acreToM2
unknown
Convert acres (acre) to square meters (m2). Factor: 1 acre = 4046.8564224 m2. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m2ToAcre
unknown
Convert square meters (m2) to acres (acre). Factor: 1 m2 = 1/4046.8564224 acre. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_ft2ToM2
unknown
Convert square feet (ft2) to square meters (m2). Factor: 1 ft2 = 0.09290304 m2. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m2ToFt2
unknown
Convert square meters (m2) to square feet (ft2). Factor: 1 m2 = 1/0.09290304 ft2. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mi2ToAcre
unknown
Convert square miles (mi2) to acres (acre). Factor: 1 mi2 = 640 acre. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_acreToMi2
unknown
Convert acres (acre) to square miles (mi2). Factor: 1 acre = 1/640 mi2. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_bblToFt3
unknown
Convert barrels (bbl) to cubic feet (ft3). Factor: 1 bbl = 5.614583 ft3. Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_ft3ToBbl
unknown
Convert cubic feet (ft3) to barrels (bbl). Factor: 1 ft3 = 1/5.614583 bbl. Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_bblToGal

unknown

Convert barrels (bbl) to gallons (gal). Factor: 1 bbl = 42 gal. Ref: API.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_galToBbl

unknown

Convert gallons (gal) to barrels (bbl). Factor: 1 gal = 1/42 bbl. Ref: API.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_bblToM3
unknown
Convert barrels (bbl) to cubic meters (m3). Factor: 1 bbl = 0.158987 m3. Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m3ToBbl
unknown
Convert cubic meters (m3) to barrels (bbl). Factor: 1 m3 = 1/0.158987 bbl. Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_ft3ToM3
unknown
Convert cubic feet (ft3) to cubic meters (m3). Factor: 1 ft3 = 0.028316846592 m3. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m3ToFt3
unknown
Convert cubic meters (m3) to cubic feet (ft3). Factor: 1 m3 = 1/0.028316846592 ft3. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mscfToMcf
unknown
Convert thousand standard cubic feet (Mscf) to thousand cubic feet (Mcf). Factor: 1 Mscf = 1 Mcf.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mcfToMscf
unknown
Convert thousand cubic feet (Mcf) to thousand standard cubic feet (Mscf). Factor: 1 Mcf = 1 Mscf.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mmscfToM3
unknown
Convert million standard cubic feet (MMscf) to cubic meters (m3). Factor: 1 MMscf = 28316.846592 m3.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_m3ToMmscf

unknown

Convert cubic meters (m3) to million standard cubic feet (MMscf).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_lbmToKg
unknown
Convert pounds-mass (lbm) to kilograms (kg). Factor: 1 lbm = 0.45359237 kg. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kgToLbm
unknown
Convert kilograms (kg) to pounds-mass (lbm). Factor: 1 kg = 1/0.45359237 lbm. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_lbfToN
unknown
Convert pounds-force (lbf) to newtons (N). Factor: 1 lbf = 4.4482216152605 N. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_nToLbf
unknown
Convert newtons (N) to pounds-force (lbf). Factor: 1 N = 1/4.4482216152605 lbf. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_shortTonToKg
unknown
Convert short tons (short ton) to kilograms (kg). Factor: 1 short ton = 907.18474 kg. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kgToShortTon
unknown
Convert kilograms (kg) to short tons (short ton). Factor: 1 kg = 1/907.18474 short ton. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToKpa
unknown
Convert pounds per square inch (psi) to kilopascals (kPa). Factor: 1 psi = 6.894757 kPa. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kpaToPsi
unknown
Convert kilopascals (kPa) to pounds per square inch (psi). Factor: 1 kPa = 1/6.894757 psi.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToBar
unknown
Convert pounds per square inch (psi) to bar (bar). Factor: 1 psi = 0.06894757 bar. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_barToPsi
unknown
Convert bar (bar) to pounds per square inch (psi). Factor: 1 bar = 1/0.06894757 psi. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToAtm
unknown
Convert pounds per square inch (psi) to atmospheres (atm). Factor: 1 psi = 0.0680459639 atm.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_atmToPsi
unknown
Convert atmospheres (atm) to pounds per square inch (psi). Factor: 1 atm = 1/0.0680459639 psi.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToPa
unknown
Convert pounds per square inch (psi) to pascals (Pa). Factor: 1 psi = 6894.757 Pa. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_paToPsi
unknown
Convert pascals (Pa) to pounds per square inch (psi). Factor: 1 Pa = 1/6894.757 psi. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToMpa
unknown
Convert pounds per square inch (psi) to megapascals (MPa). Factor: 1 psi = 0.006894757 MPa.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mpaToPsi
unknown
Convert megapascals (MPa) to pounds per square inch (psi). Factor: 1 MPa = 1/0.006894757 psi.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToKgCm2
unknown
Convert pounds per square inch (psi) to kilograms-force per square centimeter (kgf/cm2).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kgCm2ToPsi
unknown
Convert kilograms-force per square centimeter (kgf/cm2) to pounds per square inch (psi).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToInHg
unknown
Convert pounds per square inch (psi) to inches of mercury (inHg). Factor: 1 psi = 2.03602 inHg.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_inHgToPsi
unknown
Convert inches of mercury (inHg) to pounds per square inch (psi). Factor: 1 inHg = 1/2.03602 psi.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiToFtH2O
unknown
Convert pounds per square inch (psi) to feet of water column (ftH2O). Factor: 1 psi = 2.30666 ftH2O.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_ftH2OToPsi

unknown

Convert feet of water column (ftH2O) to pounds per square inch (psi).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_lbFt3ToKgM3
unknown
Convert pounds per cubic foot (lb/ft3) to kilograms per cubic meter (kg/m3).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kgM3ToLbFt3
unknown
Convert kilograms per cubic meter (kg/m3) to pounds per cubic foot (lb/ft3).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_apiToSg
unknown
Convert API gravity (API) to specific gravity (SG). Factor: SG = 141.5/(131.5+API). Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_sgToApi
unknown
Convert specific gravity (SG) to API gravity (API). Factor: API = 141.5/SG - 131.5. Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_sgToLbGal
unknown
Convert specific gravity (SG) to pounds per gallon (lb/gal). Factor: 1 SG = 8.345404 lb/gal.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_lbGalToSg
unknown
Convert pounds per gallon (lb/gal) to specific gravity (SG). Factor: 1 lb/gal = 1/8.345404 SG.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_lbFt3ToLbGal

unknown

Convert pounds per cubic foot (lb/ft3) to pounds per gallon (lb/gal).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_lbGalToLbFt3

unknown

Convert pounds per gallon (lb/gal) to pounds per cubic foot (lb/ft3).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_ppgToPsiFtGradient
unknown
Convert mud weight in pounds per gallon (ppg) to pressure gradient in psi per foot (psi/ft).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiFtGradientToPpg
unknown
Convert pressure gradient in psi per foot (psi/ft) to mud weight in pounds per gallon (ppg).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_fToC
unknown
Convert degrees Fahrenheit (F) to degrees Celsius (C). Factor: C = (F - 32)*5/9. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_cToF
unknown
Convert degrees Celsius (C) to degrees Fahrenheit (F). Factor: F = C*9/5 + 32. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_fToK
unknown
Convert degrees Fahrenheit (F) to Kelvin (K). Factor: K = (F + 459.67)*5/9. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kToF
unknown
Convert Kelvin (K) to degrees Fahrenheit (F). Factor: F = K*9/5 - 459.67. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_cToK

unknown

Convert degrees Celsius (C) to Kelvin (K). Factor: K = C + 273.15. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_kToC

unknown

Convert Kelvin (K) to degrees Celsius (C). Factor: C = K - 273.15. Ref: NIST.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_fToR
unknown
Convert degrees Fahrenheit (F) to degrees Rankine (R). Factor: R = F + 459.67. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_rToF
unknown
Convert degrees Rankine (R) to degrees Fahrenheit (F). Factor: F = R - 459.67. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_cToR
unknown
Convert degrees Celsius (C) to degrees Rankine (R). Factor: R = (C + 273.15)*9/5. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_rToC
unknown
Convert degrees Rankine (R) to degrees Celsius (C). Factor: C = R*5/9 - 273.15. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_cpToPaS
unknown
Convert centipoise viscosity (cP) to pascal-second viscosity (Pa*s). Factor: 1 cP = 0.001 Pa*s.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_paSToCp
unknown
Convert pascal-second viscosity (Pa*s) to centipoise viscosity (cP). Factor: 1 Pa*s = 1000 cP.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_cpToLbFtS
unknown
Convert centipoise viscosity (cP) to pounds per foot-second viscosity (lb/(ft*s)).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_lbFtSToCp
unknown
Convert pounds per foot-second viscosity (lb/(ft*s)) to centipoise viscosity (cP).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mdToM2
unknown
Convert millidarcys permeability (md) to square meters (m2). Factor: 1 md = 9.869233e-16 m2.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m2ToMd
unknown
Convert square meters (m2) to millidarcys permeability (md). Factor: 1 m2 = 1/9.869233e-16 md.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mdToUm2
unknown
Convert millidarcys permeability (md) to square micrometers (um2). Factor: 1 md = 0.0009869233 um2.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_um2ToMd

unknown

Convert square micrometers (um2) to millidarcys permeability (md).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_darcyToMd
unknown
Convert darcys permeability (darcy) to millidarcys permeability (md). Factor: 1 darcy = 1000 md.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_mdToDarcy
unknown
Convert millidarcys permeability (md) to darcys permeability (darcy). Factor: 1 md = 1/1000 darcy.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_bblDToM3D
unknown
Convert barrels per day (bbl/d) to cubic meters per day (m3/d). Factor: 1 bbl/d = 0.158987 m3/d.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m3DToBblD
unknown
Convert cubic meters per day (m3/d) to barrels per day (bbl/d). Factor: 1 m3/d = 1/0.158987 bbl/d.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_bblDToGalMin

unknown

Convert barrels per day (bbl/d) to gallons per minute (gal/min).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_galMinToBblD

unknown

Convert gallons per minute (gal/min) to barrels per day (bbl/d).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_mscfDToM3D
unknown
Convert thousand standard cubic feet per day (Mscf/d) to cubic meters per day (m3/d).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m3DToMscfD
unknown
Convert cubic meters per day (m3/d) to thousand standard cubic feet per day (Mscf/d).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_stbDToBblD
unknown
Convert stock-tank barrels per day (STB/d) to barrels per day (bbl/d). Factor: 1 STB/d = 1 bbl/d.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_bblDToStbD
unknown
Convert barrels per day (bbl/d) to stock-tank barrels per day (STB/d). Factor: 1 bbl/d = 1 STB/d.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_scfStbToM3M3
unknown
Convert standard cubic feet per stock-tank barrel (scf/STB) to cubic meters per cubic meter (m3/m3).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m3M3ToScfStb
unknown
Convert cubic meters per cubic meter (m3/m3) to standard cubic feet per stock-tank barrel (scf/STB).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_scfBblToM3M3
unknown
Convert standard cubic feet per barrel (scf/bbl) to cubic meters per cubic meter (m3/m3).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_m3M3ToScfBbl
unknown
Convert cubic meters per cubic meter (m3/m3) to standard cubic feet per barrel (scf/bbl).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_btuToKj
unknown
Convert British thermal units (Btu) to kilojoules (kJ). Factor: 1 Btu = 1.05505585262 kJ. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kjToBtu
unknown
Convert kilojoules (kJ) to British thermal units (Btu). Factor: 1 kJ = 1/1.05505585262 Btu.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_hpToKw
unknown
Convert horsepower (hp) to kilowatts (kW). Factor: 1 hp = 0.745699871582 kW. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kwToHp
unknown
Convert kilowatts (kW) to horsepower (hp). Factor: 1 kW = 1/0.745699871582 hp. Ref: NIST.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_btuScfToKjM3
unknown
Convert Btu per standard cubic foot (Btu/scf) to kilojoules per cubic meter (kJ/m3).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_kjM3ToBtuScf
unknown
Convert kilojoules per cubic meter (kJ/m3) to Btu per standard cubic foot (Btu/scf).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_bblToTonneByApi

unknown

Convert barrels (bbl) to metric tonnes using API gravity (tonnes by API). Factor: t=bbl*0.158987*SG.

Entitiescalculation, unit, lease, well

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    },
    "api": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "api"
  ]
}

Inputs: value, api.

units_tonneToBblByApi

unknown

Convert metric tonnes (tonnes) to barrels using API gravity (bbl by API).

Entitiescalculation, unit, lease, well

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    },
    "api": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "api"
  ]
}

Inputs: value, api.

units_ppgToPsiFt
unknown
Convert mud weight in pounds per gallon (ppg) to pressure gradient in psi per foot (psi/ft).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.
units_psiFtToPpg
unknown
Convert pressure gradient in psi per foot (psi/ft) to mud weight in pounds per gallon (ppg).
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_mdFtAngleToTvdFt

unknown

Convert measured depth and angle (MD ft and angle) to true vertical depth (TVD ft).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    },
    "angleDeg": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "angleDeg"
  ]
}

Inputs: value, angleDeg.

units_tvdFtAngleToMdFt

unknown

Convert true vertical depth and angle (TVD ft and angle) to measured depth (MD ft).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    },
    "angleDeg": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value",
    "angleDeg"
  ]
}

Inputs: value, angleDeg.

units_densityKgM3ToApi

unknown

Convert kilograms per cubic meter (kg/m3) to API gravity (API).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_densityLbFt3ToApi

unknown

Convert pounds per cubic foot (lb/ft3) to API gravity (API).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

units_apiToDensityKgM3
unknown
Convert API gravity (API) to kilograms per cubic meter (kg/m3). Factor: kg/m3 = SG*1000. Ref: API.
Entitiescalculation, unit, lease
Input schema
```
{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}
```
Inputs: value.

units_apiToDensityLbFt3

unknown

Convert API gravity (API) to pounds per cubic foot (lb/ft3).

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "value"
  ]
}

Inputs: value.

comp_criticalProperties
unknown
Lookup component critical properties. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "component": {}
  },
  "additionalProperties": false,
  "required": [
    "component"
  ]
}
```
Inputs: component.
comp_listComponents
read
List component table keys. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

comp_apparentMolecularWeight

unknown

Compute apparent molecular weight. Ref: GPSA Engineering Data Book; Katz et al.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "components": {
      "type": "array",
      "items": {}
    },
    "moleFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false,
  "required": [
    "components",
    "moleFractions"
  ]
}

Inputs: components, moleFractions.

comp_gasSpecificGravity

unknown

Compute gas specific gravity relative to air. Ref: GPSA Engineering Data Book.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "apparentMW": {},
    "components": {
      "type": "array",
      "items": {}
    },
    "moleFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false
}

Inputs: apparentMW?, components?, moleFractions?.

comp_pseudoCriticalKay

unknown

Compute Kay pseudo-critical temperature and pressure. Ref: Katz et al.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "components": {
      "type": "array",
      "items": {}
    },
    "moleFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false,
  "required": [
    "components",
    "moleFractions"
  ]
}

Inputs: components, moleFractions.

comp_pseudoCriticalSuttonFromSG
unknown
Compute Sutton pseudo-criticals from gas gravity. Ref: Sutton 1985.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "gasGravity": {}
  },
  "additionalProperties": false,
  "required": [
    "gasGravity"
  ]
}
```
Inputs: gasGravity.

comp_pseudoReduced

unknown

Compute pseudo-reduced pressure and temperature. Ref: Katz et al.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "P": {},
    "T": {},
    "Ppc": {},
    "Tpc": {}
  },
  "additionalProperties": false,
  "required": [
    "P",
    "T",
    "Ppc",
    "Tpc"
  ]
}

Inputs: P, T, Ppc, Tpc.

comp_wichertAzizCorrection

unknown

Correct sour-gas pseudo-critical properties. Ref: Wichert-Aziz 1972.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Tpc": {},
    "Ppc": {},
    "yCO2": {},
    "yH2S": {}
  },
  "additionalProperties": false,
  "required": [
    "Tpc",
    "Ppc",
    "yCO2",
    "yH2S"
  ]
}

Inputs: Tpc, Ppc, yCO2, yH2S.

comp_molarMassFromGravity
unknown
Convert gas gravity to molar mass. Ref: GPSA Engineering Data Book.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "gasGravity": {}
  },
  "additionalProperties": false,
  "required": [
    "gasGravity"
  ]
}
```
Inputs: gasGravity.

comp_gasDensityIdeal

unknown

Compute ideal gas density in field units. Ref: GPSA Engineering Data Book.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "P": {},
    "T": {},
    "MW": {}
  },
  "additionalProperties": false,
  "required": [
    "P",
    "T",
    "MW"
  ]
}

Inputs: P, T, MW.

comp_componentWeightFractions

unknown

Convert component mole fractions to weight fractions. Ref: Katz et al.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "components": {
      "type": "array",
      "items": {}
    },
    "moleFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false,
  "required": [
    "components",
    "moleFractions"
  ]
}

Inputs: components, moleFractions.

comp_componentMoleFractions

unknown

Convert component weight fractions to mole fractions. Ref: Katz et al.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "components": {
      "type": "array",
      "items": {}
    },
    "weightFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false,
  "required": [
    "components",
    "weightFractions"
  ]
}

Inputs: components, weightFractions.

comp_mixtureCriticalTemperature

unknown

Compute Kay mixture critical temperature. Ref: Katz et al.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "components": {
      "type": "array",
      "items": {}
    },
    "moleFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false,
  "required": [
    "components",
    "moleFractions"
  ]
}

Inputs: components, moleFractions.

comp_mixturePseudoCriticalPressure

unknown

Compute Kay mixture pseudo-critical pressure. Ref: Katz et al.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "components": {
      "type": "array",
      "items": {}
    },
    "moleFractions": {
      "type": "array",
      "items": {}
    }
  },
  "additionalProperties": false,
  "required": [
    "components",
    "moleFractions"
  ]
}

Inputs: components, moleFractions.

comp_standingKatzPseudoCriticals
unknown
Compute Standing-Katz pseudo-criticals from gas gravity. Ref: Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "gasGravity": {},
    "type": {}
  },
  "additionalProperties": false,
  "required": [
    "gasGravity",
    "type"
  ]
}
```
Inputs: gasGravity, type.
comp_criticalTemperature
unknown
Lookup component critical temperature. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "component": {}
  },
  "additionalProperties": false,
  "required": [
    "component"
  ]
}
```
Inputs: component.
comp_criticalPressure
unknown
Lookup component critical pressure. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "component": {}
  },
  "additionalProperties": false,
  "required": [
    "component"
  ]
}
```
Inputs: component.
comp_acentricFactor
unknown
Lookup component acentric factor. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "component": {}
  },
  "additionalProperties": false,
  "required": [
    "component"
  ]
}
```
Inputs: component.
comp_molecularWeight
unknown
Lookup component molecular weight. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "component": {}
  },
  "additionalProperties": false,
  "required": [
    "component"
  ]
}
```
Inputs: component.
comp_normalBoilingPoint
unknown
Lookup component normal boiling point. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "component": {}
  },
  "additionalProperties": false,
  "required": [
    "component"
  ]
}
```
Inputs: component.

pet_archieFormationFactor

unknown

Archie F, F=a/phi^m. Ref: Archie 1942.

Entitiescalculation, formation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "phi_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "phi_fraction"
  ]
}

Inputs: a, m, phi_fraction.

pet_archieWaterSaturation

unknown

Archie Sw, Sw=((a*Rw)/(phi^m*Rt))^(1/n). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m"
  ]
}

Inputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m.

pet_archieResistivityIndex

unknown

Archie RI, RI=Rt/Ro. Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "rt_ohm_m": {},
    "ro_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "rt_ohm_m",
    "ro_ohm_m"
  ]
}

Inputs: rt_ohm_m, ro_ohm_m.

pet_resistivityIndexFromSaturation

unknown

Resistivity index from water saturation, RI=Sw^-n (Archie 1942).

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "sw_fraction": {},
    "n": {}
  },
  "additionalProperties": false,
  "required": [
    "sw_fraction",
    "n"
  ]
}

Inputs: sw_fraction, n.

pet_archieResistivityAtSaturation

unknown

Archie Rt, Rt=(a*Rw)/(phi^m*Sw^n). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "sw_fraction"
  ]
}

Inputs: a, m, n, rw_ohm_m, phi_fraction, sw_fraction.

pet_archiePorosityFromRt

unknown

Archie phi, phi=((a*Rw)/(Rt*Sw^n))^(1/m). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "rt_ohm_m": {},
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "rt_ohm_m",
    "sw_fraction"
  ]
}

Inputs: a, m, n, rw_ohm_m, rt_ohm_m, sw_fraction.

pet_archieSaturationExponent

unknown

Archie n, n=ln(aRw/(phi^m*Rt))/ln(Sw). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {},
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m",
    "sw_fraction"
  ]
}

Inputs: a, m, rw_ohm_m, phi_fraction, rt_ohm_m, sw_fraction.

pet_archieCementationExponent

unknown

Archie m, m=ln(aRw/(Rt*Sw^n))/ln(phi). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {},
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m",
    "sw_fraction"
  ]
}

Inputs: a, n, rw_ohm_m, phi_fraction, rt_ohm_m, sw_fraction.

pet_porosityDensity

unknown

Density porosity, phi=(rhoma-rhob)/(rhoma-rhofl). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "rhoma_g_cm3": {},
    "rhofl_g_cm3": {},
    "rhob_g_cm3": {}
  },
  "additionalProperties": false,
  "required": [
    "rhoma_g_cm3",
    "rhofl_g_cm3",
    "rhob_g_cm3"
  ]
}

Inputs: rhoma_g_cm3, rhofl_g_cm3, rhob_g_cm3.

pet_porosityDensityShaleCorrected

unknown

Density shale correction, phiE=phiD-Vsh*phiDsh. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "rhoma_g_cm3": {},
    "rhofl_g_cm3": {},
    "rhob_g_cm3": {},
    "rhosh_g_cm3": {},
    "vsh_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "rhoma_g_cm3",
    "rhofl_g_cm3",
    "rhob_g_cm3",
    "rhosh_g_cm3",
    "vsh_fraction"
  ]
}

Inputs: rhoma_g_cm3, rhofl_g_cm3, rhob_g_cm3, rhosh_g_cm3, vsh_fraction.

pet_matrixDensityFromDensityPorosity

unknown

Matrix density, rhoma=(rhob-phi*rhofl)/(1-phi). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "rhob_g_cm3": {},
    "rhofl_g_cm3": {},
    "phi_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "rhob_g_cm3",
    "rhofl_g_cm3",
    "phi_fraction"
  ]
}

Inputs: rhob_g_cm3, rhofl_g_cm3, phi_fraction.

pet_porosityNeutronDensity

unknown

Neutron-density porosity, phi=sqrt((phiN^2+phiD^2)/2). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_neutron_fraction": {},
    "phi_density_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_neutron_fraction",
    "phi_density_fraction"
  ]
}

Inputs: phi_neutron_fraction, phi_density_fraction.

pet_porosityNeutronShaleCorrected

unknown

Neutron shale correction, phiE=phiN-Vsh*phiNsh. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_neutron_fraction": {},
    "vsh_fraction": {},
    "phi_neutron_shale_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_neutron_fraction",
    "vsh_fraction",
    "phi_neutron_shale_fraction"
  ]
}

Inputs: phi_neutron_fraction, vsh_fraction, phi_neutron_shale_fraction.

pet_porositySonicWyllie

unknown

Sonic Wyllie porosity, phi=(dt-dtma)/(dtfl-dtma). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "dt_us_ft": {},
    "dtma_us_ft": {},
    "dtfl_us_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "dt_us_ft",
    "dtma_us_ft",
    "dtfl_us_ft"
  ]
}

Inputs: dt_us_ft, dtma_us_ft, dtfl_us_ft.

pet_porositySonicRaymerHuntGardner

unknown

Sonic RHG porosity, 1/dt=(1-phi)^2/dtma+phi/dtfl. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "dt_us_ft": {},
    "dtma_us_ft": {},
    "dtfl_us_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "dt_us_ft",
    "dtma_us_ft",
    "dtfl_us_ft"
  ]
}

Inputs: dt_us_ft, dtma_us_ft, dtfl_us_ft.

pet_porositySonic

unknown

Sonic porosity pair, phiW=(dt-dtma)/(dtfl-dtma). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "dt_us_ft": {},
    "dtma_us_ft": {},
    "dtfl_us_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "dt_us_ft",
    "dtma_us_ft",
    "dtfl_us_ft"
  ]
}

Inputs: dt_us_ft, dtma_us_ft, dtfl_us_ft.

pet_secondaryPorosityIndex

unknown

Secondary porosity index, SPI=phiND-phiS. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_neutron_density_fraction": {},
    "phi_sonic_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_neutron_density_fraction",
    "phi_sonic_fraction"
  ]
}

Inputs: phi_neutron_density_fraction, phi_sonic_fraction.

pet_totalPorosity

unknown

Total porosity, phiT=phiE+Vsh*phiSh. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_effective_fraction": {},
    "vsh_fraction": {},
    "phi_shale_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_effective_fraction",
    "vsh_fraction",
    "phi_shale_fraction"
  ]
}

Inputs: phi_effective_fraction, vsh_fraction, phi_shale_fraction.

pet_effectivePorosity

unknown

Effective porosity, phiE=phiT-Vsh*phiSh. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_total_fraction": {},
    "vsh_fraction": {},
    "phi_shale_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_total_fraction",
    "vsh_fraction",
    "phi_shale_fraction"
  ]
}

Inputs: phi_total_fraction, vsh_fraction, phi_shale_fraction.

pet_gammaRayIndex

unknown

Gamma-ray index, IGR=(GR-GRmin)/(GRmax-GRmin). Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "gr_api": {},
    "gr_min_api": {},
    "gr_max_api": {}
  },
  "additionalProperties": false,
  "required": [
    "gr_api",
    "gr_min_api",
    "gr_max_api"
  ]
}

Inputs: gr_api, gr_min_api, gr_max_api.

pet_vshaleLinear

unknown

Linear shale volume, Vsh=IGR. Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "igr_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "igr_fraction"
  ]
}

Inputs: igr_fraction.

pet_vshaleLarionovTertiary
unknown
Larionov Tertiary Vsh, Vsh=0.083*(2^(3.7*IGR)-1). Ref: Schlumberger.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "igr_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "igr_fraction"
  ]
}
```
Inputs: igr_fraction.
pet_vshaleLarionovOlder
unknown
Larionov older Vsh, Vsh=0.33*(2^(2*IGR)-1). Ref: Schlumberger.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "igr_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "igr_fraction"
  ]
}
```
Inputs: igr_fraction.
pet_vshaleClavier
unknown
Clavier shale volume, Vsh=1.7-sqrt(3.38-(IGR+0.7)^2). Ref: Schlumberger.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "igr_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "igr_fraction"
  ]
}
```
Inputs: igr_fraction.

pet_vshaleSteiber

unknown

Steiber shale volume, Vsh=IGR/(3-2*IGR). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "igr_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "igr_fraction"
  ]
}

Inputs: igr_fraction.

pet_rwTemperatureCorrection

unknown

Arps resistivity correction, R2=R1*(T1+6.77)/(T2+6.77). Ref: Arps.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "r1_ohm_m": {},
    "t1_f": {},
    "t2_f": {}
  },
  "additionalProperties": false,
  "required": [
    "r1_ohm_m",
    "t1_f",
    "t2_f"
  ]
}

Inputs: r1_ohm_m, t1_f, t2_f.

pet_rmfAtFormationTemp

unknown

Rmf at formation temp, Rmf2=Rmf1*(T1+6.77)/(Tf+6.77). Ref: Arps.

Entitiescalculation, formation

Input schema

{
  "type": "object",
  "properties": {
    "rmf1_ohm_m": {},
    "measured_temp_f": {},
    "formation_temp_f": {}
  },
  "additionalProperties": false,
  "required": [
    "rmf1_ohm_m",
    "measured_temp_f",
    "formation_temp_f"
  ]
}

Inputs: rmf1_ohm_m, measured_temp_f, formation_temp_f.

pet_rwFromSp

unknown

SP water resistivity, Rw=Rmf/10^(-SSP/K). Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "ssp_mv": {},
    "rmf_ohm_m": {},
    "formation_temp_f": {}
  },
  "additionalProperties": false,
  "required": [
    "ssp_mv",
    "rmf_ohm_m",
    "formation_temp_f"
  ]
}

Inputs: ssp_mv, rmf_ohm_m, formation_temp_f.

pet_staticSpFromRw

unknown

Static SP, SSP=-K*log10(Rmf/Rw). Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "rw_ohm_m": {},
    "rmf_ohm_m": {},
    "formation_temp_f": {}
  },
  "additionalProperties": false,
  "required": [
    "rw_ohm_m",
    "rmf_ohm_m",
    "formation_temp_f"
  ]
}

Inputs: rw_ohm_m, rmf_ohm_m, formation_temp_f.

pet_formationTemperature

unknown

Formation temperature, Tf=Ts+grad*depth/100. Ref: Asquith-Krygowski.

Entitiescalculation, formation

Input schema

{
  "type": "object",
  "properties": {
    "surface_temp_f": {},
    "gradient_f_per_100ft": {},
    "tvd_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "surface_temp_f",
    "gradient_f_per_100ft",
    "tvd_ft"
  ]
}

Inputs: surface_temp_f, gradient_f_per_100ft, tvd_ft.

pet_bulkVolumeWater

unknown

Bulk volume water, BVW=phi*Sw. Ref: Schlumberger.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "sw_fraction"
  ]
}

Inputs: phi_fraction, sw_fraction.

pet_bulkVolumeWaterFlushed

unknown

Flushed BVW, BVWxo=phi*Sxo. Ref: Schlumberger.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "sxo_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "sxo_fraction"
  ]
}

Inputs: phi_fraction, sxo_fraction.

pet_moveableHydrocarbons

unknown

Moveable hydrocarbons, BVHmov=phi*(Sxo-Sw). Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "sw_fraction": {},
    "sxo_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "sw_fraction",
    "sxo_fraction"
  ]
}

Inputs: phi_fraction, sw_fraction, sxo_fraction.

pet_hydrocarbonSaturation

unknown

Hydrocarbon saturation, Sh=1-Sw. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "sw_fraction"
  ]
}

Inputs: sw_fraction.

pet_residualHydrocarbonSaturation
unknown
Residual hydrocarbon saturation, Shr=1-Sxo. Ref: Schlumberger.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "sxo_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "sxo_fraction"
  ]
}
```
Inputs: sxo_fraction.

pet_waterFilledPorosity

unknown

Water-filled porosity, WFP=phi*Sw. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "sw_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "sw_fraction"
  ]
}

Inputs: phi_fraction, sw_fraction.

pet_swSimandoux

unknown

Simandoux Sw, Ct=A*Sw^n+B*Sw. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {},
    "vsh_fraction": {},
    "rsh_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m",
    "vsh_fraction",
    "rsh_ohm_m"
  ]
}

Inputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m, vsh_fraction, rsh_ohm_m.

pet_swIndonesia

unknown

Indonesia Sw, 1/sqrt(Rt)=A*Sw^(n/2). Ref: Poupon-Leveaux.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {},
    "vsh_fraction": {},
    "rsh_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m",
    "vsh_fraction",
    "rsh_ohm_m"
  ]
}

Inputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m, vsh_fraction, rsh_ohm_m.

pet_swWaxmanSmits

unknown

Waxman-Smits Sw, Ct=A(Cw*Sw^n+BQv*Sw^(n-1)). Ref: Waxman-Smits.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {},
    "bqv_s_per_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m",
    "bqv_s_per_m"
  ]
}

Inputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m, bqv_s_per_m.

pet_permeabilityTimur

unknown

Timur permeability, k=8581*phi^4.4/Swirr^2. Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "swirr_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "swirr_fraction"
  ]
}

Inputs: phi_fraction, swirr_fraction.

pet_permeabilityCoatesDumanoir

unknown

Coates-Dumanoir k, k=(C*phi^2*((1-Swirr)/Swirr))^2. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "swirr_fraction": {},
    "c_factor": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "swirr_fraction"
  ]
}

Inputs: phi_fraction, swirr_fraction, c_factor?.

pet_permeabilityWyllieRose

unknown

Wyllie-Rose permeability, k=C*phi^3/Swirr^2. Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "swirr_fraction": {},
    "coefficient_md": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "swirr_fraction"
  ]
}

Inputs: phi_fraction, swirr_fraction, coefficient_md?.

pet_permeabilityMorris

unknown

Morris-Biggs permeability, k=C*phi^6/Swirr^2. Ref: Asquith-Krygowski.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "swirr_fraction": {},
    "fluid": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "swirr_fraction"
  ]
}

Inputs: phi_fraction, swirr_fraction, fluid?.

pet_netPayFlag

unknown

Net pay flag, pay=phi>=cutoff && Sw<=cutoff && Vsh<=cutoff. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "sw_fraction": {},
    "vsh_fraction": {},
    "phi_cutoff_fraction": {},
    "sw_cutoff_fraction": {},
    "vsh_cutoff_fraction": {},
    "gross_thickness_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "sw_fraction",
    "vsh_fraction",
    "phi_cutoff_fraction",
    "sw_cutoff_fraction",
    "vsh_cutoff_fraction",
    "gross_thickness_ft"
  ]
}

Inputs: phi_fraction, sw_fraction, vsh_fraction, phi_cutoff_fraction, sw_cutoff…

pet_netToGross

unknown

Net-to-gross, NTG=net/gross. Ref: Schlumberger.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "net_pay_ft": {},
    "gross_thickness_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "net_pay_ft",
    "gross_thickness_ft"
  ]
}

Inputs: net_pay_ft, gross_thickness_ft.

pet_hydrocarbonPoreVolume

unknown

Hydrocarbon pore volume, HCPV=phi*(1-Sw)*h*area. Ref: Schlumberger.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "phi_fraction": {},
    "sw_fraction": {},
    "thickness_ft": {},
    "area_acres": {}
  },
  "additionalProperties": false,
  "required": [
    "phi_fraction",
    "sw_fraction",
    "thickness_ft",
    "area_acres"
  ]
}

Inputs: phi_fraction, sw_fraction, thickness_ft, area_acres.

pet_pickettSlope

unknown

Pickett slope, m=-dlog(Rt)/dlog(phi). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "phi1_fraction": {},
    "rt1_ohm_m": {},
    "phi2_fraction": {},
    "rt2_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "phi1_fraction",
    "rt1_ohm_m",
    "phi2_fraction",
    "rt2_ohm_m"
  ]
}

Inputs: phi1_fraction, rt1_ohm_m, phi2_fraction, rt2_ohm_m.

pet_pickettSwFromPoint

unknown

Pickett Sw, Sw=((a*Rw)/(phi^m*Rt))^(1/n). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rw_ohm_m": {},
    "phi_fraction": {},
    "rt_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rw_ohm_m",
    "phi_fraction",
    "rt_ohm_m"
  ]
}

Inputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m.

pet_apparentWaterResistivity

unknown

Apparent water resistivity, Rwa=phi^m*Rt/a. Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "phi_fraction": {},
    "rt_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "phi_fraction",
    "rt_ohm_m"
  ]
}

Inputs: a, m, phi_fraction, rt_ohm_m.

pet_flushedZoneWaterSaturation

unknown

Flushed-zone Sw, Sxo=((a*Rmf)/(phi^m*Rxo))^(1/n). Ref: Archie 1942.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "a": {},
    "m": {},
    "n": {},
    "rmf_ohm_m": {},
    "phi_fraction": {},
    "rxo_ohm_m": {}
  },
  "additionalProperties": false,
  "required": [
    "a",
    "m",
    "n",
    "rmf_ohm_m",
    "phi_fraction",
    "rxo_ohm_m"
  ]
}

Inputs: a, m, n, rmf_ohm_m, phi_fraction, rxo_ohm_m.

drill_hydrostaticPressure

unknown

Hydrostatic pressure psi: P=0.052*MW*TVD. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {},
    "tvd_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg",
    "tvd_ft"
  ]
}

Inputs: mudWeight_ppg, tvd_ft.

drill_mudWeightFromGradient

unknown

Mud weight ppg: MW=gradient/0.052. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pressureGradient_psi_per_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "pressureGradient_psi_per_ft"
  ]
}

Inputs: pressureGradient_psi_per_ft.

drill_pressureGradientFromMudWeight
unknown
Pressure gradient psi/ft: G=0.052*MW. Ref: Bourgoyne/API13D.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg"
  ]
}
```
Inputs: mudWeight_ppg.

drill_equivalentMudWeight

unknown

Equivalent mud weight ppg: EMW=P/(0.052*TVD). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pressure_psi": {},
    "tvd_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "pressure_psi",
    "tvd_ft"
  ]
}

Inputs: pressure_psi, tvd_ft.

drill_ecd

unknown

Equivalent circulating density ppg: ECD=MW+dP/(0.052*TVD). Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {},
    "annularPressureLoss_psi": {},
    "tvd_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg",
    "annularPressureLoss_psi",
    "tvd_ft"
  ]
}

Inputs: mudWeight_ppg, annularPressureLoss_psi, tvd_ft.

drill_annularVelocity

unknown

Annular velocity ft/min: AV=24.51*q/(Dh^2-Dp^2). Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "holeDiameter_in": {},
    "pipeOuterDiameter_in": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "holeDiameter_in",
    "pipeOuterDiameter_in"
  ]
}

Inputs: flowRate_gpm, holeDiameter_in, pipeOuterDiameter_in.

drill_pipeVelocity

unknown

Pipe velocity ft/min: V=24.51*q/ID^2. Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "pipeInnerDiameter_in": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "pipeInnerDiameter_in"
  ]
}

Inputs: flowRate_gpm, pipeInnerDiameter_in.

drill_criticalVelocity

unknown

Critical velocity ft/s: Vc=Re*mu/(928*MW*D). Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {},
    "viscosity_cp": {},
    "hydraulicDiameter_in": {},
    "criticalReynoldsNumber": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg",
    "viscosity_cp",
    "hydraulicDiameter_in"
  ]
}

Inputs: mudWeight_ppg, viscosity_cp, hydraulicDiameter_in, criticalReynoldsNumb…

drill_pumpOutputTriplex

unknown

Triplex pump output bbl/stk: O=0.000243*D^2*S*E. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "linerDiameter_in": {},
    "strokeLength_in": {},
    "pumpEfficiency_fraction": {},
    "pumpSpeed_spm": {}
  },
  "additionalProperties": false,
  "required": [
    "linerDiameter_in",
    "strokeLength_in",
    "pumpEfficiency_fraction",
    "pumpSpeed_spm"
  ]
}

Inputs: linerDiameter_in, strokeLength_in, pumpEfficiency_fraction, pumpSpeed_s…

drill_pumpOutputDuplex

unknown

Duplex pump output bbl/stk: O=0.000162*S*(2D^2-r^2)*E. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "linerDiameter_in": {},
    "rodDiameter_in": {},
    "strokeLength_in": {},
    "pumpEfficiency_fraction": {},
    "pumpSpeed_spm": {}
  },
  "additionalProperties": false,
  "required": [
    "linerDiameter_in",
    "rodDiameter_in",
    "strokeLength_in",
    "pumpEfficiency_fraction",
    "pumpSpeed_spm"
  ]
}

Inputs: linerDiameter_in, rodDiameter_in, strokeLength_in, pumpEfficiency_fract…

drill_pumpPressureFromHHP

unknown

Pump pressure psi: P=HHP*1714/q. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "hydraulicHorsepower_hp": {},
    "flowRate_gpm": {}
  },
  "additionalProperties": false,
  "required": [
    "hydraulicHorsepower_hp",
    "flowRate_gpm"
  ]
}

Inputs: hydraulicHorsepower_hp, flowRate_gpm.

drill_strokesToBottomsUp

unknown

Bottoms-up strokes: strokes=annularVolume/pumpOutput. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "holeDiameter_in": {},
    "pipeOuterDiameter_in": {},
    "measuredDepth_ft": {},
    "pumpOutput_bbl_per_stk": {}
  },
  "additionalProperties": false,
  "required": [
    "holeDiameter_in",
    "pipeOuterDiameter_in",
    "measuredDepth_ft",
    "pumpOutput_bbl_per_stk"
  ]
}

Inputs: holeDiameter_in, pipeOuterDiameter_in, measuredDepth_ft, pumpOutput_bbl…

drill_annularCapacity

unknown

Annular capacity bbl/ft: C=(Dh^2-Dp^2)/1029.4. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "holeDiameter_in": {},
    "pipeOuterDiameter_in": {}
  },
  "additionalProperties": false,
  "required": [
    "holeDiameter_in",
    "pipeOuterDiameter_in"
  ]
}

Inputs: holeDiameter_in, pipeOuterDiameter_in.

drill_pipeCapacity

unknown

Pipe capacity bbl/ft: C=ID^2/1029.4. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pipeInnerDiameter_in": {}
  },
  "additionalProperties": false,
  "required": [
    "pipeInnerDiameter_in"
  ]
}

Inputs: pipeInnerDiameter_in.

drill_annularVolume

unknown

Annular volume bbl: V=L*(Dh^2-Dp^2)/1029.4. Ref: Bourgoyne.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "holeDiameter_in": {},
    "pipeOuterDiameter_in": {},
    "length_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "holeDiameter_in",
    "pipeOuterDiameter_in",
    "length_ft"
  ]
}

Inputs: holeDiameter_in, pipeOuterDiameter_in, length_ft.

drill_pipeDisplacement

unknown

Pipe displacement bbl: V=L*(OD^2-ID^2)/1029.4. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "pipeOuterDiameter_in": {},
    "pipeInnerDiameter_in": {},
    "length_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "pipeOuterDiameter_in",
    "pipeInnerDiameter_in",
    "length_ft"
  ]
}

Inputs: pipeOuterDiameter_in, pipeInnerDiameter_in, length_ft.

drill_holeVolume

unknown

Hole volume bbl: V=L*Dh^2/1029.4. Ref: Bourgoyne.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "holeDiameter_in": {},
    "length_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "holeDiameter_in",
    "length_ft"
  ]
}

Inputs: holeDiameter_in, length_ft.

drill_lagTime

unknown

Lag time min: t=annularVolume/(q/42). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "holeDiameter_in": {},
    "pipeOuterDiameter_in": {},
    "measuredDepth_ft": {},
    "flowRate_gpm": {}
  },
  "additionalProperties": false,
  "required": [
    "holeDiameter_in",
    "pipeOuterDiameter_in",
    "measuredDepth_ft",
    "flowRate_gpm"
  ]
}

Inputs: holeDiameter_in, pipeOuterDiameter_in, measuredDepth_ft, flowRate_gpm.

drill_bitNozzleArea

unknown

Bit nozzle TFA in2: A=sum(pi/4*(n/32)^2). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "nozzleDiameters_32nds": {}
  },
  "additionalProperties": false,
  "required": [
    "nozzleDiameters_32nds"
  ]
}

Inputs: nozzleDiameters_32nds.

drill_jetVelocity

unknown

Jet velocity ft/s: Vj=0.32086*q/TFA. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "totalFlowArea_in2": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "totalFlowArea_in2"
  ]
}

Inputs: flowRate_gpm, totalFlowArea_in2.

drill_bitPressureDrop

write

Bit dP psi: dP=156.5*MW*q^2/(sum d32^2)^2. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {},
    "flowRate_gpm": {},
    "totalFlowArea_in2": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg",
    "flowRate_gpm",
    "totalFlowArea_in2"
  ]
}

Inputs: mudWeight_ppg, flowRate_gpm, totalFlowArea_in2.

drill_hydraulicHorsepower

unknown

Hydraulic horsepower hp: HHP=q*dP/1714. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "pressureDrop_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "pressureDrop_psi"
  ]
}

Inputs: flowRate_gpm, pressureDrop_psi.

drill_bitArea

unknown

Bit area in2: A=pi*D^2/4. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "bitDiameter_in": {}
  },
  "additionalProperties": false,
  "required": [
    "bitDiameter_in"
  ]
}

Inputs: bitDiameter_in.

drill_hsi

unknown

HSI hp/in2: HSI=(q*dP/1714)/(pi*Db^2/4). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "bitPressureDrop_psi": {},
    "bitDiameter_in": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "bitPressureDrop_psi",
    "bitDiameter_in"
  ]
}

Inputs: flowRate_gpm, bitPressureDrop_psi, bitDiameter_in.

drill_jetImpactForce

unknown

Jet impact force lbf: JIF=0.01823*q*sqrt(MW*dP). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "mudWeight_ppg": {},
    "bitPressureDrop_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "mudWeight_ppg",
    "bitPressureDrop_psi"
  ]
}

Inputs: flowRate_gpm, mudWeight_ppg, bitPressureDrop_psi.

drill_pressureDropAtBitFraction

write

Bit pressure fraction: f=dPbit/Ppump. Ref: Bourgoyne/API13D.

Entitiescalculation, frac_job, completion

Input schema

{
  "type": "object",
  "properties": {
    "bitPressureDrop_psi": {},
    "pumpPressure_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "bitPressureDrop_psi",
    "pumpPressure_psi"
  ]
}

Inputs: bitPressureDrop_psi, pumpPressure_psi.

drill_optimumFlowExponent

unknown

Flow exponent: m=ln(dP2/dP1)/ln(q2/q1). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate1_gpm": {},
    "pressureDrop1_psi": {},
    "flowRate2_gpm": {},
    "pressureDrop2_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate1_gpm",
    "pressureDrop1_psi",
    "flowRate2_gpm",
    "pressureDrop2_psi"
  ]
}

Inputs: flowRate1_gpm, pressureDrop1_psi, flowRate2_gpm, pressureDrop2_psi.

drill_plasticViscosity

unknown

Plastic viscosity cp: PV=theta600-theta300. Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "theta600": {},
    "theta300": {}
  },
  "additionalProperties": false,
  "required": [
    "theta600",
    "theta300"
  ]
}

Inputs: theta600, theta300.

drill_yieldPoint

unknown

Yield point lbf/100ft2: YP=theta300-PV. Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "theta300": {},
    "plasticViscosity_cp": {}
  },
  "additionalProperties": false,
  "required": [
    "theta300",
    "plasticViscosity_cp"
  ]
}

Inputs: theta300, plasticViscosity_cp.

drill_apparentViscosity

unknown

Apparent viscosity cp: AV=theta600/2. Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "theta600": {}
  },
  "additionalProperties": false,
  "required": [
    "theta600"
  ]
}

Inputs: theta600.

drill_powerLawN

unknown

Power-law n: n=3.32*log10(theta600/theta300). Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "theta600": {},
    "theta300": {}
  },
  "additionalProperties": false,
  "required": [
    "theta600",
    "theta300"
  ]
}

Inputs: theta600, theta300.

drill_powerLawK

unknown

Power-law K: K=theta300/(511^n). Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "theta600": {},
    "theta300": {}
  },
  "additionalProperties": false,
  "required": [
    "theta600",
    "theta300"
  ]
}

Inputs: theta600, theta300.

drill_gelStrength

unknown

Gel strength lbf/100ft2: G=theta3 after static time. Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "theta3": {},
    "staticTime_min": {}
  },
  "additionalProperties": false,
  "required": [
    "theta3",
    "staticTime_min"
  ]
}

Inputs: theta3, staticTime_min.

drill_reynoldsPipe

unknown

Pipe Reynolds: Re=928*MW*V*D/mu_eff. Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "flowRate_gpm": {},
    "pipeInnerDiameter_in": {},
    "mudWeight_ppg": {},
    "rheologyModel": {},
    "plasticViscosity_cp": {},
    "yieldPoint_lbf_per_100ft2": {},
    "powerLawN_dimensionless": {},
    "powerLawK_lbf_s_n_per_100ft2": {}
  },
  "additionalProperties": false,
  "required": [
    "flowRate_gpm",
    "pipeInnerDiameter_in",
    "mudWeight_ppg"
  ]
}

Inputs: flowRate_gpm, pipeInnerDiameter_in, mudWeight_ppg, rheologyModel?, plas…

drill_cuttingSlipVelocity

unknown

Cutting slip ft/s: Vs=sqrt(4*g*d*(rhos-rhom)/(3*Cd*rhom)). Ref: API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "cuttingDiameter_in": {},
    "cuttingsDensity_ppg": {},
    "mudWeight_ppg": {},
    "fluidViscosity_cp": {}
  },
  "additionalProperties": false,
  "required": [
    "cuttingDiameter_in",
    "cuttingsDensity_ppg",
    "mudWeight_ppg",
    "fluidViscosity_cp"
  ]
}

Inputs: cuttingDiameter_in, cuttingsDensity_ppg, mudWeight_ppg, fluidViscosity_…

drill_cuttingsCarryingCapacity

unknown

Cuttings carrying fraction: C=max(0,(AV-Vs)/AV). Ref: Bourgoyne/API13D.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "annularVelocity_ft_min": {},
    "slipVelocity_ft_min": {}
  },
  "additionalProperties": false,
  "required": [
    "annularVelocity_ft_min",
    "slipVelocity_ft_min"
  ]
}

Inputs: annularVelocity_ft_min, slipVelocity_ft_min.

drill_killMudWeight

unknown

Kill mud weight ppg: KMW=MW+SIDPP/(0.052*TVD). Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "currentMudWeight_ppg": {},
    "shutInDrillPipePressure_psi": {},
    "tvd_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "currentMudWeight_ppg",
    "shutInDrillPipePressure_psi",
    "tvd_ft"
  ]
}

Inputs: currentMudWeight_ppg, shutInDrillPipePressure_psi, tvd_ft.

drill_maaspMaximumAllowableMudWeight

unknown

MAASP psi: MAASP=(FG/0.052-MW)*0.052*TVDshoe. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "fractureGradient_psi_per_ft": {},
    "currentMudWeight_ppg": {},
    "shoeTVD_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "fractureGradient_psi_per_ft",
    "currentMudWeight_ppg",
    "shoeTVD_ft"
  ]
}

Inputs: fractureGradient_psi_per_ft, currentMudWeight_ppg, shoeTVD_ft.

drill_kickTolerance

unknown

Kick tolerance ppg: KT=FG/0.052-MW-margin. Ref: Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "fractureGradient_psi_per_ft": {},
    "mudWeight_ppg": {},
    "shoeTVD_ft": {},
    "safetyMargin_ppg": {}
  },
  "additionalProperties": false,
  "required": [
    "fractureGradient_psi_per_ft",
    "mudWeight_ppg",
    "shoeTVD_ft",
    "safetyMargin_ppg"
  ]
}

Inputs: fractureGradient_psi_per_ft, mudWeight_ppg, shoeTVD_ft, safetyMargin_pp…

drill_formationPressureFromKick

unknown

Formation pressure psi: Pf=0.052*MW*TVD+SIDPP. Ref: Bourgoyne.

Entitiescalculation, formation

Input schema

{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {},
    "tvd_ft": {},
    "shutInDrillPipePressure_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg",
    "tvd_ft",
    "shutInDrillPipePressure_psi"
  ]
}

Inputs: mudWeight_ppg, tvd_ft, shutInDrillPipePressure_psi.

econ_ooipVolumetric

unknown

Calculate OOIP; OOIP=7758*A*h*phi*(1-Sw)/Boi. Ref: SPE PRMS.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "area_acres": {},
    "netPay_ft": {},
    "porosity_fraction": {},
    "waterSaturation_fraction": {},
    "oilFormationVolumeFactor_rbPerSTB": {}
  },
  "additionalProperties": false,
  "required": [
    "area_acres",
    "netPay_ft",
    "porosity_fraction",
    "waterSaturation_fraction",
    "oilFormationVolumeFactor_rbPerSTB"
  ]
}

Inputs: area_acres, netPay_ft, porosity_fraction, waterSaturation_fraction, oil…

econ_ogipVolumetric

unknown

Calculate OGIP; OGIP=43560*A*h*phi*(1-Sw)/Bgi. Ref: SPE PRMS.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "area_acres": {},
    "netPay_ft": {},
    "porosity_fraction": {},
    "waterSaturation_fraction": {},
    "gasFormationVolumeFactor_ft3PerMMscf": {}
  },
  "additionalProperties": false,
  "required": [
    "area_acres",
    "netPay_ft",
    "porosity_fraction",
    "waterSaturation_fraction",
    "gasFormationVolumeFactor_ft3PerMMscf"
  ]
}

Inputs: area_acres, netPay_ft, porosity_fraction, waterSaturation_fraction, gas…

econ_recoverableOil

unknown

Calculate recoverable oil; R=OOIP*RF. Ref: SPE PRMS.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "originalOilInPlace_STB": {},
    "recoveryFactor_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "originalOilInPlace_STB",
    "recoveryFactor_fraction"
  ]
}

Inputs: originalOilInPlace_STB, recoveryFactor_fraction.

econ_recoveryFactor

unknown

Calculate recovery factor; RF=recoverable/original. Ref: SPE PRMS.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "recoverableVolume_STB": {},
    "originalVolume_STB": {}
  },
  "additionalProperties": false,
  "required": [
    "recoverableVolume_STB",
    "originalVolume_STB"
  ]
}

Inputs: recoverableVolume_STB, originalVolume_STB.

econ_reservesFromDecline

unknown

Calculate decline reserves; R=EUR-Np using Arps qi,Di,b,qab. Ref: Arps 1945.

Entitiescalculation, production, field

Input schema

{
  "type": "object",
  "properties": {
    "initialRate_STBPerDay": {},
    "nominalDeclineRate_perDay": {},
    "declineExponent": {},
    "abandonmentRate_STBPerDay": {},
    "cumulativeProduction_STB": {}
  },
  "additionalProperties": false,
  "required": [
    "initialRate_STBPerDay",
    "nominalDeclineRate_perDay",
    "declineExponent",
    "abandonmentRate_STBPerDay",
    "cumulativeProduction_STB"
  ]
}

Inputs: initialRate_STBPerDay, nominalDeclineRate_perDay, declineExponent, aban…

econ_drainageVolume

unknown

Calculate drainage volume; V=A*h. Ref: SPE PRMS.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "drainageArea_acres": {},
    "netPay_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "drainageArea_acres",
    "netPay_ft"
  ]
}

Inputs: drainageArea_acres, netPay_ft.

econ_netRockVolume

unknown

Calculate net rock volume; NRV=A*Hgross*NTG. Ref: SPE PRMS.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "area_acres": {},
    "grossThickness_ft": {},
    "netToGross_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "area_acres",
    "grossThickness_ft",
    "netToGross_fraction"
  ]
}

Inputs: area_acres, grossThickness_ft, netToGross_fraction.

econ_presentValue

unknown

Calculate present value; PV=FV/(1+i)^n. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "futureValue_USD": {},
    "discountRate_fraction": {},
    "periods": {}
  },
  "additionalProperties": false,
  "required": [
    "futureValue_USD",
    "discountRate_fraction",
    "periods"
  ]
}

Inputs: futureValue_USD, discountRate_fraction, periods.

econ_futureValue

unknown

Calculate future value; FV=PV*(1+i)^n. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "presentValue_USD": {},
    "discountRate_fraction": {},
    "periods": {}
  },
  "additionalProperties": false,
  "required": [
    "presentValue_USD",
    "discountRate_fraction",
    "periods"
  ]
}

Inputs: presentValue_USD, discountRate_fraction, periods.

econ_npv

unknown

Calculate NPV; NPV=sum(CFt/(1+i)^t). Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "cashflows_USD": {},
    "cashflows": {},
    "discountRate_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "discountRate_fraction"
  ]
}

Inputs: discountRate_fraction.

econ_discountFactor

unknown

Calculate discount factor; DF=1/(1+i)^n. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "discountRate_fraction": {},
    "periods": {}
  },
  "additionalProperties": false,
  "required": [
    "discountRate_fraction",
    "periods"
  ]
}

Inputs: discountRate_fraction, periods.

econ_pvAnnuity

unknown

Calculate PV of annuity; PV=P*(1-(1+i)^-n)/i. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "payment_USD": {},
    "discountRate_fraction": {},
    "periods": {}
  },
  "additionalProperties": false,
  "required": [
    "payment_USD",
    "discountRate_fraction",
    "periods"
  ]
}

Inputs: payment_USD, discountRate_fraction, periods.

econ_irr

unknown

Calculate IRR; sum(CFt/(1+r)^t)=0. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "cashflows_USD": {},
    "cashflows": {},
    "guess_fraction": {},
    "tolerance": {},
    "maxIterations": {}
  },
  "additionalProperties": false
}

Inputs: guess_fraction?, tolerance?, maxIterations?.

econ_paybackPeriod
unknown
Calculate payback period; cumulative CF reaches zero. Ref: standard DCF.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "cashflows_USD": {},
    "cashflows": {}
  },
  "additionalProperties": false
}
```

econ_discountedPayback

unknown

Calculate discounted payback; cum discounted CF reaches zero. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "cashflows_USD": {},
    "cashflows": {},
    "discountRate_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "discountRate_fraction"
  ]
}

Inputs: discountRate_fraction.

econ_profitabilityIndex

unknown

Calculate profitability index; PI=PV future CF/investment. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "cashflows_USD": {},
    "cashflows": {},
    "discountRate_fraction": {},
    "initialInvestment_USD": {}
  },
  "additionalProperties": false,
  "required": [
    "discountRate_fraction"
  ]
}

Inputs: discountRate_fraction, initialInvestment_USD?.

econ_growthRateOfReturn

unknown

Calculate CAGR; g=(ending/beginning)^(1/n)-1. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "beginningValue_USD": {},
    "endingValue_USD": {},
    "periods": {}
  },
  "additionalProperties": false,
  "required": [
    "beginningValue_USD",
    "endingValue_USD",
    "periods"
  ]
}

Inputs: beginningValue_USD, endingValue_USD, periods.

econ_grossRevenue

unknown

Calculate gross revenue; GR=q*price. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "salesRate_bblPerDay": {},
    "price_USDPerBbl": {}
  },
  "additionalProperties": false,
  "required": [
    "salesRate_bblPerDay",
    "price_USDPerBbl"
  ]
}

Inputs: salesRate_bblPerDay, price_USDPerBbl.

econ_netRevenueInterest

unknown

Calculate NRI; NRI=WI*(1-royalty). Ref: standard DCF.

Entitiescalculation, ownership

Input schema

{
  "type": "object",
  "properties": {
    "workingInterest_fraction": {},
    "royalty_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "workingInterest_fraction",
    "royalty_fraction"
  ]
}

Inputs: workingInterest_fraction, royalty_fraction.

econ_workingInterestRevenue

unknown

Calculate WI revenue; WIR=grossRevenue*WI. Ref: standard DCF.

Entitiescalculation, ownership

Input schema

{
  "type": "object",
  "properties": {
    "grossRevenue_USD": {},
    "workingInterest_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "grossRevenue_USD",
    "workingInterest_fraction"
  ]
}

Inputs: grossRevenue_USD, workingInterest_fraction.

econ_royaltyValue

unknown

Calculate royalty value; royalty=grossRevenue*royaltyRate. Ref: standard DCF.

Entitiescalculation, production, ownership

Input schema

{
  "type": "object",
  "properties": {
    "grossRevenue_USD": {},
    "royalty_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "grossRevenue_USD",
    "royalty_fraction"
  ]
}

Inputs: grossRevenue_USD, royalty_fraction.

econ_netRevenue

unknown

Calculate net revenue; NR=grossRevenue*NRI. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "grossRevenue_USD": {},
    "netRevenueInterest_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "grossRevenue_USD",
    "netRevenueInterest_fraction"
  ]
}

Inputs: grossRevenue_USD, netRevenueInterest_fraction.

econ_severanceTax

unknown

Calculate severance tax; tax=taxableRevenue*taxRate. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "taxableRevenue_USD": {},
    "taxRate_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "taxableRevenue_USD",
    "taxRate_fraction"
  ]
}

Inputs: taxableRevenue_USD, taxRate_fraction.

econ_operatingCashFlow

unknown

Calculate operating cash flow; OCF=NR-opex-tax. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "netRevenue_USD": {},
    "operatingExpense_USD": {},
    "tax_USD": {}
  },
  "additionalProperties": false,
  "required": [
    "netRevenue_USD",
    "operatingExpense_USD",
    "tax_USD"
  ]
}

Inputs: netRevenue_USD, operatingExpense_USD, tax_USD.

econ_netCashFlow

unknown

Calculate net cash flow; NCF=rev-opex-capex-tax. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "revenue_USD": {},
    "operatingExpense_USD": {},
    "capitalExpense_USD": {},
    "tax_USD": {}
  },
  "additionalProperties": false,
  "required": [
    "revenue_USD",
    "operatingExpense_USD",
    "capitalExpense_USD",
    "tax_USD"
  ]
}

Inputs: revenue_USD, operatingExpense_USD, capitalExpense_USD, tax_USD.

econ_breakevenPrice

unknown

Calculate breakeven price; P=cost/(volume*NRI). Ref: standard DCF.

Entitiescalculation, commodity

Input schema

{
  "type": "object",
  "properties": {
    "totalCost_USD": {},
    "salesVolume_bbl": {},
    "netRevenueInterest_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "totalCost_USD",
    "salesVolume_bbl",
    "netRevenueInterest_fraction"
  ]
}

Inputs: totalCost_USD, salesVolume_bbl, netRevenueInterest_fraction.

econ_breakevenVolume

unknown

Calculate breakeven volume; V=cost/(price*NRI). Ref: standard DCF.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "totalCost_USD": {},
    "price_USDPerBbl": {},
    "netRevenueInterest_fraction": {}
  },
  "additionalProperties": false,
  "required": [
    "totalCost_USD",
    "price_USDPerBbl",
    "netRevenueInterest_fraction"
  ]
}

Inputs: totalCost_USD, price_USDPerBbl, netRevenueInterest_fraction.

econ_unitTechnicalCost

unknown

Calculate unit technical cost; UTC=(capex+opex+abex)/volume. Ref: SPE PRMS.

Entitiescalculation, unit, lease

Input schema

{
  "type": "object",
  "properties": {
    "capitalCost_USD": {},
    "operatingCost_USD": {},
    "abandonmentCost_USD": {},
    "recoverableVolume_STB": {}
  },
  "additionalProperties": false,
  "required": [
    "capitalCost_USD",
    "operatingCost_USD",
    "recoverableVolume_STB"
  ]
}

Inputs: capitalCost_USD, operatingCost_USD, abandonmentCost_USD?, recoverableVo…

econ_returnOnInvestment

unknown

Calculate ROI; ROI=netProfit/investment. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "netProfit_USD": {},
    "investment_USD": {}
  },
  "additionalProperties": false,
  "required": [
    "netProfit_USD",
    "investment_USD"
  ]
}

Inputs: netProfit_USD, investment_USD.

econ_capitalEfficiency

unknown

Calculate capital efficiency; CE=NPV/capex. Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "npv_USD": {},
    "capex_USD": {}
  },
  "additionalProperties": false,
  "required": [
    "npv_USD",
    "capex_USD"
  ]
}

Inputs: npv_USD, capex_USD.

econ_findingDevelopmentCost

unknown

Calculate F&D cost; FDC=cost/reservesAdded. Ref: SPE PRMS.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "findingDevelopmentCost_USD": {},
    "reservesAdded_STB": {}
  },
  "additionalProperties": false,
  "required": [
    "findingDevelopmentCost_USD",
    "reservesAdded_STB"
  ]
}

Inputs: findingDevelopmentCost_USD, reservesAdded_STB.

econ_economicLimitRate

unknown

Calculate economic limit rate; q=opex/(price*NRI*conv). Ref: standard DCF.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "operatingExpense_USDPerDay": {},
    "price_USDPerBbl": {},
    "netRevenueInterest_fraction": {},
    "conversion_factor": {}
  },
  "additionalProperties": false,
  "required": [
    "operatingExpense_USDPerDay",
    "price_USDPerBbl",
    "netRevenueInterest_fraction",
    "conversion_factor"
  ]
}

Inputs: operatingExpense_USDPerDay, price_USDPerBbl, netRevenueInterest_fractio…

geo_overburdenGradient
unknown
Integrate density to OBG; OBG=sum(rho/144 dz)/sum(dz); Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_overburdenStress
unknown
Convert OBG to overburden stress; Sv=OBG*z; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_verticalStressFromDensityLog
unknown
Integrate density log to vertical stress; Sv=sum(rho/144 dz); Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_porePressureEatonResistivity
unknown
Eaton resistivity PP; PPg=OBG-(OBG-Pn)(Robs/Rn)^1.2; Ref: Eaton 1975.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_porePressureEatonSonic
unknown
Eaton sonic PP; PPg=OBG-(OBG-Pn)(DTn/DTo)^3; Ref: Eaton 1975.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_porePressureBowers
unknown
Bowers PP from velocity; Pp=Sv-((Vp-V0)/A)^(1/B); Ref: Bowers 1995.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_normalPorePressure
unknown
Normal hydrostatic PP; Pn=rho_fluid*z/144; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_fractureGradientEaton
unknown
Eaton fracture gradient; FG=nu/(1-nu)(OBG-PP)+PP; Ref: Eaton 1975.
Entitiescalculation, frac_job, completion
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_fractureGradientMatthewsKelly
unknown
Matthews-Kelly FG; FG=Ki(OBG-PP)+PP; Ref: Matthews-Kelly 1967.
Entitiescalculation, frac_job, completion
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_fractureGradientHubbertWillis
unknown
Hubbert-Willis FG; FG=(OBG-PP)/3+PP; Ref: Hubbert-Willis 1957.
Entitiescalculation, frac_job, completion
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_fractureGradientDaines
unknown
Daines fracture gradient; FG=nu/(1-nu)(OBG-aPP)+aPP+T; Ref: Daines.
Entitiescalculation, frac_job, completion
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_leakOffPressure
unknown
Leak-off pressure from FG; P=FG*z; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_effectiveStress
unknown
Terzaghi effective stress; sigma_eff=sigma-alpha Pp; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_biotCoefficient
unknown
Biot coefficient; alpha=1-Kdry/Kgrain; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_sonicVelocityFromSlowness
unknown
Convert sonic slowness to velocity; V=1e6/DT; Ref: log unit definition.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_dynamicYoungsModulus
unknown
Dynamic Young modulus; E=2G(1+nu); Ref: Zoback log mechanics.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_dynamicPoissonsRatio
unknown
Dynamic Poisson ratio; nu=(R^2-2)/(2(R^2-1)); Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_shearModulus
unknown
Dynamic shear modulus; G=C rho Vs^2; Ref: Zoback log mechanics.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_bulkModulus
unknown
Dynamic bulk modulus; K=C rho(Vp^2-4Vs^2/3); Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_compressibilityFromModulus
unknown
Compressibility from modulus; c=1/M; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_vpvsRatio
unknown
Velocity ratio; R=Vp/Vs; Ref: sonic log unit definition.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_pWaveModulus
unknown
P-wave modulus; M=C rho Vp^2; Ref: Zoback log mechanics.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_staticFromDynamicModulus
unknown
Static modulus correlation; Est=a Edyn+b; Ref: Zoback empirical.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_ucsFromSonic
unknown
Empirical UCS from sonic; UCS=f(Vp or DT); Ref: Horsrud/McNally/Freyburg.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_frictionAngleFromUCS
unknown
Friction angle from UCS; phi=a+b log10(UCS/1000); Ref: Zoback empirical.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_mohrCoulombShearStrength
unknown
Mohr-Coulomb shear strength; tau=c+sigma_n tan(phi); Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_principalStressAtFailure
unknown
Principal failure stress; sigma1=UCS+q sigma3; Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_minimumHorizontalStress
unknown
Minimum horizontal stress; Sh=nu/(1-nu)(Sv-aPp)+aPp+T; Ref: Zoback.
Entitiescalculation, formation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_breakdownPressure
unknown
Breakdown pressure; Pb=3Shmin-SHmax-aPp+T0; Ref: Hubbert-Willis.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_collapsePressure
unknown
Collapse pressure; Pw=(3SH-Sh-UCS+aPp(q-1))/(1+q); Ref: Zoback.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_horizontalStressPoroelastic
unknown
Poroelastic horizontal stresses; Sh=base+E strain/(1-nu^2); Ref: Zoback.
Entitiescalculation, formation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```
geo_stressPolygonBounds
unknown
Stress polygon bounds; S1e/S3e<=Q(mu); Ref: Zoback Reservoir Geomechanics.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {},
  "additionalProperties": true
}
```

tub_barlowBurstPressure

unknown

Barlow burst pressure, Pb = 2*Yp*t*f/D. Ref API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "t_in": {},
    "Yp_psi": {},
    "wallFactor": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "t_in",
    "Yp_psi"
  ]
}

Inputs: od_in, t_in, Yp_psi, wallFactor?.

tub_internalYieldPressure

unknown

Internal yield pressure, Piy = 2*Yp*t*f/D. Ref API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "t_in": {},
    "Yp_psi": {},
    "wallFactor": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "t_in",
    "Yp_psi"
  ]
}

Inputs: od_in, t_in, Yp_psi, wallFactor?.

tub_burstSafetyFactor

unknown

Burst safety factor, SF = Pb/Papplied. Ref Bourgoyne/API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "burstPressure_psi": {},
    "appliedPressure_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "burstPressure_psi",
    "appliedPressure_psi"
  ]
}

Inputs: burstPressure_psi, appliedPressure_psi.

tub_collapsePressureYield

unknown

Yield collapse pressure, Pyp = 2*Yp*(D/t-1)/(D/t)^2. Ref API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "t_in": {},
    "Yp_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "t_in",
    "Yp_psi"
  ]
}

Inputs: od_in, t_in, Yp_psi.

tub_collapsePlasticElastic

unknown

Collapse selector, Pc = API 5C3 four-regime D/t model. Ref API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "t_in": {},
    "Yp_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "t_in",
    "Yp_psi"
  ]
}

Inputs: od_in, t_in, Yp_psi.

tub_collapseSafetyFactor

unknown

Collapse safety factor, SF = Pc/Papplied. Ref Bourgoyne/API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "collapsePressure_psi": {},
    "appliedPressure_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "collapsePressure_psi",
    "appliedPressure_psi"
  ]
}

Inputs: collapsePressure_psi, appliedPressure_psi.

tub_pipeBodyYieldStrength

unknown

Pipe body yield strength, T = Yp*A. Ref API 5C3/Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "id_in": {},
    "Yp_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "id_in",
    "Yp_psi"
  ]
}

Inputs: od_in, id_in, Yp_psi.

tub_jointStrength

unknown

Approx joint strength, Tj = efficiency*Yp*A. Ref API 5C2.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "id_in": {},
    "Yp_psi": {},
    "jointEfficiency": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "id_in",
    "Yp_psi"
  ]
}

Inputs: od_in, id_in, Yp_psi, jointEfficiency?.

tub_tensionSafetyFactor

unknown

Tension safety factor, SF = Trating/Fapplied. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "tensileRating_lbf": {},
    "appliedLoad_lbf": {}
  },
  "additionalProperties": false,
  "required": [
    "tensileRating_lbf",
    "appliedLoad_lbf"
  ]
}

Inputs: tensileRating_lbf, appliedLoad_lbf.

tub_axialStressFromLoad

unknown

Axial stress from load, Sa = F/A. Ref Bourgoyne/API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "load_lbf": {},
    "area_in2": {}
  },
  "additionalProperties": false,
  "required": [
    "load_lbf",
    "area_in2"
  ]
}

Inputs: load_lbf, area_in2.

tub_pipeCrossSectionalArea

unknown

Pipe steel area, A = pi/4*(OD^2-ID^2). Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "id_in": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "id_in"
  ]
}

Inputs: od_in, id_in.

tub_pipeWeightPerFoot

unknown

Pipe air weight, W = A/144*rhoSteel. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "id_in": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "id_in"
  ]
}

Inputs: od_in, id_in.

tub_buoyantWeight

unknown

Buoyant pipe weight, Wb = Wair*(1-MW/65.4). Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "weight_lb_per_ft": {},
    "mudWeight_ppg": {}
  },
  "additionalProperties": false,
  "required": [
    "weight_lb_per_ft",
    "mudWeight_ppg"
  ]
}

Inputs: weight_lb_per_ft, mudWeight_ppg.

tub_buoyancyFactor

unknown

Buoyancy factor, BF = 1-MW/65.4. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "mudWeight_ppg": {}
  },
  "additionalProperties": false,
  "required": [
    "mudWeight_ppg"
  ]
}

Inputs: mudWeight_ppg.

tub_airWeightOfString

unknown

Air string weight, W = w*L. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "weight_lb_per_ft": {},
    "length_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "weight_lb_per_ft",
    "length_ft"
  ]
}

Inputs: weight_lb_per_ft, length_ft.

tub_hookLoad

unknown

Hook load, H = w*L*(1-MW/65.4)+overpull. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "weight_lb_per_ft": {},
    "length_ft": {},
    "mudWeight_ppg": {},
    "overpull_lbf": {}
  },
  "additionalProperties": false,
  "required": [
    "weight_lb_per_ft",
    "length_ft",
    "mudWeight_ppg"
  ]
}

Inputs: weight_lb_per_ft, length_ft, mudWeight_ppg, overpull_lbf?.

tub_pipeCapacity

unknown

Pipe capacity, C = pi/4*ID^2*12/9702. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "id_in": {}
  },
  "additionalProperties": false,
  "required": [
    "id_in"
  ]
}

Inputs: id_in.

tub_pipeDisplacement

unknown

Pipe displacement, V = pi/4*(OD^2-ID^2)*12. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "id_in": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "id_in"
  ]
}

Inputs: od_in, id_in.

tub_annularCapacityBetweenStrings

unknown

Annular capacity, C = pi/4*(outerID^2-innerOD^2)*12/9702. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "outerId_in": {},
    "innerOd_in": {}
  },
  "additionalProperties": false,
  "required": [
    "outerId_in",
    "innerOd_in"
  ]
}

Inputs: outerId_in, innerOd_in.

tub_internalVolume

unknown

Internal volume, V = capacity*L. Ref Bourgoyne.

Entitiescalculation, production

Input schema

{
  "type": "object",
  "properties": {
    "id_in": {},
    "length_ft": {}
  },
  "additionalProperties": false,
  "required": [
    "id_in",
    "length_ft"
  ]
}

Inputs: id_in, length_ft.

tub_pipeStretchHookesLaw

unknown

Hooke stretch, e = F*L/(A*E). Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "load_lbf": {},
    "length_ft": {},
    "area_in2": {},
    "E_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "load_lbf",
    "length_ft",
    "area_in2"
  ]
}

Inputs: load_lbf, length_ft, area_in2, E_psi?.

tub_stretchDueToWeight

unknown

Stretch due to weight, e = w*BF*L*(12L)/(2AE). Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "weight_lb_per_ft": {},
    "length_ft": {},
    "area_in2": {},
    "buoyancyFactor": {},
    "E_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "weight_lb_per_ft",
    "length_ft",
    "area_in2"
  ]
}

Inputs: weight_lb_per_ft, length_ft, area_in2, buoyancyFactor?, E_psi?.

tub_thermalElongation

unknown

Thermal elongation, dL = alpha*dT*L. Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "length_ft": {},
    "temperatureChange_F": {},
    "coefficient_per_F": {}
  },
  "additionalProperties": false,
  "required": [
    "length_ft",
    "temperatureChange_F"
  ]
}

Inputs: length_ft, temperatureChange_F, coefficient_per_F?.

tub_ballooningStretch

unknown

Ballooning stretch, e = -2*nu*L*(dPi*Ai-dPo*Ao)/(E*As). Ref Bourgoyne.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "od_in": {},
    "id_in": {},
    "length_ft": {},
    "internalPressureChange_psi": {},
    "externalPressureChange_psi": {},
    "E_psi": {},
    "poissonRatio": {}
  },
  "additionalProperties": false,
  "required": [
    "od_in",
    "id_in",
    "length_ft",
    "internalPressureChange_psi"
  ]
}

Inputs: od_in, id_in, length_ft, internalPressureChange_psi, externalPressureCh…

tub_driftDiameter

unknown

Drift diameter, Ddrift = ID-allowance. Ref API 5C2.

Entitiescalculation, facility

Input schema

{
  "type": "object",
  "properties": {
    "id_in": {},
    "driftAllowance_in": {}
  },
  "additionalProperties": false,
  "required": [
    "id_in"
  ]
}

Inputs: id_in, driftAllowance_in?.

tub_makeupTorque

unknown

Approx makeup torque, T = K*F*D/12. Ref API 5C2.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "axialPreload_lbf": {},
    "diameter_in": {},
    "torqueFactor": {}
  },
  "additionalProperties": false,
  "required": [
    "axialPreload_lbf",
    "diameter_in"
  ]
}

Inputs: axialPreload_lbf, diameter_in, torqueFactor?.

tub_vonMisesEquivalentStress

unknown

Von Mises triaxial stress, seq = sqrt(J2 form). Ref API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "axialStress_psi": {},
    "hoopStress_psi": {},
    "radialStress_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "axialStress_psi",
    "hoopStress_psi",
    "radialStress_psi"
  ]
}

Inputs: axialStress_psi, hoopStress_psi, radialStress_psi.

tub_biaxialCollapseDerating

unknown

Biaxial collapse derating, Ypa = Yp*(sqrt(1-.75*r^2)-.5*r). Ref API 5C3.

Entitiescalculation

Input schema

{
  "type": "object",
  "properties": {
    "Yp_psi": {},
    "axialStress_psi": {},
    "internalPressure_psi": {}
  },
  "additionalProperties": false,
  "required": [
    "Yp_psi",
    "axialStress_psi"
  ]
}

Inputs: Yp_psi, axialStress_psi, internalPressure_psi?.

tub_minYieldFromGrade
unknown
Minimum yield from OCTG grade lookup, Yp = table[grade]. Ref API 5CT/5C3.
Entitiescalculation
Input schema
```
{
  "type": "object",
  "properties": {
    "grade": {}
  },
  "additionalProperties": false,
  "required": [
    "grade"
  ]
}
```
Inputs: grade.