This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
HistoryOutput.py
126 lines (102 loc) · 4.14 KB
/
HistoryOutput.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
import typing
from abaqusConstants import *
class HistoryOutput:
"""The HistoryOutput object contains the history output at a point for the specified
variable.
Attributes
----------
data: float
A tuple of pairs of Floats specifying the pairs (**frameValue**, **value**) where
**frameValue** is either time, frequency, or mode and **value** is the value of the
specified variable at **frameValue**. (This value depends on the type of the variable.)
conjugateData: float
A tuple of pairs of Floats specifying the imaginary portion of a specified complex
variable at each frame value (time, frequency, or mode). The pairs have the form
(**frameValue**, **value**).
Notes
-----
This object can be accessed by:
.. code-block:: python
import odbAccess
session.odbs[name].steps[name].historyRegions[name].historyOutputs[name]
"""
# A tuple of pairs of Floats specifying the pairs (*frameValue*, *value*) where
# *frameValue* is either time, frequency, or mode and *value* is the value of the
# specified variable at *frameValue*. (This value depends on the type of the variable.)
data: float = None
# A tuple of pairs of Floats specifying the imaginary portion of a specified complex
# variable at each frame value (time, frequency, or mode). The pairs have the form
# (*frameValue*, *value*).
conjugateData: float = None
def __init__(
self,
name: str,
description: str,
type: SymbolicConstant,
validInvariants: SymbolicConstant = None,
):
"""This method creates a HistoryOutput object.
Notes
-----
This function can be accessed by:
.. code-block:: python
session.odbs[name].steps[name].historyRegions[name].HistoryOutput
Parameters
----------
name
A String specifying the output variable name.
description
A String specifying the output variable.
type
A SymbolicConstant specifying the output type. Only SCALAR is currently supported.
validInvariants
A sequence of SymbolicConstants specifying which invariants should be calculated for
this field. Possible values are MAGNITUDE, MISES, TRESCA, PRESS, INV3, MAX_PRINCIPAL,
MID_PRINCIPAL, and MIN_PRINCIPAL. The default value is an empty sequence.
Returns
-------
A HistoryOutput object.
"""
pass
@typing.overload
def addData(self, frame: str, value: str):
"""This method adds data to the *data* member of the HistoryOutput object.
Parameters
----------
frame
A Double specifying the frame value. *frame* can be specified in step time, frequency,
or mode number.
value
A Double specifying the value of the variable at the frame value specified in *frame*.
"""
pass
@typing.overload
def addData(self, frame: tuple, value: tuple):
"""This method adds data to the *data* member of the HistoryOutput object.
Parameters
----------
frame
A sequence of Floats specifying the frame values. *frame* can be specified in step time,
frequency, or mode number.
value
A sequence of Floats specifying the value of the variable at the frame values specified
in *frame*.
Raises
------
If the length of *frame* is not the same as the length of *value* a ValueError is
raised.
"""
pass
@typing.overload
def addData(self, data: tuple):
"""This method adds data to the *data* member of the HistoryOutput object.
Parameters
----------
data
A sequence of pairs of Floats specifying the pairs (*frameValue*, *value*) where
*frameValue* is either time, frequency, or mode and *value* is the value of the
specified variable at *frameValue*. (This value depends on the type of the variable.)
"""
pass
def addData(self, *args, **kwargs):
pass