-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathfield_documentation.html
More file actions
365 lines (352 loc) · 11.5 KB
/
field_documentation.html
File metadata and controls
365 lines (352 loc) · 11.5 KB
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
<!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>Physical fields — Thetis 2025.10.1+1.gf513865b documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/thetis.css?v=0f3339d6" />
<script src="_static/documentation_options.js?v=b0987aea"></script>
<script src="_static/doctools.js?v=9bcbadda"></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="field_documentation">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="physical-fields">
<h1>Physical fields<a class="headerlink" href="#physical-fields" title="Link to this heading">¶</a></h1>
<p>This page lists all supported physical fields.
Every field is identified with an unique key, e.g. <code class="docutils literal notranslate"><span class="pre">temp_3d</span></code>.
The field metadata is defined in <a class="reference internal" href="thetis.html#module-thetis.field_defs" title="thetis.field_defs"><code class="xref py py-mod docutils literal notranslate"><span class="pre">field_defs</span></code></a> module.</p>
<p>Fields are stored in solver’s <a class="reference internal" href="thetis.html#thetis.solver.FlowSolver.fields" title="thetis.solver.FlowSolver.fields"><code class="xref py py-attr docutils literal notranslate"><span class="pre">fields</span></code></a> dictionary:
one can access a field <a class="reference external" href="https://www.firedrakeproject.org/firedrake.html#firedrake.function.Function" title="(in Firedrake v2025.10.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Function</span></code></a> using:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># dictionary access</span>
<span class="n">solver_obj</span><span class="o">.</span><span class="n">fields</span><span class="p">[</span><span class="s1">'temp_3d'</span><span class="p">]</span>
<span class="c1"># or attribute access</span>
<span class="n">solver_obj</span><span class="o">.</span><span class="n">fields</span><span class="o">.</span><span class="n">temp_3d</span>
</pre></div>
</div>
<section id="list-of-fields">
<h2>List of fields<a class="headerlink" href="#list-of-fields" title="Link to this heading">¶</a></h2>
<ul>
<li><p><strong>baroc_head_3d</strong>: Baroclinic head [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: BaroHead3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>bathymetry_2d</strong>: Bathymetry [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: bathymetry2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>buoy_freq_3d</strong>: Buoyancy frequency squared [s-2]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: BuoyFreq3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>coriolis_2d</strong>: Coriolis parameter [s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: coriolis_2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>coriolis_3d</strong>: Coriolis parameter [s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: coriolis_3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>density_3d</strong>: Water density [kg m-3]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Density3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>eddy_diff_3d</strong>: Eddy diffusivity [m2 s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: EddyDiff3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>eddy_visc_3d</strong>: Eddy Viscosity [m2 s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: EddyVisc3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>elev_2d</strong>: Water elevation [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Elevation2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>elev_cg_2d</strong>: Water elevation CG [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: ElevationCG2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>elev_domain_2d</strong>: Surface elevation of domain [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: ElevationDomain2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>eps_3d</strong>: TKE dissipation rate [m2 s-3]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: TurbEps3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>h_elem_size_2d</strong>: Element size in horizontal direction [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: h_elem_size_2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>h_elem_size_3d</strong>: Element size in horizontal direction [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: h_elem_size_3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>hcc_metric_3d</strong>: HCC mesh quality [-]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: HCCMetric3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>int_pg_3d</strong>: Internal pressure gradient [m s-2]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: IntPG3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>len_3d</strong>: Turbulent length scale [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: TurbLen3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>max_h_diff</strong>: Maximum stable horizontal diffusivity [m2 s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: MaxHDiffusivity3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>psi_3d</strong>: Turbulence psi variable [-]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: TurbPsi3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>q_2d</strong>: Non-hydrostatic pressure at bottom [Pa]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: NHPressure2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>salt_3d</strong>: Water salinity [psu]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Salinity3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>sediment_2d</strong>: Sediment [-]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Sediment2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>shear_freq_3d</strong>: Vertical shear frequency squared [s-2]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: ShearFreq3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>smag_visc_3d</strong>: Smagorinsky viscosity [m2 s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: SmagViscosity3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>split_residual_2d</strong>: Momentum eq. residual for mode splitting [m s-2]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: SplitResidual2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>temp_3d</strong>: Water temperature [C]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Temperature3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>tke_3d</strong>: Turbulent Kinetic Energy [m2 s-2]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: TurbKEnergy3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>turbine_density_2d</strong>: Turbine density [m-2]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: turbine_density_2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>uv_2d</strong>: Depth averaged velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Velocity2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>uv_3d</strong>: Horizontal velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: Velocity3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>uv_dav_2d</strong>: Depth averaged velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: DAVelocity2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>uv_dav_3d</strong>: Depth averaged velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: DAVelocity3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>v_elem_size_2d</strong>: Element size in vertical direction [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: VElemSize2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>v_elem_size_3d</strong>: Element size in vertical direction [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: VElemSize3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>w_2d</strong>: Depth averaged vertical velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: VertVelo2d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>w_3d</strong>: Vertical velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: VertVelo3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>w_mesh_3d</strong>: Mesh velocity [m s-1]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: MeshVelo3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>wind_stress_3d</strong>: Wind stress [Pa]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: wind_stress_3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>z_coord_3d</strong>: Mesh z coordinates [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: ZCoord3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
<li><p><strong>z_coord_ref_3d</strong>: Static mesh z coordinates [m]</p>
<blockquote>
<div><ul class="simple">
<li><p>output file: ZCoordRef3d.pvd</p></li>
</ul>
</div></blockquote>
</li>
</ul>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016-2025, Tuomas Kärnä et al..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>