File: tetgen.sgml

package info (click to toggle)
tetgen 1.5.0-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, forky, sid, trixie
  • size: 1,576 kB
  • sloc: cpp: 28,540; sh: 107; makefile: 37
file content (256 lines) | stat: -rw-r--r-- 9,003 bytes parent folder | download | duplicates (5)
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
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

    Preview with:

    docbook-to-man tetgen.sgml | groff -mandoc -Tlatin1 |less

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Ondrej</firstname>">
  <!ENTITY dhsurname   "<surname>Certik</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>June  1, 2007</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>&lt;ondrej@certik.cz&gt</email>">
  <!ENTITY dhusername  "Ondrej Certik">
  <!ENTITY dhucpackage "<refentrytitle>TETGEN</refentrytitle>">
  <!ENTITY dhpackage   "tetgen">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>A Quality Tetrahedral Mesh Generator</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-pq__a__AriYMS__T__dzjo_fengGOJBNEFICQVvh</option></arg>

      <arg choice="req">file</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command. Full documentation is available
      online: http://tetgen.berlios.de/</para>

    <para><command>&dhpackage;</command>
 generates the Delaunay tetrahedralization, Voronoi diagram, and convex
 hull for three-dimensional point sets, generates the constrained Delaunay
 tetrahedralizations and quality tetrahedral meshes for three-dimensional
 domains with piecewise linear boundary.
    </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>A summary of
      options is included below.  For a complete description, see the
      online documentation.
    </para>

<variablelist>
<varlistentry><term><option>-p</option> </term> <listitem>
  <para>Tetrahedralizes a picecwise linear complex (.poly or .smesh file).</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-q</option> </term> <listitem>
  <para>Quality mesh generation. A minimum radius-edge ratio may be specifyed
  (default 2.0).</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-a</option> </term> <listitem>
  <para>Applies a maximum tetrahedron volume constraint.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-A</option> </term> <listitem>
  <para>Assigns attributes to identify tetrahedra in certain regions.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-r</option> </term> <listitem>
  <para>Reconstructs/Refines a previously generated mesh.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-Y</option> </term> <listitem>
  <para>Suppresses boundary facets/segments splitting.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-i</option> </term> <listitem>
  <para>Inserts a list of additional points into mesh.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-M</option> </term> <listitem>
  <para>Does not merge coplanar facets.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-T</option> </term> <listitem>
  <para>Set a tolerance for coplanar test (default 1e-8).</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-d</option> </term> <listitem>
  <para>Detect intersections of PLC facets.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-z</option> </term> <listitem>
  <para>Numbers all output items starting from zero.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-j</option> </term> <listitem>
  <para>Jettison unused vertices from output .node file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-o2</option> </term> <listitem>
  <para>Generates second-order subparametric elements.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-f</option> </term> <listitem>
  <para>Outputs faces (including non-boundary faces) to .face file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-e</option> </term> <listitem>
  <para>Outputs subsegments to .edge file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-n</option> </term> <listitem>
  <para>Outputs tetrahedra neighbors to .neigh file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-g</option> </term> <listitem>
  <para>Outputs mesh to .mesh file for viewing by Medit.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-G</option> </term> <listitem>
  <para>Outputs mesh to .msh file for viewing by Gid.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-O</option> </term> <listitem>
  <para>Outputs mesh to .off file for viewing by Geomview.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-B</option> </term> <listitem>
  <para>Suppresses output of boundary information.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-N</option> </term> <listitem>
  <para>Suppresses output of .node file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-E</option> </term> <listitem>
  <para>Suppresses output of .ele file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-F</option> </term> <listitem>
  <para>Suppresses output of .face file.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-I</option> </term> <listitem>
  <para>Suppresses mesh iteration numbers.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-C</option> </term> <listitem>
  <para>Checks the consistency of the final mesh.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-Q</option> </term> <listitem>
  <para>Quiet: No terminal output except errors.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-V</option> </term> <listitem>
  <para>Verbose: Detailed information on what I'm doing.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-v</option> </term> <listitem>
  <para>Prints the version information.</para> </listitem> 
</varlistentry>
<varlistentry><term><option>-h</option> </term> <listitem>
  <para>Help: A brief instruction for using TetGen.</para> </listitem> 
</varlistentry>
</variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>

    <para>
   The wing is described in two files: wing.node and wing.poly.
   The command line:

   tetgen -pq wing

   generates the quality mesh in three files:
   wing.1.node, wing.1.ele, and wing.1.face.
    </para>
    <para>
    Default, the radius-edge ratio of each tetrahedron is bounded below 2.0.
    You can impose a tight bound by adding a number directly after the '-q'
    switch. Like this:

    tetgen -pq1.2 wing

    generates a quality mesh which have more points
    inserted than the mesh created in above.
    </para>
    <para>
    See http://tetgen.berlios.de/switches.examples.html for more examples.
    </para>

  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>netgen (1)</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->