city_generator2.1.in (5922B)
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 1 21 .Os 22 .Sh NAME 23 .Nm city_generator2 24 .Nd generation of conformal 3D meshes of a city from a simple ascii description 25 .Sh SYNOPSIS 26 .Nm 27 .Op Fl @CG2_ARGS_CHANGE_BINARY_DEFAULT_OPTION@Ehksv 28 .Op Fl c Ar file_name 29 .Op Fl f Ar building_name 30 .Op Fl F Ar level 31 .Op Fl m Ar file_name 32 .Op Fl V Ar level 33 .Sh DESCRIPTION 34 .Nm 35 generates a city as 3D conformal meshes from an ascii description. 36 The description includes the city map and at least one catalog file. 37 The provided description must comply with the 38 .Xr city_generator2-input 5 39 input format. 40 .Pp 41 The output of 42 .Nm 43 is a set of STL files, either in ascii or in binary format, that contain the 44 various meshes of the ground layers and building parts, along with all their 45 boundaries. 46 As expected for use by most solvers, including 47 .Xr stardis 1 , the output meshes are conformal. 48 The various output files for buildings are named after the name of the building 49 they are part of, as well as the name of the part they mesh. 50 Please refer to 51 .Xr city_generator2-output 5 52 for the complete description of this naming scheme. 53 .Pp 54 .Nm Ns ' 55 internals rely on the star-cad library which itself relies on the gmsh library. 56 .Pp 57 The options are as follows: 58 .Bl -tag -width Ds 59 .It Fl @CG2_ARGS_CHANGE_BINARY_DEFAULT_OPTION@ 60 Change the output format of the generated STL files to 61 @CG2_ARGS_STL_NON_DEFAULT_STR@ (default @CG2_ARGS_STL_DEFAULT_STR@). 62 .It Fl c Ar file_name 63 Read a catalog file which is a text file in yaml 1.1 format containing datasets 64 for a given construction mode. 65 All the datasets in a given file share the same construction mode. 66 If the city map uses more than one construction mode, the different datasets 67 must be provided in (at least) as many catalog files as there are construction 68 modes involved. 69 Please refer to 70 .Xr city_generator2-input 5 71 for more information on formats. 72 .It Fl f Ar building_name 73 Dump the footprint of the building with the given name, if any. 74 Can be used more than once. 75 .It Fl F Ar level 76 Dump the footprint of some buildings in OBJ format, depending on 77 .Ar level . 78 Possible values are\&: 79 .Bl -tag -nested -width Ds 80 .It Cm 1 81 Dump the footprint of any building not generated due to an error, 82 .It Cm 2 83 Dump the footprint of any building. 84 .El 85 .It Fl E 86 Don't use escape characters in output text. 87 Use as first option to avoid escape characters in initial messages. 88 .It Fl h 89 Output short help and exit. 90 .It Fl k 91 Keep running on errors. 92 .It Fl m Ar file_name 93 Read a city map file which is a text file in yaml 1.1 format containing the 94 description of the ground and a list of buildings. 95 The description of an individual building includes its footprint and 96 construction mode among other things. 97 Please refer to 98 .Xr city_generator2-input 5 99 for more information on formats. 100 .It Fl s Ar base_name 101 Specify a base name for the stardis files that are created along the STL files. 102 The two files created are the stardis model file, whose name is 103 .Ar base_name.txt, and the shell script file name dedicated to set the numerous 104 script shell variables used in the model file, and whose name is 105 .Ar base_name.sh. 106 Default 107 .Ar base_name 108 is "@CG2_ARGS_DEFAULT_STARDIS_FILES_BASENAME@". 109 .It Fl v 110 Output version information and exit. 111 .It Fl V Ar level 112 Set the verbosity 113 .Ar level . 114 Possible values are\&: 115 .Bl -tag -nested -width Ds 116 .It Cm 0 117 No message, 118 .It Cm 1 119 Error messages only, 120 .It Cm 2 121 Error and warning messages, 122 .It Cm 3 123 Error, warning and informative messages. 124 .El 125 .Pp 126 All the messages are written to standard error. 127 Default verbosity 128 .Ar level 129 is @CG2_ARGS_DEFAULT_VERBOSITY_LEVEL@. 130 .It Fl 1 131 Force single threaded execution. 132 By default use as many threads as available. 133 Note however that only a small part of the processing is parallelized. 134 Therefore, poor speedup when run multithreaded is not a bug and can even be 135 expected. 136 .El 137 .Sh EXIT STATUS 138 .Ex -std 139 .Sh EXAMPLES 140 Generates the city described in the 141 .Pa city.yaml 142 file, looking for the needed datasets in the 143 .Pa catalog0.yaml 144 and 145 .Pa catalog1.yaml 146 datafile: 147 .Pp 148 .Dl city_generator2 -m city.yaml -c catalog0.yaml -c catalog1.yaml 149 .Sh SEE ALSO 150 .Xr city_generator2-input 5 , 151 .Xr city_generator2-output 5 152 .Rs 153 .%A C. Geuzaine and J.-F. Remacle. 154 .%T Gmsh: a three-dimensional finite element mesh generator with \ 155 built-in pre- and post-processing facilities. 156 .%J International Journal for Numerical Methods in Engineering 157 .%V 79 158 .%N 11 159 .%P 1309-1331 160 .%D 2009 161 .Re 162 .Sh STANDARDS 163 .Rs 164 .%T Appendix B1 of Advanced Visualizer software 3.0 manual 165 .%A Wavefront Technologies 166 .%D 1992 167 .%U http://fegemo.github.io/cefet-cg/attachments/obj-spec.pdf 168 .Re 169 .Rs 170 .Pp 171 .%T The StL Format: Standard Data Format for Fabbers 172 .%A Marshall Burns 173 .%D 1993 174 .%U https://www.fabbers.com/tech/STL_Format 175 .Re 176 .Pp 177 .Rs 178 .%T YAML Ain't Markup Language version 1.1 179 .%A Oren Ben-Kiki 180 .%A Clark Evans 181 .%A Ingy döt Net 182 .%D 2005 183 .%U https://yaml.org/spec/1.1 184 .Re 185 .Sh HISTORY 186 .Nm 187 has been initially developed as part of the 188 .Sy Readynov No funding program of the Occitanie / 189 Pyrénées-Méditerranée region.