FLOW(1)
πΈ FLOW(1) β User Commands πΈ
okay bestie, sit DOWN, because this is flow(1) and she is that girl π
β¨ NAME β¨
flow β Eclipse compatible parallel reservoir simulator π’οΈβ¨
π SYNOPSIS π
flow [OPTIONS] [ECL_DECK_FILENAME]
π DESCRIPTION π
Flow is an advanced reservoir simulator for ECL-decks, brought to you by the Open Porous Media project. It's giving "big science energy" and honestly? obsessed π«Ά
π Recognized options: π
no cap, this is a long list, so hydrate first π
-h,--helpβ prints this help message and then dips. bye π--help-allβ prints literally every parameter, even the obsolete, hidden and deprecated ones. the full vault, unlocked π--accelerator-mode=STRINGβ picks/uses a GPU accelerator for the linear solver. usage:'--accelerator-mode=[none|cusparse|opencl|amgcl|rocalution|rocsparse]'. Default:"none"--action-parsing-strictness=STRINGβ sets how strict the parsing process is for ActionX and PyAction. the options arenormal(do not apply keywords that haven't been tested for ActionX or PyAction) andlow(try to apply all keywords β beware: the simulation outcome might be incorrect π). Default:"normal"
β οΈ bestie, low is that risky friend. she will cause problems. the manpage said the outcome might be incorrect and I believe it.
--add-corners=BOOLEANβ 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"--allow-distributed-wells=BOOLEANβ allows the perforations of a well to be distributed to the interior of multiple processes. Default:false--allow-splitting-inactive-wells=BOOLEANβ allows inactive (never non-shut) wells to be split across multiple domains. Default:true--alternative-well-rate-init=BOOLEANβ uses the alternative well rate initialization procedure. Default:true--check-group-constraints-inner-well-iterations=BOOLEANβ allows checking of group constraints during inner well iterations. Default:true--check-satfunc-consistency=BOOLEANβ whether or not to check saturation function consistency requirements. Default:false--continue-on-convergence-error=BOOLEANβ continues 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--convergence-monitoring=BOOLEANβ enables convergence monitoring. Default:false--convergence-monitoring-cut-off=INTEGERβ cut off limit for convergence monitoring. Default:6--convergence-monitoring-decay-factor=SCALARβ decay factor for convergence monitoring. Default:0.75--cpr-reuse-interval=INTEGERβ reuse preconditioner interval. used whenCprReuseSetupis set to4, then the preconditioner will be fully recreated instead of reused every N linear solve, where N is this parameter. Default:30--cpr-reuse-setup=INTEGERβ reuse preconditioner setup. valid options are0: 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 everyCprReuseInterval. Default:4--dbhp-max-rel=SCALARβ maximum relative change of the bottom-hole pressure in a single iteration. Default:1--dp-max-rel=SCALARβ maximum relative change of pressure in a single iteration. Default:0.3--ds-max=SCALARβ maximum absolute change of any saturation in a single iteration. Default:0.2--dwell-fraction-max=SCALARβ maximum absolute change of a well's volume fraction in a single iteration. Default:0.2--ecl-deck-file-name=STRINGβ the name of the file which contains the ECL deck to be simulated. Default:""--ecl-output-double-precision=BOOLEANβ tells the output writer to use double precision. useful for'perfect'restarts. Default:false--ecl-output-interval=INTEGERβ the number of report steps that ought to be skipped between two writes of ECL results. Default:-1--edge-weights-method=INTEGERβ chooses the edge-weighing strategy:0=uniform,1=trans,2=log(trans). Default:1--enable-adaptive-time-stepping=BOOLEANβ uses adaptive time stepping between report steps. Default:true--enable-async-ecl-output=BOOLEANβ writes the ECL-formated results in a non-blocking way (i.e., using a separate thread). Default:true--enable-async-vtk-output=BOOLEANβ dispatches a separate thread to write the VTK output. Default:true--enable-drift-compensation=BOOLEANβ enables partial compensation of systematic mass losses via the source term of the next time step. Default:false--enable-dry-run=STRINGβ specifies if the simulation ought to be actually run, or just pretended to be. Default:"auto"--enable-ecl-output=BOOLEANβ writes binary output which is compatible with the commercial Eclipse simulator. Default:true--enable-esmry=BOOLEANβ writes an ESMRY file for fast loading of summary data. Default:false--enable-logging-fallout-warning=BOOLEANβ developer option to see whether logging was on non-root processors. in that case it will be appended to the*.DBGor*.PRTfiles. Default:false--enable-opm-rst-file=BOOLEANβ includes OPM-specific keywords in the ECL restart file to enable restart of OPM simulators from these files. Default:false--enable-storage-cache=BOOLEANβ stores previous storage terms and avoids re-calculating them. Default:true--enable-terminal-output=BOOLEANβ prints high-level information about the simulation's progress to the terminal. Default:true--enable-tuning=BOOLEANβ honors some aspects of theTUNINGkeyword. Default:false--enable-vtk-output=BOOLEANβ global switch for turning on writing VTK files. Default:false--enable-well-operability-check=BOOLEANβ enables the well operability checking. Default:true--enable-well-operability-check-iter=BOOLEANβ enables the well operability checking during iterations. Default:false--enable-write-all-solutions=BOOLEANβ writes all solutions to disk instead of only the ones for the report steps. Default:false--force-disable-fluid-in-place-output=BOOLEANβ does not print fluid-in-place values after each report step even if requested by the deck. Default:false--force-disable-resv-fluid-in-place-output=BOOLEANβ does not print reservoir volumes values after each report step even if requested by the deck. Default:false--full-time-step-initially=BOOLEANβ always attempts to finish a report step using a single substep. Default:false--gpu-device-id=INTEGERβ chooses the device ID forcusparseSolveroropenclSolver. use'nvidia-smi'or'clinfo'to determine valid IDs. Default:0--ignore-keywords=STRINGβ list of Eclipse keywords which should be ignored. as a':'separated string. Default:""--ilu-fillin-level=INTEGERβ the fill-in level of the linear solver's ILU preconditioner. Default:0--ilu-redblack=BOOLEANβ uses red-black partitioning for the ILU preconditioner. Default:false--ilu-relaxation=SCALARβ the relaxation factor of the linear solver's ILU preconditioner. Default:0.9--ilu-reorder-spheres=BOOLEANβ whether to reorder the entries of the matrix in the red-black ILU preconditioner in spheres starting at an edge. iffalsethe 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--imbalance-tol=SCALARβ tolerable imbalance of the loadbalancing (default:1.1). Default:1.1--initial-time-step-in-days=SCALARβ the size of the initial time step in days. Default:1--inj-mult-damp-mult=SCALARβ injection multiplier dampening factor (dampening multiplied by this each time oscillation is detected). Default:0.9--inj-mult-min-damp-factor=SCALARβ minimum injection multiplier dampening factor (maximum dampening level). Default:0.05--inj-mult-osc-threshold=SCALARβ injection multiplier oscillation threshold (used for multiplier dampening). Default:0.1--input-skip-mode=STRINGβ sets compatibility mode for theSKIP100/SKIP300keywords. options are100(skipSKIP100..ENDSKIP, keepSKIP300..ENDSKIP) [default],300(skipSKIP300..ENDSKIP, keepSKIP100..ENDSKIP) andall(skip bothSKIP100..ENDSKIPandSKIP300..ENDSKIP) . Default:"100"--linear-solver=STRINGβ configuration of solver. valid options are:cprw(default),ilu0,dilu,cpr(an alias forcprw),cpr_quasiimpes,cpr_trueimpes,cpr_trueimpesanalytic,amgorhybrid(experimental). alternatively, you can request a configuration to be read from a JSON file by giving the filename here, ending with'.json.'. Default:"cprw"
π heads up: hybrid is marked experimental. proceed with main character energy but also with caution.
--linear-solver-ignore-convergence-failure=BOOLEANβ continues with the simulation like nothing happened after the linear solver did not converge. Default:false--linear-solver-max-iter=INTEGERβ the maximum number of iterations of the linear solver. Default:200--linear-solver-print-json-definition=BOOLEANβ writes the JSON definition of the linear solver setup to the DBG file. Default:true--linear-solver-reduction=SCALARβ the minimum reduction of the residual which the linear solver must achieve. Default:0.01--linear-solver-restart=INTEGERβ the number of iterations after which GMRES is restarted. Default:40--linear-solver-verbosity=INTEGERβ the verbosity level of the linear solver (0: off,2: all). Default:0--load-step=INTEGERβ loads serialized state from.OPMRSTfile. either a specific report step, or0to load the last stored report step. Default:-1--local-domains-ordering-measure=STRINGβ subdomain ordering measure. allowed values are'maxpressure','averagepressure'and'residual'. Default:"maxpressure"--local-domains-well-neighbor-levels=INTEGERβ number of neighbor levels of cells around wells to include in the same domain during NLDD partitioning. Default:1--local-domains-partitioning-imbalance=SCALARβ subdomain partitioning imbalance tolerance.1.03is 3 percent imbalance. Default:1.03--local-domains-partitioning-method=STRINGβ bestie, this is the subdomain partitioning method. Allowed values are'zoltan','simple', and the name of a partition file ending with'.partition'. Default:"zoltan"β¨--local-solve-approach=STRINGβ pick your local solve approach. Valid choices arejacobiandgauss-seidel. Default:"gauss-seidel"π--local-tolerance-scaling-cnv=SCALARβ set this lower than1.0to use a stricter convergence tolerance for local solves. Default:0.1π--local-tolerance-scaling-mb=SCALARβ same energy: set lower than1.0for a stricter convergence tolerance in local solves. Default:1πΈ--local-well-solve-control-switching=BOOLEANβ allow control switching during local well solutions. Default:trueβ--matrix-add-well-contributions=BOOLEANβ explicitly specify the influences of wells between cells in the Jacobian and preconditioner matrices. Default:falseπ¦--max-inner-iter-ms-wells=INTEGERβ maximum number of inner iterations for multi-segment wells. Default:100π--max-inner-iter-wells=INTEGERβ maximum number of inner iterations for standard wells. Default:50π--max-local-solve-iterations=INTEGERβ max iterations for local solves with the NLDD nonlinear solver. Default:20π--max-newton-iterations-with-inner-well-iterations=INTEGERβ maximum Newton iterations with inner well iterations. Default:8π₯--max-pressure-change-ms-wells=SCALARβ maximum relative pressure change for a single iteration of the multi-segment well model. Default:1e+06π--max-residual-allowed=SCALARβ absolute maximum tolerated for residuals without cutting the time step size. Default:1e+07π--max-single-precision-days=SCALARβ maximum time step size where single precision floating point arithmetic can be used solving for the linear systems of equations. Default:20π--max-temperature-change=SCALARβ maximum absolute change of temperature in a single iteration. Default:5π--max-welleq-iter=INTEGERβ max number of iterations to determine the solution to the well equations. Default:30π§--maximum-number-of-group-switches=INTEGERβ maximum number of times a group can switch to the same control. Default:3π--maximum-number-of-well-switches=INTEGERβ maximum number of times a well can switch to the same control. Default:3π--maximum-water-saturation=SCALARβ maximum water saturation. Default:1π§--metis-params=STRINGβ configuration of the Metis partitioner. You can request a configuration to be read from a JSON file by giving the filename here, ending with extension'.json.'. Seehttp://glaros.dtc.umn.edu/gkhome/fetch/sw/metis/manual.pdffor available METIS options. Default:"default"π--milu-variant=STRINGβ 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"π--min-strict-cnv-iter=INTEGERβ minimum number of Newton iterations before relaxed tolerances can be used for the CNV convergence criterion. Default:-1β¨--min-strict-mb-iter=INTEGERβ minimum number of Newton iterations before relaxed tolerances can be used for the MB convergence criterion. Default-1means that the relaxed tolerance is used when maximum number of Newton iterations are reached. Default:-1π--min-time-step-based-on-newton-iterations=SCALARβ 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πΈ--min-time-step-before-shutting-problematic-wells-in-days=SCALARβ the minimum time step size in days for which problematic wells are not shut. Default:0.01π¦--network-max-outer-iterations=INTEGERβ maximum outer number of iterations in the network solver before giving up. Default:10β--network-max-pressure-update-in-bars=SCALARβ maximum pressure update in the inner network pressure update iterations. Default:5π--network-max-strict-outer-iterations=INTEGERβ maximum outer iterations in network solver before relaxing tolerance. Default:10π--network-max-sub-iterations=INTEGERβ maximum number of sub-iterations to update network pressures (within a single well/group control update). Default:20π--network-pressure-damping-factor=SCALARβ damping factor in the inner network pressure update iterations. Default:0.1π₯--newton-max-iterations=INTEGERβ the maximum number of Newton iterations per time step. Default:20π--newton-max-relax=SCALARβ the maximum relaxation factor of a Newton iteration. Default:0.5π--newton-min-iterations=INTEGERβ the minimum number of Newton iterations per time step. Default:2π--newton-relaxation-type=STRINGβ the type of relaxation used by Newton method. Default:"dampen"π--nldd-local-linear-solver=STRINGβ configuration of NLDD local linear solver. Valid options are:ilu0(default),dilu,cpr_quasiimpesandamg. Alternatively, you can request a configuration to be read from a JSON file by giving the filename here, ending with'.json.'. Default:"ilu0"π§--nldd-local-linear-solver-max-iter=INTEGERβ the maximum number of iterations of the NLDD local linear solver. Default:200π--nldd-local-linear-solver-reduction=SCALARβ the minimum reduction of the residual which the NLDD local linear solver must achieve. Default:0.01π--nldd-num-initial-newton-iter=INTEGERβ number of initial global Newton iterations when running the NLDD nonlinear solver. Default:1π§--nonlinear-solver=STRINGβ choose nonlinear solver. Valid choices arenewtonornldd. Default:"newton"π--num-local-domains=INTEGERβ number of local domains for NLDD nonlinear solver. Default:0π--num-overlap=INTEGERβ numbers of layers overlap in parallel partition. Default:1β¨--num-satfunc-consistency-sample-points=INTEGERβ maximum number of reported failures for each individual saturation function consistency check. Default:5π--nupcol-group-rate-tolerance=SCALARβ tolerance for acceptable changes in VREP/RAIN group rates. Default:0.001πΈ--opencl-ilu-parallel=BOOLEANβ parallelize ILU decomposition and application on GPU. Default:trueπ¦--opencl-platform-id=INTEGERβ choose platform ID for openclSolver, use'clinfo'to determine valid platform IDs. Default:0β--output-dir=STRINGβ the directory to which result files are written. Default:""π--output-extra-convergence-info=STRINGβ 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"π--output-interval=INTEGERβ specify the number of report steps between two consecutive writes of restart data. Default:1π--output-mode=STRINGβ specify which messages are going to be printed. Valid values are:none,log,all(default). Default:"all"π₯--owner-cells-first=BOOLEANβ order cells owned by rank before ghost/overlap cells. Default:trueπ--parameter-file=STRINGβ an.inifile which contains a set of run-time parameters. Default:""π--parsing-strictness=STRINGβ set strictness of parsing process. Available options arenormal(stop for critical errors),high(stop for all errors) andlow(as normal, except do not stop due to unsupported keywords even if marked critical. Default:"normal"π--partition-method=INTEGERβ choose partitioning strategy:0=simple,1=Zoltan,2=METIS,3=Zoltan with all cells of well represented by one vertex. Default:3π--pre-solve-network=BOOLEANβ whether to pre solve and iterate the network model at start-up. Default:trueπ§--pressure-max=SCALARβ maximum absolute pressure. Default:1e+99π--pressure-min=SCALARβ minimum absolute pressure. Default:-1e+99π--pressure-scale=SCALARβ scaling of pressure primary variable. Default:1π§--pri-var-oscilation-threshold=SCALARβ the threshold value for the primary variable switching conditions after its meaning has switched to hinder oscillations. Default:1e-05π--print-parameters=INTEGERβ print the values of the run-time parameters at the start of the simulation. Default:2π--project-saturations=BOOLEANβ option for doing saturation projection. Default:falseβ¨--regularization-factor-wells=SCALARβ regularization factor for wells. Default:100π--relaxed-linear-solver-reduction=SCALARβ the minimum reduction of the residual which the linear solver need to achieve for the solution to be accepted. Default:0.01πΈ--relaxed-max-pv-fraction=SCALARβ the fraction of the pore volume of the reservoir where the volumetric error (CNV) may be violated during strict Newton iterations. Default:0.03π¦--relaxed-pressure-tol-msw=SCALARβ relaxed tolerance for the MSW pressure solution. Default:10000β--relaxed-well-flow-tol=SCALARβ relaxed tolerance for the well flow residual. Default:0.001π--save-step=STRINGβ save serialized state to.OPMRSTfile. 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:""π--scale-linear-system=BOOLEANβ scale linear system according to equation scale and primary variable types. Default:falseπ--sched-restart=BOOLEANβ when restarting: should we try to initialize wells and groups from historical SCHEDULE section. Default:falseπ₯--serial-partitioning=BOOLEANβ do the partitioning for parallel runs on a single process instead of spreading out. Default:false--shut-unsolvable-wells=BOOLEANβ shut down the wells that just can't be solved, bestie, no shame in it. Default:true--solve-welleq-initially=BOOLEANβ fully solve the well equations before every single iteration of the reservoir model. Default:true--solver-continue-on-convergence-failure=BOOLEANβ keep going instead of stopping when the minimum solver time step is reached. Default:false--solver-growth-factor=SCALARβ the factor that time steps get stretched by after a successful substep. Default:2--solver-max-growth=SCALARβ the max factor time steps get stretched by after a report step. Default:3--solver-max-restarts=INTEGERβ how many breakdowns a substep is allowed before we give up on it and the simulator gets terminated. Default:10--solver-max-time-step-in-days=SCALARβ biggest time step allowed, in days. Default:365--solver-min-time-step=SCALARβ smallest time step allowed: days for field and metric, hours for lab. If a step can't converge without getting cut below this size, the simulator stops. Default:1e-12--solver-restart-factor=SCALARβ the factor time steps get stretched by after restarts. Default:0.33--solver-verbosity=INTEGERβ how "chatty" the non-linear solver itself is. Default:1--strict-inner-iter-wells=INTEGERβ number of inner well iterations with strict tolerance. Default:40--strict-outer-iter-wells=INTEGERβ number of newton iterations where wells get checked with strict tolerance. Default:6--temperature-max=SCALARβ maximum absolute temperature. Default:1e+09--temperature-min=SCALARβ minimum absolute temperature. Default:0--threads-per-process=INTEGERβ max number of threads to be instantiated per process ('-1'means'automatic'). Default:2--time-step-after-event-in-days=SCALARβ the size of the first time step after an event happens during the simulation, in days. Default:-1--time-step-control=STRINGβ the algorithm used to figure out time-step sizes. Valid options are:'pid'(default),'pid+iteration','pid+newtoniteration','iterationcount','newtoniterationcount'and'hardcoded'. Default:"pid+newtoniteration"
okay so the valid-options line says'pid'is the default and then the Default line says"pid+newtoniteration"β I'm just the messenger, bestie, I'm reading it exactly like it's written π
--time-step-control-decay-damping-factor=SCALARβ the decay rate of the time step decrease when the target iterations get exceeded. Default:1--time-step-control-decay-rate=SCALARβ the decay rate of the time step size when the number of target iterations gets exceeded. Default:0.75--time-step-control-file-name=STRINGβ name of the file that holds the hardcoded time step sizes. Default:"timesteps"--time-step-control-growth-damping-factor=SCALARβ the growth rate of the time step increase when the target iterations get undercut. Default:3.2--time-step-control-growth-rate=SCALARβ the growth rate of the time step size when the number of target iterations gets undercut. Default:1.25--time-step-control-safety-factor=SCALARβ a value multiplied with the time step control tolerance to make sure the target relative change stays lower than the tolerance. Default:0.8--time-step-control-target-iterations=INTEGERβ how many linear iterations the time step control scheme should aim for (if applicable). Default:30--time-step-control-target-newton-iterations=INTEGERβ how many Newton iterations the time step control scheme should aim for (if applicable). Default:8--time-step-control-tolerance=SCALARβ the tolerance the time step size control algorithm uses. Default:0.1--time-step-verbosity=INTEGERβ how "chatty" things get during the time integration. Default:1--tolerance-cnv=SCALARβ local convergence tolerance (maximum of local saturation errors). Default:0.01--tolerance-cnv-energy=SCALARβ local energy convergence tolerance (maximum of local energy errors). Default:0.01--tolerance-cnv-energy-relaxed=SCALARβ the relaxed local energy convergence tolerance that applies for iterations after the ones with the strict tolerance. Default:1--tolerance-cnv-relaxed=SCALARβ the relaxed local convergence tolerance that applies for iterations after the ones with the strict tolerance. Default:1--tolerance-energy-balance=SCALARβ tolerated energy balance error relative to the (scaled) total energy present. Default:1e-07--tolerance-energy-balance-relaxed=SCALARβ the relaxed tolerated energy balance error that applies for iterations after the ones with the strict tolerance. Default:1e-06--tolerance-mb=SCALARβ tolerated mass balance error relative to total mass present. Default:1e-07--tolerance-mb-relaxed=SCALARβ the relaxed tolerated mass balance error that applies for iterations after the ones with the strict tolerance. Default:1e-06--tolerance-pressure-ms-wells=SCALARβ tolerance for the pressure equations for multi-segment wells. Default:1000--tolerance-well-control=SCALARβ tolerance for the well control equations. Default:1e-07--tolerance-wells=SCALARβ well convergence tolerance. Default:0.0001--update-equations-scaling=BOOLEANβ update the scaling factors for mass balance equations during the run. Default:false--use-gmres=BOOLEANβ use GMRES as the linear solver. Default:false--use-implicit-ipr=BOOLEANβ compute implict IPR for stability checks and stable solution search. Default:true--use-multisegment-well=BOOLEANβ use the well model for multi-segment wells instead of the one for single-segment wells. Default:true--use-update-stabilization=BOOLEANβ try to detect and correct oscillations or stagnation during the Newton method. Default:true--water-only-threshold=SCALARβ cells with water saturation above or equal to this are considered one-phase water only. Default:1
and that's a wrap on the options, bestie π this whole page is from the flow fam, dated October 2025, and it's FLOW(1) β section 1 of the manual, main character energy only. go run your simulator, you've got this π
β¨π¦
π¦ where this page comes from
- ubuntu resolute: libopm-simulators-bin 2025.10+ds-6 Β· GPL-3.0-or-later
- ubuntu stonking: libopm-simulators-bin 2025.10+ds-6build1 Β· GPL-3.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms