This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
ProbeOptions.py
267 lines (239 loc) · 14.2 KB
/
ProbeOptions.py
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
257
258
259
260
261
262
263
264
265
266
267
from abaqusConstants import *
class ProbeOptions:
"""The ProbeOptions object is used to store settings associated with probing a model or an
*X–Y* plot. The ProbeOptions object has no constructor. Abaqus creates the
*defaultProbeOptions* and the *probeOptions* members when you import the Visualization
module. When probing is initiated for the first time, the values in the *probeOptions*
member are initialized using the values from the *defaultProbeOptions* member.
Attributes
----------
probeEntity: SymbolicConstant
A SymbolicConstant specifying the entity being probed when **probeObject**="ODB". Possible
values are NODE and ELEMENT. The default value is ELEMENT.
probeOutputPosition: SymbolicConstant
A SymbolicConstant specifying the output position to probe for field output results when
**probeObject**="ODB". Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE,
ELEMENT_NODAL, and ELEMENT_CENTROID.When **probeEntity=NODE**, the only possible value is
NODAL. When **probeEntity=ELEMENT**, the only possible values are INTEGRATION_POINT,
ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID, and the default is INTEGRATION_POINT.
partInstance: Boolean
A Boolean specifying whether to display the part instance information. This member is
valid when **probeObject=ODB**. The default value is ON.
elementID: Boolean
A Boolean specifying whether to display the element ID information. This member is valid
when **probeObject=ODB** and **probeEntity=ELEMENT**. The default value is ON.
elementType: Boolean
A Boolean specifying whether to display the element type information. This member is
valid when **probeObject=ODB** and **probeEntity=ELEMENT**. The default value is ON.
elementConnectivity: Boolean
A Boolean specifying whether to display the element connectivity. This member is valid
when **probeObject=ODB** and **probeEntity=ELEMENT**. The default value is ON.
elementFieldResults: Boolean
A Boolean specifying whether to display the element field output results. This member is
valid when **probeObject=ODB**, **probeEntity=ELEMENT**, and **isFieldOutputAvailable=ON**.
The default value is ON.
nodeId: Boolean
A Boolean specifying whether to display the node ID when **probeObject=ODB** and
**probeEntity=NODE**. The default value is ON.
baseCoordinates: Boolean
A Boolean specifying whether to display the base coordinates of a node when
**probeObject=ODB** and **probeEntity=NODE**. The default value is ON.
deformedCoordinates: Boolean
A Boolean specifying whether to display the deformed coordinates of a node when
**probeObject=ODB** and **probeEntity=NODE**. The default value is ON.
attachedElements: Boolean
A Boolean specifying whether to display the elements attached to a node when
**probeObject=ODB** and **probeEntity=NODE**. The default value is ON.
nodeFieldResults: Boolean
A Boolean specifying whether to display the node field output results. This member is
valid when **probeObject=ODB**, **probeEntity=NODE**, and **isFieldOutputAvailable=ON**. The
default value is ON.
legend: Boolean
A Boolean specifying whether to display the legend for a curve being probed. This member
is valid when **probeObject=XYPlot**. The default value is ON.
xValue: Boolean
A Boolean specifying whether to display the **x**-coordinate value of the point on the
curve being probed. This member is valid when **probeObject=XYPlot**. The default value is
ON.
yValue: Boolean
A Boolean specifying whether to display the **y**-coordinate value of the point on the
curve being probed. This member is valid when **probeObject=XYPlot**. The default value is
ON.
sequenceID: Boolean
A Boolean specifying whether to display the sequence ID of the point on the curve being
probed. This member is valid when **probeObject=XYPlot**. The default value is ON.
interpolateXy: Boolean
A Boolean specifying whether to interpolate values within a line segment when
**probeObject=XYPlot**. When **interpolateXy=OFF**, probing returns the nearest *X–Y* data
point on the curve. When **interpolateXy=ON**, probing interpolates data to return a value
at the nearest point on the curve. The default value is OFF.
isFieldOutputAvailable: Boolean
A Boolean specifying whether field output is available for probing when
**probeObject=XYPlot**. This member is read-only.
probeObject: str
A String specifying the type of the :py:class:`~.displayed` object being probed. Possible values are
"ODB" and "XYPlot". This member is read-only.
Notes
-----
This object can be accessed by:
.. code-block:: python
import visualization
session.defaultProbeOptions
session.probeOptions
"""
# A SymbolicConstant specifying the entity being probed when *probeObject*="ODB". Possible
# values are NODE and ELEMENT. The default value is ELEMENT.
probeEntity: SymbolicConstant = ELEMENT
# A SymbolicConstant specifying the output position to probe for field output results when
# *probeObject*="ODB". Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE,
# ELEMENT_NODAL, and ELEMENT_CENTROID.When *probeEntity*=NODE, the only possible value is
# NODAL. When *probeEntity*=ELEMENT, the only possible values are INTEGRATION_POINT,
# ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID, and the default is INTEGRATION_POINT.
probeOutputPosition: SymbolicConstant = None
# A Boolean specifying whether to display the part instance information. This member is
# valid when *probeObject*=ODB. The default value is ON.
partInstance: Boolean = ON
# A Boolean specifying whether to display the element ID information. This member is valid
# when *probeObject*=ODB and *probeEntity*=ELEMENT. The default value is ON.
elementID: Boolean = ON
# A Boolean specifying whether to display the element type information. This member is
# valid when *probeObject*=ODB and *probeEntity*=ELEMENT. The default value is ON.
elementType: Boolean = ON
# A Boolean specifying whether to display the element connectivity. This member is valid
# when *probeObject*=ODB and *probeEntity*=ELEMENT. The default value is ON.
elementConnectivity: Boolean = ON
# A Boolean specifying whether to display the element field output results. This member is
# valid when *probeObject*=ODB, *probeEntity*=ELEMENT, and *isFieldOutputAvailable*=ON.
# The default value is ON.
elementFieldResults: Boolean = ON
# A Boolean specifying whether to display the node ID when *probeObject*=ODB and
# *probeEntity*=NODE. The default value is ON.
nodeId: Boolean = ON
# A Boolean specifying whether to display the base coordinates of a node when
# *probeObject*=ODB and *probeEntity*=NODE. The default value is ON.
baseCoordinates: Boolean = ON
# A Boolean specifying whether to display the deformed coordinates of a node when
# *probeObject*=ODB and *probeEntity*=NODE. The default value is ON.
deformedCoordinates: Boolean = ON
# A Boolean specifying whether to display the elements attached to a node when
# *probeObject*=ODB and *probeEntity*=NODE. The default value is ON.
attachedElements: Boolean = ON
# A Boolean specifying whether to display the node field output results. This member is
# valid when *probeObject*=ODB, *probeEntity*=NODE, and *isFieldOutputAvailable*=ON. The
# default value is ON.
nodeFieldResults: Boolean = ON
# A Boolean specifying whether to display the legend for a curve being probed. This member
# is valid when *probeObject*=XYPlot. The default value is ON.
legend: Boolean = ON
# A Boolean specifying whether to display the *x*-coordinate value of the point on the
# curve being probed. This member is valid when *probeObject*=XYPlot. The default value is
# ON.
xValue: Boolean = ON
# A Boolean specifying whether to display the *y*-coordinate value of the point on the
# curve being probed. This member is valid when *probeObject*=XYPlot. The default value is
# ON.
yValue: Boolean = ON
# A Boolean specifying whether to display the sequence ID of the point on the curve being
# probed. This member is valid when *probeObject*=XYPlot. The default value is ON.
sequenceID: Boolean = ON
# A Boolean specifying whether to interpolate values within a line segment when
# *probeObject*=XYPlot. When *interpolateXy*=OFF, probing returns the nearest *X–Y* data
# point on the curve. When *interpolateXy*=ON, probing interpolates data to return a value
# at the nearest point on the curve. The default value is OFF.
interpolateXy: Boolean = OFF
# A Boolean specifying whether field output is available for probing when
# *probeObject*=XYPlot. This member is read-only.
isFieldOutputAvailable: Boolean = OFF
# A String specifying the type of the displayed object being probed. Possible values are
# "ODB" and "XYPlot". This member is read-only.
probeObject: str = ""
def setValues(
self,
options: "ProbeOptions" = None,
probeEntity: SymbolicConstant = ELEMENT,
probeOutputPosition: SymbolicConstant = None,
partInstance: Boolean = ON,
elementID: Boolean = ON,
elementType: Boolean = ON,
elementConnectivity: Boolean = ON,
elementFieldResults: Boolean = ON,
nodeId: Boolean = ON,
baseCoordinates: Boolean = ON,
deformedCoordinates: Boolean = ON,
attachedElements: Boolean = ON,
nodeFieldResults: Boolean = ON,
legend: Boolean = ON,
xValue: Boolean = ON,
yValue: Boolean = ON,
sequenceID: Boolean = ON,
interpolateXy: Boolean = OFF,
):
"""This method modifies the settings on the ProbeOptions object.
Parameters
----------
options
A ProbeOptions object from which values are to be copied. If other arguments are also
supplied to setValues, they will override the values in *options*. The default value is
None.
probeEntity
A SymbolicConstant specifying the entity being probed when *probeObject*="ODB". Possible
values are NODE and ELEMENT. The default value is ELEMENT.
probeOutputPosition
A SymbolicConstant specifying the output position to probe for field output results when
*probeObject*="ODB". Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE,
ELEMENT_NODAL, and ELEMENT_CENTROID.When *probeEntity*=NODE, the only possible value is
NODAL. When *probeEntity*=ELEMENT, the only possible values are INTEGRATION_POINT,
ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID, and the default is INTEGRATION_POINT.
partInstance
A Boolean specifying whether to display the part instance information. This member is
valid when *probeObject*=ODB. The default value is ON.
elementID
A Boolean specifying whether to display the element ID information. This member is valid
when *probeObject*=ODB and *probeEntity*=ELEMENT. The default value is ON.
elementType
A Boolean specifying whether to display the element type information. This member is
valid when *probeObject*=ODB and *probeEntity*=ELEMENT. The default value is ON.
elementConnectivity
A Boolean specifying whether to display the element connectivity. This member is valid
when *probeObject*=ODB and *probeEntity*=ELEMENT. The default value is ON.
elementFieldResults
A Boolean specifying whether to display the element field output results. This member is
valid when *probeObject*=ODB, *probeEntity*=ELEMENT, and *isFieldOutputAvailable*=ON.
The default value is ON.
nodeId
A Boolean specifying whether to display the node ID when *probeObject*=ODB and
*probeEntity*=NODE. The default value is ON.
baseCoordinates
A Boolean specifying whether to display the base coordinates of a node when
*probeObject*=ODB and *probeEntity*=NODE. The default value is ON.
deformedCoordinates
A Boolean specifying whether to display the deformed coordinates of a node when
*probeObject*=ODB and *probeEntity*=NODE. The default value is ON.
attachedElements
A Boolean specifying whether to display the elements attached to a node when
*probeObject*=ODB and *probeEntity*=NODE. The default value is ON.
nodeFieldResults
A Boolean specifying whether to display the node field output results. This member is
valid when *probeObject*=ODB, *probeEntity*=NODE, and *isFieldOutputAvailable*=ON. The
default value is ON.
legend
A Boolean specifying whether to display the legend for a curve being probed. This member
is valid when *probeObject*=XYPlot. The default value is ON.
xValue
A Boolean specifying whether to display the *x*-coordinate value of the point on the
curve being probed. This member is valid when *probeObject*=XYPlot. The default value is
ON.
yValue
A Boolean specifying whether to display the *y*-coordinate value of the point on the
curve being probed. This member is valid when *probeObject*=XYPlot. The default value is
ON.
sequenceID
A Boolean specifying whether to display the sequence ID of the point on the curve being
probed. This member is valid when *probeObject*=XYPlot. The default value is ON.
interpolateXy
A Boolean specifying whether to interpolate values within a line segment when
*probeObject*=XYPlot. When *interpolateXy*=OFF, probing returns the nearest *X–Y* data
point on the curve. When *interpolateXy*=ON, probing interpolates data to return a value
at the nearest point on the curve. The default value is OFF.
"""
pass