city_generator2

commit ad302bce290e51d244714f69f17d1ddea14b5fd1
parent b81f70f4ac82c68fcb604b78d18ff5e239168efb
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Thu, 26 Jan 2023 11:56:56 +0100

Some changes in output manpage

Diffstat:
M
doc/city_generator2-output.5.txt
 | 
33
++++++++++++++++-----------------

1 file changed, 16 insertions(+), 17 deletions(-)
diff --git a/doc/city_generator2-output.5.txt b/doc/city_generator2-output.5.txt
@@ -23,11 +23,11 @@
 
 == NAME
 
-city_generator2-output - naming-scheme for city_generator2(1) generated files.
+city_generator2-output - naming-scheme for files created by city_generator2(1).
 
 == DESCRIPTION
 
-The output of *city_generator2* is a set of *STL* files, either in ascii or in
+The output of *city_generator2* is a set of *STL* files, in either ascii or
 binary format, that describe the ground and the building parts, along with all
 their boundaries. As expected for use by most solvers, including *stardis*(1),
 the output meshes are conformal. The various output files for buildings are
@@ -39,24 +39,25 @@ the part they mesh.
 Some conventions apply in file names, regardless of which part of the output is
 concerned:
 
-- The name starts with either "ground", or a building name; the later obviously
-  indicates this file is part of the output for this building.
+- The name begins either with "ground" or the name of a building; the later
+  obviously indicates that this file is part of the output for this building.
 
-- The next part of the name is a capital letter that indicates which type of
+- The next part of the name is a capital letter that indicates what type of
   mesh the file describes: *B* if the file describes a boundary (a frontier with
   the external fluid), *C* if the file describes a connection (a frontier
-  between two solids or between a solid and the internal fluid), *F* is the file
+  between two solids or between a solid and the internal fluid), *F* if the file
   describes a fluid closed volume, and *S* if the file describes a solid closed
   volume.
 
-- The final part of the name indicates which part is described.
+- The final part of the name indicates which part is being described.
 
-- The parts are separated with *_*.
+- Parts are separated by *_*.
 
 The simplest part of the output is the ground. The mesh describing the ground is
 provided both in a single file named *ground_B.stl* and in 6 files, one file per
-side, named *ground_B_0.stl* to *ground_B_5.stl*. The shape of the mesh is the
-box described in the city map file used in input (see
+face, named *ground_B_top.stl*, *ground_B_bottom.stl*, and
+*ground_B_lateral_0.stl* through *ground_B_lateral_3.stl*. The shape of the mesh
+is the box described in the city map file used in input (see
 *city_generator2-intput*(5)) punched with 1 hole per building, according to
 building footprints.
 
@@ -108,8 +109,6 @@ output files, some being optional:
 
 - The solid for the external insulation (optional).
 
-- The solid for the attic insulation (optional).
-
 - The solid for the floor insulation (optional).
 
 - The solid for the roof insulation (optional).
@@ -121,8 +120,8 @@ output files, some being optional:
 - The internal fluid for the other levels (all levels merged).
 
 - Various solid-fluid connections between an internal fluid and a solid.
-  Depending on optional layer presence, the connection can be between a fluid
-  and an optional layer, or between a fluid and the next layer.
+  Depending on the presence of an optional layer, the connection can be between
+  a fluid and the optional layer, or between a fluid and the next layer.
 
 - The solid-solid connection between the building and the ground.
 
@@ -137,9 +136,9 @@ are not part of the output.
 All the meshes enclosing either a fluid or a solid are defined with all
 triangles having their direct normal (right-hand rule) pointing to the outside.
 
-Additionally, all the meshes, either defining an enclosure or a connection or a
-boundary, comply with a consistency requirement regarding normal orientation
-(all the normals on the same side).
+Additionally, all the meshes, wether they define an enclosure or a connection or
+a boundary, comply with a consistency requirement regarding normal orientation
+(all normals on the same side).
 
 == SEE ALSO