Merge pull request #374 from nens/olof-improve-docs-2d-boundaries

Geometry requirements for 2D boundaries

STYLE_GUIDE.md

@@ -1,6 +1,6 @@
 Style guide
 -----------
-- Use British English
+- Use British English. Write e.g. schematisation instead of schematization, schematise instead of schematize.
 - If you make screenshots, make sure there are no real user names and real projects in the screenshots. Create them using a demo account or blur them.
 - Headings use sentence case, i.e. starting with a capital letter, but other words not capitalized
 - The following names are used for our user interfaces:
@@ -14,3 +14,5 @@ Style guide
 
 - Do not mention that something is 'new' in the docs, because that will require changes once it is no longer new. Explain how things work as if you are explaining it to new users that are not familiar with the 'old' situation.
 - Native QGIS functionality does not need to be explained in the 3Di docs. Instead, refer to the QGIS documentation. In the URL, replace the version number (e.g. 3.28) by 'latest' (and check if it works).
+- Avoid using dashes, e.g. write "2D boundaries" instead of "2D-boundaries"
+- When mentioning a tool or section in the docs, use an actual reference. Write "use the tool :ref:`computational_grid_from_schematisation`", not "use the tool 'Computational grid from schematisation'"

source/d_2d_objects.rst

@@ -21,8 +21,23 @@ Boundary condition for 2D model edge. Boundary conditions are crucial in hydraul
 
 Geometry
 ^^^^^^^^
+
 Line
 
+Geometry requirements: 
+
+- 2D boundary condition line can only touch boundary computational cells. These are defined as cells having at least one side that does not share an edge with another computational cell. This is often a cell at the outer edge of the model domain. It is also possible to schematise 2D boundaries on an inner edge of the model domain, i.e. if there is a NODATA hole in the DEM. 
+
+- 2D boundary condition lines must intersect with one or more computational cells.
+
+- When multiple computational cells are touched by the 2D boundary condition line, it is essential that these cells align either vertically or horizontally. Diagonal alignment is not permitted.
+
+- All cells intersected by a 2D boundary condition line must have the same size, i.e. do not use grid refinement at the location of a 2D boundary condition.
+
+.. tip::
+  When experiencing difficulties adding 2D boundary conditions, generate the computational grid locally using :ref:`computational_grid_from_schematisation`. This helps you see where the 2D boundary condition line is located relative to the computational cells. 
+
+
 Attributes
 ^^^^^^^^^^
 

source/i_checking_schematisations.rst

@@ -63,6 +63,8 @@ Computational grid from gridadmin.h5 file
 
 The processing algorithm "Computational grid from gridadmin.h5" reads the computational grid data from the .h5 file and writes it to GIS-layers in a GeoPackage. You can find it in the :ref:`3di_processing_toolbox` (Main Menu > Processing > Toolbox), under 3Di > Computational Grid. Choose a folder that contains a gridadmin.h5 file and an output location for the GeoPackage. Once the algorithm has run, the layers from the GeoPackage will be added to your project. If you do not need this data anymore after closing the 3Di Modeller Interface, you can also save to a temporary file. 
 
+.. _computational_grid_from_schematisation:
+
 Computational grid from schematisation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^