UPSCALE_RELPERM(1)

πŸ“¦
version 2025.10 Β· 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ‘‘ upscale_relperm(1) β€” the manual page, but make it fashion πŸ’…

okay bestie, sit down, hydrate, because today we're learning upscale_relperm β€” a User Command, section 1 of the manual, and honestly? she's iconic.


✨ NAME ✨

upscale_relperm β€” upscale two-phase relative permeability πŸ›’οΈπŸ’–


🌸 SYNOPSIS 🌸

upscale_relperm [option=value] [grid file] [rock file 1] [rock file 2]
[rock file 3] ...

so it's the command, then a bunch of option=value situations, then a grid file, then as many rock files as your little heart desires. the ... is not decoration, bestie, it's an invitation. 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

We are upscaling two-phase relative permeability in the capillary limit, for lithofacies models described by Eclipse corner point grids. that's the whole job. that's what she does. no cap. πŸ’…

Example usage, straight from the source:

upscale_relperm -bc p grid.grdecl swof1.inc swof2.inc

For isotropic input, the rock file has four columns, and looks like this:

-- Stone 1 -- Sw           Krw             Kro     J-func
  1.42000E-01  0.00000E+00  1.00000E+00  2.25999E+00
  2.79250E-01  1.93652E-03  5.03619E-01  5.76122E-02
  4.14850E-01  1.09648E-02  2.36036E-01  -1.23421E-02
  6.14150E-01  4.10007E-02  3.95006E-02  -8.96693E-02
  7.26100E-01  1.41398E-01  9.30808E-03  -1.19849E-01
  9.48000E-01  8.40000E-01  0.00000E+00  -1.42553E+00

four columns, one header line, Sw, Krw, Kro, J-func. screenshot it. memorize it. it's giving science. πŸ”₯


πŸŽ€ OPTIONS πŸŽ€

one bullet per option, all of them, no skipping, we do not gatekeep here:

  • -bc β€” which boundary conditions to use, bestie. possible values are p (periodic), f (fixed), or l (linear). defaults to f. ✨
  • -points β€” how many saturation points to upscale for, uniformly distributed. defaults to 30. ⭐
  • -upscaleBothPhases β€” whether to upscale both phases or not. defaults to true. πŸ’–
  • -relPermCurve β€” if upscaleBothPhases is false and the input is isotropic, this specifies the column number in the rock-files to be upscaled. defaults to 2. πŸŽ€
  • -jFunctionCurve β€” if upscaleBothPhases is false and the input is isotropic, this is the column number in the stone-files that represent the Leverett J-function. defaults to 4. πŸ¦‹
  • -gravity β€” gravitational acceleration, in m/sΒ². use 9.8 for standard gravity. defaults to 0. 🌈
  • -fluids β€” which two-phase fluid system we are dealing with. possible values are ow (oil/water) and go (gas/oil). defaults to ow. πŸ›’οΈ
  • -surfaceTension β€” surface tension in dynes/cm to use in J-function/Pc conversion. Contact angle is not supported, and β€” yes, the sentence genuinely just stops there in the original, iykyk. 😭
  • -waterDensity β€” density of water, in g/cmΒ³. only relevant for non-zero gravity. if fluids is set to go (gas/oil), this should be set to density of gas. defaults to 1.0. πŸ’§
  • -oilDensity β€” density of oil, in g/cmΒ³. only relevant for non-zero gravity. defaults to 0.6. πŸ’œ
  • -output β€” filename for where to write upscaled values. πŸ“
  • -doEclipseCheck β€” check that input curves include critical saturation points, i.e. saturation points where relperms are 0. see critRelpermThresh. defaults to true. πŸ‘‘
  • -critRelpermThresh β€” if minimum relperm value is less than this value, it is set to 0. only applicable if doEclipseCheck is true. defaults to 1e-6. ⚠️
  • -interpolate β€” if this option is used, the outputted values will be interpolated values using the supplied number of points (integer larger than 0). Monotone cubic interpolation is used, and will thus produce a smooth curve for a few number of saturation points. smooth. glossy. flawless. πŸ’…βœ¨

πŸ› REPORTING BUGS πŸ›

Report on github repository <https://github.com/OPM/opm-upscaling/issues> β€” go tell them, bestie, they're literally so nice about it. πŸ™ˆ


🌟 SEE ALSO 🌟

upscale_perm β€” her sister, also serving. πŸ’–


ngl, if you read all the way down here you are officially the main character of reservoir simulation. periodt. πŸ‘‘

that's the whole vibe check, bestie β€” page written by upscale_relperm 2023.10, dated October 2023. mwah. πŸ’‹πŸŽ€