From f67fd07aee98518153a60a389dd111ffbdd7796b Mon Sep 17 00:00:00 2001 From: Christoph Lehmann <christoph.lehmann@ufz.de> Date: Wed, 24 Aug 2016 08:51:05 +0200 Subject: [PATCH] [Doc] documented the gml file --- Documentation/ProjectFile/gml/c_gml.md | 3 +++ Documentation/ProjectFile/gml/points/i_points.md | 2 +- Documentation/ProjectFile/gml/points/point/a_id.md | 3 ++- Documentation/ProjectFile/gml/points/point/a_name.md | 2 +- Documentation/ProjectFile/gml/points/point/a_x.md | 2 +- Documentation/ProjectFile/gml/points/point/a_y.md | 2 +- Documentation/ProjectFile/gml/points/point/a_z.md | 2 +- Documentation/ProjectFile/gml/points/point/i_point.md | 2 +- Documentation/ProjectFile/gml/polylines/i_polylines.md | 2 +- Documentation/ProjectFile/gml/polylines/polyline/a_id.md | 2 +- Documentation/ProjectFile/gml/polylines/polyline/a_name.md | 2 +- .../ProjectFile/gml/polylines/polyline/i_polyline.md | 4 +++- Documentation/ProjectFile/gml/polylines/polyline/t_pnt.md | 3 ++- Documentation/ProjectFile/gml/surfaces/i_surfaces.md | 2 +- Documentation/ProjectFile/gml/surfaces/surface/a_id.md | 2 +- Documentation/ProjectFile/gml/surfaces/surface/a_name.md | 2 +- .../ProjectFile/gml/surfaces/surface/element/a_p1.md | 3 ++- .../ProjectFile/gml/surfaces/surface/element/a_p2.md | 3 ++- .../ProjectFile/gml/surfaces/surface/element/a_p3.md | 3 ++- .../ProjectFile/gml/surfaces/surface/element/i_element.md | 4 +++- Documentation/ProjectFile/gml/surfaces/surface/i_surface.md | 3 ++- Documentation/ProjectFile/gml/t_name.md | 5 ++++- 22 files changed, 37 insertions(+), 21 deletions(-) diff --git a/Documentation/ProjectFile/gml/c_gml.md b/Documentation/ProjectFile/gml/c_gml.md index e69de29bb2d..5be1f430181 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 576add64edc..629d0f80d62 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 576add64edc..74338bd51db 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 576add64edc..4ea3bfb2f38 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 576add64edc..41f91425413 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 576add64edc..0b12fa75be6 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 576add64edc..923fdb82ff0 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 576add64edc..9b00fe3f018 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 576add64edc..e9929013937 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 576add64edc..7cd2fd8c1ba 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 576add64edc..2abacdde47e 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 576add64edc..70af4a01b0b 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 576add64edc..67c9e4b4331 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 576add64edc..f5885286619 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 576add64edc..ddc80ae9947 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 576add64edc..a7ed0f2097b 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 576add64edc..4c7cabdcf9f 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 576add64edc..e35a3d28700 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 576add64edc..447b818b8d3 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 576add64edc..e9552bc2187 100644 --- a/Documentation/ProjectFile/gml/surfaces/surface/element/i_element.md +++ b/Documentation/ProjectFile/gml/surfaces/surface/element/i_element.md @@ -1 +1,3 @@ -\ogs_missing_documentation +Defines a triangle by its three points. +The face normal of the triangle is determined such that the points are +located counter-clockwise around it (right-hand rule). diff --git a/Documentation/ProjectFile/gml/surfaces/surface/i_surface.md b/Documentation/ProjectFile/gml/surfaces/surface/i_surface.md index 576add64edc..642b503ea87 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 576add64edc..f081c356a48 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. -- GitLab