Merge pull request #4987 from blattms/update-man-page

Update manpage for release

Author: blattms

doc/man1/flow.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
-.TH FLOW "1" "October 2022" "flow 2022.10" "User Commands"
+.TH FLOW "1" "October 2023" "flow 2023.10" "User Commands"
 .SH NAME
 flow \- Eclipse compatible parallel reservoir simulator
 .SH SYNOPSIS
@@ -16,7 +16,7 @@ Print this help message and exit
 Print all parameters, including obsolete, hidden and deprecated ones.
 .TP
 \fB\-\-accelerator\-mode\fR=\fI\,STRING\/\fR
-Use GPU (cusparseSolver or openclSolver) or FPGA (fpgaSolver) as the linear solver, usage: '\-\-accelerator\-mode=[none|cusparse|opencl|fpga|amgcl]'. Default: "none"
+Use GPU (cusparseSolver, openclSolver, amgcl or rocalution) in the linear solver, usage: '\-\-accelerator\-mode=[none|cusparse|opencl|amgcl|rocalution]'. Default: "none"
 .TP
 \fB\-\-allow\-distributed\-wells\fR=\fI\,BOOLEAN\/\fR
 Allow the perforations of a well to be distributed to interior of multiple processes. Default: false
@@ -30,14 +30,11 @@ Choose device ID for cusparseSolver or openclSolver, use 'nvidia\-smi' or 'clinf
 \fB\-\-continue\-on\-convergence\-error\fR=\fI\,BOOLEAN\/\fR
 Continue with a non\-converged solution instead of giving up if we encounter a time step size smaller than the minimum time step size. Default: false
 .TP
-\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
+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: 30
 .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, 4: recreated every CprReuseInterval. 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: 4
 .TP
 \fB\-\-dbhp\-max\-rel\fR=\fI\,SCALAR\/\fR
 Maximum relative change of the bottom\-hole pressure in a single iteration. Default: 1
@@ -63,9 +60,6 @@ Tell the output writer to use double precision. Useful for 'perfect' restarts. D
 \fB\-\-ecl\-output\-interval\fR=\fI\,INTEGER\/\fR
 The number of report steps that ought to be skipped between two writes of ECL results. Default: \fB\-1\fR
 .TP
-\fB\-\-ecl\-strict\-parsing\fR=\fI\,BOOLEAN\/\fR
-Use strict mode for parsing \- all errors are collected before the applicaton exists. Default: false
-.TP
 \fB\-\-edge\-weights\-method\fR=\fI\,INTEGER\/\fR
 Choose edge\-weighing strategy: 0=uniform, 1=trans, 2=log(trans). Default: 1
 .TP
@@ -120,9 +114,6 @@ Do not print fluid\-in\-place values after each report step even if requested by
 \fB\-\-force\-disable\-resv\-fluid\-in\-place\-output\fR=\fI\,BOOLEAN\/\fR
 Do not print reservoir volumes values after each report step even if requested by the deck. Default: false
 .TP
-\fB\-\-fpga\-bitstream\fR=\fI\,STRING\/\fR
-Specify the bitstream file for fpgaSolver (including path), usage: '\-\-fpga\-bitstream=<filename>'. Default: ""
-.TP
 \fB\-\-full\-time\-step\-initially\fR=\fI\,BOOLEAN\/\fR
 Always attempt to finish a report step using a single substep. Default: false
 .TP
@@ -145,26 +136,50 @@ Whether to reorder the entries of the matrix in the red\-black ILU preconditione
 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"
+Configuration of solver. Valid options are: ilu0 (default), dilu, cprw, cpr (an alias for cprw), cpr_quasiimpes, cpr_trueimpes, amg or hybrid (experimental). 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
 \fB\-\-linear\-solver\-max\-iter\fR=\fI\,INTEGER\/\fR
 The maximum number of iterations of the linear solver. Default: 200
 .TP
+\fB\-\-linear\-solver\-print\-json\-definition\fR=\fI\,BOOLEAN\/\fR
+Write the JSON definition of the linear solver setup to the DBG file. Default: true
+.TP
 \fB\-\-linear\-solver\-reduction\fR=\fI\,SCALAR\/\fR
 The minimum reduction of the residual which the linear solver must achieve. Default: 0.01
 .TP
-\fB\-\-linear\-solver\-require\-full\-sparsity\-pattern\fR=\fI\,BOOLEAN\/\fR
-Produce the full sparsity pattern for the linear solver. Default: false
-.TP
 \fB\-\-linear\-solver\-restart\fR=\fI\,INTEGER\/\fR
 The number of iterations after which GMRES is restarted. Default: 40
 .TP
 \fB\-\-linear\-solver\-verbosity\fR=\fI\,INTEGER\/\fR
 The verbosity level of the linear solver (0: off, 2: all). Default: 0
 .TP
+\fB\-\-load\-step\fR=\fI\,INTEGER\/\fR
+Load serialized state from .OPMRST file. Either a specific report step, or 0 to load last stored report step. Default: \fB\-1\fR
+.TP
+\fB\-\-local\-domains\-ordering\-measure\fR=\fI\,STRING\/\fR
+Subdomain ordering measure. Allowed values are 'pressure' and  'residual'. Default: "pressure"
+.TP
+\fB\-\-local\-domains\-partitioning\-imbalance\fR=\fI\,SCALAR\/\fR
+Subdomain partitioning imbalance tolerance. 1.03 is 3 percent imbalance. Default: 1.03
+.TP
+\fB\-\-local\-domains\-partitioning\-method\fR=\fI\,STRING\/\fR
+Subdomain partitioning method. Allowed values are 'zoltan', 'simple', and the name of a partition file ending with '.partition'. Default: "zoltan"
+.TP
+\fB\-\-local\-solve\-approach\fR=\fI\,STRING\/\fR
+Choose local solve approach. Valid choices are jacobi and gauss\-seidel. Default: "jacobi"
+.TP
+\fB\-\-local\-tolerance\-scaling\-cnv\fR=\fI\,SCALAR\/\fR
+Set lower than 1.0 to use stricter convergence tolerance for local solves. Default: 0.01
+.TP
+\fB\-\-local\-tolerance\-scaling\-mb\fR=\fI\,SCALAR\/\fR
+Set lower than 1.0 to use stricter convergence tolerance for local solves. Default: 1
+.TP
+\fB\-\-local\-well\-solve\-control\-switching\fR=\fI\,BOOLEAN\/\fR
+Allow control switching during local well solutions. Default: false
+.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
 .TP
@@ -174,6 +189,9 @@ Maximum number of inner iterations for multi\-segment wells. Default: 100
 \fB\-\-max\-inner\-iter\-wells\fR=\fI\,INTEGER\/\fR
 Maximum number of inner iterations for standard wells. Default: 50
 .TP
+\fB\-\-max\-local\-solve\-iterations\fR=\fI\,INTEGER\/\fR
+Max iterations for local solves with NLDD nonlinear solver. Default: 20
+.TP
 \fB\-\-max\-newton\-iterations\-with\-inner\-well\-iterations\fR=\fI\,INTEGER\/\fR
 Maximum newton iterations with inner well iterations. Default: 8
 .TP
@@ -195,6 +213,9 @@ Maximum number of iterations to determine solution the  well equations. Default:
 \fB\-\-maximum\-number\-of\-well\-switches\fR=\fI\,INTEGER\/\fR
 Maximum number of times a well can switch to the same control. Default: 3
 .TP
+\fB\-\-maximum\-water\-saturation\fR=\fI\,SCALAR\/\fR
+Maximum water saturation. Default: 1
+.TP
 \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
@@ -207,6 +228,15 @@ The minimum time step size (in days for field and metric unit and hours for lab
 \fB\-\-min\-time\-step\-before\-shutting\-problematic\-wells\-in\-days\fR=\fI\,SCALAR\/\fR
 The minimum time step size in days for which problematic wells are not shut. Default: 0.01
 .TP
+\fB\-\-network\-max\-iterations\fR=\fI\,INTEGER\/\fR
+Maximum number of iterations in the network solver before giving up. Default: 200
+.TP
+\fB\-\-network\-max\-strict\-iterations\fR=\fI\,INTEGER\/\fR
+Maximum iterations in network solver before relaxing tolerance. Default: 100
+.TP
+\fB\-\-newton\-max\-iterations\fR=\fI\,INTEGER\/\fR
+The maximum number of Newton iterations per time step. Default: 20
+.TP
 \fB\-\-newton\-max\-relax\fR=\fI\,SCALAR\/\fR
 The maximum relaxation factor of a Newton iteration. Default: 0.5
 .TP
@@ -219,6 +249,15 @@ The type of relaxation used by Newton method. Default: "dampen"
 \fB\-\-num\-jacobi\-blocks\fR=\fI\,INTEGER\/\fR
 Number of blocks to be created for the Block\-Jacobi preconditioner. Default: 0
 .TP
+\fB\-\-nldd\-num\-initial\-newton\-iter\fR=\fI\,INTEGER\/\fR
+Number of initial global Newton iterations when running the NLDD nonlinear solver. Default: 1
+.TP
+\fB\-\-nonlinear\-solver\fR=\fI\,STRING\/\fR
+Choose nonlinear solver. Valid choices are newton or nldd. Default: "newton"
+.TP
+\fB\-\-num\-local\-domains\fR=\fI\,INTEGER\/\fR
+Number of local domains for NLDD nonlinear solver. Default: 0
+.TP
 \fB\-\-opencl\-ilu\-parallel\fR=\fI\,BOOLEAN\/\fR
 Parallelize ILU decomposition and application on GPU. Default: true
 .TP
@@ -228,6 +267,9 @@ Choose platform ID for openclSolver, use 'clinfo' to determine valid platform ID
 \fB\-\-output\-dir\fR=\fI\,STRING\/\fR
 The directory to which result files are written. Default: ""
 .TP
+\fB\-\-output\-extra\-convergence\-info\fR=\fI\,STRING\/\fR
+Provide additional convergence output files for diagnostic purposes. "none" gives no extra output and overrides all other options, "steps" generates an INFOSTEP file, "iterations" generates an INFOITER file. Combine options with commas, e.g., "steps,iterations" for multiple outputs. Default: "none"
+.TP
 \fB\-\-output\-interval\fR=\fI\,INTEGER\/\fR
 Specify the number of report steps between two consecutive writes of restart data. Default: 1
 .TP
@@ -240,6 +282,9 @@ Order cells owned by rank before ghost/overlap cells. Default: true
 \fB\-\-parameter\-file\fR=\fI\,STRING\/\fR
 An .ini file which contains a set of run\-time parameters. Default: ""
 .TP
+\fB\-\-parsing\-strictness\fR=\fI\,STRING\/\fR
+Set strictness of parsing process. Available options are normal (stop for critical errors), high (stop for all errors) and low (as normal, except do not stop due to unsupported keywords even if marked critical. Default: "normal"
+.TP
 \fB\-\-pri\-var\-oscilation\-threshold\fR=\fI\,SCALAR\/\fR
 The threshold value for the primary variable switching conditions after its meaning has switched to hinder oscilations. Default: 1e\-05
 .TP
@@ -255,6 +300,9 @@ Option for doing saturation projection. Default: false
 \fB\-\-regularization\-factor\-wells\fR=\fI\,SCALAR\/\fR
 Regularization factor for wells. Default: 100
 .TP
+\fB\-\-relaxed\-linear\-solver\-reduction\fR=\fI\,SCALAR\/\fR
+The minimum reduction of the residual which the linear solver need to achieve for the solution to be accepted. Default: 0.01
+.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
@@ -264,6 +312,9 @@ Relaxed tolerance for the MSW pressure solution. Default: 10000
 \fB\-\-relaxed\-well\-flow\-tol\fR=\fI\,SCALAR\/\fR
 Relaxed tolerance for the well flow residual. Default: 0.001
 .TP
+\fB\-\-save\-step\fR=\fI\,STRING\/\fR
+Save serialized state to .OPMRST file. Either a specific report step, "all" to save all report steps or ":x" to save every x'th step.Use negative values of "x" to keep only the last written step, or "last" to save every step, keeping only the last. Default: ""
+.TP
 \fB\-\-scale\-linear\-system\fR=\fI\,BOOLEAN\/\fR
 Scale linear system according to equation scale and primary variable types. Default: false
 .TP
@@ -381,5 +432,8 @@ 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\-\-water\-only\-threshold\fR=\fI\,SCALAR\/\fR
+Cells with water saturation above or equal is considered one\-phase water only. Default: 1
+.TP
 \fB\-\-zoltan\-imbalance\-tol\fR=\fI\,SCALAR\/\fR
 Tolerable imbalance of the loadbalancing provided by Zoltan (default: 1.1). Default: 1.1