-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_wake_models.html
641 lines (355 loc) · 38.9 KB
/
api_wake_models.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="">
<title>foxes.models.wake_models - foxes 1.2 documentation</title>
<meta name="theme-color" content="#009485">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.3625f807144f53acf.min.css?v=fbfc4466" />
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="index.html" title="foxes 1.2 documentation" class="md-header__button md-logo" aria-label="foxes 1.2 documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
foxes 1.2 documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
foxes.models.wake_models
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/FraunhoferIWES/foxes" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
foxes
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="index.html" title="foxes 1.2 documentation" class="md-nav__button md-logo" aria-label="foxes 1.2 documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
foxes 1.2 documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/FraunhoferIWES/foxes" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
foxes
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="citation.html" class="md-nav__link">
<span title="/citation.md (reference label)" class="md-ellipsis">Citation</span>
</a>
</li>
<li class="md-nav__item">
<a href="installation.html" class="md-nav__link">
<span title="/installation.md (reference label)" class="md-ellipsis">Installation</span>
</a>
</li>
<li class="md-nav__item">
<a href="overview.html" class="md-nav__link">
<span title="/overview.md (reference label)" class="md-ellipsis">Overview -<wbr> how to setup foxes</span>
</a>
</li>
<li class="md-nav__item">
<a href="inputs.html" class="md-nav__link">
<span title="/inputs.rst (reference label)" class="md-ellipsis">Inputs</span>
</a>
</li>
<li class="md-nav__item">
<a href="models.html" class="md-nav__link">
<span title="/models.rst (reference label)" class="md-ellipsis">Models</span>
</a>
</li>
<li class="md-nav__item">
<a href="notebooks/parallelization.html" class="md-nav__link">
<span title="/notebooks/parallelization.ipynb (reference label)" class="md-ellipsis">Parallelization</span>
</a>
</li>
<li class="md-nav__item">
<a href="apps.html" class="md-nav__link">
<span title="/apps.md (reference label)" class="md-ellipsis">Command line applications</span>
</a>
</li>
<li class="md-nav__item">
<a href="examples.html" class="md-nav__link">
<span title="/examples.rst (reference label)" class="md-ellipsis">Examples</span>
</a>
</li>
<li class="md-nav__item">
<a href="optimization.html" class="md-nav__link">
<span title="/optimization.md (reference label)" class="md-ellipsis">Optimization</span>
</a>
</li>
<li class="md-nav__item">
<a href="api.html" class="md-nav__link">
<span title="/api.rst (reference label)" class="md-ellipsis">API</span>
</a>
</li>
<li class="md-nav__item">
<a href="notebooks/data.html" class="md-nav__link">
<span title="/notebooks/data.ipynb (reference label)" class="md-ellipsis">Static data</span>
</a>
</li>
<li class="md-nav__item">
<a href="testing.html" class="md-nav__link">
<span title="/testing.md (reference label)" class="md-ellipsis">Testing</span>
</a>
</li>
<li class="md-nav__item">
<a href="CHANGELOG.html" class="md-nav__link">
<span title="/changelog.md (reference label)" class="md-ellipsis">History</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset" role="main">
<h1 id="foxes-models-wake-models">foxes.models.wake_models<a class="headerlink" href="#foxes-models-wake-models" title="Link to this heading">¶</a></h1>
<blockquote>
<div><table class="docutils data align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Package</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="#foxes-models-wake-models-wind"><span class="std std-ref">foxes.models.wake_models.wind</span></a></p></td>
<td><p>Wind deficit wake models.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#foxes-models-wake-models-ti"><span class="std std-ref">foxes.models.wake_models.ti</span></a></p></td>
<td><p>Turbulence intensity increase wake models.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#foxes-models-wake-models-induction"><span class="std std-ref">foxes.models.wake_models.induction</span></a></p></td>
<td><p>Induction models for blockage modelling.</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>Abstract base classes for wake models are available directly
under the <em>foxes.models.wake_models</em> package. They introduce a wake model
classification that is relevant for the different partial
wakes models.</p>
<blockquote>
<div><dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/DistSlicedWakeModel.html" title="foxes.models.wake_models.DistSlicedWakeModel (Python class) — Abstract base class for wake models for which the x-denpendency can be separated from the yz-dependency."><span class="sig-name descname pseudo-toc-entry"><span class="pre">DistSlicedWakeModel</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/core/WakeModel.html" title="foxes.core.WakeModel (Python class) — Abstract base class for wake models."><span class="pre">foxes.core.WakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/dist_sliced.html#DistSlicedWakeModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Abstract base class for wake models for which
the x-denpendency can be separated from the
yz-dependency.</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/AxisymmetricWakeModel.html" title="foxes.models.wake_models.AxisymmetricWakeModel (Python class) — Abstract base class for wake models that depend on (x, r) separately."><span class="sig-name descname pseudo-toc-entry"><span class="pre">AxisymmetricWakeModel</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/DistSlicedWakeModel.html" title="foxes.models.wake_models.DistSlicedWakeModel (Python class) — Abstract base class for wake models for which the x-denpendency can be separated from the yz-dependency."><span class="pre">foxes.models.wake_models.DistSlicedWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/axisymmetric.html#AxisymmetricWakeModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Abstract base class for wake models
that depend on (x, r) separately.</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/TopHatWakeModel.html" title="foxes.models.wake_models.TopHatWakeModel (Python class) — Abstract base class for top-hat wake models."><span class="sig-name descname pseudo-toc-entry"><span class="pre">TopHatWakeModel</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/AxisymmetricWakeModel.html" title="foxes.models.wake_models.AxisymmetricWakeModel (Python class) — Abstract base class for wake models that depend on (x, r) separately."><span class="pre">foxes.models.wake_models.AxisymmetricWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/top_hat.html#TopHatWakeModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Abstract base class for top-hat wake models.</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/GaussianWakeModel.html" title="foxes.models.wake_models.GaussianWakeModel (Python class) — Abstract base class for Gaussian wake models."><span class="sig-name descname pseudo-toc-entry"><span class="pre">GaussianWakeModel</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/AxisymmetricWakeModel.html" title="foxes.models.wake_models.AxisymmetricWakeModel (Python class) — Abstract base class for wake models that depend on (x, r) separately."><span class="pre">foxes.models.wake_models.AxisymmetricWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/gaussian.html#GaussianWakeModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Abstract base class for Gaussian wake models.</p>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
</div></blockquote>
<h1 id="foxes-models-wake-models-wind">foxes.models.wake_models.wind<a class="headerlink" href="#foxes-models-wake-models-wind" title="Link to this heading">¶</a></h1>
<p>Concrete wind deficit wake models.</p>
<blockquote>
<div><dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.wind.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/wind/JensenWake.html" title="foxes.models.wake_models.wind.JensenWake (Python class) — The Jensen wake model."><span class="sig-name descname pseudo-toc-entry"><span class="pre">JensenWake</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/TopHatWakeModel.html" title="foxes.models.wake_models.TopHatWakeModel (Python class) — Abstract base class for top-hat wake models."><span class="pre">foxes.models.wake_models.TopHatWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/wind/jensen.html#JensenWake"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Jensen wake model.</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.wind.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/wind/Bastankhah2014.html" title="foxes.models.wake_models.wind.Bastankhah2014 (Python class) — The Bastankhah 2014 wake model"><span class="sig-name descname pseudo-toc-entry"><span class="pre">Bastankhah2014</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/GaussianWakeModel.html" title="foxes.models.wake_models.GaussianWakeModel (Python class) — Abstract base class for Gaussian wake models."><span class="pre">foxes.models.wake_models.GaussianWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/wind/bastankhah14.html#Bastankhah2014"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Bastankhah 2014 wake model</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.wind.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/wind/Bastankhah2016Model.html" title="foxes.models.wake_models.wind.Bastankhah2016Model (Python class) — Common calculations for the wake model and the wake frame, such that code repetitions can be avoided."><span class="sig-name descname pseudo-toc-entry"><span class="pre">Bastankhah2016Model</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/core/Model.html" title="foxes.core.Model (Python class) — Base class for all models."><span class="pre">foxes.core.Model</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/wind/bastankhah16.html#Bastankhah2016Model"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Common calculations for the wake model and the wake
frame, such that code repetitions can be avoided.</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.wind.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/wind/Bastankhah2016.html" title="foxes.models.wake_models.wind.Bastankhah2016 (Python class) — The Bastankhah 2016 wake model"><span class="sig-name descname pseudo-toc-entry"><span class="pre">Bastankhah2016</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/DistSlicedWakeModel.html" title="foxes.models.wake_models.DistSlicedWakeModel (Python class) — Abstract base class for wake models for which the x-denpendency can be separated from the yz-dependency."><span class="pre">foxes.models.wake_models.DistSlicedWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/wind/bastankhah16.html#Bastankhah2016"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Bastankhah 2016 wake model</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.wind.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/wind/TurbOParkWake.html" title="foxes.models.wake_models.wind.TurbOParkWake (Python class) — The TurbOPark wake model"><span class="sig-name descname pseudo-toc-entry"><span class="pre">TurbOParkWake</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/GaussianWakeModel.html" title="foxes.models.wake_models.GaussianWakeModel (Python class) — Abstract base class for Gaussian wake models."><span class="pre">foxes.models.wake_models.GaussianWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/wind/turbopark.html#TurbOParkWake"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The TurbOPark wake model</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.wind.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/wind/TurbOParkWakeIX.html" title="foxes.models.wake_models.wind.TurbOParkWakeIX (Python class) — The generalized TurbOPark wake model, integrating TI over the streamline."><span class="sig-name descname pseudo-toc-entry"><span class="pre">TurbOParkWakeIX</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/GaussianWakeModel.html" title="foxes.models.wake_models.GaussianWakeModel (Python class) — Abstract base class for Gaussian wake models."><span class="pre">foxes.models.wake_models.GaussianWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/wind/turbopark.html#TurbOParkWakeIX"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The generalized TurbOPark wake model, integrating TI over the streamline.</p>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
</div></blockquote>
<h1 id="foxes-models-wake-models-ti">foxes.models.wake_models.ti<a class="headerlink" href="#foxes-models-wake-models-ti" title="Link to this heading">¶</a></h1>
<p>Concrete turbulence intensity increase wake models.</p>
<blockquote>
<div><dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.ti.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/ti/CrespoHernandezTIWake.html" title="foxes.models.wake_models.ti.CrespoHernandezTIWake (Python class) — The Crespo and Hernandez TI empirical correlation"><span class="sig-name descname pseudo-toc-entry"><span class="pre">CrespoHernandezTIWake</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/TopHatWakeModel.html" title="foxes.models.wake_models.TopHatWakeModel (Python class) — Abstract base class for top-hat wake models."><span class="pre">foxes.models.wake_models.TopHatWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/ti/crespo_hernandez.html#CrespoHernandezTIWake"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Crespo and Hernandez TI empirical correlation</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.ti.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/ti/IECTIWake.html" title="foxes.models.wake_models.ti.IECTIWake (Python class) — The TI wake model from IEC-64100-1-2005-8 (2005):"><span class="sig-name descname pseudo-toc-entry"><span class="pre">IECTIWake</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/TopHatWakeModel.html" title="foxes.models.wake_models.TopHatWakeModel (Python class) — Abstract base class for top-hat wake models."><span class="pre">foxes.models.wake_models.TopHatWakeModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/ti/iec_ti.html#IECTIWake"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The TI wake model from IEC-64100-1-2005-8 (2005):</p>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
</div></blockquote>
<h1 id="foxes-models-wake-models-induction">foxes.models.wake_models.induction<a class="headerlink" href="#foxes-models-wake-models-induction" title="Link to this heading">¶</a></h1>
<p>Concrete induction models for blockage modelling.</p>
<blockquote>
<div><dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.induction.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/induction/RankineHalfBody.html" title="foxes.models.wake_models.induction.RankineHalfBody (Python class) — The Rankine half body induction wake model"><span class="sig-name descname pseudo-toc-entry"><span class="pre">RankineHalfBody</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/core/TurbineInductionModel.html" title="foxes.core.TurbineInductionModel (Python class) — Abstract base class for turbine induction models."><span class="pre">foxes.core.TurbineInductionModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/induction/rankine_half_body.html#RankineHalfBody"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Rankine half body induction wake model</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.induction.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/induction/Rathmann.html" title="foxes.models.wake_models.induction.Rathmann (Python class) — The Rathmann induction wake model"><span class="sig-name descname pseudo-toc-entry"><span class="pre">Rathmann</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/core/TurbineInductionModel.html" title="foxes.core.TurbineInductionModel (Python class) — Abstract base class for turbine induction models."><span class="pre">foxes.core.TurbineInductionModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/induction/rathmann.html#Rathmann"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Rathmann induction wake model</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.induction.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/induction/SelfSimilar.html" title="foxes.models.wake_models.induction.SelfSimilar (Python class) — The self-similar induction wake model from Troldborg and Meyer Forsting"><span class="sig-name descname pseudo-toc-entry"><span class="pre">SelfSimilar</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/core/TurbineInductionModel.html" title="foxes.core.TurbineInductionModel (Python class) — Abstract base class for turbine induction models."><span class="pre">foxes.core.TurbineInductionModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/induction/self_similar.html#SelfSimilar"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The self-similar induction wake model
from Troldborg and Meyer Forsting</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.induction.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/induction/SelfSimilar2020.html" title="foxes.models.wake_models.induction.SelfSimilar2020 (Python class) — The self-similar 2020 induction wake model from Troldborg and Meyer Forsting"><span class="sig-name descname pseudo-toc-entry"><span class="pre">SelfSimilar2020</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/models/wake_models/induction/SelfSimilar.html" title="foxes.models.wake_models.induction.SelfSimilar (Python class) — The self-similar induction wake model from Troldborg and Meyer Forsting"><span class="pre">foxes.models.wake_models.induction.SelfSimilar</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/induction/self_similar2020.html#SelfSimilar2020"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The self-similar 2020 induction wake model
from Troldborg and Meyer Forsting</p>
</dd></dl>
<dl class="py class summary objdesc">
<dt class="sig sig-object highlight sig-wrap py">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">foxes.models.wake_models.induction.</span></span><a class="sig-name descname pseudo-toc-entry reference internal" href="_foxes/models/wake_models/induction/VortexSheet.html" title="foxes.models.wake_models.induction.VortexSheet (Python class) — The Vortex Sheet model implemented with a radial dependency"><span class="sig-name descname pseudo-toc-entry"><span class="pre">VortexSheet</span></span></a><span class="p"><span class="pre">(</span></span><span class="desctype"><a class="reference internal" href="_foxes/core/TurbineInductionModel.html" title="foxes.core.TurbineInductionModel (Python class) — Abstract base class for turbine induction models."><span class="pre">foxes.core.TurbineInductionModel</span></a></span><span class="p"><span class="pre">)</span></span><a class="reference internal" href="_modules/foxes/models/wake_models/induction/vortex_sheet.html#VortexSheet"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>The Vortex Sheet model implemented with a radial dependency</p>
</dd></dl>
<div class="toctree-wrapper compound">
</div>
</div></blockquote>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-footer-copyright__highlight">
© Copyright 2024, Fraunhofer IWES.
</div>
Created using
<a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
8.1.3.
and
<a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
<script src="_static/sphinx_immaterial_theme.f9d9eeeb247ace16c.min.js?v=8ec58cb5"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
</body>
</html>