mirror of
https://github.com/OPM/opm-simulators.git
synced 2026-10-31 09:44:07 -05:00
Nitpicks for command line parameters descriptions
This commit is contained in:
David Landa Marban committed
1 parent
330bfc0452
commit
db0af827e6
3 files changed
+22
-26
No files matched your search
@@ -171,7 +171,7 @@ registerParameters()
|
||||
Parameters::Register<Parameters::NewtonMaxRelax<Scalar>>
|
||||
("The maximum relaxation factor of a Newton iteration");
|
||||
Parameters::Register<Parameters::NewtonRelaxationType>
|
||||
("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<double>;
|
||||
|
||||
@@ -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<Parameters::UseGmres>
|
||||
("Use GMRES as the linear solver");
|
||||
Parameters::Register<Parameters::LinearSolverIgnoreConvergenceFailure>
|
||||
@@ -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<Parameters::NlddLocalLinearSolver>
|
||||
("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<Parameters::LinearSolverPrintJsonDefinition>
|
||||
("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<Parameters::CprReuseSetup>
|
||||
("Reuse preconditioner setup. Valid options are "
|
||||
"0: recreate the preconditioner for every linear solve, "
|
||||
@@ -155,10 +155,10 @@ void FlowLinearSolverParameters::registerParameters()
|
||||
Parameters::Register<Parameters::CprReuseInterval>
|
||||
("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<Parameters::AcceleratorMode>
|
||||
("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<Parameters::GpuDeviceId>
|
||||
("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<Parameters::OpenclIluParallel>
|
||||
("Parallelize ILU decomposition and application on GPU");
|
||||
Parameters::Register<Parameters::LinearSolverAccelerator>
|
||||
("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<Parameters::GpuAwareMpi>
|
||||
("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<Parameters::VerifyGpuAwareMpi>
|
||||
("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<Parameters::CprWeightsThreadParallel>
|
||||
("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<Parameters::LinearSolverVerbosity>(0);
|
||||
}
|
||||
|
||||
@@ -115,7 +115,7 @@ void registerAdaptiveParameters()
|
||||
"'pid+newtoniteration', "
|
||||
"'iterationcount', "
|
||||
"'newtoniterationcount', "
|
||||
"'general3rdorder' "
|
||||
"'general3rdorder', "
|
||||
"and 'hardcoded'");
|
||||
Parameters::Register<Parameters::TimeStepControlTolerance>
|
||||
("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<Parameters::TimeStepControlRejectCompletedStep>
|
||||
("(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<Parameters::TimeStepControlToleranceTestVersion>
|
||||
("(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<Parameters::TimeStepControlMaxReductionTimeStep>
|
||||
("(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<Parameters::TimeStepControlParameters>
|
||||
("(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<TimeStepControlType, std::unique_ptr<TimeStepControlInterface>, bool>
|
||||
|
||||
Reference in new issue
Block a user