diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md b/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md index 576add64edccf5d980a0ff86143dc43a7109a788..617b5386e4911c093fc9e5b730b48006d8eb6d17 100644 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md +++ b/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md @@ -1 +1 @@ -\ogs_missing_documentation +Contains nonlinear solver settings. diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md deleted file mode 100644 index 576add64edccf5d980a0ff86143dc43a7109a788..0000000000000000000000000000000000000000 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md +++ /dev/null @@ -1 +0,0 @@ -\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md index 576add64edccf5d980a0ff86143dc43a7109a788..cbd405790981f018f0a0ab8c399fdbcb52ca639f 100644 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md +++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines a single nonlinear solver. diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md index 576add64edccf5d980a0ff86143dc43a7109a788..66686d595320bcb3cb0682696664c3d4f8a70bed 100644 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md +++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md @@ -1 +1,4 @@ -\ogs_missing_documentation +Specifies the linear solver used to solve the linearized equation systems. + +The linear solver is referenced by \ref ogs_file_param__linear_solver__name +"name". diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md index 576add64edccf5d980a0ff86143dc43a7109a788..3625da906eb67d01bd14bd84681781255b192556 100644 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md +++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md @@ -1 +1,4 @@ -\ogs_missing_documentation +Specifies the maximum number of iterations the nonlinear solver can make for +solving a single equation system. + +If this number is exceeded, the nonlinear solver failed. diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md index 576add64edccf5d980a0ff86143dc43a7109a788..4651bb622299c25dcbb84de1b9d1bf945e4f8266 100644 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md +++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md @@ -1 +1,3 @@ -\ogs_missing_documentation +Name of the nonlinear solver. + +Used to specify which process is solved by which nonlinear solver. diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md index 576add64edccf5d980a0ff86143dc43a7109a788..3da8618c7a31efb451a2934e429c2f5544b9d052 100644 --- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md +++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md @@ -1 +1,3 @@ -\ogs_missing_documentation +Type of the nonlinear solver. + +Can be <tt>Picard</tt> or <tt>Newton</tt>.