mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-16 20:24:48 -06:00
Update flow manpage with help2man.
Not ideal as it uses our help message. Unfortunately, the description in there are not the best.
This commit is contained in:
Markus Blatt
parent
fadc96da44
commit
b50c19eb17
128
doc/man1/flow.1
128
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 2023" "flow 2023.10" "User Commands"
|
||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
||||
.TH FLOW "1" "October 2024" "flow" "User Commands"
|
||||
.SH NAME
|
||||
flow \- Eclipse compatible parallel reservoir simulator
|
||||
.SH SYNOPSIS
|
||||
@ -16,20 +16,41 @@ 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, openclSolver, amgcl or rocalution) in the linear solver, usage: '\-\-accelerator\-mode=[none|cusparse|opencl|amgcl|rocalution]'. Default: "none"
|
||||
Use/choose a GPU accelerator for linear solver, usage: '\-\-accelerator\-mode=[none|cusparse|opencl|amgcl|rocalution|rocsparse]'. Default: "none"
|
||||
.TP
|
||||
\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\-\-allow\-distributed\-wells\fR=\fI\,BOOLEAN\/\fR
|
||||
Allow the perforations of a well to be distributed to interior of multiple processes. Default: false
|
||||
.TP
|
||||
\fB\-\-allow\-splitting\-inactive\-wells\fR=\fI\,BOOLEAN\/\fR
|
||||
Allow inactive (never non\-shut) wells to be split across multiple domains. Default: true
|
||||
.TP
|
||||
\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
|
||||
\fB\-\-check\-satfunc\-consistency\fR=\fI\,BOOLEAN\/\fR
|
||||
Whether or not to check saturation function consistency requirements. Default: false
|
||||
.TP
|
||||
\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\-\-convergence\-monitoring\fR=\fI\,BOOLEAN\/\fR
|
||||
Enable convergence monitoring. Default: false
|
||||
.TP
|
||||
\fB\-\-convergence\-monitoring\-cut\-off\fR=\fI\,INTEGER\/\fR
|
||||
Cut off limit for convergence monitoring. Default: 6
|
||||
.TP
|
||||
\fB\-\-convergence\-monitoring\-decay\-factor\fR=\fI\,SCALAR\/\fR
|
||||
Decay factor for convergence monitoring. Default: 0.75
|
||||
.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: 30
|
||||
.TP
|
||||
@ -51,9 +72,6 @@ Maximum absolute change of a well's volume fraction in a single iteration. Defau
|
||||
\fB\-\-ecl\-deck\-file\-name\fR=\fI\,STRING\/\fR
|
||||
The name of the file which contains the ECL deck to be simulated. Default: ""
|
||||
.TP
|
||||
\fB\-\-ecl\-enable\-drift\-compensation\fR=\fI\,BOOLEAN\/\fR
|
||||
Enable partial compensation of systematic mass losses via the source term of the next time step. Default: true
|
||||
.TP
|
||||
\fB\-\-ecl\-output\-double\-precision\fR=\fI\,BOOLEAN\/\fR
|
||||
Tell the output writer to use double precision. Useful for 'perfect' restarts. Default: false
|
||||
.TP
|
||||
@ -72,6 +90,9 @@ Write the ECL\-formated results in a non\-blocking way (i.e., using a separate t
|
||||
\fB\-\-enable\-async\-vtk\-output\fR=\fI\,BOOLEAN\/\fR
|
||||
Dispatch a separate thread to write the VTK output. Default: true
|
||||
.TP
|
||||
\fB\-\-enable\-drift\-compensation\fR=\fI\,BOOLEAN\/\fR
|
||||
Enable partial compensation of systematic mass losses via the source term of the next time step. Default: false
|
||||
.TP
|
||||
\fB\-\-enable\-dry\-run\fR=\fI\,STRING\/\fR
|
||||
Specify if the simulation ought to be actually run, or just pretended to be. Default: "auto"
|
||||
.TP
|
||||
@ -132,11 +153,26 @@ The relaxation factor of the linear solver's ILU preconditioner. Default: 0.9
|
||||
\fB\-\-ilu\-reorder\-spheres\fR=\fI\,BOOLEAN\/\fR
|
||||
Whether to reorder the entries of the matrix in the red\-black ILU preconditioner in spheres starting at an edge. If false the original ordering is preserved in each color. Otherwise why try to ensure D4 ordering (in a 2D structured grid, the diagonal elements are consecutive). Default: false
|
||||
.TP
|
||||
\fB\-\-imbalance\-tol\fR=\fI\,SCALAR\/\fR
|
||||
Tolerable imbalance of the loadbalancing (default: 1.1). Default: 1.1
|
||||
.TP
|
||||
\fB\-\-initial\-time\-step\-in\-days\fR=\fI\,SCALAR\/\fR
|
||||
The size of the initial time step in days. Default: 1
|
||||
.TP
|
||||
\fB\-\-inj\-mult\-damp\-mult\fR=\fI\,SCALAR\/\fR
|
||||
Injection multiplier dampening factor (dampening multiplied by this each time oscillation is detected). Default: 0.9
|
||||
.TP
|
||||
\fB\-\-inj\-mult\-min\-damp\-factor\fR=\fI\,SCALAR\/\fR
|
||||
Minimum injection multiplier dampening factor (maximum dampening level). Default: 0.05
|
||||
.TP
|
||||
\fB\-\-inj\-mult\-osc\-threshold\fR=\fI\,SCALAR\/\fR
|
||||
Injection multiplier oscillation threshold (used for multiplier dampening). Default: 0.1
|
||||
.TP
|
||||
\fB\-\-input\-skip\-mode\fR=\fI\,STRING\/\fR
|
||||
Set compatibility mode for the SKIP100/SKIP300 keywords. Options are 100 (skip SKIP100..ENDSKIP, keep SKIP300..ENDSKIP) [default], 300 (skip SKIP300..ENDSKIP, keep SKIP100..ENDSKIP) and all (skip both SKIP100..ENDSKIP and SKIP300..ENDSKIP) . Default: "100"
|
||||
.TP
|
||||
\fB\-\-linear\-solver\fR=\fI\,STRING\/\fR
|
||||
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"
|
||||
Configuration of solver. Valid options are: cprw (default), ilu0, dilu, cpr (an alias for cprw), cpr_quasiimpes, cpr_trueimpes, cpr_trueimpesanalytic, 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: "cprw"
|
||||
.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
|
||||
@ -160,7 +196,7 @@ The verbosity level of the linear solver (0: off, 2: all). Default: 0
|
||||
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"
|
||||
Subdomain ordering measure. Allowed values are 'maxpressure', 'averagepressure' and 'residual'. Default: "maxpressure"
|
||||
.TP
|
||||
\fB\-\-local\-domains\-partitioning\-imbalance\fR=\fI\,SCALAR\/\fR
|
||||
Subdomain partitioning imbalance tolerance. 1.03 is 3 percent imbalance. Default: 1.03
|
||||
@ -169,16 +205,16 @@ Subdomain partitioning imbalance tolerance. 1.03 is 3 percent imbalance. Default
|
||||
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"
|
||||
Choose local solve approach. Valid choices are jacobi and gauss\-seidel. Default: "gauss\-seidel"
|
||||
.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
|
||||
Set lower than 1.0 to use stricter convergence tolerance for local solves. Default: 0.1
|
||||
.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
|
||||
Allow control switching during local well solutions. Default: true
|
||||
.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
|
||||
@ -208,7 +244,7 @@ Maximum time step size where single precision floating point arithmetic can be u
|
||||
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
|
||||
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
|
||||
@ -216,11 +252,17 @@ Maximum number of times a well can switch to the same control. Default: 3
|
||||
\fB\-\-maximum\-water\-saturation\fR=\fI\,SCALAR\/\fR
|
||||
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"
|
||||
.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 entries, otherwise subtract them), MILU_4 (if diagonal is positive add sum of dropped row entries, 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
|
||||
Minimum number of Newton iterations before relaxed tolerances can be used for the CNV convergence criterion. Default: \fB\-1\fR
|
||||
.TP
|
||||
\fB\-\-min\-strict\-mb\-iter\fR=\fI\,INTEGER\/\fR
|
||||
Minimum number of Newton iterations before relaxed tolerances can be used for the MB convergence criterion. Default \fB\-1\fR means that the relaxed tolerance is used when maximum number of Newton iterations are reached. Default: \fB\-1\fR
|
||||
.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
|
||||
@ -241,13 +283,19 @@ The maximum number of Newton iterations per time step. Default: 20
|
||||
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
|
||||
The minimum number of Newton iterations per time step. Default: 2
|
||||
.TP
|
||||
\fB\-\-newton\-relaxation\-type\fR=\fI\,STRING\/\fR
|
||||
The type of relaxation used by Newton method. Default: "dampen"
|
||||
.TP
|
||||
\fB\-\-num\-jacobi\-blocks\fR=\fI\,INTEGER\/\fR
|
||||
Number of blocks to be created for the Block\-Jacobi preconditioner. Default: 0
|
||||
\fB\-\-nldd\-local\-linear\-solver\fR=\fI\,STRING\/\fR
|
||||
Configuration of NLDD local linear solver. Valid options are: ilu0 (default), dilu, cpr_quasiimpes and 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\-\-nldd\-local\-linear\-solver\-max\-iter\fR=\fI\,INTEGER\/\fR
|
||||
The maximum number of iterations of the NLDD local linear solver. Default: 200
|
||||
.TP
|
||||
\fB\-\-nldd\-local\-linear\-solver\-reduction\fR=\fI\,SCALAR\/\fR
|
||||
The minimum reduction of the residual which the NLDD local linear solver must achieve. Default: 0.01
|
||||
.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
|
||||
@ -258,6 +306,9 @@ 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\-satfunc\-consistency\-sample\-points\fR=\fI\,INTEGER\/\fR
|
||||
Maximum number of reported failures for each individual saturation function consistency check. Default: 5
|
||||
.TP
|
||||
\fB\-\-opencl\-ilu\-parallel\fR=\fI\,BOOLEAN\/\fR
|
||||
Parallelize ILU decomposition and application on GPU. Default: true
|
||||
.TP
|
||||
@ -285,15 +336,24 @@ An .ini file which contains a set of run\-time parameters. Default: ""
|
||||
\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\-\-partition\-method\fR=\fI\,INTEGER\/\fR
|
||||
Choose partitioning strategy: 0=simple, 1=Zoltan, 2=METIS. Default: 1
|
||||
.TP
|
||||
\fB\-\-pressure\-max\fR=\fI\,SCALAR\/\fR
|
||||
Maximum absolute pressure. Default: 1e+99
|
||||
.TP
|
||||
\fB\-\-pressure\-min\fR=\fI\,SCALAR\/\fR
|
||||
Minimum absolute pressure. Default: \fB\-1e\fR+99
|
||||
.TP
|
||||
\fB\-\-pressure\-scale\fR=\fI\,SCALAR\/\fR
|
||||
Scaling of pressure primary variable. Default: 1
|
||||
.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
|
||||
The threshold value for the primary variable switching conditions after its meaning has switched to hinder oscillations. Default: 1e\-05
|
||||
.TP
|
||||
\fB\-\-print\-parameters\fR=\fI\,INTEGER\/\fR
|
||||
Print the values of the run\-time parameters at the start of the simulation. Default: 2
|
||||
.TP
|
||||
\fB\-\-print\-properties\fR=\fI\,INTEGER\/\fR
|
||||
Print the values of the compile time properties at the start of the simulation. Default: 2
|
||||
.TP
|
||||
\fB\-\-project\-saturations\fR=\fI\,BOOLEAN\/\fR
|
||||
Option for doing saturation projection. Default: false
|
||||
.TP
|
||||
@ -373,7 +433,7 @@ The maximum number of threads to be instantiated per process ('\-1' means 'autom
|
||||
Time step size of the first time step after an event occurs during the simulation in days. Default: \fB\-1\fR
|
||||
.TP
|
||||
\fB\-\-time\-step\-control\fR=\fI\,STRING\/\fR
|
||||
The algorithm used to determine time\-step sizes. valid options are: 'pid' (default), 'pid+iteration', 'pid+newtoniteration', 'iterationcount', 'newtoniterationcount' and 'hardcoded'. Default: "pid+newtoniteration"
|
||||
The algorithm used to determine time\-step sizes. Valid options are: 'pid' (default), 'pid+iteration', 'pid+newtoniteration', 'iterationcount', 'newtoniterationcount' and 'hardcoded'. Default: "pid+newtoniteration"
|
||||
.TP
|
||||
\fB\-\-time\-step\-control\-decay\-damping\-factor\fR=\fI\,SCALAR\/\fR
|
||||
The decay rate of the time step decrease when the target iterations is exceeded. Default: 1
|
||||
@ -405,11 +465,26 @@ Specify the "chattiness" during the time integration. Default: 1
|
||||
\fB\-\-tolerance\-cnv\fR=\fI\,SCALAR\/\fR
|
||||
Local convergence tolerance (Maximum of local saturation errors). Default: 0.01
|
||||
.TP
|
||||
\fB\-\-tolerance\-cnv\-energy\fR=\fI\,SCALAR\/\fR
|
||||
Local energy convergence tolerance (Maximum of local energy errors). Default: 0.01
|
||||
.TP
|
||||
\fB\-\-tolerance\-cnv\-energy\-relaxed\fR=\fI\,SCALAR\/\fR
|
||||
Relaxed local energy convergence tolerance that applies for iterations after the iterations with the strict tolerance. Default: 1
|
||||
.TP
|
||||
\fB\-\-tolerance\-cnv\-relaxed\fR=\fI\,SCALAR\/\fR
|
||||
Relaxed local convergence tolerance that applies for iterations after the iterations with the strict tolerance. Default: 1
|
||||
.TP
|
||||
\fB\-\-tolerance\-energy\-balance\fR=\fI\,SCALAR\/\fR
|
||||
Tolerated energy balance error relative to (scaled) total energy present. Default: 1e\-07
|
||||
.TP
|
||||
\fB\-\-tolerance\-energy\-balance\-relaxed\fR=\fI\,SCALAR\/\fR
|
||||
Relaxed tolerated energy balance error that applies for iterations after the iterations with the strict tolerance. Default: 1e\-06
|
||||
.TP
|
||||
\fB\-\-tolerance\-mb\fR=\fI\,SCALAR\/\fR
|
||||
Tolerated mass balance error relative to total mass present. Default: 1e\-06
|
||||
Tolerated mass balance error relative to total mass present. Default: 1e\-07
|
||||
.TP
|
||||
\fB\-\-tolerance\-mb\-relaxed\fR=\fI\,SCALAR\/\fR
|
||||
Relaxed tolerated mass balance error that applies for iterations after the iterations with the strict tolerance. Default: 1e\-06
|
||||
.TP
|
||||
\fB\-\-tolerance\-pressure\-ms\-wells\fR=\fI\,SCALAR\/\fR
|
||||
Tolerance for the pressure equations for multi\-segment wells. Default: 1000
|
||||
@ -426,6 +501,9 @@ 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\-implicit\-ipr\fR=\fI\,BOOLEAN\/\fR
|
||||
Compute implict IPR for stability checks and stable solution search. Default: true
|
||||
.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
|
||||
@ -434,6 +512,4 @@ Try to detect and correct oscillations or stagnation during the Newton method. D
|
||||
.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
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user