city_generator2

commit 58c1cc912404cafae930d1e01bde2df27d695412
parent a7663999fad151c6901070425cdecb145b7d86e2
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Wed, 29 Jan 2025 08:53:31 +0100

Write mode 2 related man page

Add mode 2 yaml grammar to city_generator2-input man pages.

Diffstat:
M
doc/city_generator2-input.5
 | 
36
+++++++++++++++++++++++++++++++++---

1 file changed, 33 insertions(+), 3 deletions(-)
diff --git a/doc/city_generator2-input.5 b/doc/city_generator2-input.5
@@ -79,20 +79,24 @@ The city map file format is as follows:
 .It Ao Va building Ac Ta ::= Ta Qo \ \ -name: \& Qc Ao Va name Ac
 .It Ta Ta Qo \ \ \ construction_mode: \& Qc Ao Va cmode-name Ac
 .It Ta Ta Qo \ \ \ dataset: \& Qc Ao Va dataset-name Ac
-.It Ta Ta Qo \ \ \ height: \& Qc Ao Va height Ac
 .It Ta Ta Qo \ \ \ footprint: [ Qc Ao Va vertices Ac Qo ] Qc
+.It Ta Ta Ao Va height-spec Ac
 .It Ao Va name Ac Ta ::= Ta Vt STRING
 .It Ao Va cmode-name Ac Ta ::= Ta Qo Construction_Mode_0 Qc | Qo Construction_Mode_1 Qc
 .It Ao Va dataset-name Ac Ta ::= Ta Vt STRING
 .It Ta Ta # The name must be found in a catalog file
 .It Ta Ta # with the same construction mode
-.It Ao Va height Ac Ta ::= Ta Vt REAL No # > 0, in m
+.It Ao Va height-spec Ac Ta ::= Ta Qo \ \ \ height: \& Qc Ao Va height Ac
+.It Ta | Ta Qo \ \ \ levels_height: [ Qc Ao Va height-list Ac Qo ] Qc
 .It Ao Va vertices Ac Ta ::= Ta Ao Va vertex Ac Bo \& Qo , Qc Ao Va vertices Ac \& Bc
 .It Ta Ta # \&At least 3 vertices
 .It Ao Va vertex Ac Ta ::= Ta Qo \&[ Qc Ao Va X Ac Qo , Qc Ao Va Y Ac Qo ] Qc
 .It Ao Va X Ac Ta ::= Ta Vt REAL No # in m
 .It Ao Va Y Ac Ta ::= Ta Vt REAL No # in m
+.It Ao Va height-list Ac Ta ::= Ta Ao Va height Ac Bo \& Qo , Qc Ao Va height-list Ac \& Bc
+.It Ao Va height Ac Ta ::= Ta Vt REAL No # > 0, in m
 .El
+
 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Ss CATALOG FILE FORMAT
 There are currently two different catalog file formats, identified by name,
@@ -108,13 +112,18 @@ construction mode.
 .Pp
 The catalog file format is as follows:
 .Bl -column (descri-line) (::) ()
-.It Ao Va catalog-file Ac Ta ::= Ta Ao Va catalog-file-0 Ac | Ao Va catalog-file-1 Ac
+.It Ao Va catalog-file Ac Ta ::= Ta Ao Va catalog-file-0 Ac
+.It Ta | Ta Ao Va catalog-file-1 Ac
+.It Ta | Ta Ao Va catalog-file-2 Ac
 .It Ao Va catalog-file-0 Ac Ta ::= Ta Qo construction_mode: Construction_Mode_0 Qc
 .It Ta Ta Qo datasets: \& Qc
 .It Ta Ta Ao Va datasets-0 Ac
 .It Ao Va catalog-file-1 Ac Ta ::= Ta Qo construction_mode: Construction_Mode_1 Qc
 .It Ta Ta Qo datasets: \& Qc
 .It Ta Ta Ao Va datasets-1 Ac
+.It Ao Va catalog-file-2 Ac Ta ::= Ta Qo construction_mode: Construction_Mode_2 Qc
+.It Ta Ta Qo datasets: \& Qc
+.It Ta Ta Ao Va datasets-2 Ac
 .It Ao Va datasets-0 Ac Ta ::= Ta Ao Va dataset-0 Ac
 .It Ta Ta [ \& Ao Va datasets-0 Ac \& ]
 .It Ao Va datasets-1 Ac Ta ::= Ta Ao Va dataset-1 Ac
@@ -140,6 +149,27 @@ The catalog file format is as follows:
 .It Ta Ta Qo \ \ \ external_insulation_thickness: \& Qc Vt REAL
 .It Ta Ta No # >= 0, in m
 .It Ta Ta Qo \ \ \ foundation_depth: \& Qc Vt REAL No # >= 0, in m
+.It Ao Va dataset-2 Ac Ta ::= Ta Qo \ \ -name: \& Qc Ao Va name Ac
+.It Ta Ta Qo \ \ \ wall_thickness: \& Qc Vt REAL No # > 0, in m
+.It Ta Ta Qo \ \ \ floor_thickness: \& Qc Vt REAL No # > 0, in m
+.It Ta Ta Qo \ \ \ inter_floor_thickness: \& Qc Vt REAL No # > 0, in m
+.It Ta Ta Qo \ \ \ roof_thickness: \& Qc Vt REAL No # > 0, in m
+.It Ta Ta Qo \ \ \ crawl_height: \& Qc Vt REAL No # >= 0, in m
+.It Ta Ta Qo \ \ \ foundation_depth: \& Qc Vt REAL No # >= 0, in m
+.It Ta Ta Qo \ \ \ has_attic: \& Qc Vt 0 | 1 No
+.It Ta Ta Qo \ \ \ glass_ratio: \& Qc Vt REAL No # >= 0 and <= 1
+.It Ta Ta Qo \ \ \ windows_min_width: \& Qc Vt REAL No # >= 0
+.It Ta Ta Qo \ \ \ windows_max_width: \& Qc Vt REAL No # >= 0
+.It Ta Ta Qo \ \ \ windows_min_spacing: \& Qc Vt REAL No # >= 0
+.It Ta Ta Qo \ \ \ windows_height_ratio: \& Qc Vt REAL No # >= 0 and <= 1
+.It Ta Ta Qo \ \ \ floor_insulation_thickness: \& Qc Vt REAL
+.It Ta Ta No # >= 0, in m
+.It Ta Ta Qo \ \ \ roof_insulation_thickness: \& Qc Vt REAL
+.It Ta Ta No # >= 0, in m
+.It Ta Ta Qo \ \ \ internal_insulation_thickness: \& Qc Vt REAL
+.It Ta Ta No # >= 0, in m
+.It Ta Ta Qo \ \ \ external_insulation_thickness: \& Qc Vt REAL
+.It Ta Ta No # >= 0, in m
 .It Ao Va name Ac Ta ::= Ta Vt STRING
 .El
 .Sh SEE ALSO