-
Notifications
You must be signed in to change notification settings - Fork 1
/
turbulence_options.html
216 lines (203 loc) · 9.74 KB
/
turbulence_options.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
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Turbulence model options — Thetis 0+untagged.2009.gb75eefa documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/thetis.css?v=0f3339d6" />
<script src="_static/documentation_options.js?v=47a7fef3"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
<!-- <link rel="stylesheet" href="_static/featured.css"> -->
<link rel="shortcut icon" href="_static/icon_thetis.ico" />
</head><body>
<div class="wrapper">
<a href="index.html"><img src="_static/banner.jpg" height="180px" alt="Thetis Project Banner" /></a>
<div id="access">
<div class="menu">
<ul>
<li class="page_item"><a href="documentation.html" title="Thetis documentation">Documentation</a></li>
<li class="page_item"><a href="download.html" title="Install Thetis">Download</a></li>
<li class="page_item"><a href="team.html" title="Development team">Team</a></li>
<li class="page_item"><a href="publications.html" title="Publications">Publications</a></li>
<li class="page_item"><a href="funding.html" title="Our financial supporters">Funding</a></li>
<li class="page_item"><a href="contact.html" title="Getting in touch">Contact</a></li>
<li class="page_item"><a href="https://github.com/thetisproject/thetis" title="Thetis source on GitHub">GitHub</a></li>
</ul>
</div><!-- .menu -->
</div><!-- #access -->
</div><!-- #wrapper -->
<div class="document">
<div class="turbulence_options">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="turbulence-model-options">
<span id="turbulence-options"></span><h1>Turbulence model options<a class="headerlink" href="#turbulence-model-options" title="Link to this heading">¶</a></h1>
<p>This page lists all available options for turbulence closure models.</p>
<section id="generic-length-scale-model-options">
<h2>Generic Length Scale model options<a class="headerlink" href="#generic-length-scale-model-options" title="Link to this heading">¶</a></h2>
<dl>
<dt>GLSModelOptions.<strong>c1</strong><span class="classifier">Float</span></dt><dd><p>float: c1 parameter for Psi equations</p>
<p>Default:</p>
<p>1.44</p>
</dd>
<dt>GLSModelOptions.<strong>c2</strong><span class="classifier">Float</span></dt><dd><p>float: c2 parameter for Psi equations</p>
<p>Default:</p>
<p>1.92</p>
</dd>
<dt>GLSModelOptions.<strong>c3_minus</strong><span class="classifier">Float</span></dt><dd><p>float: c3 parameter for Psi equations, stable stratification</p>
<blockquote>
<div><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">compute_c3_minus</span></code> is True this value will be overriden</p>
</div></blockquote>
<p>Default:</p>
<p>-0.52</p>
</dd>
<dt>GLSModelOptions.<strong>c3_plus</strong><span class="classifier">Float</span></dt><dd><p>float: c3 parameter for Psi equations, unstable stratification</p>
<p>Default:</p>
<p>1.0</p>
</dd>
<dt>GLSModelOptions.<strong>closure_name</strong><span class="classifier">‘k-epsilon’|’k-omega’|’Generic Length Scale’</span></dt><dd><p>Name of two-equation closure</p>
<p>Default:</p>
<p>‘k-epsilon’</p>
</dd>
<dt>GLSModelOptions.<strong>cmu0</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: cmu0 parameter</p>
<p>Default:</p>
<p>0.5477</p>
</dd>
<dt>GLSModelOptions.<strong>compute_c3_minus</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute <code class="xref py py-attr docutils literal notranslate"><span class="pre">c3_minus</span></code> from <code class="xref py py-attr docutils literal notranslate"><span class="pre">ri_st</span></code></p>
<p>Default:</p>
<p>True</p>
</dd>
<dt>GLSModelOptions.<strong>compute_cmu0</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute cmu0 from stability function parameters</p>
<blockquote>
<div><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">compute_cmu0</span></code> is True, this value will be overriden</p>
</div></blockquote>
<p>Default:</p>
<p>True</p>
</dd>
<dt>GLSModelOptions.<strong>compute_galperin_clim</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute c_lim length scale limiting factor</p>
<p>Default:</p>
<p>True</p>
</dd>
<dt>GLSModelOptions.<strong>compute_kappa</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute von Karman constant from <code class="xref py py-attr docutils literal notranslate"><span class="pre">schmidt_nb_psi</span></code></p>
<p>Default:</p>
<p>False</p>
</dd>
<dt>GLSModelOptions.<strong>compute_len_min</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute min_len from k_min and psi_min</p>
<p>Default:</p>
<p>False</p>
</dd>
<dt>GLSModelOptions.<strong>compute_psi_min</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute psi_len from k_min and eps_min</p>
<p>Default:</p>
<p>False</p>
</dd>
<dt>GLSModelOptions.<strong>compute_schmidt_nb_psi</strong><span class="classifier">Bool</span></dt><dd><p>bool: compute psi Schmidt number</p>
<p>Default:</p>
<p>True</p>
</dd>
<dt>GLSModelOptions.<strong>diff_min</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: minimum value for eddy diffusivity</p>
<p>Default:</p>
<p>1e-08</p>
</dd>
<dt>GLSModelOptions.<strong>eps_min</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: minimum value for epsilon</p>
<p>Default:</p>
<p>1e-14</p>
</dd>
<dt>GLSModelOptions.<strong>f_wall</strong><span class="classifier">Float</span></dt><dd><p>float: wall function parameter</p>
<p>Default:</p>
<p>1.0</p>
</dd>
<dt>GLSModelOptions.<strong>galperin_clim</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: Galperin length scale limitation parameter</p>
<p>Default:</p>
<p>0.3</p>
</dd>
<dt>GLSModelOptions.<strong>k_min</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: minimum value for turbulent kinetic energy</p>
<p>Default:</p>
<p>1e-06</p>
</dd>
<dt>GLSModelOptions.<strong>kappa</strong><span class="classifier">Float</span></dt><dd><p>float: von Karman constant</p>
<blockquote>
<div><p>If <code class="xref py py-attr docutils literal notranslate"><span class="pre">compute_kappa</span></code> is True this value will be overriden</p>
</div></blockquote>
<p>Default:</p>
<p>0.4</p>
</dd>
<dt>GLSModelOptions.<strong>len_min</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: minimum value for turbulent length scale</p>
<p>Default:</p>
<p>1e-12</p>
</dd>
<dt>GLSModelOptions.<strong>limit_eps</strong><span class="classifier">Bool</span></dt><dd><p>bool: apply Galperin length scale limit on epsilon</p>
<p>Default:</p>
<p>False</p>
</dd>
<dt>GLSModelOptions.<strong>limit_len</strong><span class="classifier">Bool</span></dt><dd><p>bool: apply Galperin length scale limit</p>
<p>Default:</p>
<p>False</p>
</dd>
<dt>GLSModelOptions.<strong>limit_len_min</strong><span class="classifier">Bool</span></dt><dd><p>bool: limit minimum turbulent length scale to len_min</p>
<p>Default:</p>
<p>True</p>
</dd>
<dt>GLSModelOptions.<strong>limit_psi</strong><span class="classifier">Bool</span></dt><dd><p>bool: apply Galperin length scale limit on psi</p>
<p>Default:</p>
<p>True</p>
</dd>
<dt>GLSModelOptions.<strong>m</strong><span class="classifier">Float</span></dt><dd><p>float: parameter m for the definition of psi</p>
<p>Default:</p>
<p>1.5</p>
</dd>
<dt>GLSModelOptions.<strong>n</strong><span class="classifier">Float</span></dt><dd><p>float: parameter n for the definition of psi</p>
<p>Default:</p>
<p>-1.0</p>
</dd>
<dt>GLSModelOptions.<strong>p</strong><span class="classifier">Float</span></dt><dd><p>float: parameter p for the definition of psi</p>
<p>Default:</p>
<p>3.0</p>
</dd>
<dt>GLSModelOptions.<strong>psi_min</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: minimum value for psi</p>
<p>Default:</p>
<p>1e-14</p>
</dd>
<dt>GLSModelOptions.<strong>ri_st</strong><span class="classifier">Float</span></dt><dd><p>steady state gradient Richardson number</p>
<p>Default:</p>
<p>0.25</p>
</dd>
<dt>GLSModelOptions.<strong>schmidt_nb_psi</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: psi Schmidt number</p>
<p>Default:</p>
<p>1.3</p>
</dd>
<dt>GLSModelOptions.<strong>schmidt_nb_tke</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: turbulent kinetic energy Schmidt number</p>
<p>Default:</p>
<p>1.0</p>
</dd>
<dt>GLSModelOptions.<strong>stability_function_name</strong><span class="classifier">‘Canuto A’|’Canuto B’|’Kantha-Clayson’|’Cheng’</span></dt><dd><p>Name of stability function family</p>
<p>Default:</p>
<p>‘Canuto A’</p>
</dd>
<dt>GLSModelOptions.<strong>visc_min</strong><span class="classifier">PositiveFloat</span></dt><dd><p>float: minimum value for eddy viscosity</p>
<p>Default:</p>
<p>1e-08</p>
</dd>
</dl>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016-2023, Tuomas Kärnä et al..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>