Amplitude#

Amplitude commands are used to create arbitrary time or frequency variations of load, displacement, and some interaction attributes throughout a step using step time or throughout an analysis using total time.

Create amplitudes#

In Mdb#

class AmplitudeModel(name: str, description: str = '', stefanBoltzmann: float | None = None, absoluteZero: float | None = None, waveFormulation: SymbolicConstantType = 'NOT_SET', modelType: SymbolicConstantType = 'STANDARD_EXPLICIT', universalGas: float | None = None, copyConstraints: BooleanType = 1, copyConnectors: BooleanType = 1, copyInteractions: BooleanType = 1)[source]#

Abaqus creates a Model object named Model-1 when a session is started.

Notes

This object can be accessed by:

mdb.models[name]

Methods

`ActuatorAmplitude`(name[, timeSpan])	This method creates a ActuatorAmplitude object.
`DecayAmplitude`(name, initial, maximum, ...)	This method creates a DecayAmplitude object.
`EquallySpacedAmplitude`(name, fixedInterval, data)	This method creates an EquallySpacedAmplitude object.
`ModulatedAmplitude`(name, initial, magnitude, ...)	This method creates a ModulatedAmplitude object.
`PeriodicAmplitude`(name, frequency, start, ...)	This method creates a PeriodicAmplitude object.
`PsdDefinition`(name, data[, unitType, ...])	This method creates a PsdDefinition object.
`SmoothStepAmplitude`(name, data[, timeSpan])	This method creates a SmoothStepAmplitude object.
`SolutionDependentAmplitude`(name[, initial, ...])	This method creates a SolutionDependentAmplitude object.
`SpectrumAmplitude`(name, method, data[, ...])	This method creates a SpectrumAmplitude object.
`TabularAmplitude`(name, data[, smooth, timeSpan])	This method creates a TabularAmplitude object.

ActuatorAmplitude(name: str, timeSpan: SymbolicConstantType = 'STEP') → ActuatorAmplitude[source]#

This method creates a ActuatorAmplitude object.

Parameters:

name: A String specifying the repository key.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An ActuatorAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].ActuatorAmplitude
session.odbs[name].ActuatorAmplitude

DecayAmplitude(name: str, initial: float, maximum: float, start: float, decayTime: float, timeSpan: SymbolicConstantType = 'STEP') → DecayAmplitude[source]#

This method creates a DecayAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the constant A0A0.
maximum: A Float specifying the coefficient AA.
start: A Float specifying the starting time t0t0. Possible values are non-negative numbers.
decayTime: A Float specifying the decay time tdtd. Possible values are non-negative numbers.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A DecayAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].DecayAmplitude
session.odbs[name].DecayAmplitude

EquallySpacedAmplitude(name: str, fixedInterval: float, data: tuple, begin: float = 0, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → EquallySpacedAmplitude[source]#

This method creates an EquallySpacedAmplitude object.

Parameters:

name: A String specifying the repository key.
fixedInterval: A Float specifying the fixed time interval at which the amplitude data are given. Possible values are positive numbers.
data: A sequence of Floats specifying the amplitude values.
begin: A Float specifying the time at which the first amplitude data are given. Possible values are non-negative numbers. The default value is 0.0.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are 0 ≤≤ smoothing ≤≤ 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An EquallySpacedAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].EquallySpacedAmplitude
session.odbs[name].EquallySpacedAmplitude

ModulatedAmplitude(name: str, initial: float, magnitude: float, start: float, frequency1: float, frequency2: float, timeSpan: SymbolicConstantType = 'STEP') → ModulatedAmplitude[source]#

This method creates a ModulatedAmplitude object.

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

Notes

This function can be accessed by:

mdb.models[name].ModulatedAmplitude
session.odbs[name].ModulatedAmplitude

PeriodicAmplitude(name: str, frequency: float, start: float, a_0: float, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → PeriodicAmplitude[source]#

This method creates a PeriodicAmplitude object.

Parameters:

name: A String specifying the repository key.
frequency: A Float specifying the circular frequency ωω. Possible values are positive numbers.
start: A Float specifying the starting time t0t0. Possible values are positive numbers.
a_0: A Float specifying the constant A0A0.
data: A sequence of pairs of Floats specifying AiAi and BiBi pairs.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A PeriodicAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].PeriodicAmplitude
session.odbs[name].PeriodicAmplitude

PsdDefinition(name: str, data: tuple, unitType: SymbolicConstantType = 'FORCE', referenceGravityAcceleration: float = 1, referenecePower: float = 0, user: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '') → PsdDefinition[source]#

This method creates a PsdDefinition object.

Parameters:

name: A String specifying the repository key.
data: A sequence of sequences of Floats specifying the real part of the frequency function, the imaginary part of the frequency function, and the frequency or frequency band number values, depending on the value of unitType.
unitType: A SymbolicConstant specifying the type of units for specifying the frequency function. FORCE implies power units. BASE implies gravity used to define base motion. DB implies decibel units. Possible values are FORCE, BASE, and DB. The default value is FORCE.
referenceGravityAcceleration: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user: A Boolean specifying whether the frequency function is defined in user subroutine UPSD. If specified, then data is not applicable, and the unitType value must not be DB. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to define the cross-spectral density frequency function. The default value is an empty string.

Returns:

A PsdDefinition object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].PsdDefinition
session.odbs[name].PsdDefinition

SmoothStepAmplitude(name: str, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → SmoothStepAmplitude[source]#

This method creates a SmoothStepAmplitude object.

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency 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 SmoothStepAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SmoothStepAmplitude
session.odbs[name].SmoothStepAmplitude

SolutionDependentAmplitude(name: str, initial: float = 1, minimum: float = 0, maximum: float = 1000, timeSpan: SymbolicConstantType = 'STEP') → SolutionDependentAmplitude[source]#

This method creates a SolutionDependentAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1.0.
minimum: A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1.
maximum: A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.0.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A SolutionDependentAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SolutionDependentAmplitude
session.odbs[name].SolutionDependentAmplitude

SpectrumAmplitude(name: str, method: SymbolicConstantType, data: tuple, specificationUnits: SymbolicConstantType = 'ACCELERATION', eventUnits: SymbolicConstantType = 'EVENT_ACCELERATION', solution: SymbolicConstantType = 'ABSOLUTE_VALUE', timeIncrement: float = 0, gravity: float = 1, criticalDamping: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '') → SpectrumAmplitude[source]#

This method creates a SpectrumAmplitude object.

Parameters:

name: A String specifying the repository key.
method: A SymbolicConstant specifying the method for specifying the spectrum. Possible values are DEFINE and CALCULATE.
data: A sequence of sequences of Floats specifying the magnitude, frequency, and damping values.
specificationUnits: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits: A SymbolicConstant specifying the units used to describe the dynamic event in the amplitude used for the calculation. Possible values are EVENT_DISPLACEMENT, EVENT_VELOCITY, EVENT_ACCELERATION, and EVENT_GRAVITY. The default value is EVENT_ACCELERATION.
solution: A SymbolicConstant specifying the solution method for the dynamic equations. Possible values are ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.
timeIncrement: A Float specifying the implicit time increment used to calculate the spectrum. This argument is required when the method = CALCULATE. The default value is 0.0.
gravity: A Float specifying the acceleration due to gravity. This argument applies only when specificationUnits = GRAVITY or*eventUnits* = GRAVITY. The default value is 1.0.
criticalDamping: A Boolean specifying whether to calculate the spectrum for only the specified range of critical damping values or a list of values. If criticalDamping = ON, the spectrum is calculated only for the specified range of critical damping values. If criticalDamping = OFF, the spectrum is calculated for a list of damping values. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to calculate the spectrum. The default value is an empty string.

Returns:

A SpectrumAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SpectrumAmplitude
session.odbs[name].SpectrumAmplitude

TabularAmplitude(name: str, data: tuple, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → TabularAmplitude[source]#

This method creates a TabularAmplitude object.

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are between 0 and 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A TabularAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].TabularAmplitude
session.odbs[name].TabularAmplitude

In Odb#

class AmplitudeOdb(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Methods

`ActuatorAmplitude`(name[, timeSpan])	This method creates a ActuatorAmplitude object.
`DecayAmplitude`(name, initial, maximum, ...)	This method creates a DecayAmplitude object.
`EquallySpacedAmplitude`(name, fixedInterval, data)	This method creates an EquallySpacedAmplitude object.
`ModulatedAmplitude`(name, initial, magnitude, ...)	This method creates a ModulatedAmplitude object.
`PeriodicAmplitude`(name, frequency, start, ...)	This method creates a PeriodicAmplitude object.
`PsdDefinition`(name, data[, unitType, ...])	This method creates a PsdDefinition object.
`SmoothStepAmplitude`(name, data[, timeSpan])	This method creates a SmoothStepAmplitude object.
`SolutionDependentAmplitude`(name[, initial, ...])	This method creates a SolutionDependentAmplitude object.
`SpectrumAmplitude`(name, method, data[, ...])	This method creates a SpectrumAmplitude object.
`TabularAmplitude`(name, data[, smooth, timeSpan])	This method creates a TabularAmplitude object.

ActuatorAmplitude(name: str, timeSpan: SymbolicConstantType = 'STEP') → ActuatorAmplitude[source]#

This method creates a ActuatorAmplitude object.

Parameters:

name: A String specifying the repository key.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An ActuatorAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].ActuatorAmplitude
session.odbs[name].ActuatorAmplitude

DecayAmplitude(name: str, initial: float, maximum: float, start: float, decayTime: float, timeSpan: SymbolicConstantType = 'STEP') → DecayAmplitude[source]#

This method creates a DecayAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the constant A0A0.
maximum: A Float specifying the coefficient AA.
start: A Float specifying the starting time t0t0. Possible values are non-negative numbers.
decayTime: A Float specifying the decay time tdtd. Possible values are non-negative numbers.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A DecayAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].DecayAmplitude
session.odbs[name].DecayAmplitude

This method creates an EquallySpacedAmplitude object.

Parameters:

name: A String specifying the repository key.
fixedInterval: A Float specifying the fixed time interval at which the amplitude data are given. Possible values are positive numbers.
data: A sequence of Floats specifying the amplitude values.
begin: A Float specifying the time at which the first amplitude data are given. Possible values are non-negative numbers. The default value is 0.0.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are 0 ≤≤ smoothing ≤≤ 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An EquallySpacedAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].EquallySpacedAmplitude
session.odbs[name].EquallySpacedAmplitude

This method creates a ModulatedAmplitude object.

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

Notes

This function can be accessed by:

mdb.models[name].ModulatedAmplitude
session.odbs[name].ModulatedAmplitude

PeriodicAmplitude(name: str, frequency: float, start: float, a_0: float, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → PeriodicAmplitude[source]#

This method creates a PeriodicAmplitude object.

Parameters:

name: A String specifying the repository key.
frequency: A Float specifying the circular frequency ωω. Possible values are positive numbers.
start: A Float specifying the starting time t0t0. Possible values are positive numbers.
a_0: A Float specifying the constant A0A0.
data: A sequence of pairs of Floats specifying AiAi and BiBi pairs.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A PeriodicAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].PeriodicAmplitude
session.odbs[name].PeriodicAmplitude

This method creates a PsdDefinition object.

Parameters:

name: A String specifying the repository key.
data: A sequence of sequences of Floats specifying the real part of the frequency function, the imaginary part of the frequency function, and the frequency or frequency band number values, depending on the value of unitType.
unitType: A SymbolicConstant specifying the type of units for specifying the frequency function. FORCE implies power units. BASE implies gravity used to define base motion. DB implies decibel units. Possible values are FORCE, BASE, and DB. The default value is FORCE.
referenceGravityAcceleration: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user: A Boolean specifying whether the frequency function is defined in user subroutine UPSD. If specified, then data is not applicable, and the unitType value must not be DB. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to define the cross-spectral density frequency function. The default value is an empty string.

Returns:

A PsdDefinition object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].PsdDefinition
session.odbs[name].PsdDefinition

SmoothStepAmplitude(name: str, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → SmoothStepAmplitude[source]#

This method creates a SmoothStepAmplitude object.

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency 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 SmoothStepAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SmoothStepAmplitude
session.odbs[name].SmoothStepAmplitude

SolutionDependentAmplitude(name: str, initial: float = 1, minimum: float = 0, maximum: float = 1000, timeSpan: SymbolicConstantType = 'STEP') → SolutionDependentAmplitude[source]#

This method creates a SolutionDependentAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1.0.
minimum: A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1.
maximum: A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.0.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A SolutionDependentAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SolutionDependentAmplitude
session.odbs[name].SolutionDependentAmplitude

This method creates a SpectrumAmplitude object.

Parameters:

name: A String specifying the repository key.
method: A SymbolicConstant specifying the method for specifying the spectrum. Possible values are DEFINE and CALCULATE.
data: A sequence of sequences of Floats specifying the magnitude, frequency, and damping values.
specificationUnits: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits: A SymbolicConstant specifying the units used to describe the dynamic event in the amplitude used for the calculation. Possible values are EVENT_DISPLACEMENT, EVENT_VELOCITY, EVENT_ACCELERATION, and EVENT_GRAVITY. The default value is EVENT_ACCELERATION.
solution: A SymbolicConstant specifying the solution method for the dynamic equations. Possible values are ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.
timeIncrement: A Float specifying the implicit time increment used to calculate the spectrum. This argument is required when the method = CALCULATE. The default value is 0.0.
gravity: A Float specifying the acceleration due to gravity. This argument applies only when specificationUnits = GRAVITY or*eventUnits* = GRAVITY. The default value is 1.0.
criticalDamping: A Boolean specifying whether to calculate the spectrum for only the specified range of critical damping values or a list of values. If criticalDamping = ON, the spectrum is calculated only for the specified range of critical damping values. If criticalDamping = OFF, the spectrum is calculated for a list of damping values. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to calculate the spectrum. The default value is an empty string.

Returns:

A SpectrumAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SpectrumAmplitude
session.odbs[name].SpectrumAmplitude

TabularAmplitude(name: str, data: tuple, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → TabularAmplitude[source]#

This method creates a TabularAmplitude object.

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are between 0 and 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A TabularAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].TabularAmplitude
session.odbs[name].TabularAmplitude

Object features#

Amplitude#

class Amplitude[source]#

The Amplitude object is the abstract base type for other Amplitude objects. The Amplitude object has no explicit constructor. The methods and members of the Amplitude object are common to all objects derived from the Amplitude.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

Attributes:

name: str: A String specifying the repository key.
timeSpan: SymbolicConstant: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

ActuatorAmplitude#

class ActuatorAmplitude(name: str, timeSpan: SymbolicConstantType = 'STEP')[source]#

The ActuatorAmplitude object defines an actuator amplitude curve. The ActuatorAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Methods

setValues([timeSpan])

This method modifies the ActuatorAmplitude object.

setValues(timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the ActuatorAmplitude 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

BaselineCorrection#

class BaselineCorrection(intervals: tuple = ())[source]#

The BaselineCorrection object modifies an acceleration history to minimize the overall drift of the displacement obtained from the time integration of the given acceleration.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name].baselineCorrection
import odbAmplitude
session.odbs[name].amplitudes[name].baselineCorrection

The corresponding analysis keywords are:

BASELINE CORRECTION

Methods

setValues()

This method modifies the BaselineCorrection object.

setValues()[source]#

This method modifies the BaselineCorrection object.

Raises:

RangeError

ConstrainedSketchGeometryArray#

class ConstrainedSketchGeometryArray[source]#

The ConstrainedSketchGeometryArray is a sequence of ConstrainedSketchGeometry objects.

Notes

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].geometry[i]

Methods

findAt(coordinates[, printWarning])

This method returns the ConstrainedSketchGeometry object located at the given coordinates.

findAt(coordinates: tuple, printWarning: BooleanType = True)[source]#

This method returns the ConstrainedSketchGeometry object located at the given coordinates.

Parameters:

coordinates: A sequence of Floats specifying the X- and Y-coordinates of the object to find.
printWarning: A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the specified location. The default value is True.

Returns:

A ConstrainedSketchGeometry object.

Correlation#

class Correlation[source]#

A Correlation is an object used to define the cross-correlation as part of the definition of random loading. The Correlation object is derived from the Amplitude object.

Notes

This object can be accessed by:

import load
mdb.models[name].boundaryConditions[name].correlation[i]

Attributes:

name: str: A String specifying the repository key.
approach: SymbolicConstant: A SymbolicConstant specifying the approach used in the correlation data representation. Possible values are CORRELATED, MOVING_NOISE, UNCORRELATED, and USER. The default value is CORRELATED.
data: float: A tuple of tuples of Floats specifying the real and imaginary part of the scaling factor. If approach=MOVING_NOISE, then data represents the noise velocity components 1, 2, and 3.
timeSpan: SymbolicConstant: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

CorrelationArray#

class CorrelationArray(iterable=(), /)[source]#

Methods

findAt

DecayAmplitude#

class DecayAmplitude(name: str, initial: float, maximum: float, start: float, decayTime: float, timeSpan: SymbolicConstantType = 'STEP')[source]#

The DecayAmplitude object defines an amplitude curve using an exponential decay. The DecayAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Methods

setValues([timeSpan])

This method modifies the DecayAmplitude object.

setValues(timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the DecayAmplitude 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

EquallySpacedAmplitude#

class EquallySpacedAmplitude(name: str, fixedInterval: float, data: tuple, begin: float = 0, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP')[source]#

The EquallySpacedAmplitude object defines a list of amplitude values at fixed time intervals beginning at a specified value of time. The EquallySpacedAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Attributes:

baselineCorrection: BaselineCorrection: A BaselineCorrection object.

Methods

setValues([begin, smooth, timeSpan])

This method modifies the EquallySpacedAmplitude object.

setValues(begin: float = 0, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the EquallySpacedAmplitude object.

Parameters:

begin: A Float specifying the time at which the first amplitude data are given. Possible values are non-negative numbers. The default value is 0.0.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are 0 ≤≤ smoothing ≤≤ 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:

RangeError

ModulatedAmplitude#

class ModulatedAmplitude(name: str, initial: float, magnitude: float, start: float, frequency1: float, frequency2: float, timeSpan: SymbolicConstantType = 'STEP')[source]#

The ModulatedAmplitude object defines a modulated amplitude curve. The ModulatedAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Methods

setValues([timeSpan])

This method modifies the ModulatedAmplitude object.

setValues(timeSpan: SymbolicConstantType = 'STEP')[source]#

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

PeriodicAmplitude#

class PeriodicAmplitude(name: str, frequency: float, start: float, a_0: float, data: tuple, timeSpan: SymbolicConstantType = 'STEP')[source]#

The PeriodicAmplitude object defines an amplitude curve using a Fourier series. The PeriodicAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Methods

setValues([timeSpan])

This method modifies the PeriodicAmplitude object.

setValues(timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the PeriodicAmplitude 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

Property#

PsdDefinition#

class PsdDefinition(name: str, data: tuple, unitType: SymbolicConstantType = 'FORCE', referenceGravityAcceleration: float = 1, referenecePower: float = 0, user: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '')[source]#

The PsdDefinition object defines the cross-spectral density frequency function for random response loading. The PsdDefinition object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

PSD-DEFINITION

Methods

setValues([unitType, ...])

This method modifies the PsdDefinition object.

setValues(unitType: SymbolicConstantType = 'FORCE', referenceGravityAcceleration: float = 1, referenecePower: float = 0, user: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '')[source]#

This method modifies the PsdDefinition object.

Parameters:

unitType: A SymbolicConstant specifying the type of units for specifying the frequency function. FORCE implies power units. BASE implies gravity used to define base motion. DB implies decibel units. Possible values are FORCE, BASE, and DB. The default value is FORCE.
referenceGravityAcceleration: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user: A Boolean specifying whether the frequency function is defined in user subroutine UPSD. If specified, then data is not applicable, and the unitType value must not be DB. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to define the cross-spectral density frequency function. The default value is an empty string.

Raises:

RangeError

SmoothStepAmplitude#

class SmoothStepAmplitude(name: str, data: tuple, timeSpan: SymbolicConstantType = 'STEP')[source]#

The SmoothStepAmplitude object defines an amplitude that ramps up or down smoothly from one data point to another. The SmoothStepAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Methods

setValues([timeSpan])

This method modifies the SmoothStepAmplitude object.

setValues(timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the SmoothStepAmplitude 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

SolutionDependentAmplitude#

class SolutionDependentAmplitude(name: str, initial: float = 1, minimum: float = 0, maximum: float = 1000, timeSpan: SymbolicConstantType = 'STEP')[source]#

The SolutionDependentAmplitude object defines a solution-dependent amplitude for superplastic forming analysis. The SolutionDependentAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Methods

setValues([initial, minimum, maximum, timeSpan])

This method modifies the SolutionDependentAmplitude object.

setValues(initial: float = 1, minimum: float = 0, maximum: float = 1000, timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the SolutionDependentAmplitude object.

Parameters:

initial: A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1.0.
minimum: A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1.
maximum: A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.0.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:

RangeError

SpectrumAmplitude#

class SpectrumAmplitude(name: str, method: SymbolicConstantType, data: tuple, specificationUnits: SymbolicConstantType = 'ACCELERATION', eventUnits: SymbolicConstantType = 'EVENT_ACCELERATION', solution: SymbolicConstantType = 'ABSOLUTE_VALUE', timeIncrement: float = 0, gravity: float = 1, criticalDamping: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '')[source]#

The SpectrumAmplitude object defines the spectrum of responses for displacement, velocity, or acceleration to be used in a response spectrum analysis. The SpectrumAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

SPECTRUM

Methods

setValues([specificationUnits, eventUnits, ...])

This method modifies the SpectrumAmplitude object.

setValues(specificationUnits: SymbolicConstantType = 'ACCELERATION', eventUnits: SymbolicConstantType = 'EVENT_ACCELERATION', solution: SymbolicConstantType = 'ABSOLUTE_VALUE', timeIncrement: float = 0, gravity: float = 1, criticalDamping: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '')[source]#

This method modifies the SpectrumAmplitude object.

Parameters:

specificationUnits: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits: A SymbolicConstant specifying the units used to describe the dynamic event in the amplitude used for the calculation. Possible values are EVENT_DISPLACEMENT, EVENT_VELOCITY, EVENT_ACCELERATION, and EVENT_GRAVITY. The default value is EVENT_ACCELERATION.
solution: A SymbolicConstant specifying the solution method for the dynamic equations. Possible values are ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.
timeIncrement: A Float specifying the implicit time increment used to calculate the spectrum. This argument is required when the method = CALCULATE. The default value is 0.0.
gravity: A Float specifying the acceleration due to gravity. This argument applies only when specificationUnits = GRAVITY or*eventUnits* = GRAVITY. The default value is 1.0.
criticalDamping: A Boolean specifying whether to calculate the spectrum for only the specified range of critical damping values or a list of values. If criticalDamping = ON, the spectrum is calculated only for the specified range of critical damping values. If criticalDamping = OFF, the spectrum is calculated for a list of damping values. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to calculate the spectrum. The default value is an empty string.

Raises:

RangeError

TabularAmplitude#

class TabularAmplitude(name: str, data: tuple, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP')[source]#

The TabularAmplitude object defines an amplitude curve as a table of values at convenient points on the time scale. The TabularAmplitude object is derived from the Amplitude object.

Notes

This object can be accessed by:

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

The corresponding analysis keywords are:

AMPLITUDE

Attributes:

baselineCorrection: BaselineCorrection: A BaselineCorrection object.

Methods

setValues([smooth, timeSpan])

This method modifies the TabularAmplitude object.

setValues(smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP')[source]#

This method modifies the TabularAmplitude object.

Parameters:

smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are between 0 and 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:

RangeError