mirror of
https://github.com/OPM/opm-simulators.git
synced 2026-10-25 15:10:09 -05:00
[doc] Updated man page to reflect changes of flow help message.
Until the recent release, only.
This commit is contained in:
1 parent
27f53657ef
commit
7c6f60d21b
1 file changed
+55
-12
+55
-12
@@ -1,5 +1,5 @@
|
||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
||||
.TH FLOW "1" "October 2024" "flow" "User Commands"
|
||||
.\" This file was generated by help2man 1.49.3. but edited later
|
||||
.TH FLOW "1" "October 2025" "flow" "User Commands"
|
||||
.SH NAME
|
||||
flow \- Eclipse compatible parallel reservoir simulator
|
||||
.SH SYNOPSIS
|
||||
@@ -21,6 +21,10 @@ Use/choose a GPU accelerator for linear solver, usage: '\-\-accelerator\-mode=[n
|
||||
\fB\-\-action\-parsing\-strictness\fR=\fI\,STRING\/\fR
|
||||
Set strictness of parsing process for ActionX and PyAction. Available options are normal (do not apply keywords that have not been tested for ActionX or PyAction) and low (try to apply all keywords, beware: the simulation outcome might be incorrect). Default: "normal"
|
||||
.TP
|
||||
\fB\-\-add\-corners\fR=\fI\,BOOLEAN\/\fR
|
||||
Whether to add overlap cells to the partition that do not share an
|
||||
intersection with other cells in the partition, but just a corner. . Default: "false"
|
||||
.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
|
||||
@@ -30,9 +34,6 @@ Allow inactive (never non\-shut) wells to be split across multiple domains. Defa
|
||||
\fB\-\-alternative\-well\-rate\-init\fR=\fI\,BOOLEAN\/\fR
|
||||
Use alternative well rate initialization procedure. Default: true
|
||||
.TP
|
||||
\fB\-\-bda\-device\-id\fR=\fI\,INTEGER\/\fR
|
||||
Choose device ID for cusparseSolver or openclSolver, use 'nvidia\-smi' or 'clinfo' to determine valid IDs. Default: 0
|
||||
.TP
|
||||
\fB\-\-check\-group\-constraints\-inner\-well\-iterations\fR=\fI\,BOOLEAN\/\fR
|
||||
Allow checking of group constraints during inner well iterations. Default: true
|
||||
.TP
|
||||
@@ -138,6 +139,9 @@ Do not print reservoir volumes values after each report step even if requested b
|
||||
\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\-device\-id\fR=\fI\,INTEGER\/\fR
|
||||
Choose device ID for cusparseSolver or openclSolver, use 'nvidia\-smi' or 'clinfo' to determine valid IDs. Default: 0
|
||||
.TP
|
||||
\fB\-\-ignore\-keywords\fR=\fI\,STRING\/\fR
|
||||
List of Eclipse keywords which should be ignored. As a ':' separated string. Default: ""
|
||||
.TP
|
||||
@@ -198,6 +202,11 @@ Load serialized state from .OPMRST file. Either a specific report step, or 0 to
|
||||
\fB\-\-local\-domains\-ordering\-measure\fR=\fI\,STRING\/\fR
|
||||
Subdomain ordering measure. Allowed values are 'maxpressure', 'averagepressure' and 'residual'. Default: "maxpressure"
|
||||
.TP
|
||||
.TP
|
||||
\fB\-\-local\-domains\-well\-neighbor-levels\fR=\fI\,INTEGER\/\fR
|
||||
Number of neighbor levels of cells around wells to include in the same domain
|
||||
during NLDD partitioning. Default: 1
|
||||
.TP
|
||||
\fB\-\-local\-domains\-partitioning\-imbalance\fR=\fI\,SCALAR\/\fR
|
||||
Subdomain partitioning imbalance tolerance. 1.03 is 3 percent imbalance. Default: 1.03
|
||||
.TP
|
||||
@@ -246,6 +255,9 @@ Maximum absolute change of temperature in a single iteration. Default: 5
|
||||
\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\-group\-switches\fR=\fI\,INTEGER\/\fR
|
||||
Maximum number of times a group can switch to the same control. Default: 3
|
||||
.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
|
||||
@@ -253,7 +265,11 @@ Maximum number of times a well can switch to the same control. Default: 3
|
||||
Maximum water saturation. Default: 1
|
||||
.TP
|
||||
\fB\-\-metis\-params\fR=\fI\,STRING\/\fR
|
||||
Configuration of Metis partitioner. You can request a configuration to be read from a JSON file by giving the filename here, ending with '.json.' See http://glaros.dtc.umn.edu/gkhome/fetch/sw/metis/manual.pdffor available METIS options. Default: "default"
|
||||
Configuration of Metis partitioner. You can request a configuration to
|
||||
be read from a JSON file by giving the filename here, ending with
|
||||
extension '.json.' See
|
||||
http://glaros.dtc.umn.edu/gkhome/fetch/sw/metis/manual.pdf for
|
||||
available METIS options. Default: "default"
|
||||
.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 entries, otherwise subtract them), MILU_4 (if diagonal is positive add sum of dropped row entries, otherwise do nothing. Default: "ILU"
|
||||
@@ -270,11 +286,21 @@ 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
|
||||
\fB\-\-network\-max\-outer\-iterations\fR=\fI\,INTEGER\/\fR
|
||||
Maximum outer number of iterations in the network solver before giving up. Default: 10
|
||||
.TP
|
||||
\fB\-\-network\-max\-strict\-iterations\fR=\fI\,INTEGER\/\fR
|
||||
Maximum iterations in network solver before relaxing tolerance. Default: 100
|
||||
\fB\-\-network\-max\-pressure\-update\-in\-bars\fR=\fI\,SCALAR\/\fR
|
||||
Maximum pressure update in the inner network pressure update iterations. Default: 5
|
||||
.TP
|
||||
\fB\-\-network\-max\-strict\-outer\-iterations\fR=\fI\,INTEGER\/\fR
|
||||
Maximum outer iterations in network solver before relaxing tolerance. Default: 10
|
||||
.TP
|
||||
\fB\-\-network\-max\-sub\-iterations\fR=\fI\,INTEGER\/\fR
|
||||
Maximum number of sub-iterations to update network pressures (within a
|
||||
single well/group control update). Default: 20
|
||||
.TP
|
||||
\fB\-\-network\-pressure\-damping\-factor\fR=\fI\,SCALAR\/\fR
|
||||
Damping factor in the inner network pressure update iterations. Default: 0.1
|
||||
.TP
|
||||
\fB\-\-newton\-max\-iterations\fR=\fI\,INTEGER\/\fR
|
||||
The maximum number of Newton iterations per time step. Default: 20
|
||||
@@ -306,9 +332,17 @@ Choose nonlinear solver. Valid choices are newton or nldd. Default: "newton"
|
||||
\fB\-\-num\-local\-domains\fR=\fI\,INTEGER\/\fR
|
||||
Number of local domains for NLDD nonlinear solver. Default: 0
|
||||
.TP
|
||||
\fB\-\-num\-overlap\fR=\fI\,INTEGER\/\fR
|
||||
Numbers of layers overlap in parallel partition. Default: 1
|
||||
.TP
|
||||
\fB\-\-num\-satfunc\-consistency\-sample\-points\fR=\fI\,INTEGER\/\fR
|
||||
Maximum number of reported failures for each individual saturation function consistency check. Default: 5
|
||||
.TP
|
||||
\fB\-\-nupcol\-group\-rate\-tolerance\fR=\fI\,SCALAR\/\fR
|
||||
Tolerance for acceptable changes in VREP/RAIN group rates. Default:
|
||||
0.001
|
||||
.TP
|
||||
.TP
|
||||
\fB\-\-opencl\-ilu\-parallel\fR=\fI\,BOOLEAN\/\fR
|
||||
Parallelize ILU decomposition and application on GPU. Default: true
|
||||
.TP
|
||||
@@ -337,7 +371,11 @@ An .ini file which contains a set of run\-time parameters. Default: ""
|
||||
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\-\-partition\-method\fR=\fI\,INTEGER\/\fR
|
||||
Choose partitioning strategy: 0=simple, 1=Zoltan, 2=METIS. Default: 1
|
||||
Choose partitioning strategy: 0=simple, 1=Zoltan, 2=METIS, 3=Zoltan
|
||||
with all cells of well represented by one vertex. Default: 3
|
||||
.TP
|
||||
\fB\-\-pre\-solve\-network\fR=\fI\,BOOLEAN\/\fR
|
||||
Whether to pre solve and iterate the network model at start-up. Default: true
|
||||
.TP
|
||||
\fB\-\-pressure\-max\fR=\fI\,SCALAR\/\fR
|
||||
Maximum absolute pressure. Default: 1e+99
|
||||
@@ -427,7 +465,7 @@ Maximum absolute temperature. Default: 1e+09
|
||||
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
|
||||
The maximum number of threads to be instantiated per process ('\-1' means 'automatic'). Default: \fB\2\fR
|
||||
.TP
|
||||
\fB\-\-time\-step\-after\-event\-in\-days\fR=\fI\,SCALAR\/\fR
|
||||
Time step size of the first time step after an event occurs during the simulation in days. Default: \fB\-1\fR
|
||||
@@ -450,6 +488,11 @@ The growth rate of the time step increase when the target iterations is undercut
|
||||
\fB\-\-time\-step\-control\-growth\-rate\fR=\fI\,SCALAR\/\fR
|
||||
The growth rate of the time step size of the number of target iterations is undercut. Default: 1.25
|
||||
.TP
|
||||
\fB\-\-time\-step\-control\-safety\-factor\fR=\fI\,SCALAR\/\fR
|
||||
Value to be multiplied with the time step control tolerance to ensure
|
||||
that the target relative change is lower than the tolerance. Default:
|
||||
0.8
|
||||
.TP
|
||||
\fB\-\-time\-step\-control\-target\-iterations\fR=\fI\,INTEGER\/\fR
|
||||
The number of linear iterations which the time step control scheme should aim for (if applicable). Default: 30
|
||||
.TP
|
||||
|
||||
Reference in new issue
Block a user