This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
ModulatedAmplitude.py
92 lines (74 loc) · 2.37 KB
/
ModulatedAmplitude.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
from abaqusConstants import *
from .Amplitude import Amplitude
class ModulatedAmplitude(Amplitude):
"""The ModulatedAmplitude object defines a modulated amplitude curve.
The ModulatedAmplitude object is derived from the Amplitude object.
Notes
-----
This object can be accessed by:
.. code-block:: python
import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]
The corresponding analysis keywords are:
- AMPLITUDE
"""
def __init__(
self,
name: str,
initial: float,
magnitude: float,
start: float,
frequency1: float,
frequency2: float,
timeSpan: SymbolicConstant = STEP,
):
"""This method creates a ModulatedAmplitude object.
Notes
-----
This function can be accessed by:
.. code-block:: python
mdb.models[name].ModulatedAmplitude
session.odbs[name].ModulatedAmplitude
Parameters
----------
name
A String specifying the repository key.
initial
A Float specifying the constant A0A0.
magnitude
A Float specifying the coefficient AA.
start
A Float specifying the starting time t0t0. Possible values are non-negative numbers.
frequency1
A Float specifying the circular frequency 1 (ω1ω1). Possible values are positive
numbers.
frequency2
A Float specifying the circular frequency 2 (ω2ω2). Possible values are positive
numbers.
timeSpan
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP
and TOTAL. The default value is STEP.
Returns
-------
A ModulatedAmplitude object.
Raises
------
InvalidNameError
RangeError
"""
super().__init__()
pass
def setValues(self, timeSpan: SymbolicConstant = STEP):
"""This method modifies the ModulatedAmplitude object.
Parameters
----------
timeSpan
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP
and TOTAL. The default value is STEP.
Raises
------
RangeError
"""
pass