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, description='', stefanBoltzmann=None, absoluteZero=None, waveFormulation=NOT_SET, modelType=STANDARD_EXPLICIT, universalGas=None, copyConstraints=1, copyConnectors=1, copyInteractions=1, )[source]¶

Bases: ModelBase

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

Note

This object can be accessed by:

mdb.models[name]

Note

Check AmplitudeModel on help.3ds.com/2024.

Public Data Attributes:

Inherited from ModelBase

`name`	A String specifying the repository key.
`stefanBoltzmann`	None or a Float specifying the Stefan-Boltzmann constant.
`absoluteZero`	None or a Float specifying the absolute zero constant.
`waveFormulation`	A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems.
`universalGas`	None or a Float specifying the universal gas constant.
`noPartsInputFile`	A Boolean specifying whether an input file should be written without parts and assemblies.
`endRestartStep`	A Boolean specifying that the step specified by restartStep should be terminated at the increment specified by restartIncrement.
`shellToSolid`	A Boolean specifying that a shell global model drives a solid submodel.
`lastChangedCount`	A Float specifying the time stamp that indicates when the model was last changed.
`description`	A String specifying the purpose and contents of the Model object.
`restartJob`	A String specifying the name of the job that generated the restart data.
`restartStep`	A String specifying the name of the step where the restart analysis will start.
`globalJob`	A String specifying the name of the job that generated the results for the global model.
`copyConstraints`	A boolean specifying the status of constraints created in a model, in the model which instances this model.
`copyConnectors`	A boolean specifying the status of connectors created in a model, in the model which instances this model.
`copyInteractions`	A boolean specifying the status of interactions created in a model, in the model which instances this model.
`keywordBlock`	A KeywordBlock object.
`amplitudes`	A repository of Amplitude objects.
`profiles`	A repository of Profile objects.
`boundaryConditions`	A repository of BoundaryCondition objects.
`constraints`	A repository of ConstrainedSketchConstraint objects.
`analyticalFields`	A repository of AnalyticalField objects.
`discreteFields`	A repository of DiscreteField objects.
`predefinedFields`	A repository of PredefinedField objects.
`interactions`	A repository of Interaction objects.
`interactionProperties`	A repository of InteractionProperty objects.
`contactControls`	A repository of ContactControl objects.
`contactInitializations`	A repository of ContactInitialization objects.
`contactStabilizations`	A repository of ContactStabilization objects.
`linkedInstances`	A tuple of tuples of Strings specifying the linked child PartInstance name in the current model to the corresponding parent PartInstance name in a different model.
`linkedParts`	A tuple of tuples of Strings specifying the linked child Part name in the current model to the corresponding parent Part name in a different model.
`loads`	A repository of Load objects.
`materials`	A repository of Material objects.
`calibrations`	A repository of Calibration objects.
`sections`	A repository of Section objects.
`remeshingRules`	A repository of RemeshingRule objects.
`sketches`	A repository of ConstrainedSketch objects.
`parts`	A repository of Part objects.
`steps`	A repository of Step objects.
`featureOptions`	A FeatureOptions object.
`adaptiveMeshConstraints`	A repository of AdaptiveMeshConstraint objects.
`adaptiveMeshControls`	A repository of AdaptiveMeshControl objects.
`timePoints`	A repository of TimePoint objects.
`filters`	A repository of Filter objects.
`integratedOutputSections`	A repository of IntegratedOutputSection objects.
`fieldOutputRequests`	A repository of FieldOutputRequest objects.
`historyOutputRequests`	A repository of HistoryOutputRequest objects.
`optimizationTasks`	A repository of OptimizationTask objects.
`tableCollections`	A repository of TableCollection objects.
`eventSeriesTypes`	A repository of EventSeriesType objects.
`eventSeriesDatas`	A repository of EventSeriesData objects.
`restartIncrement`	An Int specifying the increment, interval, iteration or cycle where the restart analysis will start.
`rootAssembly`	An Assembly object.

Public 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.

Inherited from ModelBase

`__init__`(name[, description, ...])	This method creates a Model object.
`ModelFromInputFile`(name, inputFileName)	This method creates a Model object by reading the keywords in an input file and creating the corresponding Abaqus/CAE objects.
`ModelFromOdbFile`(name, odbFileName)	This method creates a Model object by reading an output database and creating any corresponding Abaqus/CAE objects.
`ModelFromNastranFile`(modelName, inputFileName)	This method creates a Model object by reading the keywords in a Nastran bulk data file or Nastran input file and creating any corresponding Abaqus/CAE objects.
`setValues`([description, noPartsInputFile, ...])	This method modifies the Model object.

Member Details:

ActuatorAmplitude(name, timeSpan=STEP)[source]¶

This method creates a ActuatorAmplitude object.

Note

This function can be accessed by:

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

Note

Check ActuatorAmplitude on help.3ds.com/2024.

Parameters:¶

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

Returns:¶

An ActuatorAmplitude object.

Return type:¶

ActuatorAmplitude

Raises:¶

InvalidNameError –
RangeError –

DecayAmplitude(name, initial, maximum, start, decayTime, timeSpan=STEP)[source]¶

This method creates a DecayAmplitude object.

Note

This function can be accessed by:

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

Note

Check DecayAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A DecayAmplitude object.

Return type:¶

DecayAmplitude

Raises:¶

InvalidNameError –
RangeError –

EquallySpacedAmplitude( name, fixedInterval, data, begin=0, smooth=SOLVER_DEFAULT, timeSpan=STEP, )[source]¶

This method creates an EquallySpacedAmplitude object.

Note

This function can be accessed by:

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

Note

Check EquallySpacedAmplitude on help.3ds.com/2024.

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=0¶: 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=SOLVER_DEFAULT¶: 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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

An EquallySpacedAmplitude object.

Return type:¶

EquallySpacedAmplitude

Raises:¶

InvalidNameError –
RangeError –

ModulatedAmplitude( name, initial, magnitude, start, frequency1, frequency2, timeSpan=STEP, )[source]¶

This method creates a ModulatedAmplitude object.

Note

This function can be accessed by:

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

Note

Check ModulatedAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A ModulatedAmplitude object.

Return type:¶

ModulatedAmplitude

Raises:¶

InvalidNameError –
RangeError –

PeriodicAmplitude(name, frequency, start, a_0, data, timeSpan=STEP)[source]¶

This method creates a PeriodicAmplitude object.

Note

This function can be accessed by:

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

Note

Check PeriodicAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A PeriodicAmplitude object.

Return type:¶

PeriodicAmplitude

Raises:¶

InvalidNameError –
RangeError –

PsdDefinition( name, data, unitType=FORCE, referenceGravityAcceleration=1, referenecePower=0, user=0, timeSpan=STEP, amplitude='', )[source]¶

This method creates a PsdDefinition object.

Note

This function can be accessed by:

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

Note

Check PsdDefinition on help.3ds.com/2024.

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=FORCE¶: 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=1¶: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower=0¶: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user=0¶: 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=STEP¶: 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.

Return type:¶

PsdDefinition

Raises:¶

InvalidNameError –
RangeError –

SmoothStepAmplitude(name, data, timeSpan=STEP)[source]¶

This method creates a SmoothStepAmplitude object.

Note

This function can be accessed by:

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

Note

Check SmoothStepAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A SmoothStepAmplitude object.

Return type:¶

SmoothStepAmplitude

Raises:¶

InvalidNameError –
RangeError –

SolutionDependentAmplitude( name, initial=1, minimum=0, maximum=1000, timeSpan=STEP, )[source]¶

This method creates a SolutionDependentAmplitude object.

Note

This function can be accessed by:

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

Note

Check SolutionDependentAmplitude on help.3ds.com/2024.

Parameters:¶

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

Returns:¶

A SolutionDependentAmplitude object.

Return type:¶

SolutionDependentAmplitude

Raises:¶

InvalidNameError –
RangeError –

SpectrumAmplitude( name, method, data, specificationUnits=ACCELERATION, eventUnits=EVENT_ACCELERATION, solution=ABSOLUTE_VALUE, timeIncrement=0, gravity=1, criticalDamping=0, timeSpan=STEP, amplitude='', )[source]¶

This method creates a SpectrumAmplitude object.

Note

This function can be accessed by:

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

Note

Check SpectrumAmplitude on help.3ds.com/2024.

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=ACCELERATION¶: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits=EVENT_ACCELERATION¶: 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=ABSOLUTE_VALUE¶: 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=0¶: 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=1¶: 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=0¶: 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=STEP¶: 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.

Return type:¶

SpectrumAmplitude

Raises:¶

InvalidNameError –
RangeError –

TabularAmplitude(name, data, smooth=SOLVER_DEFAULT, timeSpan=STEP)[source]¶

This method creates a TabularAmplitude object.

Note

This function can be accessed by:

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

Note

Check TabularAmplitude on help.3ds.com/2024.

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=SOLVER_DEFAULT¶: 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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A TabularAmplitude object.

Return type:¶

TabularAmplitude

Raises:¶

InvalidNameError –
RangeError –

In Odb¶

class AmplitudeOdb(name, analysisTitle='', description='', path='')[source]¶

Bases: OdbBase

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

Note

This object can be accessed by:

import odbAccess
session.odbs[name]

Note

Check AmplitudeOdb on help.3ds.com/2024.

Public Data Attributes:

Inherited from OdbBase

`isReadOnly`	A Boolean specifying whether the output database was opened with read-only access.
`amplitudes`	A repository of Amplitude objects.
`filters`	A repository of Filter objects.
`rootAssembly`	An OdbAssembly object.
`jobData`	A JobData object.
`parts`	A repository of OdbPart objects.
`materials`	A repository of Material objects.
`steps`	A repository of OdbStep objects.
`sections`	A repository of Section objects.
`sectionCategories`	A repository of SectionCategory objects.
`sectorDefinition`	A SectorDefinition object.
`userData`	A UserData object.
`customData`	A RepositorySupport object.
`profiles`	A repository of Profile objects.

Public 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.

Inherited from OdbBase

`__init__`(name[, analysisTitle, description, ...])	This method creates a new Odb object.
`close`()	This method closes an output database.
`getFrame`(frameValue[, match])	This method returns the frame at the specified time, frequency, or mode.
`save`()	This method saves output to an output database (.odb ) file.
`update`()	This method is used to update an Odb object in memory while an Abaqus analysis writes data to the associated output database.

Member Details:

ActuatorAmplitude(name, timeSpan=STEP)[source]¶

This method creates a ActuatorAmplitude object.

Note

This function can be accessed by:

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

Note

Check ActuatorAmplitude on help.3ds.com/2024.

Parameters:¶

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

Returns:¶

An ActuatorAmplitude object.

Return type:¶

ActuatorAmplitude

Raises:¶

InvalidNameError –
RangeError –

DecayAmplitude(name, initial, maximum, start, decayTime, timeSpan=STEP)[source]¶

This method creates a DecayAmplitude object.

Note

This function can be accessed by:

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

Note

Check DecayAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A DecayAmplitude object.

Return type:¶

DecayAmplitude

Raises:¶

InvalidNameError –
RangeError –

EquallySpacedAmplitude( name, fixedInterval, data, begin=0, smooth=SOLVER_DEFAULT, timeSpan=STEP, )[source]¶

This method creates an EquallySpacedAmplitude object.

Note

This function can be accessed by:

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

Note

Check EquallySpacedAmplitude on help.3ds.com/2024.

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=0¶: 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=SOLVER_DEFAULT¶: 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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

An EquallySpacedAmplitude object.

Return type:¶

EquallySpacedAmplitude

Raises:¶

InvalidNameError –
RangeError –

ModulatedAmplitude( name, initial, magnitude, start, frequency1, frequency2, timeSpan=STEP, )[source]¶

This method creates a ModulatedAmplitude object.

Note

This function can be accessed by:

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

Note

Check ModulatedAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A ModulatedAmplitude object.

Return type:¶

ModulatedAmplitude

Raises:¶

InvalidNameError –
RangeError –

PeriodicAmplitude(name, frequency, start, a_0, data, timeSpan=STEP)[source]¶

This method creates a PeriodicAmplitude object.

Note

This function can be accessed by:

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

Note

Check PeriodicAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A PeriodicAmplitude object.

Return type:¶

PeriodicAmplitude

Raises:¶

InvalidNameError –
RangeError –

PsdDefinition( name, data, unitType=FORCE, referenceGravityAcceleration=1, referenecePower=0, user=0, timeSpan=STEP, amplitude='', )[source]¶

This method creates a PsdDefinition object.

Note

This function can be accessed by:

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

Note

Check PsdDefinition on help.3ds.com/2024.

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=FORCE¶: 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=1¶: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower=0¶: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user=0¶: 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=STEP¶: 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.

Return type:¶

PsdDefinition

Raises:¶

InvalidNameError –
RangeError –

SmoothStepAmplitude(name, data, timeSpan=STEP)[source]¶

This method creates a SmoothStepAmplitude object.

Note

This function can be accessed by:

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

Note

Check SmoothStepAmplitude on help.3ds.com/2024.

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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A SmoothStepAmplitude object.

Return type:¶

SmoothStepAmplitude

Raises:¶

InvalidNameError –
RangeError –

SolutionDependentAmplitude( name, initial=1, minimum=0, maximum=1000, timeSpan=STEP, )[source]¶

This method creates a SolutionDependentAmplitude object.

Note

This function can be accessed by:

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

Note

Check SolutionDependentAmplitude on help.3ds.com/2024.

Parameters:¶

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

Returns:¶

A SolutionDependentAmplitude object.

Return type:¶

SolutionDependentAmplitude

Raises:¶

InvalidNameError –
RangeError –

This method creates a SpectrumAmplitude object.

Note

This function can be accessed by:

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

Note

Check SpectrumAmplitude on help.3ds.com/2024.

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=ACCELERATION¶: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits=EVENT_ACCELERATION¶: 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=ABSOLUTE_VALUE¶: 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=0¶: 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=1¶: 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=0¶: 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=STEP¶: 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.

Return type:¶

SpectrumAmplitude

Raises:¶

InvalidNameError –
RangeError –

TabularAmplitude(name, data, smooth=SOLVER_DEFAULT, timeSpan=STEP)[source]¶

This method creates a TabularAmplitude object.

Note

This function can be accessed by:

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

Note

Check TabularAmplitude on help.3ds.com/2024.

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=SOLVER_DEFAULT¶: 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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:¶

A TabularAmplitude object.

Return type:¶

TabularAmplitude

Raises:¶

InvalidNameError –
RangeError –

Other Classes¶

class ActuatorAmplitude(name, timeSpan=STEP)[source]¶

Bases: Amplitude

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

Note

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

Note

Check ActuatorAmplitude on help.3ds.com/2024.

Member Details:

setValues(timeSpan=STEP)[source]¶

This method modifies the ActuatorAmplitude object.

Note

Check ActuatorAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

timeSpan=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class Amplitude[source]¶

Bases: object

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.

Note

This object can be accessed by:

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

Note

Check Amplitude on help.3ds.com/2024.

Member Details:

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the repository key.

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class DecayAmplitude(name, initial, maximum, start, decayTime, timeSpan=STEP)[source]¶

Bases: Amplitude

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

Note

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

Note

Check DecayAmplitude on help.3ds.com/2024.

Member Details:

decayTime : --is-rst--:py:class:`float`[source]¶: A Float specifying the decay time tdtd. Possible values are non-negative numbers.

initial : --is-rst--:py:class:`float`[source]¶: A Float specifying the constant A0A0.

maximum : --is-rst--:py:class:`float`[source]¶: A Float specifying the coefficient AA.

setValues(timeSpan=STEP)[source]¶

This method modifies the DecayAmplitude object.

Note

Check DecayAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

timeSpan=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

start : --is-rst--:py:class:`float`[source]¶: A Float specifying the starting time t0t0. Possible values are non-negative numbers.

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class EquallySpacedAmplitude( name, fixedInterval, data, begin=0, smooth=SOLVER_DEFAULT, timeSpan=STEP, )[source]¶

Bases: Amplitude

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.

Note

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

Note

Check EquallySpacedAmplitude on help.3ds.com/2024.

Member Details:

baselineCorrection : --is-rst--:py:class:`~abaqus.Amplitude.BaselineCorrection.BaselineCorrection` = <abaqus.Amplitude.BaselineCorrection.BaselineCorrection object>[source]¶: A BaselineCorrection object.

begin : --is-rst--:py:class:`float` = 0[source]¶: 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.

data : --is-rst--:py:class:`tuple`[source]¶: A sequence of Floats specifying the amplitude values.

fixedInterval : --is-rst--:py:class:`float`[source]¶: A Float specifying the fixed time interval at which the amplitude data are given. Possible values are positive numbers.

setValues(begin=0, smooth=SOLVER_DEFAULT, timeSpan=STEP)[source]¶

This method modifies the EquallySpacedAmplitude object.

Note

Check EquallySpacedAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

begin=0¶: 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=SOLVER_DEFAULT¶: 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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

smooth : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = 'SOLVER_DEFAULT'[source]¶: 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 : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class ModulatedAmplitude(name, initial, magnitude, start, frequency1, frequency2, timeSpan=STEP)[source]¶

Bases: Amplitude

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

Note

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

Note

Check ModulatedAmplitude on help.3ds.com/2024.

Member Details:

frequency1 : --is-rst--:py:class:`float`[source]¶: A Float specifying the circular frequency 1 (ω1ω1). Possible values are positive numbers.

frequency2 : --is-rst--:py:class:`float`[source]¶: A Float specifying the circular frequency 2 (ω2ω2). Possible values are positive numbers.

initial : --is-rst--:py:class:`float`[source]¶: A Float specifying the constant A0A0.

magnitude : --is-rst--:py:class:`float`[source]¶: A Float specifying the coefficient AA.

setValues(timeSpan=STEP)[source]¶

This method modifies the ModulatedAmplitude object.

Note

Check ModulatedAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

timeSpan=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

start : --is-rst--:py:class:`float`[source]¶: A Float specifying the starting time t0t0. Possible values are non-negative numbers.

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class PeriodicAmplitude(name, frequency, start, a_0, data, timeSpan=STEP)[source]¶

Bases: Amplitude

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

Note

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

Note

Check PeriodicAmplitude on help.3ds.com/2024.

Member Details:

a_0 : --is-rst--:py:class:`float`[source]¶: A Float specifying the constant A0A0.

data : --is-rst--:py:class:`tuple`[source]¶: A sequence of pairs of Floats specifying AiAi and BiBi pairs.

frequency : --is-rst--:py:class:`float`[source]¶: A Float specifying the circular frequency ωω. Possible values are positive numbers.

setValues(timeSpan=STEP)[source]¶

This method modifies the PeriodicAmplitude object.

Note

Check PeriodicAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

timeSpan=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

start : --is-rst--:py:class:`float`[source]¶: A Float specifying the starting time t0t0. Possible values are positive numbers.

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class PsdDefinition( name, data, unitType=FORCE, referenceGravityAcceleration=1, referenecePower=0, user=0, timeSpan=STEP, amplitude='', )[source]¶

Bases: Amplitude

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

Note

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

Note

Check PsdDefinition on help.3ds.com/2024.

Member Details:

amplitude : --is-rst--:py:class:`str` = ''[source]¶: 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.

data : --is-rst--:py:class:`tuple`[source]¶: 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.

referenceGravityAcceleration : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.

referenecePower : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.

setValues( unitType=FORCE, referenceGravityAcceleration=1, referenecePower=0, user=0, timeSpan=STEP, amplitude='', )[source]¶

This method modifies the PsdDefinition object.

Note

Check PsdDefinition.setValues on help.3ds.com/2024.

Parameters:¶

unitType=FORCE¶: 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=1¶: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower=0¶: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user=0¶: 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=STEP¶: 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 –

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

unitType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FORCE'[source]¶: 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.

user : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: 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.

class SmoothStepAmplitude(name, data, timeSpan=STEP)[source]¶

Bases: Amplitude

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.

Note

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

Note

Check SmoothStepAmplitude on help.3ds.com/2024.

Member Details:

data : --is-rst--:py:class:`tuple`[source]¶: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.

setValues(timeSpan=STEP)[source]¶

This method modifies the SmoothStepAmplitude object.

Note

Check SmoothStepAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

timeSpan=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class SolutionDependentAmplitude(name, initial=1, minimum=0, maximum=1000, timeSpan=STEP)[source]¶

Bases: Amplitude

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

Note

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

Note

Check SolutionDependentAmplitude on help.3ds.com/2024.

Member Details:

initial : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1.0.

maximum : --is-rst--:py:class:`float` = 1000[source]¶: A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.0.

minimum : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1.

setValues(initial=1, minimum=0, maximum=1000, timeSpan=STEP)[source]¶

This method modifies the SolutionDependentAmplitude object.

Note

Check SolutionDependentAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

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

Raises:¶

RangeError –

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class SpectrumAmplitude( name, method, data, specificationUnits=ACCELERATION, eventUnits=EVENT_ACCELERATION, solution=ABSOLUTE_VALUE, timeIncrement=0, gravity=1, criticalDamping=0, timeSpan=STEP, amplitude='', )[source]¶

Bases: Amplitude

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.

Note

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

Note

Check SpectrumAmplitude on help.3ds.com/2024.

Member Details:

amplitude : --is-rst--:py:class:`str` = ''[source]¶: 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.

criticalDamping : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: 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.

data : --is-rst--:py:class:`tuple`[source]¶: A sequence of sequences of Floats specifying the magnitude, frequency, and damping values.

eventUnits : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'EVENT_ACCELERATION'[source]¶: 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.

gravity : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the acceleration due to gravity. This argument applies only when specificationUnits = GRAVITY or*eventUnits* = GRAVITY. The default value is 1.0.

method : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant specifying the method for specifying the spectrum. Possible values are DEFINE and CALCULATE.

setValues( specificationUnits=ACCELERATION, eventUnits=EVENT_ACCELERATION, solution=ABSOLUTE_VALUE, timeIncrement=0, gravity=1, criticalDamping=0, timeSpan=STEP, amplitude='', )[source]¶

This method modifies the SpectrumAmplitude object.

Note

Check SpectrumAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

specificationUnits=ACCELERATION¶: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits=EVENT_ACCELERATION¶: 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=ABSOLUTE_VALUE¶: 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=0¶: 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=1¶: 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=0¶: 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=STEP¶: 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 –

solution : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ABSOLUTE_VALUE'[source]¶: A SymbolicConstant specifying the solution method for the dynamic equations. Possible values are ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.

specificationUnits : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ACCELERATION'[source]¶: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.

timeIncrement : --is-rst--:py:class:`float` = 0[source]¶: 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.

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class TabularAmplitude(name, data, smooth=SOLVER_DEFAULT, timeSpan=STEP)[source]¶

Bases: Amplitude

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.

Note

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

Note

Check TabularAmplitude on help.3ds.com/2024.

Member Details:

baselineCorrection : --is-rst--:py:class:`~abaqus.Amplitude.BaselineCorrection.BaselineCorrection` = <abaqus.Amplitude.BaselineCorrection.BaselineCorrection object>[source]¶: A BaselineCorrection object.

data : --is-rst--:py:class:`~typing.Sequence`\ \[:py:class:`~typing.Sequence`\ \[:py:class:`float`]][source]¶: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.

setValues(smooth=SOLVER_DEFAULT, timeSpan=STEP)[source]¶

This method modifies the TabularAmplitude object.

Note

Check TabularAmplitude.setValues on help.3ds.com/2024.

Parameters:¶

smooth=SOLVER_DEFAULT¶: 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=STEP¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Raises:¶

RangeError –

smooth : --is-rst--:py:data:`~typing.Union`\ \[:py:data:`~typing.Literal`\ \[``SOLVER_DEFAULT``], :py:class:`float`] = 'SOLVER_DEFAULT'[source]¶: 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 : --is-rst--:py:data:`~typing.Literal`\ \[``STEP``, ``TOTAL``] = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

class BaselineCorrection(intervals=())[source]¶

Bases: object

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

Note

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

Note

Check BaselineCorrection on help.3ds.com/2024.

Member Details:

intervals : --is-rst--:py:class:`tuple` = ()[source]¶: A sequence of Floats specifying the correction time interval end points. Possible values are positive and monotonically increasing Floats. The default value is an empty sequence.

setValues(*args, **kwargs)[source]¶

This method modifies the BaselineCorrection object.

Raises:¶: RangeError –

class Correlation[source]¶

Bases: Amplitude

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.

Note

This object can be accessed by:

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

Note

Check Correlation on help.3ds.com/2024.

Member Details:

approach : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CORRELATED'[source]¶: 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 : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: 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.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the repository key.

timeSpan : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'STEP'[source]¶: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.