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

Move man pages to doc and install them.

Browse Source 
The directory doc already exists and there does not seem a need to
introduces docs as an additional source of documentation.

With this change the doc layout is similar to opm-common and
opm-simulators.
This commit is contained in:
Markus Blatt
2021-11-15 14:30:46 +01:00
parent 99462f6f68
commit 7e288e0ea4
15 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/man1/cpchop.1 Normal file
View File

@@ -0,0 +1,31 @@
.TH CPCHOP "29" "April 2021" "cpchop 2020.04" "User Commands"
.SH NAME
cpchop \- Upscale simple statistics
.SH SYNOPSIS
cpchop gridfilename=cornerpointgrid.grdecl [option=value]
.SH DESCRIPTION
Utility for doing subsampling and property analysis of Eclipse grid files, typically generated in SBED or ReservoirStudio, but can be used on all corner point grids with box shape and vertical pillars.
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.
.SH "REPORTING BUGS"
Report on github repository <https://github.com/OPM/opm-upscaling/issues>
.SH "SEE ALSO"
upscale_perm