city_generator2-output.5 (5606B)
1 .\" Copyright (C) 2022-2023 Université de Pau et des Pays de l'Adour UPPA 2 .\" Copyright (C) 2022-2023 CNRS 3 .\" Copyright (C) 2022-2023 Sorbonne Université 4 .\" Copyright (C) 2022-2023 Université Paul Sabatier 5 .\" Copyright (C) 2022-2023 |Meso|Star>. 6 .\" 7 .\" This program is free software: you can redistribute it and/or modify 8 .\" it under the terms of the GNU General Public License as published by 9 .\" the Free Software Foundation, either version 3 of the License, or 10 .\" (at your option) any later version. 11 .\" 12 .\" This program is distributed in the hope that it will be useful, 13 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of 14 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 .\" GNU General Public License for more details. 16 .\" 17 .\" You should have received a copy of the GNU General Public License 18 .\" along with this program. If not, see <http://www.gnu.org/licenses/>. 19 .Dd June 11, 2024 20 .Dt CITY_GENERATOR2-OUTPUT 5 21 .Os 22 .Sh NAME 23 .Nm city_generator2-output 24 .Nd naming-scheme for files created by 25 .Xr city_generator2 1 26 .Sh DESCRIPTION 27 The output of 28 .Xr city-generator2 1 29 is a set of STL files, in either ascii or binary format, that describe the 30 ground and the building parts, along with all their boundaries. 31 As expected for use by most solvers, including 32 .Xr stardis 1 , the output meshes are conformal. 33 The various output files for buildings are named after the name of the building 34 they are part of, as well as the name of the part they mesh. 35 .Sh NAMING SCHEME 36 Some conventions apply in file names, regardless of which part of the output is 37 concerned: 38 .Bl -dash -offset indent 39 .It 40 The name begins either with 41 .Sy ground No or the Sy name No of a building; the later obviously indicates 42 that this file is part of the output for this building. 43 .It 44 The next part of the name is a capital letter that indicates what type of 45 mesh the file describes: 46 .Bl -tag -nested -width Ds 47 .It B 48 if the file describes a boundary (a frontier with the external fluid), 49 .It C 50 if the file describes a connection (a frontier between two solids or 51 between a solid and the internal fluid), 52 .It F 53 if the file describes a fluid closed volume, 54 .It S 55 if the file describes a solid closed volume. 56 .El 57 .It 58 The final part of the name indicates which part is being described. 59 .It 60 Parts are separated by underscore characters. 61 .El 62 .Pp 63 The simplest part of the output is the ground. 64 The mesh describing the ground is provided in 6 files, one file per face, named 65 .Sm off 66 .Sy ground_B_top.stl No \&, 67 .Sm on 68 .Sm off 69 .Sy ground_B_bottom.stl No \&, 70 .Sm on 71 and 72 .Sy ground_B_lateral_0.stl No through 73 .Sm off 74 .Sy ground_B_lateral_3.stl No \&. 75 .Sm on 76 The shape of the mesh is the box described in the city map file used in input 77 (see 78 .Xr city_generator2-intput 5 ) 79 punched with 1 hole per building, according to building footprints. 80 .Pp 81 The connection between the ground and each building is part of the building 82 description. 83 If a closed volume for the ground is needed, it can be obtained as 84 the union of the meshes in 85 .Sy ground_B_*.stl No and 86 .Sm off 87 .Sy *_C_ground.stl No \&. 88 .Sm on 89 .Pp 90 Each building on the map is described by various files, depending on its 91 construction mode. 92 .Pp 93 Buildings of construction mode 94 .Sy Construction_Mode_0 No produce the following output files\&: 95 .Bl -dash -offset indent 96 .It 97 The solid for the walls, 98 .It 99 The solid for the floor, 100 .It 101 The solid for the roof, 102 .It 103 The internal fluid, 104 .It 105 The 3 solid-fluid connections between the internal fluid and the 3 solids, 106 .It 107 The solid-solid connection between the building and the ground, 108 .It 109 The boundary of the walls, 110 .It 111 The boundary of the roof. 112 .El 113 .Pp 114 Note that the many solid-solid connections between the different building layers 115 are not part of the output. 116 .Pp 117 Buildings of construction mode 118 .Sy Construction_Mode_1 No produce the following output files, some being 119 optional: 120 .Bl -dash -offset indent 121 .It 122 The solid for the walls, 123 .It 124 The solid for the floor, 125 .It 126 The solid for the roof, 127 .It 128 The solid for the glazing, 129 .It 130 The solid for the foundation (optional). 131 .It 132 The solid for the intermediate floors (optional, all levels merged). 133 .It 134 The solid for the internal insulation (optional). 135 .It 136 The solid for the external insulation (optional). 137 .It 138 The solid for the floor insulation (optional). 139 .It 140 The solid for the roof insulation (optional). 141 .It 142 The internal fluid in the attic (optional). 143 .It 144 The internal fluid in the crawlspace (optional). 145 .It 146 The internal fluid for the other levels (all levels merged). 147 .It 148 Various solid-fluid connections between an internal fluid and a solid. 149 Depending on the presence of an optional layer, the connection can be between 150 a fluid and the optional layer, or between a fluid and the next layer. 151 .It 152 The solid-solid connection between the building and the ground. 153 .It 154 The boundary of the various solids, including optional ones, that are part of 155 the external layer of the building. 156 .El 157 .Pp 158 Note that the many solid-solid connections between the different building layers 159 are not part of the output. 160 .Sh MESH ORIENTATION 161 All the meshes enclosing either a fluid or a solid are defined with all 162 triangles having their direct normal (right-hand rule) pointing to the outside. 163 .Pp 164 Additionally, all the meshes, whether they define an enclosure or a connection 165 or a boundary, comply with a consistency requirement regarding normal 166 orientation (all normals on the same side). 167 .Sh SEE ALSO 168 .Xr city_generator2 1 , 169 .Xr city_generator2-input 5 170 .Sh HISTORY 171 .Nm 172 has been initially developed as part of the 173 .Sy Readynov No funding program of the Occitanie / 174 Pyrénées-Méditerranée region.