diff --git a/opm/simulators/flow/NonlinearSolver.cpp b/opm/simulators/flow/NonlinearSolver.cpp index 9cb4e8da8f..26bef3da7b 100644 --- a/opm/simulators/flow/NonlinearSolver.cpp +++ b/opm/simulators/flow/NonlinearSolver.cpp @@ -171,7 +171,7 @@ registerParameters() Parameters::Register> ("The maximum relaxation factor of a Newton iteration"); Parameters::Register - ("The type of relaxation used by Newton method"); + ("The type of relaxation used by Newton method. Valid options are: dampen or sor"); } template struct NonlinearSolverParameters; diff --git a/opm/simulators/linalg/FlowLinearSolverParameters.cpp b/opm/simulators/linalg/FlowLinearSolverParameters.cpp index 26e7a5ee29..c5d9c1d12b 100644 --- a/opm/simulators/linalg/FlowLinearSolverParameters.cpp +++ b/opm/simulators/linalg/FlowLinearSolverParameters.cpp @@ -124,7 +124,7 @@ void FlowLinearSolverParameters::registerParameters() "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)."); + "the diagonal elements are consecutive)"); Parameters::Register ("Use GMRES as the linear solver"); Parameters::Register @@ -137,14 +137,14 @@ void FlowLinearSolverParameters::registerParameters() "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.'"); + "JSON file by giving the filename here, ending with '.json'"); Parameters::Register ("Configuration of NLDD local linear solver. Valid options are: ilu0 (default), " - "dilu, cpr_quasiimpes and amg. " + "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.'"); + "JSON file by giving the filename here, ending with '.json'"); Parameters::Register - ("Write the JSON definition of the linear solver setup to the DBG file."); + ("Write the JSON definition of the linear solver setup to the DBG file"); Parameters::Register ("Reuse preconditioner setup. Valid options are " "0: recreate the preconditioner for every linear solve, " @@ -155,10 +155,10 @@ void FlowLinearSolverParameters::registerParameters() Parameters::Register ("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."); + "every N linear solve, where N is this parameter"); Parameters::Register - ("Choose a linear solver, usage: " - "'--accelerator-mode=[none|cusparse|opencl|amgcl|rocalution|rocsparse]'"); + ("Choose a linear solver. Valid options are: cusparse, opencl, amgcl, " + "rocalution, rocsparse, and none"); Parameters::Register ("Choose device ID for cusparseSolver or openclSolver, " "use 'nvidia-smi' or 'clinfo' to determine valid IDs"); @@ -168,26 +168,22 @@ void FlowLinearSolverParameters::registerParameters() Parameters::Register ("Parallelize ILU decomposition and application on GPU"); Parameters::Register - ("Choose the backend for the linear solver, usage: " - "'--linear-solver-accelerator=[cpu|gpu]'."); + ("Choose the backend for the linear solver. Valid options are: cpu or gpu"); Parameters::Register ("MPI communication use GPU aware MPI in the sense that " "it will use GPU direct communication. Setting this to true " " will require that the MPI implementation " "supports GPU direct communication. " - "If you are unsure, set this to false. " - "Usage: --gpu-aware-mpi=[true|false]. "); + "If you are unsure, set this to false"); Parameters::Register ("Verify that the MPI implementation supports GPU aware MPI. " "If this is set to true *and* --gpu-aware-mpi=true, the simulation will fail if the " "MPI implementation does not support GPU aware MPI. " "Note that the verification is not exhaustive, " - "and some configurations will not verify, but will work in practice. " - "Usage: --verify-gpu-aware-mpi=[true|false]. "); + "and some configurations might not be verified, but will work in practice"); Parameters::Register ("Enable OpenMP thread parallelization of CPR weight calculation. " - "This can improve performance for large models but is disabled by default." - "Usage: --cpr-weights-thread-parallel=[true|false]. "); + "This can improve performance for large models but is disabled by default"); Parameters::SetDefault(0); } diff --git a/opm/simulators/timestepping/AdaptiveTimeStepping.cpp b/opm/simulators/timestepping/AdaptiveTimeStepping.cpp index 06a1aec425..1dd9483ab0 100644 --- a/opm/simulators/timestepping/AdaptiveTimeStepping.cpp +++ b/opm/simulators/timestepping/AdaptiveTimeStepping.cpp @@ -115,7 +115,7 @@ void registerAdaptiveParameters() "'pid+newtoniteration', " "'iterationcount', " "'newtoniterationcount', " - "'general3rdorder' " + "'general3rdorder', " "and 'hardcoded'"); Parameters::Register ("The tolerance used by the time step size control algorithm"); @@ -148,21 +148,21 @@ void registerAdaptiveParameters() ("Value to be multiplied with the time step control tolerance to ensure that the target " "relative change is lower than the tolerance"); Parameters::Register - ("(Only applicable for the general 3rd order controller.) Include rejection of completed " + ("Only applicable for the general 3rd order controller. Include rejection of completed " "time steps if the relative change is larger than the time step control tolerance"); Parameters::Register - ("(Only applicable for the general 3rd order controller.) Ways to decide if the time step " + ("Only applicable for the general 3rd order controller. Ways to decide if the time step " "should be rejected. Options: 'standard' and 'control-error-filtering'. The standard " "version compares relative change to tolerance directly to decide if the time step should " "be rejected, while the control-error-filtering version compares the relative change " - "in time step size to the max-reduction-time-step parameter."); + "in time step size to the max-reduction-time-step parameter"); Parameters::Register - ("(Only applicable for the general 3rd order controller, using 'control-error-filtering' " - "as time-step-control-tolerance-test-version) If the (proposed) relative change in time " - "step size is larger than this parameter, the time step will be rejected."); + ("Only applicable for the general 3rd order controller, using 'control-error-filtering' " + "as time-step-control-tolerance-test-version. If the (proposed) relative change in time " + "step size is larger than this parameter, the time step will be rejected"); Parameters::Register - ("(Only applicable for the general 3rd order controller.) Parameters for the general " - "3rd order controller. Should be given as 'beta_1;beta_2;beta_3;alpha_2;alpha_3'."); + ("Only applicable for the general 3rd order controller. Parameters for the general " + "3rd order controller. Should be given as 'beta_1;beta_2;beta_3;alpha_2;alpha_3'"); } std::tuple, bool>