Updated man-page for 2021 release.

help2man -h "-h" --version-string="2021.10" --no-discard-stderr -n \
"Eclipse compatible parallel reservoir simulator" -N flow > man.1

doc/man1/flow.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
-.TH FLOW "1" "April 2021" "flow 2021.04" "User Commands"
+.TH FLOW "1" "November 2021" "flow 2021.10" "User Commands"
 .SH NAME
 flow \- Eclipse compatible parallel reservoir simulator
 .SH SYNOPSIS
@@ -15,6 +15,9 @@ Print this help message and exit
 \fB\-\-help\-all\fR
 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"
+.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
 .TP
@@ -78,6 +81,9 @@ Specify if the simulation ought to be actually run, or just pretended to be. Def
 \fB\-\-enable\-ecl\-output\fR=\fI\,BOOLEAN\/\fR
 Write binary output which is compatible with the commercial Eclipse simulator. Default: true
 .TP
+\fB\-\-enable\-esmry\fR=\fI\,BOOLEAN\/\fR
+Write ESMRY file for fast loading of summary data. Default: false
+.TP
 \fB\-\-enable\-logging\-fallout\-warning\fR=\fI\,BOOLEAN\/\fR
 Developer option to see whether logging was on non\-root processors. In that case it will be appended to the *.DBG or *.PRT files. Default: false
 .TP
@@ -91,7 +97,7 @@ Store previous storage terms and avoid re\-calculating them. Default: true
 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: false
+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
@@ -102,6 +108,9 @@ Global switch for turning on writing VTK files. Default: false
 \fB\-\-enable\-well\-operability\-check\fR=\fI\,BOOLEAN\/\fR
 Enable the well operability checking. Default: true
 .TP
+\fB\-\-enable\-well\-operability\-check\-iter\fR=\fI\,BOOLEAN\/\fR
+Enable the well operability checking during iterations. Default: false
+.TP
 \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
@@ -117,12 +126,15 @@ The minimum number of Newton iterations per time step used by flow. Default: 1
 \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
+\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
-\fB\-\-gpu\-mode\fR=\fI\,STRING\/\fR
-Use GPU cusparseSolver or openclSolver as the linear solver, usage: '\-\-gpu\-mode=[none|cusparse|opencl]'. Default: "none"
-.TP
 \fB\-\-ignore\-keywords\fR=\fI\,STRING\/\fR
 List of Eclipse keywords which should be ignored. As a ':' separated string. Default: ""
 .TP
@@ -130,7 +142,7 @@ List of Eclipse keywords which should be ignored. As a ':' separated string. Def
 The fill\-in level of the linear solver's ILU preconditioner. Default: 0
 .TP
 \fB\-\-ilu\-redblack\fR=\fI\,BOOLEAN\/\fR
-Use red\-black partitioning for the ILU preconditioner. Default: false
+Use red\-black partioning for the ILU preconditioner. Default: false
 .TP
 \fB\-\-ilu\-relaxation\fR=\fI\,SCALAR\/\fR
 The relaxation factor of the linear solver's ILU preconditioner. Default: 0.9
@@ -168,6 +180,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\-newton\-iterations\-with\-inner\-well\-iterations\fR=\fI\,INTEGER\/\fR
+Maximum newton iterations with inner well iterations. Default: 8
+.TP
 \fB\-\-max\-pressure\-change\-ms\-wells\fR=\fI\,SCALAR\/\fR
 Maximum relative pressure change for a single iteration of the multi\-segment well model. Default: 1e+06
 .TP
@@ -180,11 +195,17 @@ Maximum time step size where single precision floating point arithmetic can be u
 \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
 \fB\-\-max\-welleq\-iter\fR=\fI\,INTEGER\/\fR
 Maximum number of iterations to determine solution the  well equations. Default: 30
 .TP
+\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\-\-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"
+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 substract them), MILU_4 (if diagonal is positive add sum of dropped row entrires. Otherwise do nothing. Default: "ILU"
 .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
@@ -199,8 +220,7 @@ The maximum relaxation factor of a Newton iteration used by flow. Default: 0.5
 The type of relaxation used by flow's Newton method. Default: "dampen"
 .TP
 \fB\-\-opencl\-ilu\-reorder\fR=\fI\,STRING\/\fR
-Choose the reordering strategy for ILU for openclSolver, possible
+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: ""
-values are level_scheduling or graph_coloring, where 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: "graph_coloring"
 .TP
 \fB\-\-opencl\-platform\-id\fR=\fI\,INTEGER\/\fR
 Choose platform ID for openclSolver, use 'clinfo' to determine valid platform IDs. Default: 0
@@ -235,14 +255,14 @@ Option for doing saturation projection. Default: false
 \fB\-\-regularization\-factor\-msw\fR=\fI\,SCALAR\/\fR
 Regularization factor for ms wells. Default: 1
 .TP
-\fB\-\-relaxed\-flow\-tol\-inner\-iter\-msw\fR=\fI\,SCALAR\/\fR
-Relaxed tolerance for the inner iteration for the MSW flow solution. Default: 1
-.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\-inner\-iter\-msw\fR=\fI\,SCALAR\/\fR
+\fB\-\-relaxed\-pressure\-tol\-msw\fR=\fI\,SCALAR\/\fR
-Relaxed tolerance for the inner iteration for the MSW pressure solution. Default: 50000
+Relaxed tolerance for the MSW pressure solution. Default: 50000
+.TP
+\fB\-\-relaxed\-well\-flow\-tol\fR=\fI\,SCALAR\/\fR
+Relaxed tolerance for the well flow residual. Default: 1
 .TP
 \fB\-\-scale\-linear\-system\fR=\fI\,BOOLEAN\/\fR
 Scale linear system according to equation scale and primary variable types. Default: false
@@ -253,9 +273,15 @@ When restarting: should we try to initialize wells and groups from historical SC
 \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
+.TP
 \fB\-\-solve\-welleq\-initially\fR=\fI\,BOOLEAN\/\fR
 Fully solve the well equations before each iteration of the reservoir model. Default: true
 .TP
+\fB\-\-solver\-continue\-on\-convergence\-failure\fR=\fI\,BOOLEAN\/\fR
+Continue instead of stop when minimum solver time step is reached. Default: false
+.TP
 \fB\-\-solver\-growth\-factor\fR=\fI\,SCALAR\/\fR
 The factor time steps are elongated after a successful substep. Default: 2
 .TP
@@ -277,8 +303,17 @@ The factor time steps are elongated after restarts. Default: 0.33
 \fB\-\-solver\-verbosity\fR=\fI\,INTEGER\/\fR
 Specify the "chattiness" of the non\-linear solver itself. Default: 1
 .TP
-\fB\-\-strict\-inner\-iter\-ms\-wells\fR=\fI\,INTEGER\/\fR
+\fB\-\-strict\-inner\-iter\-wells\fR=\fI\,INTEGER\/\fR
-Number of inner iterations for multi\-segment wells with strict tolerance. Default: 40
+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
+.TP
+\fB\-\-temperature\-max\fR=\fI\,SCALAR\/\fR
+Maximum absolute temperature. Default: 400
+.TP
+\fB\-\-temperature\-min\fR=\fI\,SCALAR\/\fR
+Minimum absolute temperature. Default: 280
 .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
@@ -340,12 +375,6 @@ Update scaling factors for mass balance equations during the run. Default: false
 \fB\-\-use\-gmres\fR=\fI\,BOOLEAN\/\fR
 Use GMRES as the linear solver. Default: false
 .TP
-\fB\-\-use\-inner\-iterations\-ms\-wells\fR=\fI\,BOOLEAN\/\fR
-Use nested iterations for multi\-segment wells. Default: true
-.TP
-\fB\-\-use\-inner\-iterations\-wells\fR=\fI\,BOOLEAN\/\fR
-Use nested iterations for standard wells. Default: false
-.TP
 \fB\-\-use\-multisegment\-well\fR=\fI\,BOOLEAN\/\fR
 Use the well model for multi\-segment wells instead of the one for single\-segment wells. Default: true
 .TP