-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathchoosing_a_model.html
195 lines (174 loc) · 11.3 KB
/
choosing_a_model.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>How to choose which model to use — OpenDrift documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="How to write a new module" href="writing_a_new_model.html" />
<link rel="prev" title="Data model" href="theory/data_model.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
OpenDrift
<img src="_static/opendrift_logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction to OpenDrift</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="history_link.html">History</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance in OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html">Theory</a></li>
<li class="toctree-l1"><a class="reference internal" href="theory/index.html#drift-in-the-ocean">Drift in the Ocean</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How to choose which model to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_a_new_model.html">How to write a new module</a></li>
<li class="toctree-l1"><a class="reference internal" href="gallery/index.html">Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="oil_types.html">Oil types</a></li>
<li class="toctree-l1"><a class="reference internal" href="interaction_with_coastline.html">Interaction with coastline</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using OpenDrift in a container</a></li>
<li class="toctree-l1"><a class="reference internal" href="gui.html">Graphical User Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services using OpenDrift</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">OpenDrift</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">How to choose which model to use</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/choosing_a_model.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="how-to-choose-which-model-to-use">
<h1>How to choose which model to use<a class="headerlink" href="#how-to-choose-which-model-to-use" title="Link to this heading"></a></h1>
<p>OpenDrift contains a few specific models for several applications such as oil drift, search and rescue and fish eggs.</p>
<p>The table below shows an overview of the advection processes within the main models:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 20.0%" />
<col style="width: 10.0%" />
<col style="width: 30.0%" />
<col style="width: 20.0%" />
<col style="width: 20.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Model</p></th>
<th class="head"><p>Move with currents</p></th>
<th class="head"><p>Direct wind drift</p></th>
<th class="head"><p>Stokes drift</p></th>
<th class="head"><p>Vertical motion</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="autoapi/opendrift/models/oceandrift/index.html#module-opendrift.models.oceandrift" title="opendrift.models.oceandrift"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OceanDrift</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes (optional wind_drift_factor)</p></td>
<td><p>yes</p></td>
<td><p>advection, turbulence</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autoapi/opendrift/models/openoil/index.html#module-opendrift.models.openoil" title="opendrift.models.openoil"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OpenOil</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes (optional wind_drift_factor)</p></td>
<td><p>yes</p></td>
<td><p>wave entrainment, turbulence, buoyancy, advection</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autoapi/opendrift/models/leeway/index.html#module-opendrift.models.leeway" title="opendrift.models.leeway"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Leeway</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes, at an angle. category-based empirical empirical wind_drift_factor</p></td>
<td><p>implicit in wind</p></td>
<td><p>no</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autoapi/opendrift/models/pelagicegg/index.html#module-opendrift.models.pelagicegg" title="opendrift.models.pelagicegg"><code class="xref py py-mod docutils literal notranslate"><span class="pre">PelagicEgg</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>no</p></td>
<td><p>yes</p></td>
<td><p>turbulence, buoyancy, advection</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autoapi/opendrift/models/plastdrift/index.html#module-opendrift.models.plastdrift" title="opendrift.models.plastdrift"><code class="xref py py-mod docutils literal notranslate"><span class="pre">PlastDrift</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>no</p></td>
<td><p>yes</p></td>
<td><p>empirical-statistical depth, exponential decrease with depth, depending on turbulence/wind</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autoapi/opendrift/models/openberg_old/index.html#module-opendrift.models.openberg_old" title="opendrift.models.openberg_old"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OpenBergOld</span></code></a></p></td>
<td><p>yes</p></td>
<td><p>yes</p></td>
<td><p>implicit in wind</p></td>
<td><p>no</p></td>
</tr>
</tbody>
</table>
<p>Direct wind drift is only applied to elements/particles at the very surface. Elements may be seeded with a user defined property <code class="docutils literal notranslate"><span class="pre">wind_drift_factor</span></code> (default is typically 0.02, i.e. 2%) which determines the fraction of wind speed at which elements will be advected.</p>
<p>Surface Stokes Drift must be obtained from a wave model, whereas the depth dependency is parameterised according to <a class="reference external" href="https://journals.ametsoc.org/doi/abs/10.1175/JPO-D-14-0020.1">Breivik et al. (2014)</a>.</p>
<p>Vertical entrainment, mixing and refloating is largely following <a class="reference external" href="https://doi.org/10.5194/os-14-1581-2018">Röhrs et al. (2018)</a></p>
<p>All models are subclasses of <a class="reference internal" href="autoapi/opendrift/models/basemodel/index.html#module-opendrift.models.basemodel" title="opendrift.models.basemodel"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OpenDrift</span></code></a>, or <a class="reference internal" href="autoapi/opendrift/models/oceandrift/index.html#module-opendrift.models.oceandrift" title="opendrift.models.oceandrift"><code class="xref py py-mod docutils literal notranslate"><span class="pre">OceanDrift</span></code></a> and inherits all core functionality from there. The OpenDrift class itself has no specification of advection or other processes, and can thus not be used directly.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="theory/data_model.html" class="btn btn-neutral float-left" title="Data model" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="writing_a_new_model.html" class="btn btn-neutral float-right" title="How to write a new module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, Knut-Frode Dagestad ([email protected]) and Gaute Hope ([email protected])..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>