forked from SINTEF/Splipy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
188 lines (178 loc) · 9.5 KB
/
index.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Splipy — Splipy 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Splipy 1.1.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="splipy">
<h1>Splipy<a class="headerlink" href="#splipy" title="Permalink to this headline">¶</a></h1>
<p>Splipy is a python package for building spline geometries. It has been designed
primarily for analysis use, and therefore allows fine-grained control over many
aspects which is not possible to achieve with conventional CAD tools.</p>
<p>For a quick start, please see the <a class="reference internal" href="tutorial.html"><span class="doc">Tutorial</span></a>.</p>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>The <em>splipy</em> module exports a handful of convenient classes. Please see
<a class="reference internal" href="basic_classes.html"><span class="doc">Basic classes</span></a> for more information.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="basic_classes.html#splipy.BSplineBasis" title="splipy.BSplineBasis"><code class="xref py py-obj docutils literal"><span class="pre">BSplineBasis</span></code></a></td>
<td>Represents a one-dimensional B-Spline basis.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="basic_classes.html#splipy.SplineObject" title="splipy.SplineObject"><code class="xref py py-obj docutils literal"><span class="pre">SplineObject</span></code></a></td>
<td>Master class for spline objects with arbitrary dimensions.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="basic_classes.html#splipy.Curve" title="splipy.Curve"><code class="xref py py-obj docutils literal"><span class="pre">Curve</span></code></a></td>
<td>Represents a curve: an object with a one-dimensional parameter space.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="basic_classes.html#splipy.Surface" title="splipy.Surface"><code class="xref py py-obj docutils literal"><span class="pre">Surface</span></code></a></td>
<td>Represents a surface: an object with a two-dimensional parameter space.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="basic_classes.html#splipy.Volume" title="splipy.Volume"><code class="xref py py-obj docutils literal"><span class="pre">Volume</span></code></a></td>
<td>Represents a volume: an object with a three-dimensional parameter space.</td>
</tr>
</tbody>
</table>
<p>Some convenience utilities for commonly seen objects can be found in the factory
modules. Please see <a class="reference internal" href="factories.html"><span class="doc">Factories</span></a> for more information.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="factories.html#module-splipy.curve_factory" title="splipy.curve_factory"><code class="xref py py-obj docutils literal"><span class="pre">splipy.curve_factory</span></code></a></td>
<td>Handy utilities for creating curves.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="factories.html#module-splipy.surface_factory" title="splipy.surface_factory"><code class="xref py py-obj docutils literal"><span class="pre">splipy.surface_factory</span></code></a></td>
<td>Handy utilities for creating surfaces.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="factories.html#module-splipy.volume_factory" title="splipy.volume_factory"><code class="xref py py-obj docutils literal"><span class="pre">splipy.volume_factory</span></code></a></td>
<td>Handy utilities for creating volumes.</td>
</tr>
</tbody>
</table>
<p>Miscellaneous utilities can be found in the <code class="docutils literal"><span class="pre">splipy.utils</span></code> module.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="utils.html#module-splipy.utils.curve" title="splipy.utils.curve"><code class="xref py py-obj docutils literal"><span class="pre">splipy.utils.curve</span></code></a></td>
<td>Implementation of various curve utilities</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="utils.html#module-splipy.utils.image" title="splipy.utils.image"><code class="xref py py-obj docutils literal"><span class="pre">splipy.utils.image</span></code></a></td>
<td>Implementation of image based mesh generation.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="utils.html#module-splipy.utils.refinement" title="splipy.utils.refinement"><code class="xref py py-obj docutils literal"><span class="pre">splipy.utils.refinement</span></code></a></td>
<td>Implementation of various refinement schemes.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="utils.html#module-splipy.utils.smooth" title="splipy.utils.smooth"><code class="xref py py-obj docutils literal"><span class="pre">splipy.utils.smooth</span></code></a></td>
<td>Implementation of various smoothing operations on a per-controlpoint level.</td>
</tr>
</tbody>
</table>
<p>For input and output, please refer to <a class="reference internal" href="io.html"><span class="doc">Input and output</span></a>.</p>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Splipy</a><ul>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Splipy 1.1.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, Arne Morten Kvarving, Kjetil Andre Johannessen, Eivind Fonn.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
</div>
</body>
</html>