OilfieldToolsNet/opm-upscaling
4
0
Fork 0
mirror of https://github.com/OPM/opm-upscaling.git synced 2025-02-25 18:45:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixes formatting of groff man-pages.

Browse Source 
There were erroneous backslashes for non-dashed options (e.g \fB\option instead
of \fBoption) and missing linebreaks. Both are fixed now. Kudos got to linitian
for noticing the regressions.
This commit is contained in:
Markus Blatt 2021-11-16 11:01:37 +01:00
parent 2b8c665f03
commit 4d5b1f8797
11 changed files with 178 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
doc/man1/cpchop.1
View File

@ -10,21 +10,42 @@ Example usage:
cpchop gridfilename=HugeReservoirStudioGrid.grdecl subsamples=100 ilen=5 jlen=5 zlen=5
.SH OPTIONS
\fB\subsamples\fR Number of subsamples. Defaults to 1.
\fB\filebase\fR If supplied, grdecl-files for each subsample will be written to files named using this filebase, it may include directory names.
\fB\resultfile\fR Name of a textfile to output table of results per subsample to.
\fB\ilen\fR Length in i-direction of subsample, specified in number of cells. Defaults to all cells in i-direction.
\fB\jlen\fR Length in j-direction of subsample, specified in number of cells. Defaults to all cells in j-direction.
\fB\zlen\fR Length in z-direction of subsample, specified in the grids length unit (typically cm or m). Defaults to full height.
\fB\imin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
\fB\imax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
\fB\jmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
\fB\jmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
\fB\zmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
\fB\zmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
\fB\upscale\fR Boolean for whether to do upscaling on the subsamples, either true or false. If the objective is to obtain a grdecl-file for the subsample, set to false for run time. Defaults to true.
\fB\bc\fR Boundary condition type for upscaling, either fixed or periodic. Defaults to fixed.
\fB\resettoorigin\fR If true, outputted grdecl-file will have its ZCORN-values and COORDS-values shifted so that the model is defined at the origin. If false, the outputted grdecl-file will be located in its original position. Defaults to true.
\fBsubsamples\fR Number of subsamples. Defaults to 1.
.br
\fBfilebase\fR If supplied, grdecl-files for each subsample will be
written to files named using this filebase, it may include directory
names.
.br
\fBresultfile\fR Name of a textfile to output table of results per
subsample to.
.br
\fBilen\fR Length in i-direction of subsample, specified in number of
cells. Defaults to all cells in i-direction.
.br
\fBjlen\fR Length in j-direction of subsample, specified in number of
cells. Defaults to all cells in j-direction.
.br
\fBzlen\fR Length in z-direction of subsample, specified in the grids length unit (typically cm or m). Defaults to full height.
\fBimin\fR Can be used to limit the search area for random
subsamples. Defaults to minimum i in inputgrid (full model).
\fBimax\fR Can be used to limit the search area for random
subsamples. Defaults to maximum i in inputgrid (full model).
.br
\fBjmin\fR Analog to imin, but in j-direction. Defaults to minimum j
in inputgrid (full model).
.br
\fBjmax\fR Analog to imax, but in j-direction. Defaults to maximum j
in inputgrid (full model).
.br
\fBzmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
.br
\fBzmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
.br
\fBupscale\fR Boolean for whether to do upscaling on the subsamples, either true or false. If the objective is to obtain a grdecl-file for the subsample, set to false for run time. Defaults to true.
.br
\fBbc\fR Boundary condition type for upscaling, either fixed or periodic. Defaults to fixed.
.br
\fBresettoorigin\fR If true, outputted grdecl-file will have its ZCORN-values and COORDS-values shifted so that the model is defined at the origin. If false, the outputted grdecl-file will be located in its original position. Defaults to true.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>
.SH "SEE ALSO"

47
doc/man1/cpchop_depthtrend.1
View File

@ -10,22 +10,37 @@ Example usage:
cpchop_depthtrend gridfilename=cornerpointgrid.grdecl subsamples=100 ilen=5 jlen=5 zlen=5
.SH OPTIONS
\fB\zresolution\fR Vertical distance between subsamples. Defaults to 1.
\fB\subsamples\fR Number of subsamples. Defaults to 1.
\fB\filebase\fR If supplied, grdecl-files for each subsample will be written to files named using this filebase, it may include directory names.
\fB\resultfile\fR Name of a textfile to output table of results per subsample to.
\fB\ilen\fR Length in i-direction of subsample, specified in number of cells. Defaults to all cells in i-direction.
\fB\jlen\fR Length in j-direction of subsample, specified in number of cells. Defaults to all cells in j-direction.
\fB\zlen\fR Length in z-direction of subsample, specified in the grids length unit (typically cm or m). Defaults to full height.
\fB\imin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
\fB\imax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
\fB\jmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
\fB\jmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
\fB\zmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
\fB\zmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
\fB\upscale\fR Boolean for whether to do upscaling on the subsamples, either true or false. If the objective is to obtain a grdecl-file for the subsample, set to false for run time. Defaults to true.
\fB\bc\fR Boundary condition type for upscaling, either fixed or periodic. Defaults to fixed.
\fB\resettoorigin\fR If true, outputted grdecl-file will have its ZCORN-values and COORDS-values shifted so that the model is defined at the origin. If false, the outputted grdecl-file will be located in its original position. Defaults to true.
\fBzresolution\fR Vertical distance between subsamples. Defaults to 1.
.br
\fBsubsamples\fR Number of subsamples. Defaults to 1.
.br
\fBfilebase\fR If supplied, grdecl-files for each subsample will be written to files named using this filebase, it may include directory names.
.br
\fBresultfile\fR Name of a textfile to output table of results per subsample to.
.br
\fBilen\fR Length in i-direction of subsample, specified in number of cells. Defaults to all cells in i-direction.
.br
\fBjlen\fR Length in j-direction of subsample, specified in number of cells. Defaults to all cells in j-direction.
.br
\fBzlen\fR Length in z-direction of subsample, specified in the grids length unit (typically cm or m). Defaults to full height.
.br
\fBimin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
.br
\fBimax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
.br
\fBjmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
.br
\fBjmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
.br
\fBzmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
.br
\fBzmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
.br
\fBupscale\fR Boolean for whether to do upscaling on the subsamples, either true or false. If the objective is to obtain a grdecl-file for the subsample, set to false for run time. Defaults to true.
.br
\fBbc\fR Boundary condition type for upscaling, either fixed or periodic. Defaults to fixed.
.br
\fBresettoorigin\fR If true, outputted grdecl-file will have its ZCORN-values and COORDS-values shifted so that the model is defined at the origin. If false, the outputted grdecl-file will be located in its original position. Defaults to true.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>
.SH "SEE ALSO"

32
doc/man1/cpregularize.1
View File

@ -13,17 +13,27 @@ Example usage:
cpregularize gridfilename=grid.grdecl ires=5 jres=5 zres=5 resultgrid=regularizedgrid.grdecl
.SH OPTIONS
\fB\resultgrid\fR File name for regular grid.
\fB\ires\fR Resolution in i-direction. Defaults to 1.
\fB\jres\fR Resolution in j-direction. Defaults to 1.
\fB\zres\fR Resolution in z-direction. Defaults to 1.
\fB\imin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
\fB\imax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
\fB\jmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
\fB\jmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
\fB\zmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
\fB\zmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
\fB\minperm\fR Cut-off value for permeability.
\fBresultgrid\fR File name for regular grid.
.br
\fBires\fR Resolution in i-direction. Defaults to 1.
.br
\fBjres\fR Resolution in j-direction. Defaults to 1.
.br
\fBzres\fR Resolution in z-direction. Defaults to 1.
.br
\fBimin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
.br
\fBimax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
.br
\fBjmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
.br
\fBjmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
.br
\fBzmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
.br
\fBzmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
.br
\fBminperm\fR Cut-off value for permeability.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>
.SH "SEE ALSO"

29
doc/man1/exp_variogram.1
View File

@ -6,16 +6,25 @@ exp_variogram gridfilename=cornerpointgrid.grdecl [option=value]
.SH DESCRIPTION
This program computes data for an experimental variogram from a cornerpoint geometry with properties. This works by choosing pairs of volumes chosen randomly, and comparing their distance with the difference in their properties (poro or perm). Direction for pairing is set from the command line.
.SH OPTIONS
\fB\ilen\fR Length in i-direction of subsample, specified in number of cells. Defaults to all cells in i-direction.
\fB\jlen\fR Length in j-direction of subsample, specified in number of cells. Defaults to all cells in j-direction.
\fB\zlen\fR Length in z-direction of subsample, specified in the grids length unit (typically cm or m). Defaults to full height.
\fB\imin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
\fB\imax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
\fB\jmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
\fB\jmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
\fB\zmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
\fB\zmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
\fB\pairs\fR Number of pairs. Defaults to 100.
\fBilen\fR Length in i-direction of subsample, specified in number of cells. Defaults to all cells in i-direction.
.br
\fBjlen\fR Length in j-direction of subsample, specified in number of cells. Defaults to all cells in j-direction.
.br
\fBzlen\fR Length in z-direction of subsample, specified in the grids length unit (typically cm or m). Defaults to full height.
.br
\fBimin\fR Can be used to limit the search area for random subsamples. Defaults to minimum i in inputgrid (full model).
.br
\fBimax\fR Can be used to limit the search area for random subsamples. Defaults to maximum i in inputgrid (full model).
.br
\fBjmin\fR Analog to imin, but in j-direction. Defaults to minimum j in inputgrid (full model).
.br
\fBjmax\fR Analog to imax, but in j-direction. Defaults to maximum j in inputgrid (full model).
.br
\fBzmin\fR Analog to imin, but in z-direction and specified in the grids length unit. Defaults to minimum in inputgrid.
.br
\fBzmax\fR Analog to imax, but in z-direction and specified in the grids length unit. Defaults to maximum in inputgrid.
.br
\fBpairs\fR Number of pairs. Defaults to 100.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

8
doc/man1/grdecldips.1
View File

@ -10,8 +10,10 @@ Example usage:
grdecldips gridfilename=grid.grdecl mincellvolume=1e-8 listallcells=false output=filename.txt
.SH OPTIONS
\fB\mincellcolume\fR Only compute dip for cells with volume larger than specified volume.
\fB\listallcells\fR Boolean for listing all cells.
\fB\output\fR File name to print output.
\fBmincellcolume\fR Only compute dip for cells with volume larger than specified volume.
.br
\fBlistallcells\fR Boolean for listing all cells.
.br
\fBoutput\fR File name to print output.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

5
doc/man1/upscale_cap.1
View File

@ -23,10 +23,15 @@ For isotropic input, the rock file has four coloumns, and looks like this:
.SH OPTIONS
\fB\-points\fR Number of saturation points to upscale for, uniformly distributed. Defaults to 30.
.br
\fB\-jFunctionCurve\fR If upscaleBothPhases is false and input is isotropic,the column number in the stone-files that represent the Leverett J-function. Defaults to 4.
.br
\fB\-surfaceTension\fR Surface tension in dynes/cm to use in J-function/Pc conversion. Contact angle is not supported, and \cos \theta=1 is effectively used. Defaults to 11.
.br
\fB\-output\fR Filename for where to write upscaled values.
.br
\fB\-maxPermContrast\fR Maximal permeability contrast in model. Defaults to 1e7.
.br
\fB\-minPerm\fR Minimum value allowed for phase permeability. Defaults to 1e-12.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

15
doc/man1/upscale_cond.1
View File

@ -12,20 +12,35 @@ upscale_cond -bc p grid.grdecl Jfunc1.datan Jfunc2.data
.SH OPTIONS
\fB\-bc\fR Which boundary conditions to use. Possible values are p (periodic), f (fixed) or l (linear). Defaults to f.
.br
\fB\-points\fR Number of saturation points to upscale for, uniformly distributed. Defaults to 30.
.br
\fB\-resistivityCutoff\fR Cut-off value for resistivity. Defaults to 10000.
.br
\fB\-lithologyCoeff\fR Archie parameter. Defaults to 1.0.
.br
\fB\-cementationExponent\fR Archie parameter. Defaults to 1.8.
.br
\fB\-saturationExponent\fR Archie parameter. Defaults to 2.3.
.br
\fB\-waterresistivity\fR Resistivity of formation water.
.br
\fB\-mudresistivity\fR Resistivity of mud. Defaults to 1.4.
.br
\fB\-mud1rocktype\fR First mud rock type, 0 if there are no mud types. Defaults to 0.
.br
\fB\-mud2rocktype\fR Second mud rock type. Defaults to 0.
.br
\fB\-jFunctionCurve\fR Which column in the supplied J-files corresponds to the J-function values. Defaults to 2.
.br
\fB\-surfaceTension\fR Surface tension in dynes/cm to use in J-function/Pc conversion. Defaults to 11.
.br
\fB\-output\fR Filename for where to write upscaled values.
.br
\fB\-interpolate\fR If supplied and > 1, the output will be interpolated using monotone cubic interpolation on a uniform grid with the specified number of points. Suggested value: 1000.
.br
\fB\-rock<int>cemexp <float>\fR Cementation exponent can be set on a per rocktype basis.
.br
\fB\-rock<int>satexp <float>\fR Saturation exponent can be set on a per rocktype basis.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

26
doc/man1/upscale_elasticity.1
View File

@ -10,15 +10,23 @@ Example usage:
upscale_elasticity gridfilename=filename.grdecl rock_list=rocklist.txt output=outfilename.txt
.SH OPTIONS
\fB\gridfilename\fR Filename for grid file.
\fB\vtufilename\fR Save results to vtu file for visual inspection. If not specified, vtu results are not saved.
\fB\rock_list\fR A file with a list of one file per satnum specifying elastic properties for each rock type.
\fB\output\fR Filename for which results are written in ASCII format. If not specified, output is not written to file.
\fB\method\fR The kind of boundary couplings to use, can be 'mpc' or 'mortar'. Defaults to 'mortar' (best for non-perfect periodic grids).
\fB\Emin\fR Minimum E (youngs) modulus. Used to avid numerical issues if contrasts in grid is too large. Defaults to 0.
\fB\ctol\fR Collapse tolerance in grid parsing. Defaults to 1e-6.
\fB\ltol\fR Tolerance in iterative linear solvers. Defaults to 1e-8.
\fB\linsolver_type\fR Type of solver for linear system. Possibilities are 'iterative' and 'direct' (LU factorization). Default is 'iterative'.
\fBgridfilename\fR Filename for grid file.
.br
\fBvtufilename\fR Save results to vtu file for visual inspection. If not specified, vtu results are not saved.
.br
\fBrock_list\fR A file with a list of one file per satnum specifying elastic properties for each rock type.
.br
\fBoutput\fR Filename for which results are written in ASCII format. If not specified, output is not written to file.
.br
\fBmethod\fR The kind of boundary couplings to use, can be 'mpc' or 'mortar'. Defaults to 'mortar' (best for non-perfect periodic grids).
.br
\fBEmin\fR Minimum E (youngs) modulus. Used to avid numerical issues if contrasts in grid is too large. Defaults to 0.
.br
\fBctol\fR Collapse tolerance in grid parsing. Defaults to 1e-6.
.br
\fBltol\fR Tolerance in iterative linear solvers. Defaults to 1e-8.
.br
\fBlinsolver_type\fR Type of solver for linear system. Possibilities are 'iterative' and 'direct' (LU factorization). Default is 'iterative'.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

13
doc/man1/upscale_relperm.1
View File

@ -23,18 +23,31 @@ For isotropic input, the rock file has four coloumns, and looks like this:
.SH OPTIONS
\fB\-bc\fR Which boundary conditions to use. Possible values are p (periodic), f (fixed) or l (linear). Defaults to f.
.br
\fB\-points\fR Number of saturation points to upscale for, uniformly distributed. Defaults to 30.
.br
\fB\-upscaleBothPhases\fR Whether to upscale both phases or not. Defaults to true.
.br
\fB\-relPermCurve\fR If upscaleBothPhases is false and input is isotropic, this specifies the column number in the rock-files to be upscaled. Defaults to 2.
.br
\fB\-jFunctionCurve\fR If upscaleBothPhases is false and input is isotropic,the column number in the stone-files that represent the Leverett J-function. Defaults to 4.
.br
\fB\-gravity\fR Gravitational acceleration, in m/s². Use 9.8 for standard gravity. Defaults to 0.
.br
\fB\-fluids\fR Which two-phase fluid system we are dealing with. Possible values are ow (oil/water) and go (gas/oil). Defaults to ow.
.br
\fB\-surfaceTension\fR Surface tension in dynes/cm to use in J-function/Pc conversion. Contact angle is not supported, and \cos \theta=1 is effectively used. Defaults to 11.
.br
\fB\-waterDensity\fR 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.
.br
\fB\-oilDensity\fR Density of oil, in g/cm³. Only relevant for non-zero gravity. Defaults to 0.6.
.br
\fB\-output\fR Filename for where to write upscaled values.
.br
\fB\-doEclipseCheck\fR Check that input curves includes critical saturation points, i.e. saturation points where relperms are 0. See critRelpermThresh. Defaults to true.
.br
\fB\-critRelpermThresh\fR If minimum relperm value is less than this value, it is set to 0. Only applicable if doEclipseCheck is true. Defaults to 1e-6.
.br
\fB\-interpolate\fR 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.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

9
doc/man1/upscale_relpermvisc.1
View File

@ -23,14 +23,23 @@ For isotropic input, the rock file has four coloumns, and looks like this:
.SH OPTIONS
\fB\-bc\fR Which boundary conditions to use. Possible values are p (periodic), f (fixed) or l (linear). Defaults to f.
.br
\fB\-points\fR Number of saturation points to upscale for, uniformly distributed. Defaults to 30.
.br
\fB\-waterViscosity\fR Viscosity of water given in Pascal seconds (1000 cP = 1 Pa s).
.br
\fB\-oilViscosity\fR Viscosity of oil given in Pascal seconds (1000 cP = 1 Pa s).
.br
\fB\-waterCurve\fR The column number in the rock files that represent relative permeability for water. Defaults to 2.
.br
\fB\-oilCurve\fR The column number in the rock files that represent relative permeability for oil. Defaults to 3.
.br
\fB\-outputWater\fR Filename for where to write upscaled values for water relperm. If not supplied, output will only go to the terminal (standard out).
.br
\fB\-outputOil\fR Filename for where to write upscaled values for oil relperm. If not supplied, output will only go to the terminal (standard out).
.br
\fB\-interpolate\fR 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.
.br
\fB\-minPerm\fR Minimum floating point value allowed for phase permeability in computations. If set to zero, some models can end up singular. Defaults to 1e-12.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>

11
doc/man1/upscale_steadystate_implicit.1
View File

@ -10,10 +10,13 @@ Example usage:
upscale_steadystate_implicit fileformat=eclipse filename=grid.grdecl rock_list=rocklist.txt boudary_condition_type=0
.SH OPTIONS
\fB\fileformat\fR Grid format, eclipse or cartiesian. Defaults to cartesian.
\fB\filename\fR Grid filename.
\fB\rock_list\fR A file with a list of one file name per satnum specifying two phase properties for each rock type.
\fB\boundary_condition_type\fR Boundary condition type.
\fBfileformat\fR Grid format, eclipse or cartiesian. Defaults to cartesian.
.br
\fBfilename\fR Grid filename.
.br
\fBrock_list\fR A file with a list of one file name per satnum specifying two phase properties for each rock type.
.br
\fBboundary_condition_type\fR Boundary condition type.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>
.SH "SEE ALSO"