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
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"