diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_tol.md b/Documentation/ProjectFile/boundary_condition/UniformRobin/c_UniformRobin.md similarity index 100% rename from Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_tol.md rename to Documentation/ProjectFile/boundary_condition/UniformRobin/c_UniformRobin.md diff --git a/Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/i_secondary_variables.md b/Documentation/ProjectFile/boundary_condition/UniformRobin/t_alpha.md similarity index 100% rename from Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/i_secondary_variables.md rename to Documentation/ProjectFile/boundary_condition/UniformRobin/t_alpha.md diff --git a/Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/t_darcy_velocity_x.md b/Documentation/ProjectFile/boundary_condition/UniformRobin/t_u_0.md similarity index 100% rename from Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/t_darcy_velocity_x.md rename to Documentation/ProjectFile/boundary_condition/UniformRobin/t_u_0.md diff --git a/Documentation/ProjectFile/gml/c_gml.md b/Documentation/ProjectFile/gml/c_gml.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..5be1f4301818a8ee0e8a77a2bffadaadc225c572 100644 --- a/Documentation/ProjectFile/gml/c_gml.md +++ b/Documentation/ProjectFile/gml/c_gml.md @@ -0,0 +1,3 @@ +In gml files geometries, i.e., points, polylines, and triangulated surfaces, are +defined. +These geometries can be used in project files, e.g., to set boundary conditions. diff --git a/Documentation/ProjectFile/gml/points/i_points.md b/Documentation/ProjectFile/gml/points/i_points.md index 576add64edccf5d980a0ff86143dc43a7109a788..629d0f80d62297021f7ef1fe8c8359a08213b090 100644 --- a/Documentation/ProjectFile/gml/points/i_points.md +++ b/Documentation/ProjectFile/gml/points/i_points.md @@ -1 +1 @@ -\ogs_missing_documentation +Contains point definitions. diff --git a/Documentation/ProjectFile/gml/points/point/a_id.md b/Documentation/ProjectFile/gml/points/point/a_id.md index 576add64edccf5d980a0ff86143dc43a7109a788..74338bd51db3200b824be139741d63c395157e21 100644 --- a/Documentation/ProjectFile/gml/points/point/a_id.md +++ b/Documentation/ProjectFile/gml/points/point/a_id.md @@ -1 +1,2 @@ -\ogs_missing_documentation +ID of the point. It is used to reference this point in the definition of +surfaces or polylines. diff --git a/Documentation/ProjectFile/gml/points/point/a_name.md b/Documentation/ProjectFile/gml/points/point/a_name.md index 576add64edccf5d980a0ff86143dc43a7109a788..4ea3bfb2f386023102eb1832f766a465febb6209 100644 --- a/Documentation/ProjectFile/gml/points/point/a_name.md +++ b/Documentation/ProjectFile/gml/points/point/a_name.md @@ -1 +1 @@ -\ogs_missing_documentation +Name of the point. It is used to reference the point in the project file. diff --git a/Documentation/ProjectFile/gml/points/point/a_x.md b/Documentation/ProjectFile/gml/points/point/a_x.md index 576add64edccf5d980a0ff86143dc43a7109a788..41f914254138da8520afe7ba41d3c2d3e0f80597 100644 --- a/Documentation/ProjectFile/gml/points/point/a_x.md +++ b/Documentation/ProjectFile/gml/points/point/a_x.md @@ -1 +1 @@ -\ogs_missing_documentation +x-coordinate of the point. diff --git a/Documentation/ProjectFile/gml/points/point/a_y.md b/Documentation/ProjectFile/gml/points/point/a_y.md index 576add64edccf5d980a0ff86143dc43a7109a788..0b12fa75be6464e4c2c5cda672aebdd48224525a 100644 --- a/Documentation/ProjectFile/gml/points/point/a_y.md +++ b/Documentation/ProjectFile/gml/points/point/a_y.md @@ -1 +1 @@ -\ogs_missing_documentation +y-coordinate of the point. diff --git a/Documentation/ProjectFile/gml/points/point/a_z.md b/Documentation/ProjectFile/gml/points/point/a_z.md index 576add64edccf5d980a0ff86143dc43a7109a788..923fdb82ff0c4d7bacba64b30ee5677d3723bd68 100644 --- a/Documentation/ProjectFile/gml/points/point/a_z.md +++ b/Documentation/ProjectFile/gml/points/point/a_z.md @@ -1 +1 @@ -\ogs_missing_documentation +z-coordinate of the point. diff --git a/Documentation/ProjectFile/gml/points/point/i_point.md b/Documentation/ProjectFile/gml/points/point/i_point.md index 576add64edccf5d980a0ff86143dc43a7109a788..9b00fe3f018e8dac9c22e4ffae7d41e1d8347c75 100644 --- a/Documentation/ProjectFile/gml/points/point/i_point.md +++ b/Documentation/ProjectFile/gml/points/point/i_point.md @@ -1 +1 @@ -\ogs_missing_documentation +Defines a single point. diff --git a/Documentation/ProjectFile/gml/polylines/i_polylines.md b/Documentation/ProjectFile/gml/polylines/i_polylines.md index 576add64edccf5d980a0ff86143dc43a7109a788..e9929013937e32ccdbb2fee696f9f1ba057bf1e9 100644 --- a/Documentation/ProjectFile/gml/polylines/i_polylines.md +++ b/Documentation/ProjectFile/gml/polylines/i_polylines.md @@ -1 +1 @@ -\ogs_missing_documentation +Contains polyline definitions. diff --git a/Documentation/ProjectFile/gml/polylines/polyline/a_id.md b/Documentation/ProjectFile/gml/polylines/polyline/a_id.md index 576add64edccf5d980a0ff86143dc43a7109a788..7cd2fd8c1ba2824559b6a904484c0fe472e39ddb 100644 --- a/Documentation/ProjectFile/gml/polylines/polyline/a_id.md +++ b/Documentation/ProjectFile/gml/polylines/polyline/a_id.md @@ -1 +1 @@ -\ogs_missing_documentation +ID of the polyline. Currently unused. diff --git a/Documentation/ProjectFile/gml/polylines/polyline/a_name.md b/Documentation/ProjectFile/gml/polylines/polyline/a_name.md index 576add64edccf5d980a0ff86143dc43a7109a788..2abacdde47ed57ec3b96307548fbcdb206729713 100644 --- a/Documentation/ProjectFile/gml/polylines/polyline/a_name.md +++ b/Documentation/ProjectFile/gml/polylines/polyline/a_name.md @@ -1 +1 @@ -\ogs_missing_documentation +Name of the polyline. Used to reference it in the project file, i.e., for instance to set boundary conditions. diff --git a/Documentation/ProjectFile/gml/polylines/polyline/i_polyline.md b/Documentation/ProjectFile/gml/polylines/polyline/i_polyline.md index 576add64edccf5d980a0ff86143dc43a7109a788..70af4a01b0b54be349d310e50e57666b6a21d5e4 100644 --- a/Documentation/ProjectFile/gml/polylines/polyline/i_polyline.md +++ b/Documentation/ProjectFile/gml/polylines/polyline/i_polyline.md @@ -1 +1,3 @@ -\ogs_missing_documentation +Defines a single polyline. +A polyline is a sequence of line segments, which is given here by a list of +points; two adjacent points define one line segment. diff --git a/Documentation/ProjectFile/gml/polylines/polyline/t_pnt.md b/Documentation/ProjectFile/gml/polylines/polyline/t_pnt.md index 576add64edccf5d980a0ff86143dc43a7109a788..67c9e4b4331e90fafcc5de492a32f332ff6db963 100644 --- a/Documentation/ProjectFile/gml/polylines/polyline/t_pnt.md +++ b/Documentation/ProjectFile/gml/polylines/polyline/t_pnt.md @@ -1 +1,2 @@ -\ogs_missing_documentation +References a \ref ogs_file_param__gml__points__point "point". +The content of this tag is the respective \ref ogs_file_attr__gml__points__point__id "point ID". diff --git a/Documentation/ProjectFile/gml/surfaces/i_surfaces.md b/Documentation/ProjectFile/gml/surfaces/i_surfaces.md index 576add64edccf5d980a0ff86143dc43a7109a788..f58852866191168b68fe738c47d6044a5bd76f3a 100644 --- a/Documentation/ProjectFile/gml/surfaces/i_surfaces.md +++ b/Documentation/ProjectFile/gml/surfaces/i_surfaces.md @@ -1 +1 @@ -\ogs_missing_documentation +Contains surface definitions. diff --git a/Documentation/ProjectFile/gml/surfaces/surface/a_id.md b/Documentation/ProjectFile/gml/surfaces/surface/a_id.md index 576add64edccf5d980a0ff86143dc43a7109a788..ddc80ae99472fb79b1ce8f3d7427cabf52fd637f 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/a_id.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/a_id.md @@ -1 +1 @@ -\ogs_missing_documentation +ID of the surface. Currently unused. diff --git a/Documentation/ProjectFile/gml/surfaces/surface/a_name.md b/Documentation/ProjectFile/gml/surfaces/surface/a_name.md index 576add64edccf5d980a0ff86143dc43a7109a788..a7ed0f2097b1ccd4e9e643ffec0d1c1d3f009549 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/a_name.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/a_name.md @@ -1 +1 @@ -\ogs_missing_documentation +The name of the surface. Used to reference it in the project file, i.e., for instance to set boundary conditions. diff --git a/Documentation/ProjectFile/gml/surfaces/surface/element/a_p1.md b/Documentation/ProjectFile/gml/surfaces/surface/element/a_p1.md index 576add64edccf5d980a0ff86143dc43a7109a788..4c7cabdcf9f8ac883b55e29a6624f0b8dcb09ac9 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/element/a_p1.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/element/a_p1.md @@ -1 +1,2 @@ -\ogs_missing_documentation +The first triangle point. +This attribute references a \ref ogs_file_attr__gml__points__point__id "point ID". diff --git a/Documentation/ProjectFile/gml/surfaces/surface/element/a_p2.md b/Documentation/ProjectFile/gml/surfaces/surface/element/a_p2.md index 576add64edccf5d980a0ff86143dc43a7109a788..e35a3d28700571231e26225454cd941ee3cc3c09 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/element/a_p2.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/element/a_p2.md @@ -1 +1,2 @@ -\ogs_missing_documentation +The second triangle point. +This attribute references a \ref ogs_file_attr__gml__points__point__id "point ID". diff --git a/Documentation/ProjectFile/gml/surfaces/surface/element/a_p3.md b/Documentation/ProjectFile/gml/surfaces/surface/element/a_p3.md index 576add64edccf5d980a0ff86143dc43a7109a788..447b818b8d31f2bd2baaf801c107d59e5ed883f3 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/element/a_p3.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/element/a_p3.md @@ -1 +1,2 @@ -\ogs_missing_documentation +The third triangle point. +This attribute references a \ref ogs_file_attr__gml__points__point__id "point ID". diff --git a/Documentation/ProjectFile/gml/surfaces/surface/element/i_element.md b/Documentation/ProjectFile/gml/surfaces/surface/element/i_element.md index 576add64edccf5d980a0ff86143dc43a7109a788..3c5185e045fb04a5133de10678f7dc8543bba658 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/element/i_element.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/element/i_element.md @@ -1 +1,4 @@ +Defines a triangle by its three points. + \ogs_missing_documentation +\todo How is the face normal of a triangle determined? diff --git a/Documentation/ProjectFile/gml/surfaces/surface/i_surface.md b/Documentation/ProjectFile/gml/surfaces/surface/i_surface.md index 576add64edccf5d980a0ff86143dc43a7109a788..642b503ea8724b3b36e9e43e3f073c14dff6896f 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/i_surface.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/i_surface.md @@ -1 +1,2 @@ -\ogs_missing_documentation +Defines a single triangulated surface. +The surface is given as the set of all triangles it comprises. diff --git a/Documentation/ProjectFile/gml/t_name.md b/Documentation/ProjectFile/gml/t_name.md index 576add64edccf5d980a0ff86143dc43a7109a788..f081c356a48d8045a22c1977da78d7706b31a7b0 100644 --- a/Documentation/ProjectFile/gml/t_name.md +++ b/Documentation/ProjectFile/gml/t_name.md @@ -1 +1,4 @@ -\ogs_missing_documentation +Name of the geometrical set, i.e., the entirety of all geometries defined in +this file. +Each individual geometry additionally has an own name, which has to be unique in +the geometrical set. diff --git a/Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/t_darcy_velocity_y.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md similarity index 100% rename from Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/t_darcy_velocity_y.md rename to Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md diff --git a/Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/t_darcy_velocity_z.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md similarity index 100% rename from Documentation/ProjectFile/process/GROUNDWATER_FLOW/secondary_variables/t_darcy_velocity_z.md rename to Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md diff --git a/Documentation/ProjectFile/process/t_secondary_variables.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md similarity index 100% rename from Documentation/ProjectFile/process/t_secondary_variables.md rename to Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md b/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/t_type.md b/Documentation/ProjectFile/process/convergence_criterion/t_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/convergence_criterion/t_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/i_secondary_variables.md b/Documentation/ProjectFile/process/secondary_variables/i_secondary_variables.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/i_secondary_variables.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_internal_name.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_internal_name.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_internal_name.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_output_name.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_output_name.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_output_name.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_sink_arg.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_sink_arg.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_sink_arg.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_source_fct.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_source_fct.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_source_fct.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_type.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/a_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/i_secondary_variable.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/i_secondary_variable.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/i_secondary_variable.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/secondary_variables/secondary_variable/t_plug.md b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/t_plug.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/secondary_variables/secondary_variable/t_plug.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp b/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp index 2c2249c1dbda3905ddd98dc47eb0749bde18cafe..8f903ee4996159874a297f3a20bf16b363f872be 100644 --- a/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp @@ -54,11 +54,15 @@ void ConvergenceCriterionDeltaX::checkDeltaX(const GlobalVector& minus_delta_x, std::unique_ptr<ConvergenceCriterionDeltaX> createConvergenceCriterionDeltaX( const BaseLib::ConfigTree& config) { + //! \ogs_file_param{process__convergence_criterion__type} config.checkConfigParameter("type", "DeltaX"); + //! \ogs_file_param{process__convergence_criterion__DeltaX__abstol} auto abstol = config.getConfigParameterOptional<double>("abstol"); + //! \ogs_file_param{process__convergence_criterion__DeltaX__reltol} auto reltol = config.getConfigParameterOptional<double>("reltol"); auto const norm_type_str = + //! \ogs_file_param{process__convergence_criterion__DeltaX__norm_type} config.getConfigParameter<std::string>("norm_type"); auto const norm_type = MathLib::convertStringToVecNormType(norm_type_str); diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp b/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp index 9615ab813d148c72e6f42fab3eaa2a23633b7ee6..6fac5ce794580a4eca4144cd4621c829238da9eb 100644 --- a/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp @@ -80,13 +80,17 @@ void ConvergenceCriterionPerComponentDeltaX::setDOFTable( std::unique_ptr<ConvergenceCriterionPerComponentDeltaX> createConvergenceCriterionPerComponentDeltaX(const BaseLib::ConfigTree& config) { + //! \ogs_file_param{process__convergence_criterion__type} config.checkConfigParameter("type", "PerComponentDeltaX"); auto abstols = + //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__abstols} config.getConfigParameterOptional<std::vector<double>>("abstols"); auto reltols = + //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__reltols} config.getConfigParameterOptional<std::vector<double>>("reltols"); auto const norm_type_str = + //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__norm_type} config.getConfigParameter<std::string>("norm_type"); if ((!abstols) && (!reltols)) diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp index 155857c71fcd28b14204a171d7e65391b12e32fa..4b8cad55d9337c645828838242e7fb14a8f6f76e 100644 --- a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp @@ -90,13 +90,17 @@ std::unique_ptr<ConvergenceCriterionPerComponentResidual> createConvergenceCriterionPerComponentResidual( const BaseLib::ConfigTree& config) { + //! \ogs_file_param{process__convergence_criterion__type} config.checkConfigParameter("type", "PerComponentResidual"); auto abstols = + //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__abstols} config.getConfigParameterOptional<std::vector<double>>("abstols"); auto reltols = + //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__reltols} config.getConfigParameterOptional<std::vector<double>>("reltols"); auto const norm_type_str = + //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__norm_type} config.getConfigParameter<std::string>("norm_type"); if ((!abstols) && (!reltols)) diff --git a/NumLib/ODESolver/ConvergenceCriterionResidual.cpp b/NumLib/ODESolver/ConvergenceCriterionResidual.cpp index 141245a44921daee3ab4bc123d4435dc192023c7..96a5b7c338ca6b5ba9e6449e3ccf790351e1bb22 100644 --- a/NumLib/ODESolver/ConvergenceCriterionResidual.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionResidual.cpp @@ -58,11 +58,15 @@ void ConvergenceCriterionResidual::checkResidual(const GlobalVector& residual) std::unique_ptr<ConvergenceCriterionResidual> createConvergenceCriterionResidual(const BaseLib::ConfigTree& config) { + //! \ogs_file_param{process__convergence_criterion__type} config.checkConfigParameter("type", "Residual"); + //! \ogs_file_param{process__convergence_criterion__Residual__abstol} auto abstol = config.getConfigParameterOptional<double>("abstol"); + //! \ogs_file_param{process__convergence_criterion__Residual__reltol} auto reltol = config.getConfigParameterOptional<double>("reltol"); auto const norm_type_str = + //! \ogs_file_param{process__convergence_criterion__Residual__norm_type} config.getConfigParameter<std::string>("norm_type"); auto const norm_type = MathLib::convertStringToVecNormType(norm_type_str); diff --git a/NumLib/ODESolver/NonlinearSolver.cpp b/NumLib/ODESolver/NonlinearSolver.cpp index 990d00a8ce1f5338dffa0f719ab6daa7ed3cec8b..4456263c744e8dfd16719a7d77550d77b3bde0a4 100644 --- a/NumLib/ODESolver/NonlinearSolver.cpp +++ b/NumLib/ODESolver/NonlinearSolver.cpp @@ -319,6 +319,7 @@ createNonlinearSolver(GlobalLinearSolver& linear_solver, //! \ogs_file_param{prj__nonlinear_solvers__nonlinear_solver__max_iter} auto const max_iter = config.getConfigParameter<unsigned>("max_iter"); + //! \ogs_file_param_special{prj__nonlinear_solvers__nonlinear_solver__Picard} if (type == "Picard") { auto const tag = NonlinearSolverTag::Picard; using ConcreteNLS = NonlinearSolver<tag>; diff --git a/ProcessLib/Utils/ParseSecondaryVariables.cpp b/ProcessLib/Utils/ParseSecondaryVariables.cpp index 1595481e71723cbbe1ee3eebd87ad2c13ee0b382..075ebf3751314b1c91569ee3a51d122f31d72526 100644 --- a/ProcessLib/Utils/ParseSecondaryVariables.cpp +++ b/ProcessLib/Utils/ParseSecondaryVariables.cpp @@ -20,24 +20,24 @@ void parseSecondaryVariables( NumLib::NamedFunctionCaller& named_function_caller) { auto sec_vars_config = - // \ogs_file_param{process__secondary_variables} + //! \ogs_file_param{process__secondary_variables} config.getConfigSubtreeOptional("secondary_variables"); if (!sec_vars_config) return; for (auto sec_var_config : - // \ogs_file_param{process__secondary_variables__secondary_variable} + //! \ogs_file_param{process__secondary_variables__secondary_variable} sec_vars_config->getConfigSubtreeList("secondary_variable")) { auto const type = - // \ogs_file_attr{process__secondary_variables__secondary_variable__type} + //! \ogs_file_attr{process__secondary_variables__secondary_variable__type} sec_var_config.getConfigAttribute<std::string>("type"); auto const internal_name = - // \ogs_file_attr{process__secondary_variables__secondary_variable__internal_name} + //! \ogs_file_attr{process__secondary_variables__secondary_variable__internal_name} sec_var_config.getConfigAttribute<std::string>("internal_name"); auto const output_name = - // \ogs_file_attr{process__secondary_variables__secondary_variable__output_name} + //! \ogs_file_attr{process__secondary_variables__secondary_variable__output_name} sec_var_config.getConfigAttribute<std::string>("output_name"); secondary_variables.addNameMapping(internal_name, output_name); @@ -48,14 +48,14 @@ void parseSecondaryVariables( auto const& sink_fct = internal_name; for (auto const plug : - // \ogs_file_param{process__secondary_variables__secondary_variable__plug} + //! \ogs_file_param{process__secondary_variables__secondary_variable__plug} sec_var_config.getConfigParameterList("plug")) { auto const sink_arg = - // \ogs_file_attr{process__secondary_variables__secondary_variable__sink_arg} + //! \ogs_file_attr{process__secondary_variables__secondary_variable__sink_arg} plug.getConfigAttribute<std::string>("sink_arg"); auto const source_fct = - // \ogs_file_attr{process__secondary_variables__secondary_variable__source_fct} + //! \ogs_file_attr{process__secondary_variables__secondary_variable__source_fct} plug.getConfigAttribute<std::string>("source_fct"); named_function_caller.plug(sink_fct, sink_arg, source_fct); diff --git a/scripts/doc/linked-xml-file.py b/scripts/doc/linked-xml-file.py index f170fc3d1c8f07f727528aed4a89c3093139181c..3e718bab98be33dbaec1eee681f8624d845d7131 100755 --- a/scripts/doc/linked-xml-file.py +++ b/scripts/doc/linked-xml-file.py @@ -250,7 +250,7 @@ for k, v in map_tag_to_prj_files.items(): for k, v in map_attr_to_prj_files.items(): map_attr_to_prj_files[k] = list(v) - documented_tags_attrs.discard((k, True)) + documented_tags_attrs.discard((k, False)) with open(os.path.join(docauxdir, "tested-parameters-cache.json"), "w") as fh: json.dump({ "tags": map_tag_to_prj_files, "attributes": map_attr_to_prj_files }, \