What you can ask
- “What does Petroleum Calcs have for the area or asset I'm working on?”
- “Pull the most recent Petroleum Calcs records and put them in a table.”
- “What does Petroleum Calcs cover, and how fresh is the data?”
About this source
Petroleum-engineering calculations, pure compute, no data source, no auth. Deterministic correlations in field units (Rs scf/STB, pressure psia, temp °F, API °API). Pairs with production/well data connectors (rrc, enverus, welldatabase) to turn raw data into engineering answers. 570 methods across: PVT, fluid properties, EOS, DCA and leakage-safe forecasting (Arps + SEDM/PLE/LGM/Duong), IPR, VFP multiphase lift, material balance, well-test/PTA, SCAL, hydraulic fracturing, surface facilities, flow assurance, artificial lift (ESP/rod/gas-lift), petrophysics/log analysis, drilling hydraulics, wellbore trajectory (minimum curvature, dogleg, closure, GeoJSON, ISCWSA uncertainty, anti-collision), geomechanics/pore pressure, reserves and economics, tubular design, and ~100 unit conversions.
Connector ID petroleum-calcs
Provenance
Freshness & coverage
› Methods (570)
Technical detail for developers: parameters, pagination, units, and freshness per method.
pvt_bubblePoint
unknownOil bubble-point pressure (Standing or Vasquez-Beggs).
EntitiescalculationInputs: Rs, gasGravity, apiGravity, tempF, correlation. -> pb_psia.
pvt_solutionGOR
unknownSolution GOR Rs at pressure (Standing or Vasquez-Beggs).
EntitiescalculationInputs: P, gasGravity, apiGravity, tempF, correlation. -> rs_scf_stb.
pvt_oilFVF
unknownSaturated oil FVF Bo (Standing or Vasquez-Beggs).
EntitiescalculationInputs: Rs, gasGravity, apiGravity, tempF, correlation. -> bo_rb_stb.
pvt_deadOilViscosity
unknownDead-oil viscosity, Beggs-Robinson (1975), cp.
EntitiescalculationInputs: apiGravity, tempF. Returns mu_od_cp.
pvt_oilViscosity
unknownLive oil viscosity (Beggs-Robinson; undersaturated via Vasquez).
EntitiescalculationInputs: Rs, apiGravity, tempF; pressure+bubblePoint together for P>Pb.
pvt_gasPseudoCriticals
unknownGas pseudo-criticals Ppc/Tpc from gravity, Sutton (1985).
EntitiescalculationInputs: gasGravity. Returns ppc_psia, tpc_R.
pvt_gasZ
unknownGas Z-factor, Dranchuk-Abou-Kassem (1975) + Sutton criticals.
EntitiescalculationInputs: P, tempF, gasGravity. Returns z.
pvt_gasFVF
unknownGas formation volume factor Bg (rcf/scf) from DAK Z.
EntitiescalculationInputs: P, tempF, gasGravity. Returns bg_rcf_scf.
pvt_gasViscosity
unknownGas viscosity, Lee-Gonzalez-Eakin (1966), cp.
EntitiescalculationInputs: P, tempF, gasGravity. Returns mu_g_cp.
dca_arpsRate
unknownArps (1945) decline rate q(t): exponential/hyperbolic/harmonic.
EntitiescalculationInputs: qi, Di (nominal, per t unit), b (0..2), t. b=0 exp, b=1 harmonic.
dca_arpsCum
unknownArps (1945) cumulative production Np(t).
EntitiescalculationInputs: qi, Di (nominal, per t unit), b (0..2), t. Returns np.
dca_arpsEUR
unknownArps EUR to an economic-limit rate qLimit.
EntitiescalculationInputs: qi, Di, b, qLimit. Returns eur.
dca_arpsFit
unknownFit Arps qi/Di/b to rate-time data by least squares.
EntitiescalculationInputs: t[], q[] (>=3 pts). Returns qi, Di, b, rmse, r2.
dca_modHypRate
unknownModified-hyperbolic (Robertson) rate with terminal exponential.
EntitiescalculationInputs: qi, Di, b, Dlim (<Di), t. Returns q, segment, tLim.
dca_modHypEUR
unknownModified-hyperbolic EUR to an economic-limit rate qLimit.
EntitiescalculationInputs: qi, Di, b, Dlim, qLimit. Returns eur.
dca_duongRate
unknownDuong (2011) rate for fracture-dominated shale decline.
EntitiescalculationInputs: q1, a, m, t. Returns q.
dca_forecastScore
unknownScore production forecasts with MAE, RMSE, MAPE, sMAPE, bias, cumulative error, and SPEE.
Required paramsactualforecastEntitiescalculation, productionNull means unreported, never zero. Cumulative metrics use aligned pairs only.
dca_probabilisticScore
unknownScore production quantiles: pinball loss, calibration, interval coverage, and crossings.
Required paramsactualquantilesEntitiescalculationQuantiles are in (0,1); forecast arrays align with actual. Null means missing.
dca_hindcastBenchmark
unknownFit DCA models before a cutoff, score the holdout without leakage, and rank them.
Required paramstqcutoffhorizonEntitiescalculationSix models; missing rates stay null and skipped or failed runs include reasons.
dca_forecastConsequences
unknownConsequences of an asserted Arps decline: next-12/24 vs trailing, EUR, terminal switch.
Required paramsanchorMonthEntitiescalculation, productiondi is NOMINAL MONTHLY. Assert oil and/or gas. No history = not yet producing.
pvt_water_fvf_mccain
unknownWater formation volume factor Bw (McCain 1990).
EntitiescalculationInputs: p, T.
pvt_water_rsw_mccain
unknownSolution gas-water ratio Rsw (McCain 1990), scf/bbl.
EntitiescalculationInputs: p, T, salinity_wt?.
pvt_water_compressibility_undersaturated_mccain
unknownWater isothermal compressibility - gas-free (undersaturated) (Osif/McCain), 1/psi.
EntitiescalculationInputs: p, T, salinity_gL? (g/L NaCl) or salinity_mgL?.
pvt_water_compressibility_saturated_mccain
unknownWater isothermal compressibility - gas-saturated (McCain 1990), 1/psi.
EntitiescalculationInputs: cw_gasfree, Rsw.
pvt_water_viscosity_mccain
unknownBrine (water) viscosity (McCain 1990), cp.
EntitiescalculationInputs: p, T, salinity_wt?.
pvt_water_density_mccain
unknownBrine density at reservoir conditions (McCain 1990), lb/ft³.
EntitiescalculationInputs: salinity_wt, Bw.
pvt_ift_gas_oil_baker_swerdloff
unknownGas-oil interfacial tension at pressure (Baker & Swerdloff, 1956), dynes/cm.
EntitiescalculationInputs: API, T, p.
pvt_ift_gas_oil_abdul_majeed
unknownGas-oil interfacial tension (Abdul-Majeed & Abu Al-Soof, 2000), dynes/cm.
EntitiescalculationInputs: API, T, Rs.
pvt_wichert_aziz_correction
unknownWichert-Aziz (1972) non-hydrocarbon (H2S/CO2) correction to pseudo-criticals.
EntitiescalculationInputs: Tpc, Ppc, yCO2?, yH2S?.
pvt_bubble_point_glaso
unknownGlaso (1980) bubble-point pressure, psia.
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_bubble_point_al_marhoun
unknownAl-Marhoun (1988) bubble-point pressure, psia (Saudi/Middle-East crudes).
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_bubble_point_petrosky_farshad
unknownPetrosky-Farshad (1993) bubble-point pressure, psia (Gulf of Mexico).
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_solution_gor_glaso
unknownGlaso (1980) solution GOR Rs at p ≤ Pb, scf/STB (inverse of the Pb form).
EntitiescalculationInputs: p, gas_sg, API, T.
pvt_oil_fvf_glaso
unknownGlaso (1980) oil formation volume factor Bo at/below Pb, rb/STB.
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_oil_fvf_al_marhoun
unknownAl-Marhoun (1988) oil formation volume factor Bo, rb/STB.
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_oil_fvf_petrosky_farshad
unknownPetrosky-Farshad (1993) oil formation volume factor Bo, rb/STB (GOM).
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_bubble_point_dindoruk_christman
unknownDindoruk-Christman (2004) bubble-point pressure, psia (GOM crudes).
EntitiescalculationInputs: Rs, gas_sg, API, T.
pvt_oil_compressibility_undersaturated_vasquez_beggs
unknownUndersaturated oil isothermal compressibility (Vasquez-Beggs, 1980), 1/psi.
EntitiescalculationInputs: Rsb, T, gas_sg, API, p.
pvt_oil_compressibility_saturated_villena_lanzi
unknownSaturated (below-Pb) oil isothermal compressibility.
EntitiescalculationInputs: p, T, API, Rsb.
pvt_dead_oil_viscosity_glaso
unknownGlaso (1980) dead-oil viscosity, cp.
EntitiescalculationInputs: API, T.
pvt_dead_oil_viscosity_egbogah
unknownEgbogah-Jack (1990) dead-oil viscosity, cp (Egbogah-Ng modified Beggs-Robinson).
EntitiescalculationInputs: API, T.
mbe_pz
unknownGas material balance p/z plotting variable for reservoir depletion analysis. [Craft & Hawkins Ch.6]
EntitiescalculationInputs: p, z.
mbe_ogip_from_pz
unknownOGIP from p/z material balance: G = Gp/(1 - (p/z)/(p_i/z_i)). [Craft & Hawkins Ch.6]
EntitiescalculationInputs: p_i, z_i, p, z, Gp.
mbe_pz_geopressured
unknownModified p/z for geopressured gas (Ramagost & Farshad, SPE 10125).
EntitiescalculationInputs: p, z, p_i, c_w, c_f, S_wi.
mbe_gas_Gp_at_pressure
unknownPredict Gp at pressure (volumetric gas): Gp = G*(1 - (p/z)/(p_i/z_i)).
EntitiescalculationInputs: G, p_i, z_i, p, z.
mbe_gas_pressure_at_Gp
unknownPredict pressure at Gp (volumetric gas): p/z = (p_i/z_i)*(1 - Gp/G).
EntitiescalculationInputs: G, p_i, z_i, Gp, z?.
mbe_gas_recovery_factor
unknownUltimate gas recovery factor at abandonment: RF = 1 - (p_a/z_a)/(p_i/z_i).
EntitiescalculationInputs: p_i, z_i, p_a, z_a.
mbe_Bt
unknownTwo-phase FVF Bt = Bo + (Rs_i - Rs)*Bg.
EntitiescalculationInputs: Bo, Bg, Rs_i, Rs.
mbe_withdrawal_F
unknownUnderground withdrawal F (Havlena-Odeh): F = Np*[Bo+(Rp-Rs)*Bg]+Wp*Bw, Rp=Gp/Np.
EntitiescalculationInputs: Np, Gp, Bo, Bg, Rs, Wp?, Bw?.
mbe_Eo
unknownOil + dissolved-gas expansion Eo = (Bo-Bo_i)+(Rs_i-Rs)*Bg.
EntitiescalculationInputs: Bo, Bo_i, Bg, Rs_i, Rs.
mbe_Eg
unknownGas-cap expansion Eg = Bt_i*(Bg/Bg_i - 1).
EntitiescalculationInputs: Bt_i, Bg, Bg_i.
mbe_Efw
unknownMaterial balance formation and connate water expansion term Efw (MBE).
EntitiescalculationInputs: m, Bt_i, c_w, c_f, S_wi, p_i, p.
mbe_co_undersaturated
unknownUndersaturated oil compressibility: c_o = -(Bo-Bo_i)/(Bo_i*(p-p_i)).
EntitiescalculationInputs: Bo_i, Bo, p_i, p.
mbe_cg
unknownReal-gas compressibility: c_g = 1/p - (1/z)*(dz/dp) (or 1/p ideal).
EntitiescalculationInputs: p, z?, dz_dp?.
mbe_ct_total
unknownTotal system compressibility: c_t = c_o*S_o + c_w*S_w + c_g*S_g + c_f.
EntitiescalculationInputs: c_o, S_o, c_w, S_w, c_g?, S_g?, c_f.
mbe_ce_undersaturated
unknownEffective undersaturated-oil compressibility: c_e = (c_o*S_o+c_w*S_wi+c_f)/(1-S_wi).
EntitiescalculationInputs: c_o, S_o, c_w, S_wi, c_f.
mbe_fetkovich_J_radial
unknownFetkovich radial J = 0.00708*k*h*f/(mu_w*(ln(r_aR)-0.75)).
EntitiescalculationInputs: k, h, mu_w, r_aR, f?.
mbe_fetkovich_J_linear
unknownFetkovich linear aquifer J: 0.001127*k*w*h/(mu_w*L); boundary no-flow uses 0.003381.
EntitiescalculationInputs: k, w, h, mu_w, L, boundary? (constant-pressure default | no-flow).
mbe_fetkovich_Wei
unknownFetkovich max encroachable water Wei = c_t*W_i*p_i.
EntitiescalculationInputs: c_t, W_i, p_i.
mbe_fetkovich_Wi_radial
unknownFetkovich initial aquifer water volume (radial): W_i = (pi/5.615)*(r_a^2-r_o^2)*h*phi*f.
EntitiescalculationInputs: r_a, r_o, h, phi, f?.
mbe_fetkovich_avg_pressure
unknownFetkovich average aquifer pressure: p_aq = p_i*(1 - We/Wei).
EntitiescalculationInputs: p_i, We, Wei.
mbe_fetkovich_influx_step
unknownFetkovich incremental influx step: dWe = (Wei/p_i)*(p_a_prev - p_R)*[1-exp(-J*p_i*dt/Wei)].
EntitiescalculationInputs: Wei, p_i, p_a_prev, p_R, J, dt, We_prev?.
mbe_schilthuis_rate
unknownSchilthuis steady-state rate: q_w = C*(p_i - p).
EntitiescalculationInputs: C, p_i, p.
mbe_schilthuis_We
unknownSchilthuis cumulative influx: We = C*Σ(p_i - p_j)*dt_j.
EntitiescalculationInputs: C, p_i, pressures, dt.
mbe_veh_dimensionless
unknownvan Everdingen-Hurst dimensionless r_D, t_D (t in days), aquifer constant U.
EntitiescalculationInputs: r_a, r_o, k, t, phi, mu_w, c_t, h, f?.
mbe_veh_We
unknownvEH water influx (single Δp step): We = U*Δp*Q(t_D).
EntitiescalculationInputs: U, dp, Q_tD.
mbe_pot_aquifer
unknownPot aquifer: pore volume W_aq and instantaneous influx We = (c_w+c_f)*W_aq*(p_i-p).
EntitiescalculationInputs: r_a, r_o, h, phi, c_w, c_f, p_i, p, f?.
pvt_gasZ_sour
unknownGas Z and Bg for sour gas: Sutton pseudo-criticals, Wichert-Aziz correction, DAK.
EntitiescalculationInputs: P, tempF, gasGravity, yCO2?, yH2S?. Equals pvt_gasZ when sweet.
pvt_blackOilTable
unknownBlack-oil PVT table over a pressure sweep: Rs, Bo, Bg, Z, Bw, viscosities per pressure.
Required paramsapiGravitygasGravitytempFpbEntitiescalculationpb sets the phase switch; Rsb follows the correlation at pb. Sweep 14.7..1.5*pb.
mbe_havlenaOdehFit
unknownHavlena-Odeh straight line from pressure surveys: N, residuals, optional pot-aquifer fit.
Required paramsp_isurveysEntitiescalculationSurveys: p, Np, Gp; PVT per survey or a fluid. fitAquifer solves N and we_mult.
mbe_campbellPlot
unknownCampbell plot from pressure surveys: F/Etot vs Np; flat = closed tank at N, rising = influx.
Required paramsp_isurveysEntitiescalculationSame inputs as mbe_havlenaOdehFit; reports the trend and a diagnosis.
mbe_colePlot
unknownCole plot for dry gas: Gp*Bg/(Bg-Bgi) vs Gp; flat = volumetric at G, rising = water drive.
Required paramsp_isurveysEntitiescalculationSurveys need p, Gp; z per survey or gasGravity+tempF (+yCO2/yH2S) to compute Z.
scal_brooksCoreyPc
unknownBrooks-Corey capillary pressure from water saturation (drainage).
EntitiescalculationInputs: Sw, Swi, Pd, lambda.
scal_brooksCoreySw
unknownBrooks-Corey water saturation from capillary pressure (inverse).
EntitiescalculationInputs: Pc, Swi, Pd, lambda.
scal_vanGenuchtenPc
unknownvan Genuchten capillary pressure from water saturation.
EntitiescalculationInputs: Sw, Swr, alpha, n, m?.
scal_vanGenuchtenSw
unknownvan Genuchten water saturation from capillary pressure (inverse).
EntitiescalculationInputs: Pc, Swr, alpha, n, m?.
scal_leverettJ
unknownLeverett J-function from capillary pressure.
EntitiescalculationInputs: Pc, sigma, theta, k, phi, constant?.
scal_leverettPc
unknownCapillary pressure from Leverett J-function (inverse).
EntitiescalculationInputs: J, sigma, theta, k, phi, constant?.
scal_normalizedWaterSaturation
unknownNormalized water saturation (Corey/effective saturation) for a water-oil system.
EntitiescalculationInputs: Sw, Swc, Sorw.
scal_coreyKrw
unknownCorey water relative permeability (water-oil system).
EntitiescalculationInputs: Sw, Swc, Sorw, nw, krwMax?.
scal_coreyKro
unknownCorey oil relative permeability (water-oil system).
EntitiescalculationInputs: Sw, Swc, Sorw, no, kroMax?.
scal_coreyKrg
unknownCorey gas relative permeability (gas-oil / gas-liquid system, drainage).
EntitiescalculationInputs: Sg, Sgc, Sorg, Swc, ng, krgMax?.
scal_newmanCfSandstone
unknownNewman (1973) pore-volume compressibility - consolidated sandstone correlation.
EntitiescalculationInputs: phi.
scal_newmanCfLimestone
unknownNewman (1973) pore-volume compressibility - consolidated limestone correlation.
EntitiescalculationInputs: phi.
scal_hallCf
unknownHall (1953) pore-volume (formation) compressibility correlation.
EntitiescalculationInputs: phi.
scal_amottHarveyIndex
unknownAmott-Harvey wettability index.
EntitiescalculationInputs: Vwsp, Vwf, Vosp, Vof.
scal_oilSaturation
unknownTotal saturation closure check / oil saturation helper.
EntitiescalculationInputs: Sw, Sg?.
frac_plane_strain_modulus
unknownPlane-strain modulus E' = E/(1-nu^2). [Economides & Nolte, Reservoir Stimulation 3rd ed.]
Entitiescalculation, frac_job, completionInputs: E, nu.
frac_pkn_width_wellbore
unknownPKN wellbore (max) fracture width, in. Perkins-Kern field form (Economides PPS).
Entitiescalculation, frac_job, completion, wellInputs: q bpm (total), mu cp, xf ft, Eprime psi. Returns width_in.
frac_pkn_width_average
unknownPKN average fracture width. w_avg = (pi/4)*(4/5)*w_w ≈ 0.628*w_w.
Entitiescalculation, frac_job, completionInputs: q, mu, xf, Eprime.
frac_pkn_net_pressure
unknownPKN net (treating) pressure at wellbore.
Entitiescalculation, frac_job, completionInputs: Eprime, width_ft, hf.
frac_pkn_volume
unknownPKN fracture volume (one wing pair, two wings, total) using ellipsoidal cross-section.
Entitiescalculation, production, frac_job, completionInputs: xf, hf, width_avg_ft.
frac_pkn_halflength_noleakoff
unknownPKN fracture half-length WITHOUT leakoff (efficiency = 1): all injected fluid stored.
Entitiescalculation, frac_job, completionInputs: q, t, hf, width_avg_ft.
frac_pkn_halflength_leakoff
unknownPKN fracture half-length WITH Carter leakoff (Carter 1957 constant-width solution).
Entitiescalculation, frac_job, completionInputs: q, t, hf, width_avg_ft, CL.
frac_kgd_width_wellbore
unknownKGD wellbore (max) width, in. Geertsma-de Klerk field form (Economides PPS).
Entitiescalculation, frac_job, completion, wellInputs: q bpm (total), mu cp, xf ft, hf ft, Eprime psi. Returns width_in.
frac_kgd_width_average
unknownKGD average width. w_avg = (pi/4)*w_w (elliptical horizontal cross-section).
Entitiescalculation, frac_job, completionInputs: q, mu, xf, hf, Eprime.
frac_kgd_net_pressure
unknownKGD net pressure. p_net = E'*w_w/(4*x_f) (Sneddon plane-strain crack).
Entitiescalculation, frac_job, completionInputs: Eprime, width_ft, xf.
frac_kgd_volume
unknownKGD fracture volume. V_f = 2*x_f*h_f*w_avg [ft^3]. [volume balance]
Entitiescalculation, production, frac_job, completionInputs: xf, hf, width_avg_ft.
frac_kgd_halflength_noleakoff
unknownKGD half-length WITHOUT leakoff. x_f = q*t/(2*h_f*w_avg) [ft]. [volume balance]
Entitiescalculation, frac_job, completionInputs: q, t, hf, width_avg_ft.
frac_kgd_halflength_leakoff
unknownKGD half-length WITH Carter leakoff (Carter 1957 constant-width solution).
Entitiescalculation, frac_job, completionInputs: q, t, hf, width_avg_ft, CL.
frac_radial_width_wellbore
unknownRadial (penny-shaped) wellbore (max) width, in (Geertsma-de Klerk).
Entitiescalculation, frac_job, completion, wellInputs: q bpm, mu cp, R ft, Eprime psi. Returns width_in.
frac_radial_width_average
unknownRadial average width. w_avg = (8/15)*w_w (Geertsma-de Klerk radial model).
Entitiescalculation, frac_job, completionInputs: q, mu, R, Eprime.
frac_radial_net_pressure
unknownRadial net pressure of a uniform-pressure (Sneddon) penny crack, pi*E'*w_max/(8R).
Entitiescalculation, frac_job, completionwidth_ft = Sneddon max width, not the GdK frac_radial_width_wellbore.
frac_radial_volume
unknownRadial fracture volume. V_f = pi*R^2*w_avg (w_avg from frac_radial_width_average).
Entitiescalculation, production, frac_job, completionInputs: R, width_avg_ft.
frac_radial_radius_noleakoff
unknownRadial fracture radius WITHOUT leakoff. q*t = pi*R^2*w_avg -> R = sqrt(q*t/(pi*w_avg)).
Entitiescalculation, frac_job, completionInputs: q, t, width_avg_ft.
frac_radial_radius_leakoff
unknownRadial fracture radius WITH Carter leakoff (Carter 1957 constant-width solution).
Entitiescalculation, frac_job, completionInputs: q, t, width_avg_ft, CL.
frac_leakoff_Cv
unknownViscosity-controlled leakoff coefficient C_v (filtrate invasion, Carter region I).
Entitiescalculation, frac_job, completionInputs: k md, phi, dp psi, mu cp. Returns ft/min^0.5.
frac_leakoff_Cc
unknownCompressibility-controlled (reservoir) leakoff coefficient C_c (Carter region III).
Entitiescalculation, frac_job, completionInputs: dp psi, k md, phi, ct 1/psi, mu cp. Returns ft/min^0.5.
frac_leakoff_combined
unknownCombined Carter leakoff coefficient from series resistances.
Entitiescalculation, frac_job, completionInputs: Cv, Cc, Cw?.
frac_leakoff_velocity
unknownCarter leakoff velocity at exposure time tau: u_L = C_L / sqrt(tau) [ft/min].
Entitiescalculation, frac_job, completionInputs: CL, tau.
frac_leakoff_volume
unknownCumulative Carter leakoff volume per unit fracture area exposed for time t.
Entitiescalculation, production, frac_job, completionInputs: CL, t, area, Sp?, faces?.
frac_fluid_efficiency
unknownFluid efficiency eta = V_fracture / V_injected (stored fraction).
Entitiescalculation, frac_job, completionInputs: V_fracture, V_injected.
frac_proppant_stokes_velocity
unknownStokes terminal (single-particle) settling velocity in laminar regime (Re<1).
Entitiescalculation, frac_job, completionInputs: dp_in, rho_p, rho_f, mu.
frac_proppant_hindered_velocity
unknownHindered settling (Richardson & Zaki 1954): v_h = v_s * (1 - C)^n.
Entitiescalculation, frac_job, completionInputs: vs, C, n?.
frac_proppant_reynolds
unknownParticle Reynolds number Re_p = rho_f * v * d_p / mu (dimensionless).
Entitiescalculation, frac_job, completionInputs: rho_f, v_ft_s, dp_in, mu.
frac_proppant_transport_ratio
unknownTransport (placement) ratio = horizontal slurry velocity / settling velocity.
Entitiescalculation, frac_job, completionInputs: v_horizontal, v_settling.
frac_proppant_wall_correction
unknownWall (channel) correction factor for settling between parallel fracture faces.
Entitiescalculation, frac_job, completionInputs: dp_in, width_in.
frac_dimensionless_conductivity
unknownDimensionless fracture conductivity C_fd = (k_f * w) / (k * x_f).
Entitiescalculation, frac_job, completionInputs: kf, w_ft, k, xf.
frac_equivalent_skin
unknownEquivalent skin factor of a fractured vertical well.
Entitiescalculation, frac_job, completionInputs: Cfd, xf, rw.
sf_chokeCriticalPressure
unknownCritical-flow wellhead pressure upstream of a bean choke.
EntitiescalculationPressure in psia; gauge-fit correlations use atmosphericPressure_psia (14.696).
sf_chokeCriticalRate
unknownLiquid rate through a bean in critical flow, inverted from.
EntitiescalculationPressure in psia; gauge-fit correlations use atmosphericPressure_psia (14.696).
sf_chokeCriticalBean
unknownBean size (64ths-inch) needed to pass a target rate at a given wellhead.
EntitiescalculationPressure in psia; gauge-fit correlations use atmosphericPressure_psia (14.696).
sf_sonicGasChokeRate
unknownSonic (critical) gas rate through a choke, field units. From the standard.
Entitiescalculationsf_subcriticalLiquidChoke
unknownSubcritical (incompressible) liquid flow through a choke/bean using the.
Entitiescalculationsf_sachdevaCriticalBoundary
unknownSachdeva et al. (1986) two-phase critical pressure ratio y_c, solved by.
Entitiescalculationsf_sachdevaRate
unknownSachdeva et al. (1986) two-phase mass flux + rate through a choke (SPE 15657).
Entitiescalculationsf_gasPipelineRate
unknownGas pipeline flow rate from inlet & outlet pressures.
Entitiescalculation, pipelinesf_gasPipelineOutletPressure
unknownGas pipeline outlet pressure from a known flow rate.
Entitiescalculation, pipelinesf_gasDensity
unknownGas density at flowing pipeline conditions, real-gas law (field units)
Entitiescalculationsf_gasVelocity
unknownActual gas velocity in a pipe, field units. Convert standard rate to actual.
Entitiescalculationsf_gasReynolds
unknownGas Reynolds number, field units (dimensionless). Standard pipeline form.
Entitiescalculationsf_liquidVelocity
unknownLiquid velocity in a pipe, field units.
Entitiescalculationsf_liquidReynolds
unknownLiquid Reynolds number, field units (dimensionless)
Entitiescalculationsf_liquidPressureDrop
writeSingle-phase liquid frictional pressure drop in a horizontal pipe via.
Entitiescalculationsf_liquidOutletPressure
unknownLiquid pipeline outlet pressure = inlet - frictional ΔP.
Entitiescalculationsf_liquidInletPressure
unknownLiquid pipeline inlet pressure = outlet + frictional ΔP.
Entitiescalculationsf_liquidRateFromPressureDrop
writeLiquid flow rate from a known frictional ΔP. Because the Moody friction.
Entitiescalculationipr_vogel
unknownVogel (1968) two-phase IPR forward rate from pwf given qmax (or a test point).
EntitiescalculationInputs: pr, pwf, qmax?, qTest?, pwfTest?.
ipr_vogelQmax
unknownVogel (1968) qmax (AOF) from a single (q,pwf,pr) test point below bubble point.
EntitiescalculationInputs: pr, q, pwf.
ipr_productivityIndex
unknownStraight-line productivity index J = q/(pr - pwf) (single-phase, pwf > pb).
EntitiescalculationInputs: q, pr, pwf.
ipr_straightLineRate
unknownStraight-line rate q = J(pr - pwf) for undersaturated single-phase flow.
EntitiescalculationInputs: J, pr, pwf.
ipr_compositeIPR
unknownComposite IPR: straight-line above pb + Vogel below pb, using J at bubble point.
EntitiescalculationInputs: J, pr, pb, pwf.
ipr_fetkovich
unknownFetkovich (1973) forward rate q = C(pr^2 - pwf^2)^n given C and n.
EntitiescalculationInputs: C, n, pr, pwf.
ipr_fetkovichCn
unknownFetkovich (1973) C,n fit from >=2 flow-after-flow test points (log-log regression).
EntitiescalculationInputs: pr, points, pwf.
ipr_standingModifiedVogel
unknownStanding (1970) Vogel extension using flow efficiency FE (damaged/stimulated).
EntitiescalculationInputs: pr, pwf, FE, qmaxFE1.
ipr_wigginsThreePhase
unknownWiggins (1993) three-phase oil IPR (generalized Vogel coefficients).
EntitiescalculationInputs: pr, pwf, qmax.
ipr_jonesEquation
unknownJones (1976) quadratic IPR rate from pr - pwf = a*q + b*q^2 (Darcy + turbulence).
EntitiescalculationInputs: a, b, pr, pwf.
ipr_jonesFit
unknownJones (1976) a,b fit from >=2 test points: (pr - pwf)/q = a + b*q (linear).
EntitiescalculationInputs: pr, points, pwf.
ipr_darcyRadialOil
unknownDarcy semi-steady-state radial oil rate (field units), STB/d.
EntitiescalculationInputs: k, h, pr, pwf, mu, Bo, re, rw, s?.
ipr_darcyRadialGas
unknownDarcy pseudo-steady-state radial gas rate (field units), Mscf/d.
EntitiescalculationInputs: k, h, pr, pwf, mu, z, T, re, rw, s?.
ipr_joshiHorizontal
unknownJoshi (1988) horizontal-well steady-state oil rate (field units), STB/d.
Entitiescalculation, formationInputs: k, kv?, h, L, reH, pr, pwf, mu, Bo, rw.
ipr_absoluteOpenFlow
unknownAbsolute open flow (AOF) at pwf=0 for Vogel and Fetkovich IPR forms.
EntitiescalculationInputs: form, qmax?, C?, n?, pr?.
fa_co2PartialPressure
unknownCO2 partial pressure from gas composition: pCO2 = y_CO2 * P_total.
Entitiescalculationfa_deWaardMilliams1991
unknownde Waard-Milliams-Lotz (1991) CO2 corrosion rate (mm/yr) of carbon steel.
Entitiescalculationfa_deWaardMilliams1975
unknownde Waard-Milliams (1975) ORIGINAL nomogram CO2 corrosion rate (mm/yr).
Entitiescalculationfa_co2Fugacity
unknownCO2 fugacity correction for high pressure (de Waard et al.). Above ~250 bar.
Entitiescalculationfa_corrosionRiskCategory
unknownClassify a corrosion rate (mm/yr) into NACE-style severity bands.
Entitiescalculationfa_apiRP14E_erosionalVelocity
unknownAPI RP 14E erosional (limiting) velocity: Ve = C / sqrt(rho_mix) [ft/s].
Entitiescalculationfa_erosionalVelocityLimit
unknownCheck an operating velocity against the API RP 14E erosional limit. Reports.
Entitiescalculationfa_minPipeDiameterForErosion
unknownMinimum pipe internal diameter (in) to keep the mixture velocity at or below.
Entitiescalculation, facilityfa_mixtureDensity
unknownNo-slip two-phase mixture density (lb/ft3)
Entitiescalculationfa_mixtureVelocity
unknownActual mixture (superficial) velocity in a pipe.
Entitiescalculationfa_hammerschmidtDepression
unknownHammerschmidt (1934) hydrate-temperature depression (deg F)
Entitiescalculationfa_hydrateInhibitorConcentration
unknownRequired inhibitor concentration (wt% in the aqueous phase) to achieve a.
Entitiescalculationfa_methanolInjectionRate
unknownRequired METHANOL injection rate (mass and volume) to dose the free water to.
Entitiescalculationfa_megInjectionRate
unknownRequired MEG (monoethylene glycol) injection rate (mass and volume) to dose.
Entitiescalculationfa_subcooling
unknownHydrate subcooling (driving force), deg F.
Entitiescalculationdca_sedmRate
unknownSEDM rate q(t) = qi * exp(-(t/tau)^n). Field units.
EntitiescalculationInputs: qi, tau, n, t.
dca_sedmCum
unknownSEDM cumulative Q(t) = (qi*tau/n) * gamma(1/n, (t/tau)^n), lower incomplete gamma.
EntitiescalculationInputs: qi, tau, n, t.
dca_sedmEUR
unknownSEDM ultimate recovery (t -> infinity) = qi*tau*Gamma(1+1/n) = (qi*tau/n)*Gamma(1/n).
EntitiescalculationInputs: qi, tau, n.
dca_sedmFit
unknownFit SEDM (qi, tau, n) to rate-time data by least squares (grid then refine).
EntitiescalculationInputs: t, q.
dca_pleRate
unknownPLE rate q(t) = qi * exp(-Dinf*t - D1*t^n). Field units.
EntitiescalculationInputs: qi, Dinf, D1, n, t.
dca_pleCum
unknownPLE cumulative Q(t) = integral(0..t) qi*exp(-Dinf*s - D1*s^n) ds (Simpson, no closed form).
EntitiescalculationInputs: qi, Dinf, D1, n, t, panels?.
dca_pleFit
unknownFit PLE (qi, Dinf, D1, n) to rate-time data by least squares (grid then refine).
EntitiescalculationInputs: t, q.
dca_lgmCum
unknownLGM cumulative Q(t) = K * t^n / (a + t^n). Field units; K = carrying capacity = EUR.
EntitiescalculationInputs: K, a, n, t.
dca_lgmRate
unknownLGM rate q(t) = dQ/dt = K*a*n*t^(n-1) / (a + t^n)^2. Field units.
EntitiescalculationInputs: K, a, n, t.
dca_lgmRateFromCum
unknownLGM instantaneous rate as the analytic derivative of cumulative q = dQ/dt (alias of dca_lgmRate).
EntitiescalculationInputs: K, a, n, t.
dca_lgmEUR
unknownLGM EUR = K (the carrying capacity; cumulative as t -> infinity).
EntitiescalculationInputs: K.
dca_lgmFit
unknownFit LGM (K, a, n) to cumulative-time data by least squares (grid then refine).
EntitiescalculationInputs: t, Q.
dca_duongCum
unknownDuong cumulative Q(t) = q(t) / (a * t^(-m)), the closed-form integral of the Duong rate.
EntitiescalculationInputs: q1, a, m, t.
dca_duongEUR
unknownDuong EUR to an economic-limit rate qLimit: solve q(t)=qLimit for t.
EntitiescalculationInputs: q1, a, m, qLimit.
dca_duongFit
unknownFit Duong (a, m, q1) to rate-time data. For candidate (a,m) the points line up.
EntitiescalculationInputs: t, q.
dca_effectiveFromNominal
unknownEffective (secant) decline from nominal (instantaneous) decline.
EntitiescalculationInputs: Dnom, b?.
dca_nominalFromEffective
unknownNominal (instantaneous) decline from effective (secant) decline.
EntitiescalculationInputs: Deff, b?.
dca_bFactorFromRates
unknownInstantaneous Arps b-factor from three (t,q) points: b = d(1/D)/dt, with the.
EntitiescalculationInputs: t, number, number], q, number, number].
dca_betaDerivative
unknownBeta-derivative diagnostic beta = t * (d ln q / d t), the log-log slope of rate.
EntitiescalculationInputs: t, q, at.
dca_eurFromArpsToHyperbolicSwitch
unknownEUR for an Arps-hyperbolic that switches to terminal exponential at decline Dlim.
EntitiescalculationInputs: qi, Di, b, Dlim, qLimit.
eos_cubicAB
unknownCalculates pure-component PR or SRK cubic EOS A, B, a, and b.
EntitiescalculationInputs: eos, Tc_degR, Pc_psia, omega, T_degR, P_psia.
eos_zFactor
unknownSolves the PR or SRK cubic EOS compressibility-factor equation.
EntitiescalculationInputs: eos, A_dimless, B_dimless.
eos_fugacityCoefficient
unknownCalculates pure-component fugacity coefficient from PR or SRK Z, A, and B.
EntitiescalculationInputs: eos, Z, A_dimless, B_dimless.
eos_molarVolume
unknownCalculates gas or liquid molar volume from Z, T, and P in field units.
Entitiescalculation, productionInputs: Z, T_degR, P_psia.
eos_massDensity
unknownCalculates mass density from Z, T, P, and molar mass in field units.
EntitiescalculationInputs: Z, T_degR, P_psia, molarMass_lb_per_lbmol.
eos_departureEnthalpy
unknownCalculates pure-component cubic-EOS residual enthalpy departure.
EntitiescalculationInputs: eos, Tc_degR, Pc_psia, omega, T_degR, P_psia, Z.
eos_departureEntropy
unknownCalculates pure-component cubic-EOS residual entropy departure.
EntitiescalculationInputs: eos, Tc_degR, Pc_psia, omega, T_degR, P_psia, Z.
eos_isothermalCompressibility
unknownCalculates isothermal compressibility from a cubic EOS Z root.
EntitiescalculationInputs: eos, Z, A_dimless, B_dimless, P_psia.
eos_wilsonK
unknownEstimates Wilson K-values for a multicomponent feed.
EntitiescalculationInputs: Tc_degR, Pc_psia, omega, T_degR, P_psia, componentNames?.
eos_rachfordRice
unknownSolves Rachford-Rice vapor fraction and phase compositions.
EntitiescalculationInputs: z, K, tolerance?, maxIter?.
eos_flashTwoPhase
unknownRuns an approximate two-phase PR or SRK flash by successive substitution.
EntitiescalculationInputs: eos, z, Tc_degR, Pc_psia, omega, T_degR, P_psia, kij?, componentNames?,…
esp_totalDynamicHead
unknownComputes ESP total dynamic head from lift, friction, and wellhead pressure.
EntitiescalculationInputs: netVerticalLift_ft, wellheadPressure_psia, fluidGradient_psiPerFt, refe…
esp_stagesRequired
unknownComputes the integer ESP stage count required to develop a target head.
EntitiescalculationInputs: totalDynamicHead_ft, headPerStage_ft, stageSafetyFactor?.
esp_affinityLaws
unknownApplies centrifugal-pump affinity laws for speed and impeller trim changes.
EntitiescalculationInputs: baseFlowRate_bpd, baseHead_ft, baseBrakeHorsepower_hp, baseSpeed, newSp…
esp_brakeHorsepower
unknownComputes ESP brake horsepower by hydraulic power or stage horsepower.
EntitiescalculationInputs: flowRate_bpd?, totalDynamicHead_ft?, fluidSpecificGravity?, pumpEfficie…
esp_npshAvailable
unknownComputes available NPSH at an ESP intake from pressure head above vapor.
EntitiescalculationInputs: intakePressure_psia, vaporPressure_psia, fluidGradient_psiPerFt, static…
esp_motorLoading
unknownComputes ESP motor loading from required brake horsepower and nameplate hp.
EntitiescalculationInputs: requiredBrakeHorsepower_hp, motorNameplateHorsepower_hp, motorServiceFa…
rod_pumpDisplacement
unknownComputes sucker-rod pump displacement from speed, plunger size, and stroke.
EntitiescalculationInputs: strokesPerMinute_spm, plungerDiameter_in, effectivePlungerStroke_in.
rod_plungerStroke
unknownComputes effective plunger stroke from elastic stroke losses and overtravel.
EntitiescalculationInputs: polishedRodStroke_in, rodStretch_in, tubingStretch_in, overtravel_in?.
rod_rodStretch
unknownComputes rod-string elastic stretch under fluid load by Hooke's law.
EntitiescalculationInputs: fluidLoad_lbf, rodLength_ft, rodDiameter_in?, rodArea_in2?, modulusElas…
rod_peakPolishedRodLoad
unknownComputes peak polished-rod load using the Mills acceleration approximation.
EntitiescalculationInputs: fluidLoad_lbf, rodStringWeight_lbf, polishedRodStroke_in, pumpingSpeed_…
rod_minPolishedRodLoad
unknownComputes minimum polished-rod load using the Mills acceleration approximation.
EntitiescalculationInputs: rodStringWeight_lbf, polishedRodStroke_in, pumpingSpeed_spm.
rod_counterbalanceEffect
unknownComputes approximate ideal counterbalance effect from polished-rod loads.
EntitiescalculationInputs: peakPolishedRodLoad_lbf, minimumPolishedRodLoad_lbf.
rod_polishedRodHorsepower
unknownComputes polished-rod horsepower from an approximate rectangular card area.
EntitiescalculationInputs: peakPolishedRodLoad_lbf, minimumPolishedRodLoad_lbf, polishedRodStroke_…
rod_pumpVolumetricEfficiency
unknownComputes rod-pump volumetric efficiency from actual rate and displacement.
Entitiescalculation, productionInputs: actualLiquidRate_bpd, pumpDisplacement_bpd.
gaslift_injectionGasGradient
unknownComputes static injection-gas pressure gradient over a gas-lift annulus.
EntitiescalculationInputs: surfaceInjectionPressure_psia, depth_ft, gasSpecificGravity, averageTem…
gaslift_casingPressureAtDepth
unknownComputes casing pressure at depth for a static gas-lift gas column.
Entitiescalculation, completionInputs: surfaceCasingPressure_psia, depth_ft, gasSpecificGravity, averageTemper…
gaslift_valveOpeningPressure
unknownComputes IPO gas-lift valve opening pressure from dome and tubing pressure.
EntitiescalculationInputs: domePressureAtDepth_psia, tubingPressureAtDepth_psia, portToBellowsArea…
gaslift_unloadingGradient
unknownComputes a straight-line gas-lift unloading gradient between two pressures.
EntitiescalculationInputs: surfacePressure_psia, transferPressureAtDepth_psia, valveDepth_ft.
gaslift_requiredInjectionGLR
unknownComputes required injected gas-liquid ratio from target and formation GLR.
EntitiescalculationInputs: targetTotalGLR_scfPerSTB, formationGLR_scfPerSTB, liquidRate_STBPerD?.
gaslift_powerForCompression
unknownComputes gas-lift compression horsepower with a polytropic ideal-gas form.
EntitiescalculationInputs: injectionGasRate_MscfPerD, suctionPressure_psia, dischargePressure_psia…
pta_exponentialIntegral
unknownComputes the line-source well function W(u) = -Ei(-u).
EntitiescalculationInputs: u.
pta_dimensionlessTime
unknownComputes radial and drainage-area dimensionless time in field units.
EntitiescalculationInputs: kMd, tHours, phi, muCp, ctPerPsi, rwFt, rFt?, drainageAreaAcres?.
pta_dimensionlessPressure
unknownComputes semilog line-source dimensionless pressure for tD above about 100.
EntitiescalculationInputs: tD.
pta_lineSourcePressure
unknownComputes infinite-acting line-source pressure at radius and time.
EntitiescalculationInputs: initialPressurePsi, qStbd, muCp, BoRbPerStb, kMd, hFt, phi, ctPerPsi, r…
pta_drawdownSemilog
unknownComputes permeability and skin from MDH drawdown semilog slope.
EntitiescalculationInputs: slopePsiPerCycle, qStbd, muCp, BoRbPerStb, hFt, p1hrPsi, pwf0Psi (=pi),…
pta_hornerTime
unknownComputes Horner buildup time ratio and its base-10 plotting coordinate.
EntitiescalculationInputs: producingTimeHours, shutInTimeHours.
pta_hornerBuildup
unknownComputes permeability, skin, and p-star from a Horner buildup semilog line.
EntitiescalculationInputs: slopePsiPerCycle, qStbd, muCp, BoRbPerStb, hFt, p1hrPsi, pwfAtShutInPsi…
pta_skinFactor
unknownComputes skin from the semilog 1-hour pressure; test buildup (default) or drawdown.
EntitiescalculationInputs: p1hrPsi, referencePressurePsi, slopePsiPerCycle, kMd, phi, muCp, test?…
pta_pressureDropDueToSkin
writeComputes pressure drop attributable to skin from semilog slope and skin.
EntitiescalculationInputs: slopePsiPerCycle, skin.
pta_flowEfficiency
unknownComputes flow efficiency from total drawdown and skin pressure drop.
EntitiescalculationInputs: averageReservoirPressurePsi, flowingBottomholePressurePsi, pressureDrop…
pta_radiusOfInvestigation
unknownComputes line-source radius of investigation in field units.
EntitiescalculationInputs: kMd, tHours, phi, muCp, ctPerPsi.
pta_wellboreStorageCoefficient
unknownComputes wellbore storage coefficient from volume or unit-slope data.
Entitiescalculation, wellInputs: volumeUnderCompressionBbl? (bbl/ft), fluidDensityLbPerFt3?, qStbd?,…
pta_dimensionlessWellboreStorage
unknownComputes dimensionless wellbore storage coefficient.
Entitiescalculation, wellInputs: storageCoefficientBblPerPsi, phi, ctPerPsi, hFt, rwFt.
pta_endOfWellboreStorage
unknownEstimates end of wellbore storage from the common semilog rule.
Entitiescalculation, wellInputs: storageCoefficientBblPerPsi, kMd, hFt, muCp, skin.
pta_dietzShapeFactor
unknownLooks up a Dietz shape factor for common closed drainage areas.
EntitiescalculationInputs: shape.
pta_pseudosteadyStatePressure
unknownComputes pseudosteady-state pressure drop using Dietz shape factor CA.
EntitiescalculationInputs: initialPressurePsi, qStbd, muCp, BoRbPerStb, kMd, hFt, phi, ctPerPsi, r…
pta_bourdetDerivative
unknownComputes Bourdet pressure derivative from time-pressure arrays.
EntitiescalculationInputs: timesHours, pressuresPsi, smoothingLogCycles?.
vfp_hydrostaticGradient
unknownComputes hydrostatic pressure gradient from fluid density.
EntitiescalculationInputs: density_lbPerFt3.
vfp_frictionGradient
unknownComputes Darcy-Weisbach friction gradient with Chen explicit friction factor.
EntitiescalculationInputs: density_lbPerFt3, velocity_ftPerS, pipeId_in, viscosity_cp, roughness_i…
vfp_reynolds
unknownComputes Reynolds number in field units for internal pipe flow.
EntitiescalculationInputs: density_lbPerFt3, velocity_ftPerS, pipeId_in, viscosity_cp.
vfp_superficialVelocities
unknownComputes liquid and gas superficial velocities from field rates.
EntitiescalculationInputs: liquidRate_STBPerD, gasRate_Mscfd, pipeId_in, pressure_psia, temperatur…
vfp_mixtureVelocity
unknownComputes mixture superficial velocity as vsl plus vsg.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS.
vfp_noSlipHoldup
unknownComputes no-slip liquid holdup from superficial velocities.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS.
vfp_gasStaticBHP
unknownComputes static gas bottomhole pressure using average T and z.
EntitiescalculationInputs: wellheadPressure_psia, trueVerticalDepth_ft, gasSpecificGravity, averag…
vfp_gasFlowingBHP
unknownComputes flowing gas bottomhole pressure with gas friction in tubing.
EntitiescalculationInputs: wellheadPressure_psia, measuredDepth_ft, trueVerticalDepth_ft?, gasSpec…
vfp_flowPatternBeggsBrill
unknownClassifies Beggs-Brill horizontal flow pattern from lambda and Froude number.
EntitiescalculationInputs: noSlipLiquidHoldup_fraction, froudeNumber.
vfp_holdupBeggsBrill
unknownComputes Beggs-Brill liquid holdup with inclination correction.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…
vfp_gradientBeggsBrill
unknownComputes full Beggs-Brill pressure gradient with elevation, friction, acceleration.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…
vfp_holdupHagedornBrown
unknownComputes Hagedorn-Brown holdup using digitized-chart polynomial fits.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…
vfp_gradientHagedornBrown
unknownComputes Hagedorn-Brown pressure gradient with chart-fit holdup.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…
vfp_gradientGray
unknownComputes Gray wet-gas vertical pressure gradient in closed form.
EntitiescalculationInputs: superficialLiquidVelocity_ftPerS, superficialGasVelocity_ftPerS, pipeId…
vfp_pressureTraverse
unknownMarches a pressure traverse down the well using Beggs-Brill or Gray.
EntitiescalculationInputs: correlation, wellheadPressure_psia, measuredDepth_ft, trueVerticalDepth…
wellpath_minimumCurvature
unknownWellbore trajectory from a deviation survey by minimum curvature: TVD, northing, easting, dogleg.
Entitiescalculation, trajectory, wellInputs: stations [{md,inc,azi}] degrees, units 'ft'|'m'. Origin = 1st station.
wellpath_interpolate
unknownInterpolate a wellbore survey at any measured depth on the minimum curvature arc.
Entitiescalculation, trajectory, wellInputs: stations, md, units. Returns inc/azi/TVD/N/E at md.
wellpath_doglegSeverity
unknownDogleg severity between two wellbore survey stations, per 100 ft or 30 m.
Entitiescalculation, trajectory, wellInputs: md1,inc1,azi1,md2,inc2,azi2, units.
wellpath_verticalSection
unknownVertical section projection of a wellbore survey onto a target azimuth plane.
Entitiescalculation, trajectory, wellInputs: stations, vsAzimuth deg, units.
wellpath_closure
unknownClosure distance and azimuth from surface to bottomhole for a deviation survey.
Entitiescalculation, trajectory, wellInputs: stations, units.
wellpath_buildTurnRates
unknownBuild and turn rates between survey stations of a wellbore trajectory.
Entitiescalculation, trajectory, wellInputs: stations, units. Rates per 100 ft / 30 m.
wellpath_positionUncertainty
unknownWellbore position uncertainty, ISCWSA MWD error model (Rev5.11 default or Rev4): sigma N/E/V.
Entitiescalculation, trajectory, wellInputs: stations, bTotal (nT), dip, declination, units, errorModel rev4|rev5.
wellpath_separationFactor
unknownAnti-collision separation factor between two wells: ISCWSA pedal-curve, Rev5.11 default or Rev4.
Entitiescalculation, trajectory, wellInputs: reference/offsetStations, bTotal, dip, declination, units, errorModel.
wellpath_subsurfaceView
readBuild a 3D subsurface trajectory map payload from deviation surveys, for patchops_render.
Entitiescalculation, trajectory, wellwells [{stations, surfaceLat, surfaceLon, name?, color?}], units. Out: mapSpec.
wellpath_toGeoJSON
unknownWellbore trajectory as GeoJSON for map rendering, from a survey and surface location.
Entitiescalculation, trajectory, wellFirst station anchored at surfaceLat/Lon. Depth = negative altitude.
units_ftToM
unknownConvert feet (ft) to meters (m). Factor: 1 ft = 0.3048 m. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_mToFt
unknownConvert meters (m) to feet (ft). Factor: 1 m = 1/0.3048 ft. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_inToCm
unknownConvert inches (in) to centimeters (cm). Factor: 1 in = 2.54 cm. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_cmToIn
unknownConvert centimeters (cm) to inches (in). Factor: 1 cm = 1/2.54 in. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_miToKm
unknownConvert miles (mi) to kilometers (km). Factor: 1 mi = 1.609344 km. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kmToMi
unknownConvert kilometers (km) to miles (mi). Factor: 1 km = 1/1.609344 mi. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_ftToIn
unknownConvert feet (ft) to inches (in). Factor: 1 ft = 12 in. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_inToFt
unknownConvert inches (in) to feet (ft). Factor: 1 in = 1/12 ft. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_acreToFt2
unknownConvert acres (acre) to square feet (ft2). Factor: 1 acre = 43560 ft2. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_ft2ToAcre
unknownConvert square feet (ft2) to acres (acre). Factor: 1 ft2 = 1/43560 acre. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_acreToM2
unknownConvert acres (acre) to square meters (m2). Factor: 1 acre = 4046.8564224 m2. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_m2ToAcre
unknownConvert square meters (m2) to acres (acre). Factor: 1 m2 = 1/4046.8564224 acre. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_ft2ToM2
unknownConvert square feet (ft2) to square meters (m2). Factor: 1 ft2 = 0.09290304 m2. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_m2ToFt2
unknownConvert square meters (m2) to square feet (ft2). Factor: 1 m2 = 1/0.09290304 ft2. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_mi2ToAcre
unknownConvert square miles (mi2) to acres (acre). Factor: 1 mi2 = 640 acre. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_acreToMi2
unknownConvert acres (acre) to square miles (mi2). Factor: 1 acre = 1/640 mi2. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_bblToFt3
unknownConvert barrels (bbl) to cubic feet (ft3). Factor: 1 bbl = 5.614583 ft3. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_ft3ToBbl
unknownConvert cubic feet (ft3) to barrels (bbl). Factor: 1 ft3 = 1/5.614583 bbl. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_bblToGal
unknownConvert barrels (bbl) to gallons (gal). Factor: 1 bbl = 42 gal. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_galToBbl
unknownConvert gallons (gal) to barrels (bbl). Factor: 1 gal = 1/42 bbl. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_bblToM3
unknownConvert barrels (bbl) to cubic meters (m3). Factor: 1 bbl = 0.158987 m3. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_m3ToBbl
unknownConvert cubic meters (m3) to barrels (bbl). Factor: 1 m3 = 1/0.158987 bbl. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_ft3ToM3
unknownConvert cubic feet (ft3) to cubic meters (m3). Factor: 1 ft3 = 0.028316846592 m3. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_m3ToFt3
unknownConvert cubic meters (m3) to cubic feet (ft3). Factor: 1 m3 = 1/0.028316846592 ft3. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_mscfToMcf
unknownConvert thousand standard cubic feet (Mscf) to thousand cubic feet (Mcf). Factor: 1 Mscf = 1 Mcf.
Entitiescalculation, unit, leaseInputs: value.
units_mcfToMscf
unknownConvert thousand cubic feet (Mcf) to thousand standard cubic feet (Mscf). Factor: 1 Mcf = 1 Mscf.
Entitiescalculation, unit, leaseInputs: value.
units_mmscfToM3
unknownConvert million standard cubic feet (MMscf) to cubic meters (m3). Factor: 1 MMscf = 28316.846592 m3.
Entitiescalculation, unit, leaseInputs: value.
units_m3ToMmscf
unknownConvert cubic meters (m3) to million standard cubic feet (MMscf).
Entitiescalculation, unit, leaseInputs: value.
units_lbmToKg
unknownConvert pounds-mass (lbm) to kilograms (kg). Factor: 1 lbm = 0.45359237 kg. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kgToLbm
unknownConvert kilograms (kg) to pounds-mass (lbm). Factor: 1 kg = 1/0.45359237 lbm. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_lbfToN
unknownConvert pounds-force (lbf) to newtons (N). Factor: 1 lbf = 4.4482216152605 N. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_nToLbf
unknownConvert newtons (N) to pounds-force (lbf). Factor: 1 N = 1/4.4482216152605 lbf. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_shortTonToKg
unknownConvert short tons (short ton) to kilograms (kg). Factor: 1 short ton = 907.18474 kg. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kgToShortTon
unknownConvert kilograms (kg) to short tons (short ton). Factor: 1 kg = 1/907.18474 short ton. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_psiToKpa
unknownConvert pounds per square inch (psi) to kilopascals (kPa). Factor: 1 psi = 6.894757 kPa. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kpaToPsi
unknownConvert kilopascals (kPa) to pounds per square inch (psi). Factor: 1 kPa = 1/6.894757 psi.
Entitiescalculation, unit, leaseInputs: value.
units_psiToBar
unknownConvert pounds per square inch (psi) to bar (bar). Factor: 1 psi = 0.06894757 bar. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_barToPsi
unknownConvert bar (bar) to pounds per square inch (psi). Factor: 1 bar = 1/0.06894757 psi. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_psiToAtm
unknownConvert pounds per square inch (psi) to atmospheres (atm). Factor: 1 psi = 0.0680459639 atm.
Entitiescalculation, unit, leaseInputs: value.
units_atmToPsi
unknownConvert atmospheres (atm) to pounds per square inch (psi). Factor: 1 atm = 1/0.0680459639 psi.
Entitiescalculation, unit, leaseInputs: value.
units_psiToPa
unknownConvert pounds per square inch (psi) to pascals (Pa). Factor: 1 psi = 6894.757 Pa. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_paToPsi
unknownConvert pascals (Pa) to pounds per square inch (psi). Factor: 1 Pa = 1/6894.757 psi. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_psiToMpa
unknownConvert pounds per square inch (psi) to megapascals (MPa). Factor: 1 psi = 0.006894757 MPa.
Entitiescalculation, unit, leaseInputs: value.
units_mpaToPsi
unknownConvert megapascals (MPa) to pounds per square inch (psi). Factor: 1 MPa = 1/0.006894757 psi.
Entitiescalculation, unit, leaseInputs: value.
units_psiToKgCm2
unknownConvert pounds per square inch (psi) to kilograms-force per square centimeter (kgf/cm2).
Entitiescalculation, unit, leaseInputs: value.
units_kgCm2ToPsi
unknownConvert kilograms-force per square centimeter (kgf/cm2) to pounds per square inch (psi).
Entitiescalculation, unit, leaseInputs: value.
units_psiToInHg
unknownConvert pounds per square inch (psi) to inches of mercury (inHg). Factor: 1 psi = 2.03602 inHg.
Entitiescalculation, unit, leaseInputs: value.
units_inHgToPsi
unknownConvert inches of mercury (inHg) to pounds per square inch (psi). Factor: 1 inHg = 1/2.03602 psi.
Entitiescalculation, unit, leaseInputs: value.
units_psiToFtH2O
unknownConvert pounds per square inch (psi) to feet of water column (ftH2O). Factor: 1 psi = 2.30666 ftH2O.
Entitiescalculation, unit, leaseInputs: value.
units_ftH2OToPsi
unknownConvert feet of water column (ftH2O) to pounds per square inch (psi).
Entitiescalculation, unit, leaseInputs: value.
units_lbFt3ToKgM3
unknownConvert pounds per cubic foot (lb/ft3) to kilograms per cubic meter (kg/m3).
Entitiescalculation, unit, leaseInputs: value.
units_kgM3ToLbFt3
unknownConvert kilograms per cubic meter (kg/m3) to pounds per cubic foot (lb/ft3).
Entitiescalculation, unit, leaseInputs: value.
units_apiToSg
unknownConvert API gravity (API) to specific gravity (SG). Factor: SG = 141.5/(131.5+API). Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_sgToApi
unknownConvert specific gravity (SG) to API gravity (API). Factor: API = 141.5/SG - 131.5. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_sgToLbGal
unknownConvert specific gravity (SG) to pounds per gallon (lb/gal). Factor: 1 SG = 8.345404 lb/gal.
Entitiescalculation, unit, leaseInputs: value.
units_lbGalToSg
unknownConvert pounds per gallon (lb/gal) to specific gravity (SG). Factor: 1 lb/gal = 1/8.345404 SG.
Entitiescalculation, unit, leaseInputs: value.
units_lbFt3ToLbGal
unknownConvert pounds per cubic foot (lb/ft3) to pounds per gallon (lb/gal).
Entitiescalculation, unit, leaseInputs: value.
units_lbGalToLbFt3
unknownConvert pounds per gallon (lb/gal) to pounds per cubic foot (lb/ft3).
Entitiescalculation, unit, leaseInputs: value.
units_ppgToPsiFtGradient
unknownConvert mud weight in pounds per gallon (ppg) to pressure gradient in psi per foot (psi/ft).
Entitiescalculation, unit, leaseInputs: value.
units_psiFtGradientToPpg
unknownConvert pressure gradient in psi per foot (psi/ft) to mud weight in pounds per gallon (ppg).
Entitiescalculation, unit, leaseInputs: value.
units_fToC
unknownConvert degrees Fahrenheit (F) to degrees Celsius (C). Factor: C = (F - 32)*5/9. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_cToF
unknownConvert degrees Celsius (C) to degrees Fahrenheit (F). Factor: F = C*9/5 + 32. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_fToK
unknownConvert degrees Fahrenheit (F) to Kelvin (K). Factor: K = (F + 459.67)*5/9. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kToF
unknownConvert Kelvin (K) to degrees Fahrenheit (F). Factor: F = K*9/5 - 459.67. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_cToK
unknownConvert degrees Celsius (C) to Kelvin (K). Factor: K = C + 273.15. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kToC
unknownConvert Kelvin (K) to degrees Celsius (C). Factor: C = K - 273.15. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_fToR
unknownConvert degrees Fahrenheit (F) to degrees Rankine (R). Factor: R = F + 459.67. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_rToF
unknownConvert degrees Rankine (R) to degrees Fahrenheit (F). Factor: F = R - 459.67. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_cToR
unknownConvert degrees Celsius (C) to degrees Rankine (R). Factor: R = (C + 273.15)*9/5. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_rToC
unknownConvert degrees Rankine (R) to degrees Celsius (C). Factor: C = R*5/9 - 273.15. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_cpToPaS
unknownConvert centipoise viscosity (cP) to pascal-second viscosity (Pa*s). Factor: 1 cP = 0.001 Pa*s.
Entitiescalculation, unit, leaseInputs: value.
units_paSToCp
unknownConvert pascal-second viscosity (Pa*s) to centipoise viscosity (cP). Factor: 1 Pa*s = 1000 cP.
Entitiescalculation, unit, leaseInputs: value.
units_cpToLbFtS
unknownConvert centipoise viscosity (cP) to pounds per foot-second viscosity (lb/(ft*s)).
Entitiescalculation, unit, leaseInputs: value.
units_lbFtSToCp
unknownConvert pounds per foot-second viscosity (lb/(ft*s)) to centipoise viscosity (cP).
Entitiescalculation, unit, leaseInputs: value.
units_mdToM2
unknownConvert millidarcys permeability (md) to square meters (m2). Factor: 1 md = 9.869233e-16 m2.
Entitiescalculation, unit, leaseInputs: value.
units_m2ToMd
unknownConvert square meters (m2) to millidarcys permeability (md). Factor: 1 m2 = 1/9.869233e-16 md.
Entitiescalculation, unit, leaseInputs: value.
units_mdToUm2
unknownConvert millidarcys permeability (md) to square micrometers (um2). Factor: 1 md = 0.0009869233 um2.
Entitiescalculation, unit, leaseInputs: value.
units_um2ToMd
unknownConvert square micrometers (um2) to millidarcys permeability (md).
Entitiescalculation, unit, leaseInputs: value.
units_darcyToMd
unknownConvert darcys permeability (darcy) to millidarcys permeability (md). Factor: 1 darcy = 1000 md.
Entitiescalculation, unit, leaseInputs: value.
units_mdToDarcy
unknownConvert millidarcys permeability (md) to darcys permeability (darcy). Factor: 1 md = 1/1000 darcy.
Entitiescalculation, unit, leaseInputs: value.
units_bblDToM3D
unknownConvert barrels per day (bbl/d) to cubic meters per day (m3/d). Factor: 1 bbl/d = 0.158987 m3/d.
Entitiescalculation, unit, leaseInputs: value.
units_m3DToBblD
unknownConvert cubic meters per day (m3/d) to barrels per day (bbl/d). Factor: 1 m3/d = 1/0.158987 bbl/d.
Entitiescalculation, unit, leaseInputs: value.
units_bblDToGalMin
unknownConvert barrels per day (bbl/d) to gallons per minute (gal/min).
Entitiescalculation, unit, leaseInputs: value.
units_galMinToBblD
unknownConvert gallons per minute (gal/min) to barrels per day (bbl/d).
Entitiescalculation, unit, leaseInputs: value.
units_mscfDToM3D
unknownConvert thousand standard cubic feet per day (Mscf/d) to cubic meters per day (m3/d).
Entitiescalculation, unit, leaseInputs: value.
units_m3DToMscfD
unknownConvert cubic meters per day (m3/d) to thousand standard cubic feet per day (Mscf/d).
Entitiescalculation, unit, leaseInputs: value.
units_stbDToBblD
unknownConvert stock-tank barrels per day (STB/d) to barrels per day (bbl/d). Factor: 1 STB/d = 1 bbl/d.
Entitiescalculation, unit, leaseInputs: value.
units_bblDToStbD
unknownConvert barrels per day (bbl/d) to stock-tank barrels per day (STB/d). Factor: 1 bbl/d = 1 STB/d.
Entitiescalculation, unit, leaseInputs: value.
units_scfStbToM3M3
unknownConvert standard cubic feet per stock-tank barrel (scf/STB) to cubic meters per cubic meter (m3/m3).
Entitiescalculation, unit, leaseInputs: value.
units_m3M3ToScfStb
unknownConvert cubic meters per cubic meter (m3/m3) to standard cubic feet per stock-tank barrel (scf/STB).
Entitiescalculation, unit, leaseInputs: value.
units_scfBblToM3M3
unknownConvert standard cubic feet per barrel (scf/bbl) to cubic meters per cubic meter (m3/m3).
Entitiescalculation, unit, leaseInputs: value.
units_m3M3ToScfBbl
unknownConvert cubic meters per cubic meter (m3/m3) to standard cubic feet per barrel (scf/bbl).
Entitiescalculation, unit, leaseInputs: value.
units_btuToKj
unknownConvert British thermal units (Btu) to kilojoules (kJ). Factor: 1 Btu = 1.05505585262 kJ. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kjToBtu
unknownConvert kilojoules (kJ) to British thermal units (Btu). Factor: 1 kJ = 1/1.05505585262 Btu.
Entitiescalculation, unit, leaseInputs: value.
units_hpToKw
unknownConvert horsepower (hp) to kilowatts (kW). Factor: 1 hp = 0.745699871582 kW. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_kwToHp
unknownConvert kilowatts (kW) to horsepower (hp). Factor: 1 kW = 1/0.745699871582 hp. Ref: NIST.
Entitiescalculation, unit, leaseInputs: value.
units_btuScfToKjM3
unknownConvert Btu per standard cubic foot (Btu/scf) to kilojoules per cubic meter (kJ/m3).
Entitiescalculation, unit, leaseInputs: value.
units_kjM3ToBtuScf
unknownConvert kilojoules per cubic meter (kJ/m3) to Btu per standard cubic foot (Btu/scf).
Entitiescalculation, unit, leaseInputs: value.
units_bblToTonneByApi
unknownConvert barrels (bbl) to metric tonnes using API gravity (tonnes by API). Factor: t=bbl*0.158987*SG.
Entitiescalculation, unit, lease, wellInputs: value, api.
units_tonneToBblByApi
unknownConvert metric tonnes (tonnes) to barrels using API gravity (bbl by API).
Entitiescalculation, unit, lease, wellInputs: value, api.
units_mdFtAngleToTvdFt
unknownConvert measured depth and angle (MD ft and angle) to true vertical depth (TVD ft).
Entitiescalculation, unit, leaseInputs: value, angleDeg.
units_tvdFtAngleToMdFt
unknownConvert true vertical depth and angle (TVD ft and angle) to measured depth (MD ft).
Entitiescalculation, unit, leaseInputs: value, angleDeg.
units_densityKgM3ToApi
unknownConvert kilograms per cubic meter (kg/m3) to API gravity (API).
Entitiescalculation, unit, leaseInputs: value.
units_densityLbFt3ToApi
unknownConvert pounds per cubic foot (lb/ft3) to API gravity (API).
Entitiescalculation, unit, leaseInputs: value.
units_apiToDensityKgM3
unknownConvert API gravity (API) to kilograms per cubic meter (kg/m3). Factor: kg/m3 = SG*1000. Ref: API.
Entitiescalculation, unit, leaseInputs: value.
units_apiToDensityLbFt3
unknownConvert API gravity (API) to pounds per cubic foot (lb/ft3).
Entitiescalculation, unit, leaseInputs: value.
comp_criticalProperties
unknownLookup component critical properties. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: component.
comp_listComponents
readList component table keys. Ref: GPSA Engineering Data Book; Katz et al.
Entitiescalculationcomp_apparentMolecularWeight
unknownCompute apparent molecular weight. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: components, moleFractions.
comp_gasSpecificGravity
unknownCompute gas specific gravity relative to air. Ref: GPSA Engineering Data Book.
EntitiescalculationInputs: apparentMW?, components?, moleFractions?.
comp_pseudoCriticalKay
unknownCompute Kay pseudo-critical temperature and pressure. Ref: Katz et al.
EntitiescalculationInputs: components, moleFractions.
comp_pseudoCriticalSuttonFromSG
unknownCompute Sutton pseudo-criticals from gas gravity. Ref: Sutton 1985.
EntitiescalculationInputs: gasGravity.
comp_pseudoReduced
unknownCompute pseudo-reduced pressure and temperature. Ref: Katz et al.
EntitiescalculationInputs: P, T, Ppc, Tpc.
comp_wichertAzizCorrection
unknownCorrect sour-gas pseudo-critical properties. Ref: Wichert-Aziz 1972.
EntitiescalculationInputs: Tpc, Ppc, yCO2, yH2S.
comp_molarMassFromGravity
unknownConvert gas gravity to molar mass. Ref: GPSA Engineering Data Book.
EntitiescalculationInputs: gasGravity.
comp_gasDensityIdeal
unknownCompute ideal gas density in field units. Ref: GPSA Engineering Data Book.
EntitiescalculationInputs: P, T, MW.
comp_componentWeightFractions
unknownConvert component mole fractions to weight fractions. Ref: Katz et al.
Entitiescalculation, frac_job, completionInputs: components, moleFractions.
comp_componentMoleFractions
unknownConvert component weight fractions to mole fractions. Ref: Katz et al.
Entitiescalculation, frac_job, completionInputs: components, weightFractions.
comp_mixtureCriticalTemperature
unknownCompute Kay mixture critical temperature. Ref: Katz et al.
EntitiescalculationInputs: components, moleFractions.
comp_mixturePseudoCriticalPressure
unknownCompute Kay mixture pseudo-critical pressure. Ref: Katz et al.
EntitiescalculationInputs: components, moleFractions.
comp_standingKatzPseudoCriticals
unknownCompute Standing-Katz pseudo-criticals from gas gravity. Ref: Katz et al.
EntitiescalculationInputs: gasGravity, type.
comp_criticalTemperature
unknownLookup component critical temperature. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: component.
comp_criticalPressure
unknownLookup component critical pressure. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: component.
comp_acentricFactor
unknownLookup component acentric factor. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: component.
comp_molecularWeight
unknownLookup component molecular weight. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: component.
comp_normalBoilingPoint
unknownLookup component normal boiling point. Ref: GPSA Engineering Data Book; Katz et al.
EntitiescalculationInputs: component.
pet_archieFormationFactor
unknownArchie F, F=a/phi^m. Ref: Archie 1942.
Entitiescalculation, formationInputs: a, m, phi_fraction.
pet_archieWaterSaturation
unknownArchie Sw, Sw=((a*Rw)/(phi^m*Rt))^(1/n). Ref: Archie 1942.
EntitiescalculationInputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m.
pet_archieResistivityIndex
unknownArchie RI, RI=Rt/Ro. Ref: Archie 1942.
EntitiescalculationInputs: rt_ohm_m, ro_ohm_m.
pet_resistivityIndexFromSaturation
unknownResistivity index from water saturation, RI=Sw^-n (Archie 1942).
EntitiescalculationInputs: sw_fraction, n.
pet_archieResistivityAtSaturation
unknownArchie Rt, Rt=(a*Rw)/(phi^m*Sw^n). Ref: Archie 1942.
EntitiescalculationInputs: a, m, n, rw_ohm_m, phi_fraction, sw_fraction.
pet_archiePorosityFromRt
unknownArchie phi, phi=((a*Rw)/(Rt*Sw^n))^(1/m). Ref: Archie 1942.
EntitiescalculationInputs: a, m, n, rw_ohm_m, rt_ohm_m, sw_fraction.
pet_archieSaturationExponent
unknownArchie n, n=ln(aRw/(phi^m*Rt))/ln(Sw). Ref: Archie 1942.
EntitiescalculationInputs: a, m, rw_ohm_m, phi_fraction, rt_ohm_m, sw_fraction.
pet_archieCementationExponent
unknownArchie m, m=ln(aRw/(Rt*Sw^n))/ln(phi). Ref: Archie 1942.
EntitiescalculationInputs: a, n, rw_ohm_m, phi_fraction, rt_ohm_m, sw_fraction.
pet_porosityDensity
unknownDensity porosity, phi=(rhoma-rhob)/(rhoma-rhofl). Ref: Schlumberger.
EntitiescalculationInputs: rhoma_g_cm3, rhofl_g_cm3, rhob_g_cm3.
pet_porosityDensityShaleCorrected
unknownDensity shale correction, phiE=phiD-Vsh*phiDsh. Ref: Schlumberger.
EntitiescalculationInputs: rhoma_g_cm3, rhofl_g_cm3, rhob_g_cm3, rhosh_g_cm3, vsh_fraction.
pet_matrixDensityFromDensityPorosity
unknownMatrix density, rhoma=(rhob-phi*rhofl)/(1-phi). Ref: Schlumberger.
EntitiescalculationInputs: rhob_g_cm3, rhofl_g_cm3, phi_fraction.
pet_porosityNeutronDensity
unknownNeutron-density porosity, phi=sqrt((phiN^2+phiD^2)/2). Ref: Schlumberger.
EntitiescalculationInputs: phi_neutron_fraction, phi_density_fraction.
pet_porosityNeutronShaleCorrected
unknownNeutron shale correction, phiE=phiN-Vsh*phiNsh. Ref: Schlumberger.
EntitiescalculationInputs: phi_neutron_fraction, vsh_fraction, phi_neutron_shale_fraction.
pet_porositySonicWyllie
unknownSonic Wyllie porosity, phi=(dt-dtma)/(dtfl-dtma). Ref: Schlumberger.
EntitiescalculationInputs: dt_us_ft, dtma_us_ft, dtfl_us_ft.
pet_porositySonicRaymerHuntGardner
unknownSonic RHG porosity, 1/dt=(1-phi)^2/dtma+phi/dtfl. Ref: Schlumberger.
EntitiescalculationInputs: dt_us_ft, dtma_us_ft, dtfl_us_ft.
pet_porositySonic
unknownSonic porosity pair, phiW=(dt-dtma)/(dtfl-dtma). Ref: Schlumberger.
EntitiescalculationInputs: dt_us_ft, dtma_us_ft, dtfl_us_ft.
pet_secondaryPorosityIndex
unknownSecondary porosity index, SPI=phiND-phiS. Ref: Schlumberger.
EntitiescalculationInputs: phi_neutron_density_fraction, phi_sonic_fraction.
pet_totalPorosity
unknownTotal porosity, phiT=phiE+Vsh*phiSh. Ref: Schlumberger.
EntitiescalculationInputs: phi_effective_fraction, vsh_fraction, phi_shale_fraction.
pet_effectivePorosity
unknownEffective porosity, phiE=phiT-Vsh*phiSh. Ref: Schlumberger.
EntitiescalculationInputs: phi_total_fraction, vsh_fraction, phi_shale_fraction.
pet_gammaRayIndex
unknownGamma-ray index, IGR=(GR-GRmin)/(GRmax-GRmin). Ref: Asquith-Krygowski.
EntitiescalculationInputs: gr_api, gr_min_api, gr_max_api.
pet_vshaleLinear
unknownLinear shale volume, Vsh=IGR. Ref: Asquith-Krygowski.
EntitiescalculationInputs: igr_fraction.
pet_vshaleLarionovTertiary
unknownLarionov Tertiary Vsh, Vsh=0.083*(2^(3.7*IGR)-1). Ref: Schlumberger.
EntitiescalculationInputs: igr_fraction.
pet_vshaleLarionovOlder
unknownLarionov older Vsh, Vsh=0.33*(2^(2*IGR)-1). Ref: Schlumberger.
EntitiescalculationInputs: igr_fraction.
pet_vshaleClavier
unknownClavier shale volume, Vsh=1.7-sqrt(3.38-(IGR+0.7)^2). Ref: Schlumberger.
EntitiescalculationInputs: igr_fraction.
pet_vshaleSteiber
unknownSteiber shale volume, Vsh=IGR/(3-2*IGR). Ref: Schlumberger.
EntitiescalculationInputs: igr_fraction.
pet_rwTemperatureCorrection
unknownArps resistivity correction, R2=R1*(T1+6.77)/(T2+6.77). Ref: Arps.
EntitiescalculationInputs: r1_ohm_m, t1_f, t2_f.
pet_rmfAtFormationTemp
unknownRmf at formation temp, Rmf2=Rmf1*(T1+6.77)/(Tf+6.77). Ref: Arps.
Entitiescalculation, formationInputs: rmf1_ohm_m, measured_temp_f, formation_temp_f.
pet_rwFromSp
unknownSP water resistivity, Rw=Rmf/10^(-SSP/K). Ref: Asquith-Krygowski.
EntitiescalculationInputs: ssp_mv, rmf_ohm_m, formation_temp_f.
pet_staticSpFromRw
unknownStatic SP, SSP=-K*log10(Rmf/Rw). Ref: Asquith-Krygowski.
EntitiescalculationInputs: rw_ohm_m, rmf_ohm_m, formation_temp_f.
pet_formationTemperature
unknownFormation temperature, Tf=Ts+grad*depth/100. Ref: Asquith-Krygowski.
Entitiescalculation, formationInputs: surface_temp_f, gradient_f_per_100ft, tvd_ft.
pet_bulkVolumeWater
unknownBulk volume water, BVW=phi*Sw. Ref: Schlumberger.
Entitiescalculation, productionInputs: phi_fraction, sw_fraction.
pet_bulkVolumeWaterFlushed
unknownFlushed BVW, BVWxo=phi*Sxo. Ref: Schlumberger.
Entitiescalculation, productionInputs: phi_fraction, sxo_fraction.
pet_moveableHydrocarbons
unknownMoveable hydrocarbons, BVHmov=phi*(Sxo-Sw). Ref: Schlumberger.
EntitiescalculationInputs: phi_fraction, sw_fraction, sxo_fraction.
pet_hydrocarbonSaturation
unknownHydrocarbon saturation, Sh=1-Sw. Ref: Schlumberger.
EntitiescalculationInputs: sw_fraction.
pet_residualHydrocarbonSaturation
unknownResidual hydrocarbon saturation, Shr=1-Sxo. Ref: Schlumberger.
EntitiescalculationInputs: sxo_fraction.
pet_waterFilledPorosity
unknownWater-filled porosity, WFP=phi*Sw. Ref: Schlumberger.
EntitiescalculationInputs: phi_fraction, sw_fraction.
pet_swSimandoux
unknownSimandoux Sw, Ct=A*Sw^n+B*Sw. Ref: Schlumberger.
EntitiescalculationInputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m, vsh_fraction, rsh_ohm_m.
pet_swIndonesia
unknownIndonesia Sw, 1/sqrt(Rt)=A*Sw^(n/2). Ref: Poupon-Leveaux.
EntitiescalculationInputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m, vsh_fraction, rsh_ohm_m.
pet_swWaxmanSmits
unknownWaxman-Smits Sw, Ct=A(Cw*Sw^n+BQv*Sw^(n-1)). Ref: Waxman-Smits.
EntitiescalculationInputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m, bqv_s_per_m.
pet_permeabilityTimur
unknownTimur permeability, k=8581*phi^4.4/Swirr^2. Ref: Asquith-Krygowski.
EntitiescalculationInputs: phi_fraction, swirr_fraction.
pet_permeabilityCoatesDumanoir
unknownCoates-Dumanoir k, k=(C*phi^2*((1-Swirr)/Swirr))^2. Ref: Schlumberger.
EntitiescalculationInputs: phi_fraction, swirr_fraction, c_factor?.
pet_permeabilityWyllieRose
unknownWyllie-Rose permeability, k=(C*phi^3/Swirr)^2. Ref: Asquith-Krygowski.
EntitiescalculationInputs: phi_fraction, swirr_fraction, coefficient_md? (C in sqrt(md), 250 oil).
pet_permeabilityMorris
unknownMorris-Biggs permeability, k=C*phi^6/Swirr^2. Ref: Asquith-Krygowski.
EntitiescalculationInputs: phi_fraction, swirr_fraction, fluid?.
pet_netPayFlag
unknownNet pay flag, pay=phi>=cutoff && Sw<=cutoff && Vsh<=cutoff. Ref: Schlumberger.
EntitiescalculationInputs: phi_fraction, sw_fraction, vsh_fraction, phi_cutoff_fraction, sw_cutoff…
pet_netToGross
unknownNet-to-gross, NTG=net/gross. Ref: Schlumberger.
EntitiescalculationInputs: net_pay_ft, gross_thickness_ft.
pet_hydrocarbonPoreVolume
unknownHydrocarbon pore volume, HCPV=phi*(1-Sw)*h*area. Ref: Schlumberger.
Entitiescalculation, productionInputs: phi_fraction, sw_fraction, thickness_ft, area_acres.
pet_pickettSlope
unknownPickett slope, m=-dlog(Rt)/dlog(phi). Ref: Archie 1942.
EntitiescalculationInputs: phi1_fraction, rt1_ohm_m, phi2_fraction, rt2_ohm_m.
pet_pickettSwFromPoint
unknownPickett Sw, Sw=((a*Rw)/(phi^m*Rt))^(1/n). Ref: Archie 1942.
EntitiescalculationInputs: a, m, n, rw_ohm_m, phi_fraction, rt_ohm_m.
pet_apparentWaterResistivity
unknownApparent water resistivity, Rwa=phi^m*Rt/a. Ref: Archie 1942.
EntitiescalculationInputs: a, m, phi_fraction, rt_ohm_m.
pet_flushedZoneWaterSaturation
unknownFlushed-zone Sw, Sxo=((a*Rmf)/(phi^m*Rxo))^(1/n). Ref: Archie 1942.
EntitiescalculationInputs: a, m, n, rmf_ohm_m, phi_fraction, rxo_ohm_m.
drill_hydrostaticPressure
unknownHydrostatic pressure psi: P=0.052*MW*TVD. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: mudWeight_ppg, tvd_ft.
drill_mudWeightFromGradient
unknownMud weight ppg: MW=gradient/0.052. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: pressureGradient_psi_per_ft.
drill_pressureGradientFromMudWeight
unknownPressure gradient psi/ft: G=0.052*MW. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: mudWeight_ppg.
drill_equivalentMudWeight
unknownEquivalent mud weight ppg: EMW=P/(0.052*TVD). Ref: Bourgoyne/API13D.
EntitiescalculationInputs: pressure_psi, tvd_ft.
drill_ecd
unknownEquivalent circulating density ppg: ECD=MW+dP/(0.052*TVD). Ref: API13D.
EntitiescalculationInputs: mudWeight_ppg, annularPressureLoss_psi, tvd_ft.
drill_annularVelocity
unknownAnnular velocity ft/min: AV=24.51*q/(Dh^2-Dp^2). Ref: API13D.
EntitiescalculationInputs: flowRate_gpm, holeDiameter_in, pipeOuterDiameter_in.
drill_pipeVelocity
unknownPipe velocity ft/min: V=24.51*q/ID^2. Ref: API13D.
EntitiescalculationInputs: flowRate_gpm, pipeInnerDiameter_in.
drill_criticalVelocity
unknownCritical velocity ft/s: Vc=Re*mu/(928*MW*D). Ref: API13D.
EntitiescalculationInputs: mudWeight_ppg, viscosity_cp, hydraulicDiameter_in, criticalReynoldsNumb…
drill_pumpOutputTriplex
unknownTriplex pump output bbl/stk: O=0.000243*D^2*S*E. Ref: Bourgoyne.
EntitiescalculationInputs: linerDiameter_in, strokeLength_in, pumpEfficiency_fraction, pumpSpeed_s…
drill_pumpOutputDuplex
unknownDuplex pump output bbl/stk: O=0.000162*S*(2D^2-r^2)*E. Ref: Bourgoyne.
EntitiescalculationInputs: linerDiameter_in, rodDiameter_in, strokeLength_in, pumpEfficiency_fract…
drill_pumpPressureFromHHP
unknownPump pressure psi: P=HHP*1714/q. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: hydraulicHorsepower_hp, flowRate_gpm.
drill_strokesToBottomsUp
unknownBottoms-up strokes: strokes=annularVolume/pumpOutput. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: holeDiameter_in, pipeOuterDiameter_in, measuredDepth_ft, pumpOutput_bbl…
drill_annularCapacity
unknownAnnular capacity bbl/ft: C=(Dh^2-Dp^2)/1029.4. Ref: Bourgoyne.
EntitiescalculationInputs: holeDiameter_in, pipeOuterDiameter_in.
drill_pipeCapacity
unknownPipe capacity bbl/ft: C=ID^2/1029.4. Ref: Bourgoyne.
EntitiescalculationInputs: pipeInnerDiameter_in.
drill_annularVolume
unknownAnnular volume bbl: V=L*(Dh^2-Dp^2)/1029.4. Ref: Bourgoyne.
Entitiescalculation, productionInputs: holeDiameter_in, pipeOuterDiameter_in, length_ft.
drill_pipeDisplacement
unknownPipe displacement bbl: V=L*(OD^2-ID^2)/1029.4. Ref: Bourgoyne.
EntitiescalculationInputs: pipeOuterDiameter_in, pipeInnerDiameter_in, length_ft.
drill_holeVolume
unknownHole volume bbl: V=L*Dh^2/1029.4. Ref: Bourgoyne.
Entitiescalculation, productionInputs: holeDiameter_in, length_ft.
drill_lagTime
unknownLag time min: t=annularVolume/(q/42). Ref: Bourgoyne/API13D.
EntitiescalculationInputs: holeDiameter_in, pipeOuterDiameter_in, measuredDepth_ft, flowRate_gpm.
drill_bitNozzleArea
unknownBit nozzle TFA in2: A=sum(pi/4*(n/32)^2). Ref: Bourgoyne/API13D.
EntitiescalculationInputs: nozzleDiameters_32nds.
drill_jetVelocity
unknownJet velocity ft/s: Vj=0.32086*q/TFA. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: flowRate_gpm, totalFlowArea_in2.
drill_bitPressureDrop
writeBit dP psi: dP=156.5*MW*q^2/(sum d32^2)^2. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: mudWeight_ppg, flowRate_gpm, totalFlowArea_in2.
drill_hydraulicHorsepower
unknownHydraulic horsepower hp: HHP=q*dP/1714. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: flowRate_gpm, pressureDrop_psi.
drill_bitArea
unknownBit area in2: A=pi*D^2/4. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: bitDiameter_in.
drill_hsi
unknownHSI hp/in2: HSI=(q*dP/1714)/(pi*Db^2/4). Ref: Bourgoyne/API13D.
EntitiescalculationInputs: flowRate_gpm, bitPressureDrop_psi, bitDiameter_in.
drill_jetImpactForce
unknownJet impact force lbf: JIF=0.01823*q*sqrt(MW*dP). Ref: Bourgoyne/API13D.
EntitiescalculationInputs: flowRate_gpm, mudWeight_ppg, bitPressureDrop_psi.
drill_pressureDropAtBitFraction
writeBit pressure fraction: f=dPbit/Ppump. Ref: Bourgoyne/API13D.
Entitiescalculation, frac_job, completionInputs: bitPressureDrop_psi, pumpPressure_psi.
drill_optimumFlowExponent
unknownFlow exponent m=ln(dP2/dP1)/ln(q2/q1); optimum bit share m/(m+1) HHP, m/(m+2) JIF.
EntitiescalculationpressureDrop1/2_psi = parasitic (non-bit) losses at flowRate1/2_gpm.
drill_plasticViscosity
unknownPlastic viscosity cp: PV=theta600-theta300. Ref: API13D.
EntitiescalculationInputs: theta600, theta300.
drill_yieldPoint
unknownYield point lbf/100ft2: YP=theta300-PV. Ref: API13D.
EntitiescalculationInputs: theta300, plasticViscosity_cp.
drill_apparentViscosity
unknownApparent viscosity cp: AV=theta600/2. Ref: API13D.
EntitiescalculationInputs: theta600.
drill_powerLawN
unknownPower-law n: n=3.32*log10(theta600/theta300). Ref: API13D.
EntitiescalculationInputs: theta600, theta300.
drill_powerLawK
unknownPower-law K in lbf*s^n/100ft2 = 1.0672*theta300/511^n (5.11 dyn/cm2/deg). API13D.
EntitiescalculationInputs: theta600, theta300. Also returns Kp dyn*s^n/cm2 and dial-unit K.
drill_gelStrength
unknownGel strength lbf/100ft2: G=theta3 after static time. Ref: API13D.
EntitiescalculationInputs: theta3, staticTime_min.
drill_reynoldsPipe
unknownPipe Reynolds: Re=928*MW*V*D/mu_eff. Ref: Bourgoyne/API13D.
EntitiescalculationInputs: flowRate_gpm, pipeInnerDiameter_in, mudWeight_ppg, rheologyModel?, plas…
drill_cuttingSlipVelocity
unknownCutting slip ft/s: Vs=sqrt(4*g*d*(rhos-rhom)/(3*Cd*rhom)). Ref: API13D.
EntitiescalculationInputs: cuttingDiameter_in, cuttingsDensity_ppg, mudWeight_ppg, fluidViscosity_…
drill_cuttingsCarryingCapacity
unknownCuttings carrying fraction: C=max(0,(AV-Vs)/AV). Ref: Bourgoyne/API13D.
EntitiescalculationInputs: annularVelocity_ft_min, slipVelocity_ft_min.
drill_killMudWeight
unknownKill mud weight ppg: KMW=MW+SIDPP/(0.052*TVD). Ref: Bourgoyne.
EntitiescalculationInputs: currentMudWeight_ppg, shutInDrillPipePressure_psi, tvd_ft.
drill_maaspMaximumAllowableMudWeight
unknownMAASP psi: MAASP=(FG/0.052-MW)*0.052*TVDshoe. Ref: Bourgoyne.
EntitiescalculationInputs: fractureGradient_psi_per_ft, currentMudWeight_ppg, shoeTVD_ft.
drill_kickTolerance
unknownKick tolerance ppg: KT=FG/0.052-MW-margin. Ref: Bourgoyne.
EntitiescalculationInputs: fractureGradient_psi_per_ft, mudWeight_ppg, shoeTVD_ft, safetyMargin_pp…
drill_formationPressureFromKick
unknownFormation pressure psi: Pf=0.052*MW*TVD+SIDPP. Ref: Bourgoyne.
Entitiescalculation, formationInputs: mudWeight_ppg, tvd_ft, shutInDrillPipePressure_psi.
econ_ooipVolumetric
unknownCalculate OOIP; OOIP=7758*A*h*phi*(1-Sw)/Boi. Ref: SPE PRMS.
Entitiescalculation, productionInputs: area_acres, netPay_ft, porosity_fraction, waterSaturation_fraction, oil…
econ_ogipVolumetric
unknownCalculate OGIP; OGIP=43560*A*h*phi*(1-Sw)/Bgi. Ref: SPE PRMS.
Entitiescalculation, productionInputs: area_acres, netPay_ft, porosity_fraction, waterSaturation_fraction, gas…
econ_recoverableOil
unknownCalculate recoverable oil; R=OOIP*RF. Ref: SPE PRMS.
EntitiescalculationInputs: originalOilInPlace_STB, recoveryFactor_fraction.
econ_recoveryFactor
unknownCalculate recovery factor; RF=recoverable/original. Ref: SPE PRMS.
EntitiescalculationInputs: recoverableVolume_STB, originalVolume_STB.
econ_reservesFromDecline
unknownCalculate decline reserves; R=EUR-Np using Arps qi,Di,b,qab. Ref: Arps 1945.
Entitiescalculation, production, fieldInputs: initialRate_STBPerDay, nominalDeclineRate_perDay, declineExponent, aban…
econ_drainageVolume
unknownCalculate drainage volume; V=A*h. Ref: SPE PRMS.
Entitiescalculation, productionInputs: drainageArea_acres, netPay_ft.
econ_netRockVolume
unknownCalculate net rock volume; NRV=A*Hgross*NTG. Ref: SPE PRMS.
Entitiescalculation, productionInputs: area_acres, grossThickness_ft, netToGross_fraction.
econ_presentValue
unknownCalculate present value; PV=FV/(1+i)^n. Ref: standard DCF.
EntitiescalculationInputs: futureValue_USD, discountRate_fraction, periods.
econ_futureValue
unknownCalculate future value; FV=PV*(1+i)^n. Ref: standard DCF.
EntitiescalculationInputs: presentValue_USD, discountRate_fraction, periods.
econ_npv
unknownCalculate NPV; NPV=sum(CFt/(1+i)^t). Ref: standard DCF.
EntitiescalculationInputs: cashflows_USD[] (CF0 at t=0, end-of-period), discountRate_fraction.
econ_statementCheckup
unknownRevenue-statement rollups: tie-outs, tax/deduction categories, statement-vs-state deltas.
Required paramsstatementpropertiesEntitiescalculationFlat statement.json keys: statement, properties. Unknown labels = deductions.
econ_discountFactor
unknownCalculate discount factor; DF=1/(1+i)^n. Ref: standard DCF.
EntitiescalculationInputs: discountRate_fraction, periods.
econ_pvAnnuity
unknownCalculate PV of annuity; PV=P*(1-(1+i)^-n)/i. Ref: standard DCF.
EntitiescalculationInputs: payment_USD, discountRate_fraction, periods.
econ_irr
unknownCalculate IRR; sum(CFt/(1+r)^t)=0. Ref: standard DCF.
EntitiescalculationInputs: cashflows_USD[] (CF0 at t=0), guess_fraction?, tolerance?.
econ_paybackPeriod
unknownCalculate payback period; cumulative CF reaches zero. Ref: standard DCF.
EntitiescalculationInputs: cashflows_USD[] (CF0 at t=0, end-of-period). Periods, interpolated.
econ_discountedPayback
unknownCalculate discounted payback; cum discounted CF reaches zero. Ref: standard DCF.
EntitiescalculationInputs: cashflows_USD[] (CF0 at t=0, end-of-period), discountRate_fraction.
econ_profitabilityIndex
unknownCalculate profitability index; PI=PV future CF/investment. Ref: standard DCF.
EntitiescalculationInputs: cashflows_USD[], discountRate_fraction, initialInvestment_USD?.
econ_growthRateOfReturn
unknownCalculate CAGR; g=(ending/beginning)^(1/n)-1. Ref: standard DCF.
EntitiescalculationInputs: beginningValue_USD, endingValue_USD, periods.
econ_grossRevenue
unknownCalculate gross revenue; GR=q*price. Ref: standard DCF.
EntitiescalculationInputs: salesRate_bblPerDay, price_USDPerBbl.
econ_netRevenueInterest
unknownCalculate NRI; NRI=WI*(1-royalty). Ref: standard DCF.
Entitiescalculation, ownershipInputs: workingInterest_fraction, royalty_fraction.
econ_workingInterestRevenue
unknownCalculate WI revenue; WIR=grossRevenue*WI. Ref: standard DCF.
Entitiescalculation, ownershipInputs: grossRevenue_USD, workingInterest_fraction.
econ_royaltyValue
unknownCalculate royalty value; royalty=grossRevenue*royaltyRate. Ref: standard DCF.
Entitiescalculation, production, ownershipInputs: grossRevenue_USD, royalty_fraction.
econ_netRevenue
unknownCalculate net revenue; NR=grossRevenue*NRI. Ref: standard DCF.
EntitiescalculationInputs: grossRevenue_USD, netRevenueInterest_fraction.
econ_severanceTax
unknownCalculate severance tax; tax=taxableRevenue*taxRate. Ref: standard DCF.
EntitiescalculationInputs: taxableRevenue_USD, taxRate_fraction.
econ_operatingCashFlow
unknownCalculate operating cash flow; OCF=NR-opex-tax. Ref: standard DCF.
EntitiescalculationInputs: netRevenue_USD, operatingExpense_USD, tax_USD.
econ_netCashFlow
unknownCalculate net cash flow; NCF=rev-opex-capex-tax. Ref: standard DCF.
EntitiescalculationInputs: revenue_USD, operatingExpense_USD, capitalExpense_USD, tax_USD.
econ_breakevenPrice
unknownCalculate breakeven price; P=cost/(volume*NRI). Ref: standard DCF.
Entitiescalculation, commodityInputs: totalCost_USD, salesVolume_bbl, netRevenueInterest_fraction.
econ_breakevenVolume
unknownCalculate breakeven volume; V=cost/(price*NRI). Ref: standard DCF.
Entitiescalculation, productionInputs: totalCost_USD, price_USDPerBbl, netRevenueInterest_fraction.
econ_unitTechnicalCost
unknownCalculate unit technical cost; UTC=(capex+opex+abex)/volume. Ref: SPE PRMS.
Entitiescalculation, unit, leaseInputs: capitalCost_USD, operatingCost_USD, abandonmentCost_USD?, recoverableVo…
econ_returnOnInvestment
unknownCalculate ROI; ROI=netProfit/investment. Ref: standard DCF.
EntitiescalculationInputs: netProfit_USD, investment_USD.
econ_capitalEfficiency
unknownCalculate capital efficiency; CE=NPV/capex. Ref: standard DCF.
EntitiescalculationInputs: npv_USD, capex_USD.
econ_findingDevelopmentCost
unknownCalculate F&D cost; FDC=cost/reservesAdded. Ref: SPE PRMS.
EntitiescalculationInputs: findingDevelopmentCost_USD, reservesAdded_STB.
econ_economicLimitRate
unknownCalculate economic limit rate; q=opex/(price*NRI*conv). Ref: standard DCF.
EntitiescalculationInputs: operatingExpense_USDPerDay, price_USDPerBbl, netRevenueInterest_fractio…
geo_overburdenGradient
unknownIntegrate density to OBG; OBG=sum(rho/144 dz)/sum(dz); Ref: Zoback.
Entitiescalculationgeo_overburdenStress
unknownConvert OBG to overburden stress; Sv=OBG*z; Ref: Zoback.
Entitiescalculationgeo_verticalStressFromDensityLog
unknownIntegrate density log to vertical stress; Sv=sum(rho/144 dz); Ref: Zoback.
Entitiescalculationgeo_porePressureEatonResistivity
unknownEaton resistivity PP; PPg=OBG-(OBG-Pn)(Robs/Rn)^1.2; Ref: Eaton 1975.
Entitiescalculationgeo_porePressureEatonSonic
unknownEaton sonic PP; PPg=OBG-(OBG-Pn)(DTn/DTo)^3; Ref: Eaton 1975.
Entitiescalculationgeo_porePressureBowers
unknownBowers PP from velocity; Pp=Sv-((Vp-V0)/A)^(1/B); Ref: Bowers 1995.
Entitiescalculationgeo_normalPorePressure
unknownNormal hydrostatic PP; Pn=rho_fluid*z/144; Ref: Zoback.
Entitiescalculationgeo_fractureGradientEaton
unknownEaton fracture gradient; FG=nu/(1-nu)(OBG-PP)+PP; Ref: Eaton 1975.
Entitiescalculation, frac_job, completiongeo_fractureGradientMatthewsKelly
unknownMatthews-Kelly FG; FG=Ki(OBG-PP)+PP; Ref: Matthews-Kelly 1967.
Entitiescalculation, frac_job, completiongeo_fractureGradientHubbertWillis
unknownHubbert-Willis FG; FG=(OBG-PP)/3+PP; Ref: Hubbert-Willis 1957.
Entitiescalculation, frac_job, completiongeo_fractureGradientDaines
unknownDaines fracture gradient; FG=nu/(1-nu)(OBG-aPP)+aPP+T; Ref: Daines.
Entitiescalculation, frac_job, completiongeo_leakOffPressure
unknownLeak-off pressure from FG; P=FG*z; Ref: Zoback.
Entitiescalculationgeo_effectiveStress
unknownTerzaghi effective stress; sigma_eff=sigma-alpha Pp; Ref: Zoback.
Entitiescalculationgeo_biotCoefficient
unknownBiot coefficient; alpha=1-Kdry/Kgrain; Ref: Zoback.
Entitiescalculationgeo_sonicVelocityFromSlowness
unknownConvert sonic slowness to velocity; V=1e6/DT; Ref: log unit definition.
Entitiescalculationgeo_dynamicYoungsModulus
unknownDynamic Young modulus; E=2G(1+nu); Ref: Zoback log mechanics.
Entitiescalculationgeo_dynamicPoissonsRatio
unknownDynamic Poisson ratio; nu=(R^2-2)/(2(R^2-1)); Ref: Zoback.
Entitiescalculationgeo_shearModulus
unknownDynamic shear modulus; G=C rho Vs^2; Ref: Zoback log mechanics.
Entitiescalculationgeo_bulkModulus
unknownDynamic bulk modulus; K=C rho(Vp^2-4Vs^2/3); Ref: Zoback.
Entitiescalculationgeo_compressibilityFromModulus
unknownCompressibility from modulus; c=1/M; Ref: Zoback.
Entitiescalculationgeo_vpvsRatio
unknownVelocity ratio; R=Vp/Vs; Ref: sonic log unit definition.
Entitiescalculationgeo_pWaveModulus
unknownP-wave modulus; M=C rho Vp^2; Ref: Zoback log mechanics.
Entitiescalculationgeo_staticFromDynamicModulus
unknownStatic modulus correlation; Est=a Edyn+b; Ref: Zoback empirical.
Entitiescalculationgeo_ucsFromSonic
unknownEmpirical UCS from sonic; UCS=f(Vp or DT); Ref: Horsrud/McNally/Freyburg.
Entitiescalculationgeo_frictionAngleFromUCS
unknownFriction angle from UCS; phi=a+b log10(UCS/1000); Ref: Zoback empirical.
Entitiescalculationgeo_mohrCoulombShearStrength
unknownMohr-Coulomb shear strength; tau=c+sigma_n tan(phi); Ref: Zoback.
Entitiescalculationgeo_principalStressAtFailure
unknownPrincipal failure stress; sigma1=UCS+q sigma3; Ref: Zoback.
Entitiescalculationgeo_minimumHorizontalStress
unknownMinimum horizontal stress; Sh=nu/(1-nu)(Sv-aPp)+aPp+T; Ref: Zoback.
Entitiescalculation, formationgeo_breakdownPressure
unknownBreakdown pressure; Pb=3Shmin-SHmax-aPp+T0; Ref: Hubbert-Willis.
Entitiescalculationgeo_collapsePressure
unknownCollapse pressure; Pw=(3SH-Sh-UCS+aPp(q-1))/(1+q); Ref: Zoback.
Entitiescalculationgeo_horizontalStressPoroelastic
unknownPoroelastic horizontal stresses; Sh=base+E strain/(1-nu^2); Ref: Zoback.
Entitiescalculation, formationgeo_stressPolygonBounds
unknownStress polygon bounds; S1e/S3e<=Q(mu); Ref: Zoback Reservoir Geomechanics.
Entitiescalculationtub_barlowBurstPressure
unknownBarlow burst pressure, Pb = 2*Yp*t*f/D. Ref API 5C3.
EntitiescalculationInputs: od_in, t_in, Yp_psi, wallFactor?.
tub_internalYieldPressure
unknownInternal yield pressure, Piy = 2*Yp*t*f/D. Ref API 5C3.
EntitiescalculationInputs: od_in, t_in, Yp_psi, wallFactor?.
tub_burstSafetyFactor
unknownBurst safety factor, SF = Pb/Papplied. Ref Bourgoyne/API 5C3.
EntitiescalculationInputs: burstPressure_psi, appliedPressure_psi.
tub_collapsePressureYield
unknownYield collapse pressure, Pyp = 2*Yp*(D/t-1)/(D/t)^2. Ref API 5C3.
EntitiescalculationInputs: od_in, t_in, Yp_psi.
tub_collapsePlasticElastic
unknownCollapse selector, Pc = API 5C3 four-regime D/t model. Ref API 5C3.
EntitiescalculationInputs: od_in, t_in, Yp_psi.
tub_collapseSafetyFactor
unknownCollapse safety factor, SF = Pc/Papplied. Ref Bourgoyne/API 5C3.
EntitiescalculationInputs: collapsePressure_psi, appliedPressure_psi.
tub_pipeBodyYieldStrength
unknownPipe body yield strength, T = Yp*A. Ref API 5C3/Bourgoyne.
EntitiescalculationInputs: od_in, id_in, Yp_psi.
tub_jointStrength
unknownApprox joint strength, Tj = efficiency*Yp*A. Ref API 5C2.
EntitiescalculationInputs: od_in, id_in, Yp_psi, jointEfficiency?.
tub_tensionSafetyFactor
unknownTension safety factor, SF = Trating/Fapplied. Ref Bourgoyne.
EntitiescalculationInputs: tensileRating_lbf, appliedLoad_lbf.
tub_axialStressFromLoad
unknownAxial stress from load, Sa = F/A. Ref Bourgoyne/API 5C3.
EntitiescalculationInputs: load_lbf, area_in2.
tub_pipeCrossSectionalArea
unknownPipe steel area, A = pi/4*(OD^2-ID^2). Ref Bourgoyne.
EntitiescalculationInputs: od_in, id_in.
tub_pipeWeightPerFoot
unknownPipe air weight, W = A/144*rhoSteel. Ref Bourgoyne.
EntitiescalculationInputs: od_in, id_in.
tub_buoyantWeight
unknownBuoyant pipe weight, Wb = Wair*(1-MW/65.4). Ref Bourgoyne.
EntitiescalculationInputs: weight_lb_per_ft, mudWeight_ppg.
tub_buoyancyFactor
unknownBuoyancy factor, BF = 1-MW/65.4. Ref Bourgoyne.
EntitiescalculationInputs: mudWeight_ppg.
tub_airWeightOfString
unknownAir string weight, W = w*L. Ref Bourgoyne.
EntitiescalculationInputs: weight_lb_per_ft, length_ft.
tub_hookLoad
unknownHook load, H = w*L*(1-MW/65.4)+overpull. Ref Bourgoyne.
EntitiescalculationInputs: weight_lb_per_ft, length_ft, mudWeight_ppg, overpull_lbf?.
tub_pipeCapacity
unknownPipe capacity, C = pi/4*ID^2*12/9702. Ref Bourgoyne.
EntitiescalculationInputs: id_in.
tub_pipeDisplacement
unknownPipe displacement, V = pi/4*(OD^2-ID^2)*12. Ref Bourgoyne.
EntitiescalculationInputs: od_in, id_in.
tub_annularCapacityBetweenStrings
unknownAnnular capacity, C = pi/4*(outerID^2-innerOD^2)*12/9702. Ref Bourgoyne.
EntitiescalculationInputs: outerId_in, innerOd_in.
tub_internalVolume
unknownInternal volume, V = capacity*L. Ref Bourgoyne.
Entitiescalculation, productionInputs: id_in, length_ft.
tub_pipeStretchHookesLaw
unknownHooke stretch, e = F*L/(A*E). Ref Bourgoyne.
EntitiescalculationInputs: load_lbf, length_ft, area_in2, E_psi?.
tub_stretchDueToWeight
unknownStretch due to weight, e = w*BF*L*(12L)/(2AE). Ref Bourgoyne.
EntitiescalculationInputs: weight_lb_per_ft, length_ft, area_in2, buoyancyFactor?, E_psi?.
tub_thermalElongation
unknownThermal elongation, dL = alpha*dT*L. Ref Bourgoyne.
EntitiescalculationInputs: length_ft, temperatureChange_F, coefficient_per_F?.
tub_ballooningStretch
unknownBallooning stretch, e = -2*nu*L*(dPi*Ai-dPo*Ao)/(E*As). Ref Bourgoyne.
EntitiescalculationInputs: od_in, id_in, length_ft, internalPressureChange_psi, externalPressureCh…
tub_driftDiameter
unknownDrift diameter, Ddrift = ID-allowance. Ref API 5C2.
Entitiescalculation, facilityInputs: id_in, driftAllowance_in?.
tub_makeupTorque
unknownApprox makeup torque, T = K*F*D/12. Ref API 5C2.
EntitiescalculationInputs: axialPreload_lbf, diameter_in, torqueFactor?.
tub_vonMisesEquivalentStress
unknownVon Mises triaxial stress, seq = sqrt(J2 form). Ref API 5C3.
EntitiescalculationInputs: axialStress_psi, hoopStress_psi, radialStress_psi.
tub_biaxialCollapseDerating
unknownBiaxial collapse derating, Ypa = Yp*(sqrt(1-.75*r^2)-.5*r). Ref API 5C3.
EntitiescalculationInputs: Yp_psi, axialStress_psi, internalPressure_psi?.
tub_minYieldFromGrade
unknownMinimum yield from OCTG grade lookup, Yp = table[grade]. Ref API 5CT/5C3.
EntitiescalculationInputs: grade.
