From 64cdc95fac1752c96d5770a8b5fc3a771ac0ed84 Mon Sep 17 00:00:00 2001 From: Markus Blatt Date: Wed, 21 Apr 2021 13:08:14 +0200 Subject: [PATCH 1/5] Added man pages for flow. Generated using: declare -A short_desc short_desc['flow']='Eclipse compatible parallel reservoir simulator' short_desc['ebos']='Eclipse compatible parallel reservoir simulator for research' for key in "${!short_desc[@]}"; do help2man -h "-h" --version-string="2021.04" --no-discard-stderr -n "${short_desc[$key]}" -N $key >\ $key.1 done Gbp-Pq: Name 0002-Added-man-pages-for-flow-and-ebos.patch --- CMakeLists.txt | 3 + doc/man1/flow.1 | 364 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 367 insertions(+) create mode 100644 doc/man1/flow.1 diff --git a/CMakeLists.txt b/CMakeLists.txt index 9462281c6..196589391 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -487,3 +487,6 @@ if(HAVE_FPGA) ExternalProject_Get_Property(FPGA_library binary_dir) target_link_libraries(opmsimulators PUBLIC ${binary_dir}/fpga_lib_alveo_u280.a) endif() + +install(DIRECTORY doc/man1 DESTINATION ${CMAKE_INSTALL_MANDIR} + FILES_MATCHING PATTERN "*.1") diff --git a/doc/man1/flow.1 b/doc/man1/flow.1 new file mode 100644 index 000000000..94e5c7712 --- /dev/null +++ b/doc/man1/flow.1 @@ -0,0 +1,364 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. +.TH FLOW "1" "April 2021" "flow 2021.04" "User Commands" +.SH NAME +flow \- Eclipse compatible parallel reservoir simulator +.SH SYNOPSIS +.B flow +[\fI\,OPTIONS\/\fR] [\fI\,ECL_DECK_FILENAME\/\fR] +.SH DESCRIPTION +Flow, an advanced reservoir simulator for ECL\-decks provided by the Open Porous Media project. +.SS "Recognized options:" +.TP +\fB\-h\fR,\-\-help +Print this help message and exit +.TP +\fB\-\-help\-all\fR +Print all parameters, including obsolete, hidden and deprecated ones. +.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\-\-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\-\-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\-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 +.TP +\fB\-\-dbhp\-max\-rel\fR=\fI\,SCALAR\/\fR +Maximum relative change of the bottom\-hole pressure in a single iteration. Default: 1 +.TP +\fB\-\-dp\-max\-rel\fR=\fI\,SCALAR\/\fR +Maximum relative change of pressure in a single iteration. Default: 0.3 +.TP +\fB\-\-ds\-max\fR=\fI\,SCALAR\/\fR +Maximum absolute change of any saturation in a single iteration. Default: 0.2 +.TP +\fB\-\-dwell\-fraction\-max\fR=\fI\,SCALAR\/\fR +Maximum absolute change of a well's volume fraction in a single iteration. Default: 0.2 +.TP +\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 +\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 +\fB\-\-enable\-adaptive\-time\-stepping\fR=\fI\,BOOLEAN\/\fR +Use adaptive time stepping between report steps. Default: true +.TP +\fB\-\-enable\-async\-ecl\-output\fR=\fI\,BOOLEAN\/\fR +Write the ECL\-formated results in a non\-blocking way (i.e., using a separate thread). Default: true +.TP +\fB\-\-enable\-async\-vtk\-output\fR=\fI\,BOOLEAN\/\fR +Dispatch a separate thread to write the VTK output. Default: true +.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 +\fB\-\-enable\-ecl\-output\fR=\fI\,BOOLEAN\/\fR +Write binary output which is compatible with the commercial Eclipse simulator. Default: true +.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 +\fB\-\-enable\-opm\-rst\-file\fR=\fI\,BOOLEAN\/\fR +Include OPM\-specific keywords in the ECL restart file to enable restart of OPM simulators from these files. Default: false +.TP +\fB\-\-enable\-storage\-cache\fR=\fI\,BOOLEAN\/\fR +Store previous storage terms and avoid re\-calculating them. Default: true +.TP +\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: false +.TP +\fB\-\-enable\-tuning\fR=\fI\,BOOLEAN\/\fR +Honor some aspects of the TUNING keyword. Default: false +.TP +\fB\-\-enable\-vtk\-output\fR=\fI\,BOOLEAN\/\fR +Global switch for turning on writing VTK files. Default: false +.TP +\fB\-\-enable\-well\-operability\-check\fR=\fI\,BOOLEAN\/\fR +Enable the well operability checking. Default: true +.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 +\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 +\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 +\fB\-\-ilu\-fillin\-level\fR=\fI\,INTEGER\/\fR +The fill\-in level of the linear solver's ILU preconditioner. Default: 0 +.TP +\fB\-\-ilu\-redblack\fR=\fI\,BOOLEAN\/\fR +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 +.TP +\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\-\-initial\-time\-step\-in\-days\fR=\fI\,SCALAR\/\fR +The size of the initial time step in days. Default: 1 +.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\-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\-\-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" +.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 +\fB\-\-max\-inner\-iter\-ms\-wells\fR=\fI\,INTEGER\/\fR +Maximum number of inner iterations for multi\-segment wells. Default: 100 +.TP +\fB\-\-max\-inner\-iter\-wells\fR=\fI\,INTEGER\/\fR +Maximum number of inner iterations for standard wells. Default: 50 +.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 +\fB\-\-max\-residual\-allowed\fR=\fI\,SCALAR\/\fR +Absolute maximum tolerated for residuals without cutting the time step size. Default: 1e+07 +.TP +\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\-welleq\-iter\fR=\fI\,INTEGER\/\fR +Maximum number of iterations to determine solution the well equations. Default: 30 +.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 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 +.TP +\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\-\-newton\-max\-relax\fR=\fI\,SCALAR\/\fR +The maximum relaxation factor of a Newton iteration used by flow. Default: 0.5 +.TP +\fB\-\-newton\-relaxation\-type\fR=\fI\,STRING\/\fR +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, 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: "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 +.TP +\fB\-\-output\-dir\fR=\fI\,STRING\/\fR +The directory to which result files are written. Default: "" +.TP +\fB\-\-output\-interval\fR=\fI\,INTEGER\/\fR +Specify the number of report steps between two consecutive writes of restart data. Default: 1 +.TP +\fB\-\-output\-mode\fR=\fI\,STRING\/\fR +Specify which messages are going to be printed. Valid values are: none, log, all (default). Default: "all" +.TP +\fB\-\-owner\-cells\-first\fR=\fI\,BOOLEAN\/\fR +Order cells owned by rank before ghost/overlap cells. Default: true +.TP +\fB\-\-parameter\-file\fR=\fI\,STRING\/\fR +An .ini file which contains a set of run\-time parameters. Default: "" +.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 +\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 +\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 +Relaxed tolerance for the inner iteration for the MSW pressure solution. Default: 50000 +.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 +.TP +\fB\-\-serial\-partitioning\fR=\fI\,BOOLEAN\/\fR +Perform partitioning for parallel runs on a single process. 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\-growth\-factor\fR=\fI\,SCALAR\/\fR +The factor time steps are elongated after a successful substep. Default: 2 +.TP +\fB\-\-solver\-max\-growth\fR=\fI\,SCALAR\/\fR +The maximum factor time steps are elongated after a report step. Default: 3 +.TP +\fB\-\-solver\-max\-restarts\fR=\fI\,INTEGER\/\fR +The maximum number of breakdowns before a substep is given up and the simulator is terminated. Default: 10 +.TP +\fB\-\-solver\-max\-time\-step\-in\-days\fR=\fI\,SCALAR\/\fR +The maximum size of a time step in days. Default: 365 +.TP +\fB\-\-solver\-min\-time\-step\fR=\fI\,SCALAR\/\fR +The minimum size of a time step in days for field and metric and hours for lab. If a step cannot converge without getting cut below this step size the simulator will stop. Default: 1e\-12 +.TP +\fB\-\-solver\-restart\-factor\fR=\fI\,SCALAR\/\fR +The factor time steps are elongated after restarts. Default: 0.33 +.TP +\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 +Number of inner iterations for multi\-segment wells with strict tolerance. Default: 40 +.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 +.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 +.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" +.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 +.TP +\fB\-\-time\-step\-control\-decay\-rate\fR=\fI\,SCALAR\/\fR +The decay rate of the time step size of the number of target iterations is exceeded. Default: 0.75 +.TP +\fB\-\-time\-step\-control\-file\-name\fR=\fI\,STRING\/\fR +The name of the file which contains the hardcoded time steps sizes. Default: "timesteps" +.TP +\fB\-\-time\-step\-control\-growth\-damping\-factor\fR=\fI\,SCALAR\/\fR +The growth rate of the time step increase when the target iterations is undercut. Default: 3.2 +.TP +\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\-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 +\fB\-\-time\-step\-control\-target\-newton\-iterations\fR=\fI\,INTEGER\/\fR +The number of Newton iterations which the time step control scheme should aim for (if applicable). Default: 8 +.TP +\fB\-\-time\-step\-control\-tolerance\fR=\fI\,SCALAR\/\fR +The tolerance used by the time step size control algorithm. Default: 0.1 +.TP +\fB\-\-time\-step\-verbosity\fR=\fI\,INTEGER\/\fR +Specify the "chattiness" during the time integration. Default: 1 +.TP +\fB\-\-tolerance\-cnv\fR=\fI\,SCALAR\/\fR +Local convergence tolerance (Maximum of local saturation errors). Default: 0.01 +.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\-mb\fR=\fI\,SCALAR\/\fR +Tolerated mass balance error relative to total mass present. Default: 1e\-06 +.TP +\fB\-\-tolerance\-pressure\-ms\-wells\fR=\fI\,SCALAR\/\fR +Tolerance for the pressure equations for multi\-segment wells. Default: 1000 +.TP +\fB\-\-tolerance\-well\-control\fR=\fI\,SCALAR\/\fR +Tolerance for the well control equations. Default: 1e\-07 +.TP +\fB\-\-tolerance\-wells\fR=\fI\,SCALAR\/\fR +Well convergence tolerance. Default: 0.0001 +.TP +\fB\-\-update\-equations\-scaling\fR=\fI\,BOOLEAN\/\fR +Update scaling factors for mass balance equations during the run. Default: false +.TP +\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 +\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 From 7fa9e8d983a427a8618754c7ffe5c8c2be2b06f6 Mon Sep 17 00:00:00 2001 From: Markus Blatt Date: Wed, 21 Apr 2021 15:59:34 +0200 Subject: [PATCH 2/5] Manually fix unbreakable long lines. Warning was: W: libopm-simulators-bin: manpage-has-errors-from-man usr/share/man/man1/flow.1.gz 202: warning [p 5, 0.5i]: cannot adjust line Gbp-Pq: Name 0003-Manually-fix-unbreakable-long-lines.patch --- doc/man1/flow.1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/man1/flow.1 b/doc/man1/flow.1 index 94e5c7712..fed1a1170 100644 --- a/doc/man1/flow.1 +++ b/doc/man1/flow.1 @@ -199,7 +199,8 @@ 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, 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: "graph_coloring" +Choose the reordering strategy for ILU for openclSolver, possible +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 From a2246d331b61500a7a98d90466cc08541462579a Mon Sep 17 00:00:00 2001 From: Markus Blatt Date: Fri, 2 Jul 2021 14:56:19 +0200 Subject: [PATCH 3/5] Spelling fixes Gbp-Pq: Name 0005-Spelling-fixes.patch --- doc/man1/flow.1 | 4 ++-- ebos/eclgenerictracermodel.cc | 2 +- ebos/eclproblem.hh | 2 +- opm/core/props/satfunc/RelpermDiagnostics.cpp | 2 +- opm/simulators/flow/BlackoilModelEbos.hpp | 2 +- opm/simulators/linalg/FlowLinearSolverParameters.hpp | 4 ++-- opm/simulators/linalg/ParallelOverlappingILU0.hpp | 2 +- opm/simulators/linalg/bda/FPGABILU0.cpp | 2 +- opm/simulators/linalg/bda/openclKernels.cpp | 2 +- opm/simulators/wells/BlackoilWellModel.hpp | 2 +- opm/simulators/wells/BlackoilWellModelGeneric.cpp | 2 +- opm/simulators/wells/GasLiftStage2.cpp | 2 +- opm/simulators/wells/WellGroupHelpers.cpp | 2 +- opm/simulators/wells/WellInterfaceGeneric.cpp | 4 ++-- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/man1/flow.1 b/doc/man1/flow.1 index fed1a1170..677d06fb8 100644 --- a/doc/man1/flow.1 +++ b/doc/man1/flow.1 @@ -130,7 +130,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 partioning for the ILU preconditioner. Default: false +Use red\-black partitioning 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 @@ -184,7 +184,7 @@ Maximum number of Newton iterations before relaxed tolerances are used for the C Maximum number of iterations to determine solution the well equations. Default: 30 .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 substract 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 subtract 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 diff --git a/ebos/eclgenerictracermodel.cc b/ebos/eclgenerictracermodel.cc index a57d348e8..12faa686e 100644 --- a/ebos/eclgenerictracermodel.cc +++ b/ebos/eclgenerictracermodel.cc @@ -95,7 +95,7 @@ doInit(bool enabled, size_t numGridDof, if (!enabled) { if (gridView_.comm().rank() == 0) { OpmLog::warning("Keyword TRACERS has only experimental support, and is hence ignored.\n" - "The experimental tracer model can still be used, but must be set explicitely.\n" + "The experimental tracer model can still be used, but must be set explicitly.\n" "To use tracers, set the command line option: --enable-tracer-model=true" "\n"); } diff --git a/ebos/eclproblem.hh b/ebos/eclproblem.hh index 805a112cb..40eef6a9e 100644 --- a/ebos/eclproblem.hh +++ b/ebos/eclproblem.hh @@ -2930,7 +2930,7 @@ private: dtNext = std::min(this->maxTimeStepSize_, remainingEpisodeTime/2.0); if (simulator.episodeStarts()) { - // if a well event occured, respect the limit for the maximum time step after + // if a well event occurred, respect the limit for the maximum time step after // that, too int reportStepIdx = std::max(episodeIdx, 0); const auto& events = simulator.vanguard().schedule()[reportStepIdx].events(); diff --git a/opm/core/props/satfunc/RelpermDiagnostics.cpp b/opm/core/props/satfunc/RelpermDiagnostics.cpp index b780b84a1..f3c89be56 100644 --- a/opm/core/props/satfunc/RelpermDiagnostics.cpp +++ b/opm/core/props/satfunc/RelpermDiagnostics.cpp @@ -326,7 +326,7 @@ namespace Opm{ } if (krg.front() > 1.0 || krg.back() < 0) { - const std::string msg = "In SLGOF table SATNUM = " + regionIdx + ", krg shoule be in range [0, 1]."; + const std::string msg = "In SLGOF table SATNUM = " + regionIdx + ", krg should be in range [0, 1]."; OpmLog::error(msg); } if (krg.back() != 0.0) { diff --git a/opm/simulators/flow/BlackoilModelEbos.hpp b/opm/simulators/flow/BlackoilModelEbos.hpp index 0f0ceeeee..6d6c4892f 100644 --- a/opm/simulators/flow/BlackoilModelEbos.hpp +++ b/opm/simulators/flow/BlackoilModelEbos.hpp @@ -267,7 +267,7 @@ namespace Opm { std::fill(wasSwitched_.begin(), wasSwitched_.end(), false); if (param_.update_equations_scaling_) { - std::cout << "equation scaling not suported yet" << std::endl; + std::cout << "equation scaling not supported yet" << std::endl; //updateEquationsScaling(); } report.pre_post_time += perfTimer.stop(); diff --git a/opm/simulators/linalg/FlowLinearSolverParameters.hpp b/opm/simulators/linalg/FlowLinearSolverParameters.hpp index 7fe037779..b702ed799 100644 --- a/opm/simulators/linalg/FlowLinearSolverParameters.hpp +++ b/opm/simulators/linalg/FlowLinearSolverParameters.hpp @@ -304,8 +304,8 @@ namespace Opm EWOMS_REGISTER_PARAM(TypeTag, int, LinearSolverRestart, "The number of iterations after which GMRES is restarted"); EWOMS_REGISTER_PARAM(TypeTag, int, FlowLinearSolverVerbosity, "The verbosity level of the linear solver (0: off, 2: all)"); EWOMS_REGISTER_PARAM(TypeTag, int, IluFillinLevel, "The fill-in level of the linear solver's ILU preconditioner"); - EWOMS_REGISTER_PARAM(TypeTag, std::string, MiluVariant, "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"); - EWOMS_REGISTER_PARAM(TypeTag, bool, IluRedblack, "Use red-black partioning for the ILU preconditioner"); + EWOMS_REGISTER_PARAM(TypeTag, std::string, MiluVariant, "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"); + EWOMS_REGISTER_PARAM(TypeTag, bool, IluRedblack, "Use red-black partitioning for the ILU preconditioner"); EWOMS_REGISTER_PARAM(TypeTag, bool, IluReorderSpheres, "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)."); EWOMS_REGISTER_PARAM(TypeTag, bool, UseGmres, "Use GMRES as the linear solver"); EWOMS_REGISTER_PARAM(TypeTag, bool, LinearSolverRequireFullSparsityPattern, "Produce the full sparsity pattern for the linear solver"); diff --git a/opm/simulators/linalg/ParallelOverlappingILU0.hpp b/opm/simulators/linalg/ParallelOverlappingILU0.hpp index 99a320369..53e4290aa 100644 --- a/opm/simulators/linalg/ParallelOverlappingILU0.hpp +++ b/opm/simulators/linalg/ParallelOverlappingILU0.hpp @@ -1058,7 +1058,7 @@ public: catch (const Dune::MatrixBlockError& error) { message = error.what(); - std::cerr<<"Exception occured on process " << rank << " during " << + std::cerr<<"Exception occurred on process " << rank << " during " << "setup of ILU0 preconditioner with message: " << message<::create_preconditioner(BlockedMatrix *mat jRowEnd = LUMat->rowPointers[j + 1]; jk = diagIndex[j] + 1; ik = ij + 1; - // substract that row scaled by the pivot from this row. + // subtract that row scaled by the pivot from this row. while (ik < iRowEnd && jk < jRowEnd) { if (LUMat->colIndices[ik] == LUMat->colIndices[jk]) { blockMultSub(LUMat->nnzValues + ik * bs * bs, pivot, LUMat->nnzValues + jk * bs * bs); diff --git a/opm/simulators/linalg/bda/openclKernels.cpp b/opm/simulators/linalg/bda/openclKernels.cpp index b21863d78..73871e1ff 100644 --- a/opm/simulators/linalg/bda/openclKernels.cpp +++ b/opm/simulators/linalg/bda/openclKernels.cpp @@ -941,7 +941,7 @@ void OpenclKernels::apply_stdwells_no_reorder(cl::Buffer& d_Cnnzs_ocl, cl::Buffe int jRowEnd = LUrows[j + 1]; int jk = diagIndex[j] + 1; int ik = ij + 1; - // substract that row scaled by the pivot from this row. + // subtract that row scaled by the pivot from this row. while (ik < iRowEnd && jk < jRowEnd) { if (LUcols[ik] == LUcols[jk]) { block_mult_sub(LUvals + ik * bs * bs, pivot + lmem_offset, LUvals + jk * bs * bs); diff --git a/opm/simulators/wells/BlackoilWellModel.hpp b/opm/simulators/wells/BlackoilWellModel.hpp index f07c1638f..657645ffc 100644 --- a/opm/simulators/wells/BlackoilWellModel.hpp +++ b/opm/simulators/wells/BlackoilWellModel.hpp @@ -244,7 +244,7 @@ namespace Opm { return wsrpt; } - // substract Binv(D)rw from r; + // subtract Binv(D)rw from r; void apply( BVector& r) const; // subtract B*inv(D)*C * x from A*x diff --git a/opm/simulators/wells/BlackoilWellModelGeneric.cpp b/opm/simulators/wells/BlackoilWellModelGeneric.cpp index c601f0e18..c43acf1bb 100644 --- a/opm/simulators/wells/BlackoilWellModelGeneric.cpp +++ b/opm/simulators/wells/BlackoilWellModelGeneric.cpp @@ -1091,7 +1091,7 @@ checkGconsaleLimits(const Group& group, double sales_rate = production_rate - injection_rate; double production_target = gconsale.sales_target + injection_rate; - // add import rate and substract consumption rate for group for gas + // add import rate and subtract consumption rate for group for gas if (schedule()[reportStepIdx].gconsump().has(group.name())) { const auto& gconsump = schedule()[reportStepIdx].gconsump().get(group.name(), summaryState_); if (phase_usage_.phase_used[BlackoilPhases::Vapour]) { diff --git a/opm/simulators/wells/GasLiftStage2.cpp b/opm/simulators/wells/GasLiftStage2.cpp index 26101dc7d..d9bbb51dd 100644 --- a/opm/simulators/wells/GasLiftStage2.cpp +++ b/opm/simulators/wells/GasLiftStage2.cpp @@ -932,7 +932,7 @@ getEcoGradients(std::vector &inc_grads, std::vector &dec_gra // Recalculate gradients (and related information, see struct GradInfo in // GasLiftSingleWell.hpp) after an ALQ increment -// has been given from the well with minumum decremental gradient (represented +// has been given from the well with minimum decremental gradient (represented // by the input argument min_dec_grad_itr) to the well with the largest // incremental gradient (represented by input argument max_inc_grad_itr). // diff --git a/opm/simulators/wells/WellGroupHelpers.cpp b/opm/simulators/wells/WellGroupHelpers.cpp index 166376f6a..f7587ae6e 100644 --- a/opm/simulators/wells/WellGroupHelpers.cpp +++ b/opm/simulators/wells/WellGroupHelpers.cpp @@ -642,7 +642,7 @@ namespace WellGroupHelpers rein[phase] = sumWellPhaseRates(false, group, schedule, wellState, reportStepIdx, phase, /*isInjector*/ false); } - // add import rate and substract consumption rate for group for gas + // add import rate and subtract consumption rate for group for gas if (schedule[reportStepIdx].gconsump().has(group.name())) { const auto& gconsump = schedule[reportStepIdx].gconsump().get(group.name(), st); if (pu.phase_used[BlackoilPhases::Vapour]) { diff --git a/opm/simulators/wells/WellInterfaceGeneric.cpp b/opm/simulators/wells/WellInterfaceGeneric.cpp index 6888bb661..04e5a0242 100644 --- a/opm/simulators/wells/WellInterfaceGeneric.cpp +++ b/opm/simulators/wells/WellInterfaceGeneric.cpp @@ -338,7 +338,7 @@ bool WellInterfaceGeneric::isVFPActive(DeferredLogger& deferred_logger) const if (vfp_properties_->getProd()->hasTable(table_id)) { return true; } else { - OPM_DEFLOG_THROW(std::runtime_error, "VFPPROD table " << std::to_string(table_id) << " is specfied," + OPM_DEFLOG_THROW(std::runtime_error, "VFPPROD table " << std::to_string(table_id) << " is specified," << " for well " << name() << ", while we could not access it during simulation", deferred_logger); } } @@ -351,7 +351,7 @@ bool WellInterfaceGeneric::isVFPActive(DeferredLogger& deferred_logger) const if (vfp_properties_->getInj()->hasTable(table_id)) { return true; } else { - OPM_DEFLOG_THROW(std::runtime_error, "VFPINJ table " << std::to_string(table_id) << " is specfied," + OPM_DEFLOG_THROW(std::runtime_error, "VFPINJ table " << std::to_string(table_id) << " is specified," << " for well " << name() << ", while we could not access it during simulation", deferred_logger); } } From e2c76dff3dc2f6a1ea7bcc35d9a0f69a53ffd2aa Mon Sep 17 00:00:00 2001 From: Markus Blatt Date: Tue, 16 Nov 2021 13:25:32 +0100 Subject: [PATCH 4/5] 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 | 73 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 51 insertions(+), 22 deletions(-) diff --git a/doc/man1/flow.1 b/doc/man1/flow.1 index 677d06fb8..65e28a2c9 100644 --- a/doc/man1/flow.1 +++ b/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='. 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 -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" +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: "" .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 -Relaxed tolerance for the inner iteration for the MSW pressure solution. Default: 50000 +\fB\-\-relaxed\-pressure\-tol\-msw\fR=\fI\,SCALAR\/\fR +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 -Number of inner iterations for multi\-segment wells with strict tolerance. Default: 40 +\fB\-\-strict\-inner\-iter\-wells\fR=\fI\,INTEGER\/\fR +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 From 2e491fbce6646b146bbf47d3d9328fc134a41c4c Mon Sep 17 00:00:00 2001 From: Markus Blatt Date: Tue, 16 Nov 2021 22:37:08 +0100 Subject: [PATCH 5/5] Fixed spelling errors in flow.1 mang page. When generating it an older version of flow (with spelling errors) was used with help2man. --- doc/man1/flow.1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/man1/flow.1 b/doc/man1/flow.1 index 65e28a2c9..77274d75d 100644 --- a/doc/man1/flow.1 +++ b/doc/man1/flow.1 @@ -142,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 partioning for the ILU preconditioner. Default: false +Use red\-black partitioning 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 @@ -205,7 +205,7 @@ Maximum number of iterations to determine solution the well equations. Default: 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 substract 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 subtract 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