This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
BodyForce.py
183 lines (159 loc) · 7.25 KB
/
BodyForce.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
import typing
from abaqusConstants import *
from .Load import Load
from ..Region.Region import Region
class BodyForce(Load):
"""The BodyForce object defines a distributed load.
The BodyForce object is derived from the Load object.
Attributes
----------
name: str
A String specifying the load repository key.
distributionType: SymbolicConstant
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field: str
A String specifying the name of the :py:class:`~abaqus.Field.AnalyticalField.AnalyticalField` object associated with this load.
The **field** argument applies only when **distributionType=FIELD**. The default value is an
empty string.
region: Region
A :py:class:`~abaqus.Region.Region.Region` object specifying the region to which the load is applied.
Notes
-----
This object can be accessed by:
.. code-block:: python
import load
mdb.models[name].loads[name]
The corresponding analysis keywords are:
- DLOAD
"""
# A String specifying the load repository key.
name: str = ""
# A SymbolicConstant specifying how the load is distributed spatially. Possible values are
# UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
distributionType: SymbolicConstant = UNIFORM
# A String specifying the name of the AnalyticalField object associated with this load.
# The *field* argument applies only when *distributionType*=FIELD. The default value is an
# empty string.
field: str = ""
# A Region object specifying the region to which the load is applied.
region: Region = Region()
def __init__(
self,
name: str,
createStepName: str,
region: Region,
field: str = "",
distributionType: SymbolicConstant = UNIFORM,
comp1: float = None,
comp2: float = None,
comp3: float = None,
amplitude: str = UNSET,
):
"""This method creates a BodyForce object.
Notes
-----
This function can be accessed by:
.. code-block:: python
mdb.models[name].BodyForce
Parameters
----------
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
field
A String specifying the name of the AnalyticalField object associated with this load.
The *field* argument applies only when *distributionType*=FIELD. The default value is an
empty string.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
comp1
A Float or a Complex specifying the body force component in the
1-direction.Note:Although *comp1*, *comp2*, and *comp3* are optional arguments, at least
one of them must be nonzero unless *distributionType*=USER_DEFINED.
comp2
A Float or a Complex specifying the body force component in the 2-direction.
comp3
A Float or a Complex specifying the body force component in the 3-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET.
You should provide the *amplitude* argument only if it is valid for the specified step.
Returns
-------
A BodyForce object.
"""
super().__init__()
pass
def setValues(
self,
field: str = "",
distributionType: SymbolicConstant = UNIFORM,
comp1: float = None,
comp2: float = None,
comp3: float = None,
amplitude: str = UNSET,
):
"""This method modifies the data for an existing BodyForce object in the step where it is
created.
Parameters
----------
field
A String specifying the name of the AnalyticalField object associated with this load.
The *field* argument applies only when *distributionType*=FIELD. The default value is an
empty string.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
comp1
A Float or a Complex specifying the body force component in the
1-direction.Note:Although *comp1*, *comp2*, and *comp3* are optional arguments, at least
one of them must be nonzero unless *distributionType*=USER_DEFINED.
comp2
A Float or a Complex specifying the body force component in the 2-direction.
comp3
A Float or a Complex specifying the body force component in the 3-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET.
You should provide the *amplitude* argument only if it is valid for the specified step.
"""
pass
def setValuesInStep(
self,
stepName: str,
comp1: typing.Union[SymbolicConstant, float] = None,
comp2: typing.Union[SymbolicConstant, float] = None,
comp3: typing.Union[SymbolicConstant, float] = None,
amplitude: str = "",
):
"""This method modifies the propagating data for an existing BodyForce object in the
specified step.
Parameters
----------
stepName
A String specifying the name of the step in which the load is modified.
comp1
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force
component in the 1-direction. UNCHANGED should be used if the body force component is
propagated from the previous analysis step.
comp2
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force
component in the 2-direction. UNCHANGED should be used if the body force component is
propagated from the previous analysis step.
comp3
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force
component in the 3-direction. UNCHANGED should be used if the body force component is
propagated from the previous analysis step.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible
values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the
load is changed to have no amplitude reference. You should provide the *amplitude*
argument only if it is valid for the specified step.
"""
pass