-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfeatures.html
184 lines (137 loc) · 7.83 KB
/
features.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
<!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>Features — capytaine 2.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=686e5160" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<link rel="stylesheet" type="text/css" href="_static/proof.css?v=e9a64e30" />
<script src="_static/documentation_options.js?v=16656018"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/proof.js?v=41e9dd12"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="User manual" href="user_manual/index.html" />
<link rel="prev" title="Capytaine: a Python-based linear potential flow BEM solver" href="index.html" />
<script defer data-domain="capytaine.github.io" src="https://plausible.io/js/script.js"></script>
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="features">
<h1>Features<a class="headerlink" href="#features" title="Link to this heading">¶</a></h1>
<p>Capytaine is a Python library for the computation of wave loads on floating structures in frequency domain.
It can be used as a standard sea-keeping code for the standalone computation of hydrodynamical coefficients.
Its Python API also allows advanced users to integrate it in more complex workflows and to customize its behavior.</p>
<p>Capytaine is based on</p>
<ul class="simple">
<li><p><a class="reference external" href="https://lheea.ec-nantes.fr/logiciels-et-brevets/nemoh-presentation-192863.kjsp">Nemoh</a>’s Fortran core routines for the computation of the Green function,</p></li>
<li><p><a class="reference external" href="https://github.com/LHEEA/meshmagick">meshmagick</a> for the manipulation of meshes,</p></li>
<li><p><a class="reference external" href="https://docs.xarray.dev">xarray</a> for the storage of hydrodynamical dataset,</p></li>
<li><p>and various other tools from the <a class="reference external" href="https://scipy.org/">Python scientific ecosystem</a>.</p></li>
</ul>
<p>Below some features of the latest version (version 2.2.1) of Capytaine are listed.</p>
<section id="core-features">
<h2>Core features<a class="headerlink" href="#core-features" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Computation of the added masses, radiation dampings, diffraction forces, Froude-Krylov forces and RAO.</p></li>
<li><p>Single rigid body, multiple rigid bodies or bodies with any arbitrary degrees of freedom.</p></li>
<li><p>Finite depth or deep water.</p></li>
<li><p>Faster computation for plane-symmetric bodies.</p></li>
<li><p>Approximate forward speed (for single rigid body only at the moment).</p></li>
<li><p>Set up problems with either angular frequency, period, wavelength or angular wavenumber.</p></li>
<li><p>Lid-based irregular frequencies removal.</p></li>
<li><p>Computation of the pressure field, the velocity field, the free surface elevation and the Kochin function.</p></li>
<li><p>Computation of the hydrostatic stiffness and rigid body inertia. Non-neutrally buoyant bodies are partially supported.</p></li>
<li><p>3D animations of the body motion and the free surface elevation.</p></li>
<li><p>Various input mesh formats supported via <a class="reference external" href="https://github.com/LHEEA/meshmagick">meshmagick</a>.</p></li>
<li><p>OpenMP parallelization.</p></li>
<li><p>Output in NetCDF format (or legacy Nemoh Tecplot format).</p></li>
</ul>
</section>
<section id="advanced-features">
<h2>Advanced features<a class="headerlink" href="#advanced-features" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>A clean code with unit tests, meaningful variable names, comments, (almost) no Fortran 77, no global variables and no error message in French.</p></li>
<li><p>Easy access to the internal of the solver through Python.</p></li>
<li><p>Direct (potential formulation) or indirect (source formulation) boundary integral equation.</p></li>
<li><p>Direct or iterative linear system solver.</p></li>
<li><p>Single or double precision floating-point numbers.</p></li>
<li><p>Several parameters to customize the evaluation of the Green function and its integration on the mesh.</p></li>
<li><p>Possibility to plug-in other implementations of the Green function.</p></li>
</ul>
</section>
<section id="experimental-features">
<h2>Experimental features<a class="headerlink" href="#experimental-features" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Hierarchical matrices with low-rank blocks for faster simulations.</p></li>
<li><p>Toeplitz matrices for faster simulations for floating bodies with local symmetries or for regular arrays of identical floating bodies.</p></li>
</ul>
</section>
<section id="roadmap">
<h2>Roadmap<a class="headerlink" href="#roadmap" title="Link to this heading">¶</a></h2>
<p>See <a class="reference external" href="https://github.com/orgs/capytaine/projects/1">on Github</a>.</p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">capytaine</a></h1>
<p class="blurb">a Python-based linear potential flow BEM solver</p>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Features</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_manual/index.html">User manual</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developer_manual/index.html">Developer manual</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="theory_manual/index.html">Theory manual</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="citing.html">Citing</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Capytaine: a Python-based linear potential flow BEM solver</a></li>
<li>Next: <a href="user_manual/index.html" title="next chapter">User manual</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2024, Matthieu Ancellin.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/features.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>