PV3FoamReader_SM.xml 8.06 KB
Newer Older
1
<ServerManagerConfiguration>
Mark Olesen's avatar
Mark Olesen committed
2
3
4
5
6
7
8
9
10
11
12
13
14
  <ProxyGroup name="sources">
  <SourceProxy
    name="PV3FoamReader"
    class="vtkPV3FoamReader">

    <!-- File name - compulsory -->
    <StringVectorProperty
      name="FileName"
      command="SetFileName"
      number_of_elements="1"
      animateable="0">
      <FileListDomain name="files"/>
      <Documentation>
15
        Specifies the filename for the OpenFOAM Reader.
Mark Olesen's avatar
Mark Olesen committed
16
17
18
      </Documentation>
    </StringVectorProperty>

19
20
21
22
23
24
25
26
27
28
29
    <!-- Send discrete time info to the animation panel -->
    <DoubleVectorProperty
      name="TimestepValues"
      repeatable="1"
      information_only="1">
      <TimeStepsInformationHelper/>
      <Documentation>
        Available timestep values.
      </Documentation>
    </DoubleVectorProperty>

30
31
32
33
34
35
36
37
38
39
40
41
42
43
    <!-- Cache Mesh check-box -->
    <IntVectorProperty
      name="UiCacheMesh"
      command="SetCacheMesh"
      number_of_elements="1"
      is_internal="1"
      default_values="1"
      animateable="0">
      <BooleanDomain name="bool"/>
      <Documentation>
        Cache the fvMesh in memory.
      </Documentation>
    </IntVectorProperty>

44
45
46
47
48
49
50
51
52
    <!-- Refresh button -->
    <IntVectorProperty
      name="UiRefresh"
      command="SetRefresh"
      number_of_elements="1"
      is_internal="0"
      default_values="0"
      animateable="0">
      <BooleanDomain name="bool"/>
Mark Olesen's avatar
Mark Olesen committed
53
      <Documentation>
54
        Rescan for updated timesteps/fields.
Mark Olesen's avatar
Mark Olesen committed
55
      </Documentation>
56
    </IntVectorProperty>
57

58
59
60
61
62
63
64
65
66
67
68
69
70
    <!-- Skip Zero Time check-box -->
    <IntVectorProperty
      name="UiZeroTime"
      command="SetSkipZeroTime"
      number_of_elements="1"
      is_internal="1"
      default_values="0"
      animateable="0">
      <BooleanDomain name="bool"/>
      <Documentation>
        Skip including the 0/ time directory
      </Documentation>
    </IntVectorProperty>
71

72
    <!-- Extrapolate Patches check-box -->
73
    <IntVectorProperty
74
75
      name="ExtrapolatePatches"
      command="SetExtrapolatePatches"
76
77
78
79
80
      number_of_elements="1"
      default_values="0"
      animateable="0">
      <BooleanDomain name="bool"/>
      <Documentation>
81
        Extrapolate internalField to non-constraint patches
82
83
84
      </Documentation>
    </IntVectorProperty>

85
86
87
88
89
90
91
92
93
    <!-- Use VTK Polyhedron check-box -->
    <IntVectorProperty
      name="UseVTKPolyhedron"
      command="SetUseVTKPolyhedron"
      number_of_elements="1"
      default_values="0"
      animateable="0">
      <BooleanDomain name="bool"/>
      <Documentation>
94
95
        Use vtkPolyhedron instead of decomposing polyhedra.
        !!Actually uses vtkConvexPointSet until this is properly supported in VTK!!
96
97
98
      </Documentation>
    </IntVectorProperty>

99
100
    <!-- Include Sets check-box -->
    <IntVectorProperty
101
      name="UiIncludeSets"
102
103
      command="SetIncludeSets"
      number_of_elements="1"
104
      is_internal="1"
105
106
107
      default_values="0"
      animateable="0">
      <Documentation>
108
        Search the polyMesh/sets/ directory
109
110
111
112
113
114
      </Documentation>
      <BooleanDomain name="bool"/>
    </IntVectorProperty>

    <!-- Include Zones check-box -->
    <IntVectorProperty
115
      name="UiIncludeZones"
116
117
      command="SetIncludeZones"
      number_of_elements="1"
118
      is_internal="1"
119
120
121
122
123
124
125
126
127
128
129
      default_values="0"
      animateable="0">
      <Documentation>
        ZoneMesh information is used to find {cell,face,point}Zones.
        The polyMesh/ directory is only checked on startup.
      </Documentation>
      <BooleanDomain name="bool"/>
    </IntVectorProperty>

    <!-- Show Patch Names check-box -->
    <IntVectorProperty
130
      name="UiShowPatchNames"
131
132
133
      command="SetShowPatchNames"
      number_of_elements="1"
      default_values="0"
134
      is_internal="1"
135
136
137
      animateable="0">
      <BooleanDomain name="bool"/>
      <Documentation>
138
        Show patch names in render window
139
140
141
      </Documentation>
    </IntVectorProperty>

142
    <!-- Force GUI update check box -->
143
144
145
146
147
148
149
150
    <IntVectorProperty
      name="UpdateGUI"
      command="SetUpdateGUI"
      number_of_elements="1"
      default_values="0"
      animateable="0">
      <BooleanDomain name="bool"/>
      <Documentation>
Mark Olesen's avatar
Mark Olesen committed
151
        A simple way to cause a reader GUI modification.
152
153
154
      </Documentation>
    </IntVectorProperty>

155
156
157
    <!--
       | Selections
       -->
158

Mark Olesen's avatar
Mark Olesen committed
159
    <!-- Available Parts (volume, patches, lagrangian) array -->
Mark Olesen's avatar
Mark Olesen committed
160
    <StringVectorProperty
161
      name="PartArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
162
      information_only="1">
Mark Olesen's avatar
Mark Olesen committed
163
      <ArraySelectionInformationHelper attribute_name="Part"/>
Mark Olesen's avatar
Mark Olesen committed
164
165
    </StringVectorProperty>
    <StringVectorProperty
Mark Olesen's avatar
Mark Olesen committed
166
      name="PartStatus"
Mark Olesen's avatar
Mark Olesen committed
167
      label="Mesh Parts"
Mark Olesen's avatar
Mark Olesen committed
168
      command="SetPartArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
169
170
171
172
      number_of_elements="0"
      repeat_command="1"
      number_of_elements_per_command="2"
      element_types="2 0"
173
      information_property="PartArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
174
175
176
      animateable="0">
      <ArraySelectionDomain name="array_list">
        <RequiredProperties>
177
          <Property name="PartArrayStatus" function="ArrayList"/>
Mark Olesen's avatar
Mark Olesen committed
178
179
        </RequiredProperties>
      </ArraySelectionDomain>
180
181
182
      <Documentation>
        This property contains a list of the mesh parts (patches, sets, zones).
      </Documentation>
Mark Olesen's avatar
Mark Olesen committed
183
184
185
186
    </StringVectorProperty>

    <!-- Available volFields array -->
    <StringVectorProperty
187
      name="VolFieldArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
188
189
190
191
192
193
194
195
196
197
198
      information_only="1">
      <ArraySelectionInformationHelper attribute_name="VolField"/>
    </StringVectorProperty>
    <StringVectorProperty
      name="VolFieldStatus"
      label="Volume Fields"
      command="SetVolFieldArrayStatus"
      number_of_elements="0"
      repeat_command="1"
      number_of_elements_per_command="2"
      element_types="2 0"
199
      information_property="VolFieldArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
200
201
202
      animateable="0">
      <ArraySelectionDomain name="array_list">
        <RequiredProperties>
203
          <Property name="VolFieldArrayStatus" function="ArrayList"/>
Mark Olesen's avatar
Mark Olesen committed
204
205
        </RequiredProperties>
      </ArraySelectionDomain>
206
207
208
      <Documentation>
        This property contains a list of the volume fields
      </Documentation>
Mark Olesen's avatar
Mark Olesen committed
209
210
211
212
    </StringVectorProperty>

    <!-- Available Lagrangian fields array -->
    <StringVectorProperty
213
      name="LagrangianFieldArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
214
215
216
217
218
219
220
221
222
223
224
      information_only="1">
      <ArraySelectionInformationHelper attribute_name="LagrangianField"/>
    </StringVectorProperty>
    <StringVectorProperty
      name="LagrangianFieldStatus"
      label="Lagrangian Fields"
      command="SetLagrangianFieldArrayStatus"
      number_of_elements="0"
      repeat_command="1"
      number_of_elements_per_command="2"
      element_types="2 0"
225
      information_property="LagrangianFieldArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
226
227
228
      animateable="0">
      <ArraySelectionDomain name="array_list">
        <RequiredProperties>
229
          <Property name="LagrangianFieldArrayStatus" function="ArrayList"/>
Mark Olesen's avatar
Mark Olesen committed
230
231
        </RequiredProperties>
      </ArraySelectionDomain>
232
233
234
      <Documentation>
        This property contains a list of the lagrangian fields
      </Documentation>
Mark Olesen's avatar
Mark Olesen committed
235
236
237
238
    </StringVectorProperty>

    <!-- Available pointFields array -->
    <StringVectorProperty
239
      name="PointFieldArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
240
241
242
243
244
245
246
247
248
249
250
      information_only="1">
      <ArraySelectionInformationHelper attribute_name="PointField"/>
    </StringVectorProperty>
    <StringVectorProperty
      name="PointFieldStatus"
      label="Point Fields"
      command="SetPointFieldArrayStatus"
      number_of_elements="0"
      repeat_command="1"
      number_of_elements_per_command="2"
      element_types="2 0"
251
      information_property="PointFieldArrayStatus"
Mark Olesen's avatar
Mark Olesen committed
252
253
254
      animateable="0">
      <ArraySelectionDomain name="array_list">
        <RequiredProperties>
255
          <Property name="PointFieldArrayStatus" function="ArrayList"/>
Mark Olesen's avatar
Mark Olesen committed
256
257
        </RequiredProperties>
      </ArraySelectionDomain>
258
259
260
      <Documentation>
        This property contains a list of the point fields
      </Documentation>
Mark Olesen's avatar
Mark Olesen committed
261
    </StringVectorProperty>
262
263
264
265

  <Hints>
    <Property name="FileName" show="0"/>
    <Property name="UiCacheMesh" show="0"/>
266
267
    <Property name="UiZeroTime" show="0"/>
    <Property name="UiRefresh" show="0"/>
268
    <Property name="UiShowPatchNames" show="0"/>
269
270
    <Property name="UiIncludeSets" show="0"/>
    <Property name="UiIncludeZones" show="0"/>
271
272
273
  </Hints>


Mark Olesen's avatar
Mark Olesen committed
274
275
  </SourceProxy>
  </ProxyGroup>
276
</ServerManagerConfiguration>