Skip to content

Commit b35835c

Browse files
hqrrrhqrrr
committed
Update documentation
1 parent da0ec36 commit b35835c

4 files changed

Lines changed: 113 additions & 0 deletions

File tree

‎documentation/README.md‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* [01:Create](#01create)
77
* [CreateCFCase](#createcfcase)
88
* [CreateCFGeometry](#createcfgeometry)
9+
* [Carbonfly Info](#carbonfly-info)
910
* [02:Boundary](#02boundary)
1011
* [Body](#body)
1112
* [Dynamic Respiration](#dynamic-respiration)
@@ -29,10 +30,12 @@
2930
* [checkMesh](#checkmesh)
3031
* [foamMonitor](#foammonitor)
3132
* [05:Util](#05util)
33+
* [Air Exchange Rate (Maas)](#air-exchange-rate-maas)
3234
* [BSA (Du Bois)](#bsa-du-bois)
3335
* [CO2 generation rate](#co2-generation-rate)
3436
* [Gagge two-node model](#gagge-two-node-model)
3537
* [Gagge two-node model (sleep)](#gagge-two-node-model-sleep)
38+
* [Surface Wind Pressure](#surface-wind-pressure)
3639
* [Manikin LOD 0](#manikin-lod-0)
3740
* [Met List](#met-list)
3841
<!-- TOC -->
@@ -82,6 +85,22 @@ Create Carbonfly geometry
8285

8386
[Back to top ↥](#carbonfly-toolbox-documentation)
8487

88+
#### Carbonfly Info
89+
90+
<img src="../grasshopper/icons/Carbonfly_Info.png" alt="icon" width="60"/>
91+
92+
Information about Carbonfly
93+
94+
![CreateCFGeometry](_pics/GH_Carbonfly_Info.png)
95+
96+
| Inputs | Outputs |
97+
|--------|--------------------------------------|
98+
| | `version` *(str)*: Carbonfly version |
99+
| | `homepage` *(str)*: Homepage URL |
100+
| | `license` *(str)*: Carbonfly license |
101+
102+
[Back to top ↥](#carbonfly-toolbox-documentation)
103+
85104
### 02:Boundary
86105

87106
#### Body
@@ -386,6 +405,37 @@ Run *foamMonitor*, live monitoring tool to track residuals during simulation.
386405

387406
### 05:Util
388407

408+
#### Air Exchange Rate (Maas)
409+
410+
<img src="../grasshopper/icons/Air_Exchange_Rate_Maas.png" alt="icon" width="60"/>
411+
412+
Air exchange rate in m3/h using Maas' formula:
413+
414+
$\rm \dot{Q} = 3600 \cdot \frac{1}{2} \cdot A_{eff} \cdot \sqrt{(C_1 \cdot u^2 + C_2 \cdot H \cdot \Delta \vartheta + C_3)}$
415+
416+
Where:
417+
1. $\rm A_{eff}$: the effective opening area in $\rm m^2$
418+
2. $\rm u$: the outdoor wind speed in m/s
419+
3. $\rm H$: the height of the window sash in m
420+
4. $\rm C_1$: coefficient, $\rm = 0.0056$
421+
5. $\rm C_2$: coefficient, $\rm = 0.0037$
422+
6. $\rm C_3$: coefficient, $\rm = 0.012$
423+
7. $\rm \Delta \vartheta$: the temperature difference between the inside and outside in K
424+
425+
> Source: Anton Maas. Experimental quantification of air exchange during window ventilation. PhD thesis, University of Kassel, Kassel, 1995.
426+
URL: https://www.uni-kassel.de/fb6/bpy/de/forschung/abgeschlprojekte/pdfs/maas_diss.pdf
427+
428+
![BSA (Du Bois)](_pics/GH_Air_Exchange_Rate_Maas.png)
429+
430+
| Inputs | Outputs |
431+
|-----------------------------------------------------------------------------------------|---------------------------------------------|
432+
| `A_eff` *(float)*: the effective opening area in $\rm m^2$ | `Qdot` *(float)*: Air exchange rate in m3/h |
433+
| `u` *(float)*: the outdoor wind speed in m/s | |
434+
| `H` *(float)*: the height of the window sash in m | |
435+
| `delta_theta` *(float)*: the temperature difference between the inside and outside in K | |
436+
437+
[Back to top ↥](#carbonfly-toolbox-documentation)
438+
389439
#### BSA (Du Bois)
390440

391441
<img src="../grasshopper/icons/BSA_Du_Bois.png" alt="icon" width="60"/>
@@ -492,6 +542,69 @@ Adaption of the Gagge two-node model for sleep thermal environment, by Yan et al
492542

493543
[Back to top ↥](#carbonfly-toolbox-documentation)
494544

545+
#### Surface Wind Pressure
546+
547+
<img src="../grasshopper/icons/Surface_Wind_Pressure.png" alt="icon" width="60"/>
548+
549+
Computes peak and surface wind pressure for vertical walls of rectangular plan buildings (h/d <=5 and height <= 200m)
550+
551+
> Source: DIN EN 1991-1-4:2010-12. Eurocode 1: Actions on structures - Part 1-4: General actions - Wind actions; German version EN 1991-1-4:2005 + A1:2010 + AC:2010. DOI: https://dx.doi.org/10.31030/1625598
552+
553+
> Notes: For other building types, please see DIN EN 1991-1-4:2010-12.
554+
555+
556+
![BSA (Du Bois)](_pics/GH_Surface_Wind_Pressure.png)
557+
558+
| Inputs | Outputs |
559+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
560+
| `vb0` *(float)*: Fundamental value of the basic wind velocity v_b,0 [m/s] (from National Annex map, 10 m, terrain II, 50 yr) | `we` *(float)*: Wind pressure on the external surface [Pa] |
561+
| `z` *(float)*: Height above ground level of the measured/evaluated point [m] | `cpe` *(float)*: External pressure coefficients for vertical walls of rectangular plan buildings [-] |
562+
| `h` *(float)*: Height of the building [m] | `qp` *(float)*: Peak velocity pressure [Pa] |
563+
| `d` *(float)*: Length of the building [m] | `vm` *(float)*: Mean wind speed [m/s] |
564+
| `window_size` *(float)*: Window size in [m^2] | `Iv` *(float)*: Turbulence intensity |
565+
| `zone` *(str)*: External pressure zones*, A/B/C on side/roof edges along the flow, D windward face, and E leeward face | `cr` *(float)*: Roughness factor |
566+
| `terrain` *(int)*: Terrain type, 0/1/2/3/4, default: 4, corresponding to Type 0/I/II/III/IV** | `vb` *(float)*: Basic wind velocity [m/s] |
567+
| `c_dir` *(float)*: Directional factor, for various wind directions may be found in the National Annex. The recommended value is 1.0 | |
568+
| `c_season` *(float)*: Season factor, may be given in the National Annex. The recommended value is 1.0 | |
569+
| `c0` *(float)*: Orography factor, taken as 1.0 unless otherwise specified. Note: Information on c0 may be given in the National Annex. If the orography is accounted for in the basic wind velocity, the recommended value is 1.0 | |
570+
| `rho` *(float)*: Air density in kg/m3. The default value is 1.25 kg/m3 | |
571+
| `k_i` *(float)*: Turbulence factor. The value of k_i may be given in the National Annex. The recommended value for k_i is 1.0 | |
572+
573+
*External pressure zones:
574+
```angular2html
575+
Top view:
576+
<- - - d (length) - ->
577+
----------------------- ^
578+
| | |
579+
wind --> D | | E b (width)
580+
| | |
581+
----------------------- -
582+
D = windward face (positive pressure / stagnation)
583+
E = leeward face (negative pressure / wake suction)
584+
585+
Side view:
586+
<- - - d (length) - ->
587+
----------------------- ^
588+
| | | | |
589+
wind --> | A | B | C | | h (height)
590+
|___|_________|_______| _
591+
<- - - e - - ->
592+
<- 4/5 e ->
593+
Where: e = b or 2h, whichever is smaller
594+
A: leading corner band (strongest suction)
595+
B: intermediate edge band
596+
C: outer side/roof band
597+
```
598+
599+
**Terrain type:
600+
- 0: Sea, coastal area exposed to the open sea.
601+
- 1: Lakes or area with negligible vegetation and without obstacles.
602+
- 2: Area with low vegetation such as grass and isolated obstacles (trees, buildings) with separations of at least 20 obstacle heights.
603+
- 3: Area with regular cover of vegetation or buildings or with isolated obstacles with separations of maximum 20 obstacle heights (such as villages, suburban terrain, permanent forest).
604+
- 4: Area in which at least 15 % of the surface is covered with buildings and their average height exceeds 15 m.
605+
606+
[Back to top ↥](#carbonfly-toolbox-documentation)
607+
495608
#### Manikin LOD 0
496609

497610
<img src="../grasshopper/icons/Body_LOD0.png" alt="icon" width="60"/>

‎documentation/_pics/GH_Air_Exchange_Rate_Maas.png‎

28.5 KB
Loading

‎documentation/_pics/GH_Carbonfly_Info.png‎

27.1 KB
Loading

‎documentation/_pics/GH_Surface_Wind_Pressure.png‎

56.4 KB
Loading

0 commit comments

Comments
 (0)