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
|
<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkOpenFOAMReader</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkio_vtkopenfoamreader.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkOpenFOAMReader </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkio.html">Visualization Toolkit IO Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkOpenFOAMReader creates a multiblock dataset. It reads mesh information and time dependent data. The polyMesh folders contain mesh information. The time folders contain transient data for the cells. Each folder can contain any number of data files.</p>
<p>To create an instance of class vtkOpenFOAMReader, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkOpenFOAMReader
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkOpenFOAMReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkOpenFOAMReader class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkOpenFOAMReader = obj.NewInstance ()</code> </li>
<li>
<code>vtkOpenFOAMReader = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.CanReadFile (string )</code> - Determine if the file can be readed with this reader. </li>
<li>
<code>obj.SetFileName (string )</code> - Set/Get the filename. </li>
<li>
<code>string = obj.GetFileName ()</code> - Set/Get the filename. </li>
<li>
<code>int = obj.GetNumberOfCellArrays (void )</code> - Get/Set whether the cell array with the given name is to be read. </li>
<li>
<code>int = obj.GetCellArrayStatus (string name)</code> - Get/Set whether the cell array with the given name is to be read. </li>
<li>
<code>obj.SetCellArrayStatus (string name, int status)</code> - Get the name of the cell array with the given index in the input. </li>
<li>
<code>string = obj.GetCellArrayName (int index)</code> - Turn on/off all cell arrays. </li>
<li>
<code>obj.DisableAllCellArrays ()</code> - Turn on/off all cell arrays. </li>
<li>
<code>obj.EnableAllCellArrays ()</code> - Get the number of point arrays available in the input. </li>
<li>
<code>int = obj.GetNumberOfPointArrays (void )</code> - Get/Set whether the point array with the given name is to be read. </li>
<li>
<code>int = obj.GetPointArrayStatus (string name)</code> - Get/Set whether the point array with the given name is to be read. </li>
<li>
<code>obj.SetPointArrayStatus (string name, int status)</code> - Get the name of the point array with the given index in the input. </li>
<li>
<code>string = obj.GetPointArrayName (int index)</code> - Turn on/off all point arrays. </li>
<li>
<code>obj.DisableAllPointArrays ()</code> - Turn on/off all point arrays. </li>
<li>
<code>obj.EnableAllPointArrays ()</code> - Get the number of Lagrangian arrays available in the input. </li>
<li>
<code>int = obj.GetNumberOfLagrangianArrays (void )</code> - Get/Set whether the Lagrangian array with the given name is to be read. </li>
<li>
<code>int = obj.GetLagrangianArrayStatus (string name)</code> - Get/Set whether the Lagrangian array with the given name is to be read. </li>
<li>
<code>obj.SetLagrangianArrayStatus (string name, int status)</code> - Get the name of the Lagrangian array with the given index in the input. </li>
<li>
<code>string = obj.GetLagrangianArrayName (int index)</code> - Turn on/off all Lagrangian arrays. </li>
<li>
<code>obj.DisableAllLagrangianArrays ()</code> - Turn on/off all Lagrangian arrays. </li>
<li>
<code>obj.EnableAllLagrangianArrays ()</code> - Get the number of Patches (inlcuding Internal Mesh) available in the input. </li>
<li>
<code>int = obj.GetNumberOfPatchArrays (void )</code> - Get/Set whether the Patch with the given name is to be read. </li>
<li>
<code>int = obj.GetPatchArrayStatus (string name)</code> - Get/Set whether the Patch with the given name is to be read. </li>
<li>
<code>obj.SetPatchArrayStatus (string name, int status)</code> - Get the name of the Patch with the given index in the input. </li>
<li>
<code>string = obj.GetPatchArrayName (int index)</code> - Turn on/off all Patches including the Internal Mesh. </li>
<li>
<code>obj.DisableAllPatchArrays ()</code> - Turn on/off all Patches including the Internal Mesh. </li>
<li>
<code>obj.EnableAllPatchArrays ()</code> - Set/Get whether to create cell-to-point translated data for cell-type data </li>
<li>
<code>obj.SetCreateCellToPoint (int )</code> - Set/Get whether to create cell-to-point translated data for cell-type data </li>
<li>
<code>int = obj.GetCreateCellToPoint ()</code> - Set/Get whether to create cell-to-point translated data for cell-type data </li>
<li>
<code>obj.CreateCellToPointOn ()</code> - Set/Get whether to create cell-to-point translated data for cell-type data </li>
<li>
<code>obj.CreateCellToPointOff ()</code> - Set/Get whether to create cell-to-point translated data for cell-type data </li>
<li>
<code>obj.SetCacheMesh (int )</code> - Set/Get whether mesh is to be cached. </li>
<li>
<code>int = obj.GetCacheMesh ()</code> - Set/Get whether mesh is to be cached. </li>
<li>
<code>obj.CacheMeshOn ()</code> - Set/Get whether mesh is to be cached. </li>
<li>
<code>obj.CacheMeshOff ()</code> - Set/Get whether mesh is to be cached. </li>
<li>
<code>obj.SetDecomposePolyhedra (int )</code> - Set/Get whether polyhedra are to be decomposed. </li>
<li>
<code>int = obj.GetDecomposePolyhedra ()</code> - Set/Get whether polyhedra are to be decomposed. </li>
<li>
<code>obj.DecomposePolyhedraOn ()</code> - Set/Get whether polyhedra are to be decomposed. </li>
<li>
<code>obj.DecomposePolyhedraOff ()</code> - Set/Get whether polyhedra are to be decomposed. </li>
<li>
<code>obj.SetPositionsIsIn13Format (int )</code> - Set/Get whether the lagrangian/positions is in OF 1.3 format </li>
<li>
<code>int = obj.GetPositionsIsIn13Format ()</code> - Set/Get whether the lagrangian/positions is in OF 1.3 format </li>
<li>
<code>obj.PositionsIsIn13FormatOn ()</code> - Set/Get whether the lagrangian/positions is in OF 1.3 format </li>
<li>
<code>obj.PositionsIsIn13FormatOff ()</code> - Set/Get whether the lagrangian/positions is in OF 1.3 format </li>
<li>
<code>obj.SetListTimeStepsByControlDict (int )</code> - Determine if time directories are to be listed according to controlDict </li>
<li>
<code>int = obj.GetListTimeStepsByControlDict ()</code> - Determine if time directories are to be listed according to controlDict </li>
<li>
<code>obj.ListTimeStepsByControlDictOn ()</code> - Determine if time directories are to be listed according to controlDict </li>
<li>
<code>obj.ListTimeStepsByControlDictOff ()</code> - Determine if time directories are to be listed according to controlDict </li>
<li>
<code>obj.SetAddDimensionsToArrayNames (int )</code> - Add dimensions to array names </li>
<li>
<code>int = obj.GetAddDimensionsToArrayNames ()</code> - Add dimensions to array names </li>
<li>
<code>obj.AddDimensionsToArrayNamesOn ()</code> - Add dimensions to array names </li>
<li>
<code>obj.AddDimensionsToArrayNamesOff ()</code> - Add dimensions to array names </li>
<li>
<code>obj.SetReadZones (int )</code> - Set/Get whether zones will be read. </li>
<li>
<code>int = obj.GetReadZones ()</code> - Set/Get whether zones will be read. </li>
<li>
<code>obj.ReadZonesOn ()</code> - Set/Get whether zones will be read. </li>
<li>
<code>obj.ReadZonesOff ()</code> - Set/Get whether zones will be read. </li>
<li>
<code>obj.SetRefresh ()</code> </li>
<li>
<code>obj.SetParent (vtkOpenFOAMReader parent)</code> </li>
<li>
<code>bool = obj.SetTimeValue (double )</code> </li>
<li>
<code>vtkDoubleArray = obj.GetTimeValues ()</code> </li>
<li>
<code>int = obj.MakeMetaDataAtTimeStep (bool )</code> </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkio.html">Visualization Toolkit IO Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:34 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
