OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-07-07 04:53:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated flow manpage.

Browse Source
This commit is contained in:
Markus Blatt 2022-10-31 10:07:19 +01:00
parent 86bbd38a55
commit c91cf5cca7
1 changed files with 32 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
doc/man1/flow.1
View File

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH FLOW "1" "November 2021" "flow 2021.10" "User Commands"
.TH FLOW "1" "October 2022" "flow 2022.10" "User Commands"
.SH NAME
flow \- Eclipse compatible parallel reservoir simulator
.SH SYNOPSIS
@ -33,8 +33,11 @@ Continue with a non\-converged solution instead of giving up if we encounter a t
\fB\-\-cpr\-max\-ell\-iter\fR=\fI\,INTEGER\/\fR
MaxIterations of the elliptic pressure part of the cpr solver. Default: 20
.TP
\fB\-\-cpr\-reuse\-interval\fR=\fI\,INTEGER\/\fR
Reuse preconditioner interval. Used when CprReuseSetup is set to 4, then the preconditioner will be fully recreated instead of reused every N linear solve, where N is this parameter. Default: 10
.TP
\fB\-\-cpr\-reuse\-setup\fR=\fI\,INTEGER\/\fR
Reuse preconditioner setup. Valid options are 0: recreate the preconditioner for every linear solve, 1: recreate once every timestep, 2: recreate if last linear solve took more than 10 iterations, 3: never recreate. Default: 3
Reuse preconditioner setup. Valid options are 0: recreate the preconditioner for every linear solve, 1: recreate once every timestep, 2: recreate if last linear solve took more than 10 iterations, 3: never recreate, 4: recreated every CprReuseInterval. Default: 3
.TP
\fB\-\-dbhp\-max\-rel\fR=\fI\,SCALAR\/\fR
Maximum relative change of the bottom\-hole pressure in a single iteration. Default: 1
@ -96,9 +99,6 @@ Store previous storage terms and avoid re\-calculating them. Default: true
\fB\-\-enable\-terminal\-output\fR=\fI\,BOOLEAN\/\fR
Print high\-level information about the simulation's progress to the terminal. Default: true
.TP
\fB\-\-enable\-tracer\-model\fR=\fI\,BOOLEAN\/\fR
Transport tracers found in the deck. Default: true
.TP
\fB\-\-enable\-tuning\fR=\fI\,BOOLEAN\/\fR
Honor some aspects of the TUNING keyword. Default: false
.TP
@ -114,15 +114,6 @@ Enable the well operability checking during iterations. Default: false
\fB\-\-enable\-write\-all\-solutions\fR=\fI\,BOOLEAN\/\fR
Write all solutions to disk instead of only the ones for the report steps. Default: false
.TP
\fB\-\-flow\-linear\-solver\-verbosity\fR=\fI\,INTEGER\/\fR
The verbosity level of the linear solver (0: off, 2: all). Default: 0
.TP
\fB\-\-flow\-newton\-max\-iterations\fR=\fI\,INTEGER\/\fR
The maximum number of Newton iterations per time step used by flow. Default: 20
.TP
\fB\-\-flow\-newton\-min\-iterations\fR=\fI\,INTEGER\/\fR
The minimum number of Newton iterations per time step used by flow. Default: 1
.TP
\fB\-\-force\-disable\-fluid\-in\-place\-output\fR=\fI\,BOOLEAN\/\fR
Do not print fluid\-in\-place values after each report step even if requested by the deck. Default: false
.TP
@ -153,6 +144,9 @@ Whether to reorder the entries of the matrix in the red\-black ILU preconditione
\fB\-\-initial\-time\-step\-in\-days\fR=\fI\,SCALAR\/\fR
The size of the initial time step in days. Default: 1
.TP
\fB\-\-linear\-solver\fR=\fI\,STRING\/\fR
Configuration of solver. Valid options are: ilu0 (default), cpr (an alias for cpr_trueimpes), cpr_quasiimpes, cpr_trueimpes or amg. Alternatively, you can request a configuration to be read from a JSON file by giving the filename here, ending with '.json.'. Default: "ilu0"
.TP
\fB\-\-linear\-solver\-ignore\-convergence\-failure\fR=\fI\,BOOLEAN\/\fR
Continue with the simulation like nothing happened after the linear solver did not converge. Default: false
.TP
@ -168,8 +162,8 @@ Produce the full sparsity pattern for the linear solver. Default: false
\fB\-\-linear\-solver\-restart\fR=\fI\,INTEGER\/\fR
The number of iterations after which GMRES is restarted. Default: 40
.TP
\fB\-\-linsolver\fR=\fI\,STRING\/\fR
Configuration of solver. Valid options are: ilu0 (default), cpr (an alias for cpr_trueimpes), cpr_quasiimpes, cpr_trueimpes or amg. Alternatively, you can request a configuration to be read from a JSON file by giving the filename here, ending with '.json.'. Default: "ilu0"
\fB\-\-linear\-solver\-verbosity\fR=\fI\,INTEGER\/\fR
The verbosity level of the linear solver (0: off, 2: all). Default: 0
.TP
\fB\-\-matrix\-add\-well\-contributions\fR=\fI\,BOOLEAN\/\fR
Explicitly specify the influences of wells between cells in the Jacobian and preconditioner matrices. Default: false
@ -192,9 +186,6 @@ Absolute maximum tolerated for residuals without cutting the time step size. Def
\fB\-\-max\-single\-precision\-days\fR=\fI\,SCALAR\/\fR
Maximum time step size where single precision floating point arithmetic can be used solving for the linear systems of equations. Default: 20
.TP
\fB\-\-max\-strict\-iter\fR=\fI\,INTEGER\/\fR
Maximum number of Newton iterations before relaxed tolerances are used for the CNV convergence criterion. Default: 0
.TP
\fB\-\-max\-temperature\-change\fR=\fI\,SCALAR\/\fR
Maximum absolute change of temperature in a single iteration. Default: 5
.TP
@ -207,6 +198,9 @@ Maximum number of times a well can switch to the same control. Default: 3
\fB\-\-milu\-variant\fR=\fI\,STRING\/\fR
Specify which variant of the modified\-ILU preconditioner ought to be used. Possible variants are: ILU (default, plain ILU), MILU_1 (lump diagonal with dropped row entries), MILU_2 (lump diagonal with the sum of the absolute values of the dropped row entries), MILU_3 (if diagonal is positive add sum of dropped row entrires. Otherwise subtract them), MILU_4 (if diagonal is positive add sum of dropped row entrires. Otherwise do nothing. Default: "ILU"
.TP
\fB\-\-min\-strict\-cnv\-iter\fR=\fI\,INTEGER\/\fR
Minimum number of Newton iterations before relaxed tolerances can be used for the CNV convergence criterion. Default: 0
.TP
\fB\-\-min\-time\-step\-based\-on\-newton\-iterations\fR=\fI\,SCALAR\/\fR
The minimum time step size (in days for field and metric unit and hours for lab unit) can be reduced to based on newton iteration counts. Default: 0
.TP
@ -214,13 +208,19 @@ The minimum time step size (in days for field and metric unit and hours for lab
The minimum time step size in days for which problematic wells are not shut. Default: 0.01
.TP
\fB\-\-newton\-max\-relax\fR=\fI\,SCALAR\/\fR
The maximum relaxation factor of a Newton iteration used by flow. Default: 0.5
The maximum relaxation factor of a Newton iteration. Default: 0.5
.TP
\fB\-\-newton\-min\-iterations\fR=\fI\,INTEGER\/\fR
The minimum number of Newton iterations per time step. Default: 1
.TP
\fB\-\-newton\-relaxation\-type\fR=\fI\,STRING\/\fR
The type of relaxation used by flow's Newton method. Default: "dampen"
The type of relaxation used by Newton method. Default: "dampen"
.TP
\fB\-\-opencl\-ilu\-reorder\fR=\fI\,STRING\/\fR
Choose the reordering strategy for ILU for openclSolver and fpgaSolver, usage: '\-\-opencl\-ilu\-reorder=[level_scheduling|graph_coloring], level_scheduling behaves like Dune and cusparse, graph_coloring is more aggressive and likely to be faster, but is random\-based and generally increases the number of linear solves and linear iterations significantly. Default: ""
\fB\-\-num\-jacobi\-blocks\fR=\fI\,INTEGER\/\fR
Number of blocks to be created for the Block\-Jacobi preconditioner. Default: 0
.TP
\fB\-\-opencl\-ilu\-parallel\fR=\fI\,BOOLEAN\/\fR
Parallelize ILU decomposition and application on GPU. Default: true
.TP
\fB\-\-opencl\-platform\-id\fR=\fI\,INTEGER\/\fR
Choose platform ID for openclSolver, use 'clinfo' to determine valid platform IDs. Default: 0
@ -252,29 +252,29 @@ Print the values of the compile time properties at the start of the simulation.
\fB\-\-project\-saturations\fR=\fI\,BOOLEAN\/\fR
Option for doing saturation projection. Default: false
.TP
\fB\-\-regularization\-factor\-msw\fR=\fI\,SCALAR\/\fR
Regularization factor for ms wells. Default: 1
\fB\-\-regularization\-factor\-wells\fR=\fI\,SCALAR\/\fR
Regularization factor for wells. Default: 100
.TP
\fB\-\-relaxed\-max\-pv\-fraction\fR=\fI\,SCALAR\/\fR
The fraction of the pore volume of the reservoir where the volumetric error (CNV) may be voilated during strict Newton iterations. Default: 0.03
.TP
\fB\-\-relaxed\-pressure\-tol\-msw\fR=\fI\,SCALAR\/\fR
Relaxed tolerance for the MSW pressure solution. Default: 50000
Relaxed tolerance for the MSW pressure solution. Default: 10000
.TP
\fB\-\-relaxed\-well\-flow\-tol\fR=\fI\,SCALAR\/\fR
Relaxed tolerance for the well flow residual. Default: 1
Relaxed tolerance for the well flow residual. Default: 0.001
.TP
\fB\-\-scale\-linear\-system\fR=\fI\,BOOLEAN\/\fR
Scale linear system according to equation scale and primary variable types. Default: false
.TP
\fB\-\-sched\-restart\fR=\fI\,BOOLEAN\/\fR
When restarting: should we try to initialize wells and groups from historical SCHEDULE section. Default: true
When restarting: should we try to initialize wells and groups from historical SCHEDULE section. Default: false
.TP
\fB\-\-serial\-partitioning\fR=\fI\,BOOLEAN\/\fR
Perform partitioning for parallel runs on a single process. Default: false
.TP
\fB\-\-shut\-unsolvable\-wells\fR=\fI\,BOOLEAN\/\fR
Shut unsolvable wells. Default: false
Shut unsolvable wells. Default: true
.TP
\fB\-\-solve\-welleq\-initially\fR=\fI\,BOOLEAN\/\fR
Fully solve the well equations before each iteration of the reservoir model. Default: true
@ -307,13 +307,13 @@ Specify the "chattiness" of the non\-linear solver itself. Default: 1
Number of inner well iterations with strict tolerance. Default: 40
.TP
\fB\-\-strict\-outer\-iter\-wells\fR=\fI\,INTEGER\/\fR
Number of newton iterations for which wells are checked with strict tolerance. Default: 99
Number of newton iterations for which wells are checked with strict tolerance. Default: 6
.TP
\fB\-\-temperature\-max\fR=\fI\,SCALAR\/\fR
Maximum absolute temperature. Default: 400
Maximum absolute temperature. Default: 1e+09
.TP
\fB\-\-temperature\-min\fR=\fI\,SCALAR\/\fR
Minimum absolute temperature. Default: 280
Minimum absolute temperature. Default: 0
.TP
\fB\-\-threads\-per\-process\fR=\fI\,INTEGER\/\fR
The maximum number of threads to be instantiated per process ('\-1' means 'automatic'). Default: \fB\-1\fR
@ -381,14 +381,5 @@ Use the well model for multi\-segment wells instead of the one for single\-segme
\fB\-\-use\-update\-stabilization\fR=\fI\,BOOLEAN\/\fR
Try to detect and correct oscillations or stagnation during the Newton method. Default: true
.TP
\fB\-\-vtk\-write\-diffusion\-coefficients\fR=\fI\,BOOLEAN\/\fR
Include the molecular diffusion coefficients in the VTK output files. Default: false
.TP
\fB\-\-vtk\-write\-effective\-diffusion\-coefficients\fR=\fI\,BOOLEAN\/\fR
Include the effective molecular diffusion coefficients the medium in the VTK output files. Default: false
.TP
\fB\-\-vtk\-write\-tortuosities\fR=\fI\,BOOLEAN\/\fR
Include the tortuosity for each phase in the VTK output files. Default: false
.TP
\fB\-\-zoltan\-imbalance\-tol\fR=\fI\,SCALAR\/\fR
Tolerable imbalance of the loadbalancing provided by Zoltan (default: 1.1). Default: 1.1