Abaqus Scripting Reference Guide

ABAQUS 2016
SCRIPTING REFERENCE GUIDE

Abaqus ID:
Printed on:
 Abaqus Scripting Reference Guide

Abaqus ID:
Printed on:
 Legal Notices
Abaqus, the 3DS logo, and SIMULIA are commercial trademarks or registered trademarks of Dassault Systèmes or its subsidiaries in the United States
and/or other countries. Use of any Dassault Systèmes or its subsidiaries trademarks is subject to their express written approval.
Abaqus and this documentation may be used or reproduced only in accordance with the terms of the software license agreement signed by the customer, or,
absent such an agreement, the then current software license agreement to which the documentation relates.
This documentation and the software described in this documentation are subject to change without prior notice.
Dassault Systèmes and its subsidiaries shall not be responsible for the consequences of any errors or omissions that may appear in this documentation.
© Dassault Systèmes, 2015
Other company, product, and service names may be trademarks or service marks of their respective owners. For additional information concerning
trademarks, copyrights, and licenses, see the Legal Notices in the Abaqus 2016 Installation and Licensing Guide.

Abaqus ID:
Printed on:
 Preface
This section lists various resources that are available for help with using Abaqus Unified FEA software.

Support

Both technical software support (for problems with creating a model or performing an analysis) and systems
support (for installation, licensing, and hardware-related problems) for Abaqus are offered through a global
network of support offices, as well as through our online support system. Contact information for our
regional offices is accessible from SIMULIA→Locations at www.3ds.com/simulia. The online support
system is accessible by selecting the SUBMIT A REQUEST link at Support - Dassault Systèmes
(http://www.3ds.com/support).

Online support
Dassault Systèmes provides a knowledge base of questions and answers, solutions to questions that we have
answered, and guidelines on how to use Abaqus, Engineering Process Composer, Isight, Tosca, fe-safe, and
other SIMULIA products. The knowledge base is available by using the Search our Knowledge option on
www.3ds.com/support (http://www.3ds.com/support).
By using the online support system, you can also submit new requests for support. All support/service
requests are tracked. If you contact us by means outside the system to discuss an existing support problem
and you know the support request number, please mention it so that we can query the support system to see
what the latest action has been.

Training

All SIMULIA regional offices offer regularly scheduled public training classes. The courses are offered in
a traditional classroom form and via the Web. We also provide training seminars at customer sites. All
training classes and seminars include workshops to provide as much practical experience with Abaqus as
possible. For a schedule and descriptions of available classes, see the Training link at www.3ds.com/products-
services/simulia (www.3ds.com/products-services/simulia) or call your support office.

Feedback

We welcome any suggestions for improvements to Abaqus software, the support tool, or documentation.
We will ensure that any enhancement requests you make are considered for future releases. If you wish to
make a suggestion about the service or products, refer to www.3ds.com/simulia. Complaints should be made
by contacting your support office or by visiting SIMULIA→Quality Assurance at www.3ds.com/simulia
(www.3ds.com/simulia).

Abaqus ID:
Printed on:
Abaqus ID:
Printed on:
Part I: Python commands

Abaqus ID:
Printed on:
 Abaqus/CAE DISPLAY PREFERENCES COMMANDS

1. Abaqus/CAE Display Preferences commands

1.1 caePrefsAccess module

The Python module caePrefsAccess contains functions that enable you to edit the Abaqus/CAE
preferences file, abaqus_2016.gpr.

Access
import caePrefsAccess

1.1.1 getGuiPrefsFileName(...)
This function enables you to retrieve the location of your abaqus_2016.gpr file.

Path
caePrefsAccess.getGuiPrefsFileName

Arguments
None.

Return value
A String with the default file name for the GUI preferences file.

1.1.2 getDisplayNamesInGuiPreferences(...)
The abaqus_2016.gpr file stores a separate guiPreferences record for each display that you
use. This function returns a list of every displayName recorded in the preferences file.

Path
caePrefsAccess.getDisplayNamesInGuiPreferences

Required argument
fileName
A String that specifies the path to the preferences file.
Optional arguments
None.

1–1

Abaqus ID:
Printed on:
Abaqus/CAE DISPLAY PREFERENCES COMMANDS

Return value
A list of Strings of displayNames.

Exceptions
None.

1.1.3 printValuesList(...)
This function enables you to print all of the options and their values for a set of guiPreferences or
sessionOptions settings derived from the abaqus_2016.gpr file.

Path
caePrefsAccess.printValuesList

Required argument
object
The guiPreferences object or sessionOptions object for which you want to print options
and their values.
Optional arguments
maxRecursionDepth
An Int, or SymbolicConstant UNLIMITED, that specifies the depth of recursion when accessing
the attributes of object.
asString
A Boolean specifying how the string representation of each option is printed. If asString is True,
printValuesList prints the str of each option; otherwise printValuesList prints the
repr of the options. The default value is False.

Return value
A String displaying the path, name, and value for all of the options in the object that you select.

Exceptions
None.

1–2

Abaqus ID:
Printed on:
 Abaqus/CAE DISPLAY PREFERENCES COMMANDS

1.1.4 openGuiPreferences(...)
This function enables you to examine and change many default behaviors in the Abaqus/CAE graphical
user interface. Abaqus stores preferences for each display you use in a separate guiPreferences
section of the abaqus_2016.gpr file.

Path
caePrefsAccess.openGuiPreferences

Required argument
displayName
A String that specifies the display for which you want to investigate GUI preferences from the
abaqus_2016.gpr file. You can retrieve the available display names in the file by using the
getDisplayNamesInGuiPreferences method.
Optional argument
fileName
A String specifying the path to the preferences file. The openGuiPreferences method uses
this argument if you are working with a preferences file that is not at the default location.
If this argument is omitted, the abaqus_2016.gpr file in your home directory is opened.

Return value
A CaeGuiPrefs object.

Exceptions
None.

1.1.5 openSessionOptions(...)
This function enables you to examine and change the default behavior for many session options
Abaqus/CAE; that is, the settings that you can save in Abaqus/CAE from the File→Save Display
Options menu option. Abaqus stores default session options in the sessionOptions section of the
abaqus_2016.gpr file.

Path
caePrefsAccess.openSessionOptions

Required arguments
None.

1–3

Abaqus ID:
Printed on:
Abaqus/CAE DISPLAY PREFERENCES COMMANDS

Optional arguments
fileName
A String specifying the path to the preferences file. The openSessionOptions method uses
this argument if you are working with a preferences file that is not at the default location.
If this argument is omitted, the abaqus_2016.gpr file in your home directory is opened.
directory
A SymbolicConstant specifying the location of the preferences file. Possible values are:
• CURRENT to open the preferences file in the current directory
(caePrefsAccess.CURRENT)
• HOME to open the preferences file in your home directory (caePrefsAccess.HOME)
The default value is HOME. Either fileName or directory must be supplied. The fileName or
directory arguments are mutually exclusive.

Return value
A CaeKerPrefs object.

Exceptions
None.

1.2 CaeGuiPrefs object

The CaeGuiPrefs object contains the details of the graphical preferences in a guiPreferences section
of the abaqus_2016.gpr file.

Access
import caePrefsAccess
caePrefsAccess.openGuiPreferences(...)

1.2.1 save(...)
This method saves the guiPreferences section specified in the current fileName.

Arguments
Required arguments
None.

1–4

Abaqus ID:
Printed on:
 Abaqus/CAE DISPLAY PREFERENCES COMMANDS

Optional argument
backupFile
A Boolean specifying whether Abaqus should save a numbered backup copy of the preferences
file, fileName. Default is True.

Return value
None

Exceptions
None.

1.2.2 saveAs(...)
This method saves the guiPreferences settings to the specified location.

Arguments
Required argument
fileName
A String specifying the path to the preferences file.
Optional arguments
None.

Return value
None

Exceptions
None.

1.2.3 Members
The CaeGuiPrefs object has the following member:
fileName
A String specifying the path to the preferences file.

1.3 CaeKerPrefs object

The CaeKerPrefs object contains the details of the sessionOptions.

1–5

Abaqus ID:
Printed on:
Abaqus/CAE DISPLAY PREFERENCES COMMANDS

Access
import caePrefsAccess
caePrefsAccess.openSessionOptions(...)

1.3.1 save(...)
This method saves the sessionOptions in the current fileName.

Arguments
Required arguments
None.
Optional argument
backupFile
A Boolean specifying whether save a numbered backup copy of the preferences file, fileName.
Default is True.

Return value
None

Exceptions
None.

1.3.2 saveAs(...)
This method saves the sessionOptions to the specified location.

Arguments
Required arguments
fileName
A String specifying the path to the preferences file.
directory
A SymbolicConstant specifying the location of the preferences file. Possible values are:

• CURRENT to open the preferences file in the current directory

(caePrefsAccess.CURRENT)
• HOME to open the preferences file in your home directory (caePrefsAccess.HOME)

1–6

Abaqus ID:
Printed on:
 Abaqus/CAE DISPLAY PREFERENCES COMMANDS

The default value is HOME. Either fileName or directory must be supplied. The fileName or
directory arguments are mutually exclusive.
Optional arguments
None.

Return value
None

Exceptions
None.

1.3.3 Members
The CaeKerPrefs object has the following member:
fileName
A String specifying the path to the preferences file that the CaeKerPrefs object represents.

1–7

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

2. Adaptivity commands
The Adaptivity commands are used to define objects, perform analyses, and calculate new meshes for
the following:
• Arbitrary Lagrangian Eularian (ALE) adaptive smoothing (adaptive meshing)
• Varying topology adaptivity (adaptive remeshing)

2.1 AdaptiveMeshConstraint object

The AdaptiveMeshConstraint object is the abstract base type for other Arbitrary Lagrangian Eularian
(ALE) style AdaptiveMeshConstraint objects. The AdaptiveMeshConstraint object has no explicit
constructor. The methods and members of the AdaptiveMeshConstraint object are common to all
objects derived from the AdaptiveMeshConstraint object.

Access
import step
mdb.models[name].adaptiveMeshConstraints[name]

2.1.1 deactivate(...)
This method deactivates the adaptive mesh constraint in the specified step and all subsequent steps.

Arguments
Required argument
stepName
A String specifying the name of the step in which the adaptive mesh constraint is deactivated.
Optional arguments
None.

Return value
None

Exceptions
TextError.

2–1

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

2.1.2 move(...)
This method moves the adaptive mesh constraint state from one step to a different step.

Arguments
Required arguments
fromStepName
A String specifying the name of the step from which the adaptive mesh constraint state is moved.
toStepName
A String specifying the name of the step to which the adaptive mesh constraint state is moved.
Optional arguments
None.

Return value
None

Exceptions
TextError.

2.1.3 reset(...)
This method resets the adaptive mesh constraint state of the specified step to the state of the previous
analysis step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the adaptive mesh constraint state is reset.
Optional arguments
None.

Return value
None

Exceptions
TextError.

2–2

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

2.1.4 resume()
This method resumes the adaptive mesh constraint that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

2.1.5 suppress()
This method suppresses the adaptive mesh constraint.

Arguments
None.

Return value
None

Exceptions
None.

2.1.6 delete(...)
This method allows you to delete existing adaptive mesh constraints.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each adaptive mesh constraint to delete.
Optional arguments
None.

2–3

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Return value
None

Exceptions
None.

2.1.7 Members
The AdaptiveMeshConstraint object can have the following members:
name
A String specifying the adaptive mesh constraint repository key.
category
A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the adaptive mesh constraint is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the adaptive mesh
constraint’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the
global coordinate system. The default value is None.

2.2 AdaptiveMeshConstraintState object

The AdaptiveMeshConstraintState object is the abstract base type for other Arbitrary Lagrangian
Eularian (ALE) style AdaptiveMeshConstraintState objects. The AdaptiveMeshConstraintState object
has no explicit constructor or methods. The members of the AdaptiveMeshConstraintState object are
common to all objects derived from the AdaptiveMeshConstraintState object.

Access
import step
mdb.models[name].steps[name].adaptiveMeshConstraintStates[name]

2.2.1 Members
The AdaptiveMeshConstraintState object has the following members:
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values
are UNSET, SET, UNCHANGED, FREED, and MODIFIED.

2–4

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

status
A SymbolicConstant specifying the propagation state of the AdaptiveMeshConstraintState object.
Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• PROPAGATED_FROM_BASE_STATE
• MODIFIED_FROM_BASE_STATE
• DEACTIVATED_FROM_BASE_STATE
• BUILT_INTO_MODES

amplitude
A String specifying the name of the amplitude reference. The String is empty if the adaptive mesh
constraint has no amplitude reference.

2.3 AdaptiveMeshControl object

The AdaptiveMeshControl object is used to control various aspects of Arbitrary Lagrangian Eularian
(ALE) style adaptive smoothing and advection algorithms applied to an ALE adaptive mesh domain.

Access
import step
mdb.models[name].adaptiveMeshControls[name]

2.3.1 AdaptiveMeshControl(...)
This method creates an AdaptiveMeshControl object.

Path
mdb.models[name].AdaptiveMeshControl

2–5

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Required argument
name
A String specifying the name of the object.
Optional arguments
remapping
A SymbolicConstant specifying the remapping algorithm. Possible values are
FIRST_ORDER_ADVECTION and SECOND_ORDER_ADVECTION. The default value is
SECOND_ORDER_ADVECTION.
smoothingAlgorithm
A SymbolicConstant specifying the type of smoothing algorithm to use. Possible values are
STANDARD and GEOMETRY_ENHANCED. The default value is GEOMETRY_ENHANCED.
smoothingPriority
A SymbolicConstant specifying the type of smoothing to perform. Possible values are UNIFORM
and GRADED. The default value is UNIFORM.
initialFeatureAngle
A Float specifying the initial geometric feature angle, , in degrees. Possible values are 0°
180°. The default value is 30.0.
transitionFeatureAngle
A Float specifying the transitional feature angle, , in degrees. Possible values are 0°
180°. The default value is 30.0.
momentumAdvection
A SymbolicConstant specifying the type of momentum advection algorithm. Possible values
are ELEMENT_CENTER_PROJECTION and HALF_INDEX_SHIFT. The default value is
ELEMENT_CENTER_PROJECTION.
meshingPredictor
A SymbolicConstant specifying the nodal starting location to use for remeshing. Possible values
are CURRENT and PREVIOUS. The default value is CURRENT.
curvatureRefinement
A Float specifying the solution dependence weight, . Possible values are 0.0 1.0. The
default value is 1.0.
volumetricSmoothingWeight
A Float specifying the weight used by Abaqus/Explicit for the volumetric smoothing method. The
default value is 1.0.
laplacianSmoothingWeight
A Float specifying the weight for the Laplacian smoothing method. The default value is 0.0.
equipotentialSmoothingWeight
A Float specifying the weight for the equipotential smoothing method. The default value is 0.0.

2–6

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

meshConstraintAngle
A Float specifying the initial geometric feature angle, . Possible values are 0° 180°.
The default value is 60.0.
originalConfigurationProjectionWeight
A Float specifying the weight for the original configuration projection method. The default value
is 1.0.
standardVolumetricSmoothingWeight
A Float specifying the weight used by Abaqus/Standard for the volumetric smoothing method.
The default value is 0.0.

Return value
An AdaptiveMeshControl object.

Exceptions
RangeError.

2.3.2 setValues(...)
This method modifies the AdaptiveMeshControl object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the
AdaptiveMeshControl method, except for the name argument.

Return value
None

Exceptions
RangeError.

2.3.3 Members
The AdaptiveMeshControl object has members with the same names and descriptions as the arguments
to the AdaptiveMeshControl method.

2–7

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

2.4 AdaptiveMeshDomain object

The AdaptiveMeshDomain object defines the region and controls that govern an Arbitrary Lagrangian
Eularian (ALE) style adaptive smoothing mesh domain.

Access
import step
mdb.models[name].steps[name].adaptiveMeshDomains[name]

2.4.1 AdaptiveMeshDomain(...)
This method creates an AdaptiveMeshDomain object.

Path
mdb.models[name].steps[name].AdaptiveMeshDomain

Required argument
region
A Region object specifying the region to which the adaptive mesh domain is applied.
Optional arguments
controls
A String specifying the name of an AdaptiveMeshControl object.
frequency
An Int specifying the frequency in increments at which adaptive meshing will be performed. The
default value is 10.
initialMeshSweeps
An Int specifying the number of mesh sweeps to be performed at the beginning of the first step in
which this adaptive mesh definition is active. The default value is 5.
meshSweeps
An Int specifying the number of mesh sweeps to be performed in each adaptive mesh increment.
The default value is 1.

Return value
An AdaptiveMeshDomain object.

2–8

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Exceptions
RangeError.

2.4.2 setValues(...)
This method modifies the AdaptiveMeshDomain object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the AdaptiveMeshDomain
method.

Return value
None

Exceptions
RangeError.

2.4.3 Members
The AdaptiveMeshDomain object has members with the same names and descriptions as the arguments
to the AdaptiveMeshDomain method.

2.5 AdaptivityIteration object

The AdaptivityIteration object contains information about a given iteration of the varying topology
adaptivity process (adaptive remeshing).

Access
import job
mdb.adaptivityProcesses[name].iterations[i]

2.5.1 AdaptivityIteration(...)
This method creates an AdaptivityIteration object.

2–9

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Path
mdb.adaptivityProcesses[name].AdaptivityIteration

Required arguments
iteration
An Int specifying the sequence number for this iteration in the adaptivity process.
jobName
A String specifying the name of the job that was run for this iteration.
modelName
A String specifying the name of the model that was analyzed and remeshed in this iteration.
odbPath
A String specifying the path to the ODB file that was created for this iteration.
remeshingErrors
An Int specifying the number of part instances which generated errors while remeshing the model
in this iteration of the adaptivity process.
Optional arguments
None.

Return value
An AdaptivityIteration object.

Exceptions
None.

2.5.2 Members
The AdaptivityIteration object has members with the same names and descriptions as the arguments to
the AdaptivityIteration method.
In addition, the AdaptivityIteration object can have the following member:
ruleResults
A repository of RuleResult objects specifying the calculated results from sizing functions
corresponding to the RemeshingRule objects for this iteration of an adaptivity process.

2.6 AdaptivityProcess object

The AdaptivityProcess object defines a series of jobs that will be submitted for analysis. Abaqus performs
adaptive remeshing between each job.

2–10

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Access
import job
mdb.adaptivityProcesses[name]

2.6.1 AdaptivityProcess(...)
This method creates an AdaptivityProcess object.

Path
mdb.AdaptivityProcess

Required arguments
name
A String specifying the name of the Adaptivity Process.
job
A ModelJob object specifying a job to be used as the prototype for all analysis jobs run by the
adaptivity process.
Optional arguments
maxIterations
An Int specifying the maximum number of analysis jobs that will be run by the Adaptivity Process.
Abaqus performs adaptive remeshing between each analysis. The default value is 3.
jobPrefix
A String specifying the prefix to use for jobs created by the adaptivity process. An empty string
indicates that the name of the adaptivity process should be used. The default value is an empty
string.

Return value
An AdaptivityProcess object.

Exceptions
AbaqusException.

2.6.2 submit(...)
This method begins the process of analysis and adaptive remeshing.

2–11

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Arguments

Required arguments
None.
Optional arguments
waitForCompletion
A Boolean specifying whether to interrupt the execution of a script until the end of the adaptive
remeshing process is reached.
datacheckJob
A Boolean specifying whether to run the adaptivity as a datacheck analysis. The default value is
False. The datacheckJob and continueJob arguments cannot both be True.
continueJob
A Boolean specifying whether to run the adaptivity as a continuation analysis. The default value
is False. The datacheckJob and continueJob arguments cannot both be True.

Return value
None

Exceptions
None.

2.6.3 setValues(...)
This method modifies the AdaptivityProcess object.

Arguments

Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the AdaptivityProcess
method, except for the name argument.

Return value
None

2–12

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Exceptions

2.6.4 Members
The AdaptivityProcess object has members with the same names and descriptions as the arguments to
the AdaptivityProcess method.
In addition, the AdaptivityProcess object can have the following members:
status
A SymbolicConstant specifying the status of the adaptivity process. Possible values are
SUBMITTED, RUNNING, ABORTED, TERMINATED, and COMPLETED.
iterations
A repository of AdaptivityIteration objects specifying the AdaptivityIteration objects received
during running the adaptivity process.

2.7 DisplacementAdaptiveMeshConstraint object

The DisplacementAdaptiveMeshConstraint object stores the data for an Arbitrary Lagrangian Eularian
(ALE) style displacement/rotation adaptive mesh constraint.
The DisplacementAdaptiveMeshConstraint object is derived from the AdaptiveMeshConstraint
object.

Access
import step
mdb.models[name].adaptiveMeshConstraints[name]

2.7.1 DisplacementAdaptiveMeshConstraint(...)
This method creates a DisplacementAdaptiveMeshConstraint object.

Path
mdb.models[name].DisplacementAdaptiveMeshConstraint

Required arguments
name
A String specifying the adaptive mesh constraint repository key.
createStepName
A String specifying the name of the step in which the adaptive mesh constraint is created.

2–13

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

region
A Region object specifying the region to which the adaptive mesh constraint is applied.

Optional arguments
u1
A Float or a SymbolicConstant specifying the displacement component in the 1-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.

Note: Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must
be specified.

u2
A Float or a SymbolicConstant specifying the displacement component in the 2-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
u3
A Float or a SymbolicConstant specifying the displacement component in the 3-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur1
A Float or a SymbolicConstant specifying the rotational displacement component about the 1-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
ur2
A Float or a SymbolicConstant specifying the rotational displacement component about the 2-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
ur3
A Float or a SymbolicConstant specifying the rotational displacement component about the 3-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the adaptive mesh constraint has no amplitude reference. The default
value is UNSET. You should provide the amplitude argument only if it is valid for the specified
step.
motionType
A SymbolicConstant specifying the mesh motion in relation to the underlying material.
Possible values are INDEPENDENT, FOLLOW and USER_DEFINED. The default value is
INDEPENDENT.

2–14

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

localCsys
None or a DatumCsys object specifying the local coordinate system of the adaptive mesh
constraint’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the
global coordinate system. The default value is None.

Return value
A DisplacementAdaptiveMeshConstraint object.

Exceptions
None.

2.7.2 setValues(...)
This method modifies the data for an existing DisplacementAdaptiveMeshConstraint object in the step
where it is created.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the
DisplacementAdaptiveMeshConstraint method, except for the name and
createStepName arguments.

Return value
None

Exceptions
None.

2.7.3 setValuesInStep(...)
This method modifies the propagating data for an existing DisplacementAdaptiveMeshConstraint object
in the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the adaptive mesh constraint is modified.

2–15

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Optional arguments
u1
A Float or a SymbolicConstant specifying the displacement component in the 1-direction. Possible
values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u2
A Float or a SymbolicConstant specifying the displacement component in the 2-direction. Possible
values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u3
A Float or a SymbolicConstant specifying the displacement component in the 3-direction. Possible
values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur1
A Float or a SymbolicConstant specifying the rotational displacement component about the 1-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur2
A Float or a SymbolicConstant specifying the rotational displacement component about the 2-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur3
A Float or a SymbolicConstant specifying the rotational displacement component about the 3-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the adaptive
mesh constraint is changed to have no amplitude reference. You should provide the amplitude
argument only if it is valid for the specified step.

Return value
None

Exceptions
None.

2.7.4 Members
The DisplacementAdaptiveMeshConstraint object can have the following members:
name
A String specifying the adaptive mesh constraint repository key.

2–16

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

category
A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the adaptive mesh constraint is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the adaptive mesh
constraint’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the
global coordinate system. The default value is None.

2.8 DisplacementAdaptiveMeshConstraintState object

The DisplacementAdaptiveMeshConstraintState object stores the propagating data for an Arbitrary

Lagrangian Eularian (ALE) style displacement/rotation adaptive mesh constraint in a step. One instance
of this object is created internally by the DisplacementAdaptiveMeshConstraint object for each step.
The instance is also deleted internally by the DisplacementAdaptiveMeshConstraint object.
The DisplacementAdaptiveMeshConstraintState object has no constructor or methods.
The DisplacementAdaptiveMeshConstraintState object is derived from the
AdaptiveMeshConstraintState object.

Access
import step
mdb.models[name].steps[name].adaptiveMeshConstraintStates[name]

2.8.1 Members
The DisplacementAdaptiveMeshConstraintState object has the following members:
u1
A Float or a Complex specifying the displacement component in the 1-direction.
u2
A Float or a Complex specifying the displacement component in the 2-direction.
u3
A Float or a Complex specifying the displacement component in the 3-direction.
ur1
A Float or a Complex specifying the rotational displacement component about the 1-direction.
ur2
A Float or a Complex specifying the rotational displacement component about the 2-direction.

2–17

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

ur3
A Float or a Complex specifying the rotational displacement component about the 3-direction.
u1State
A SymbolicConstant specifying the propagation state of the displacement component in the 1-
direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
u2State
A SymbolicConstant specifying the propagation state of the displacement component in the 2-
direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
u3State
A SymbolicConstant specifying the propagation state of the displacement component in the 3-
direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur1State
A SymbolicConstant specifying the propagation state of the rotational displacement component
about the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ur2State
A SymbolicConstant specifying the propagation state of the rotational displacement component
about the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ur3State
A SymbolicConstant specifying the propagation state of the rotational displacement component
about the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values
are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status
A SymbolicConstant specifying the propagation state of the AdaptiveMeshConstraintState object.
Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• PROPAGATED_FROM_BASE_STATE

2–18

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

• MODIFIED_FROM_BASE_STATE
• DEACTIVATED_FROM_BASE_STATE
• BUILT_INTO_MODES

amplitude
A String specifying the name of the amplitude reference. The String is empty if the adaptive mesh
constraint has no amplitude reference.

2.8.2 Corresponding analysis keywords

*ADAPTIVE MESH CONSTRAINT, TYPE=DISPLACEMENT (degree of freedom: 1, 2, 3, 4, 5,

or 6)

2.9 ErrorIndicatorResult object

The ErrorIndicatorResult object contains result information corresponding to an error indicator variable
in a RemeshingRule object for an adaptivity iteration.

Access
import job
mdb.adaptivityProcesses[name].iterations[i].ruleResults[name]\
.indicatorResults[name]

2.9.1 ErrorIndicatorResult(...)
This method creates an ErrorIndicatorResult with data for an error indicator variable in a RemeshingRule
for a given adaptivity iteration.

Path
mdb.adaptivityProcesses[name].iterations[i].ruleResults[name]\
.ErrorIndicatorResult

Required arguments
name
A String specifying the name of the error indicator variable to which these results correspond.

2–19

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

results
A String-to-Float Dictionary specifying the calculated results from the sizing function
corresponding to the error indicator variable represented by this ErrorIndicatorResult.
Optional arguments
None.

Return value
An ErrorIndicatorResult object.

Exceptions
AbaqusException.

2.9.2 Members
The ErrorIndicatorResult object has members with the same names and descriptions as the arguments to
the ErrorIndicatorResult method.

2.10 Model object

The following commands operate on Model objects. For more information about the Model object, see
“Model object,” Section 33.1.

Access
import mesh

2.10.1 adaptiveRemesh(...)
This method remeshes the model using the active remesh rules in the model and the error indicator results
from a previous analysis.

Arguments
Required argument
odb
An Odb object containing error output field results.
Optional arguments
None.

2–20

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Return value
An AdaptivityIteration Object.

Exceptions
None.

2.11 RemeshingRule object

The RemeshingRule object controls the adaptive remeshing resizing and the error indicators written to
the output database for a specified region of the model.

Access
import mesh
mdb.models[name].remeshingRules[name]

2.11.1 RemeshingRule(...)
This method creates a RemeshingRule object.

Path
mdb.models[name].RemeshingRule

Required arguments
name
A String specifying the name of the object.
stepName
A String specifying the name of the step in which resizing should occur for this rule.
variables
A sequence of Strings specifying the output request variables that Abaqus will use as error
indicators.
Optional arguments
description
A String specifying a descriptive string for this rule. The default value is an empty string.

2–21

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

region
The SymbolicConstant MODEL or a Region object specifying the region in which Abaqus will
remesh and generate output. The SymbolicConstant MODEL represents the entire applicable
model. The default value is MODEL.
sizingMethod
A SymbolicConstant specifying the method for calculating the new mesh sizes. The
SymbolicConstant DEFAULT indicates that Abaqus will use the default calculation method
for each individual variable. Possible values are DEFAULT, UNIFORM_ERROR, and
MINIMUM_MAXIMUM. The default value is DEFAULT.
errorTarget
A Float specifying the target error percentage for each variable in the region. A value of 0.0
indicates that Abaqus will use automated error target reduction for the region. You use the
errorTarget argument when sizingMethod=UNIFORM_ERROR. The default value is 0.0.
maxSolutionErrorTarget
A Float specifying the target error percentage at the location of the maximum solution
value in the region. A value of 0.0 indicates that Abaqus will use automated error
target reduction for the region. You use the maxSolutionErrorTarget argument when
sizingMethod=MINIMUM_MAXIMUM. The default value is 0.0.
minSolutionErrorTarget
A Float specifying the target error percentage at the location of the minimum solution
value in the region. A value of 0.0 indicates that Abaqus will use automated error
target reduction for the region. You use the minSolutionErrorTarget argument when
sizingMethod=MINIMUM_MAXIMUM. The default value is 0.0.
meshBias
An Int specifying an indication of how much Abaqus will bias the mesh toward the location
of the maximum solution value in the region. The higher the value, the more the mesh will
bias towards the location of the maximum solution value. You use the meshBias argument when
sizingMethod=MINIMUM_MAXIMUM. The default value is 0.0.
minElementSize
A Float specifying the minimum size of any single element. The default value is 0.0.
maxElementSize
A Float specifying the maximum size of any single element. The default value is 0.0.
outputFrequency
A SymbolicConstant specifying the frequency with which the error indicators are saved to the
output database file (.odb). Possible values are LAST_INCREMENT and ALL_INCREMENTS.
The default value is LAST_INCREMENT.
specifyMinSize
A Boolean specifying an indication of whether to use a user-supplied minimum element size or to
calculate a characteristic minimum element size. The default value is OFF.

2–22

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

specifyMaxSize
A Boolean specifying an indication of whether to use a user-supplied maximum element size or to
calculate a characteristic maximum element size. The default value is ON.
coarseningFactor
A SymbolicConstant or an Int specifying an indication of the upper limit on the element
growth from one remeshing iteration to the next. Possible values are DEFAULT_LIMIT and
NOT_ALLOWED. The default value is DEFAULT_LIMIT.
refinementFactor
A SymbolicConstant or an Int specifying an indication of the upper limit on element shrinkage from
one remeshing iteration to the next. Possible values are DEFAULT_LIMIT and NOT_ALLOWED.
The default value is DEFAULT_LIMIT.
elementCountLimit
None or an Int specifying an approximate limit on the number of elements that will be created
during remeshing. Use None to indicate there is not upper limit. The default value is None.

Return value
A RemeshingRule object.

Exceptions
AbaqusException.

2.11.2 resume()
This method resumes the remeshing rule that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

2.11.3 suppress()
This method suppresses the remeshing rule. Abaqus will not remesh regions where the rules are
suppressed.

2–23

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

2.11.4 setValues(...)
This method modifies the RemeshingRule object.

Arguments

Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the RemeshingRule method,
except for the name argument.

Return value
None

Exceptions

2.11.5 Members
The RemeshingRule object has members with the same names and descriptions as the arguments to the
RemeshingRule method.
In addition, the RemeshingRule object has the following member:
suppressed
A Boolean specifying whether the remeshing rule is suppressed. Remeshing of the remeshing
rule’s region will not occur if you suppress a rule. The default value is OFF.

2–24

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

2.12 RuleResult object

The RuleResult object contains result information corresponding to a RemeshingRule object for an
adaptivity iteration.

Access
import job
mdb.adaptivityProcesses[name].iterations[i].ruleResults[name]

2.12.1 RuleResult(...)
This method creates a RuleResult with data for a RemeshingRule for a given adaptivity iteration.

Path
mdb.adaptivityProcesses[name].iterations[i].RuleResult

Required arguments
name
A String specifying the name of the Remeshing Rule to which these results correspond.
indicatorResults
A repository of ErrorIndicatorResult objects specifying the calculated results from the sizing
function corresponding to the error indicator variables for the Remeshing Rule.
numElems
An Int specifying the number of elements before remeshing in the region of the Remeshing Rule.
minSizeElemCount
An Int specifying the number of elements that were constrained to the minimum element size by
the Remeshing Rule.
Optional argument
satisfiedVars
A sequence of Strings specifying the error indicator variables that have satisfied the Remeshing
Rule.

Return value
A RuleResult object.

Exceptions
AbaqusException.

2–25

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

2.12.2 Members
The RuleResult object has members with the same names and descriptions as the arguments to the
RuleResult method.

2.13 VelocityAdaptiveMeshConstraint object

The VelocityAdaptiveMeshConstraint object stores the data for an Arbitrary Lagrangian Eularian (ALE)
style velocity adaptive mesh constraint.
The VelocityAdaptiveMeshConstraint object is derived from the AdaptiveMeshConstraint object.

Access
import step
mdb.models[name].adaptiveMeshConstraints[name]

2.13.1 VelocityAdaptiveMeshConstraint(...)
This method creates a VelocityAdaptiveMeshConstraint object.

Path
mdb.models[name].VelocityAdaptiveMeshConstraint

Required arguments
name
A String specifying the adaptive mesh constraint repository key.
createStepName
A String specifying the name of the step in which the adaptive mesh constraint is created.
region
A Region object specifying the region to which the adaptive mesh constraint is applied.
Optional arguments
v1
A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.

Note: Although v1, v2, v3, vr1, vr2, and vr3 are optional arguments, at least one of them must be
specified.

2–26

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

v2
A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
v3
A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr1
A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction.
Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr2
A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction.
Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr3
A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction.
Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the adaptive mesh constraint has no amplitude reference. The default
value is UNSET. You should provide the amplitude argument only if it is valid for the specified
step.
localCsys
None or a DatumCsys object specifying the local coordinate system of the adaptive mesh
constraint’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the
global coordinate system. The default value is None.
motionType
A SymbolicConstant specifying the mesh motion in relation to the underlying material.
Possible values are INDEPENDENT, FOLLOW and USER_DEFINED. The default value is
INDEPENDENT.

Return value
A VelocityAdaptiveMeshConstraint object.

Exceptions
None.

2.13.2 setValues(...)
This method modifies the data for an existing VelocityAdaptiveMeshConstraint object in the step where
it is created.

2–27

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the
VelocityAdaptiveMeshConstraint method, except for the name and createStepName
arguments.

Return value
None

Exceptions
None.

2.13.3 setValuesInStep(...)
This method modifies the propagating data for an existing VelocityAdaptiveMeshConstraint object in
the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the adaptive mesh constraint is modified.
Optional arguments
v1
A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible
values for the SymbolicConstant are SET and FREED.
v2
A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible
values for the SymbolicConstant are SET and FREED.
v3
A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible
values for the SymbolicConstant are SET and FREED.
vr1
A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction.
Possible values for the SymbolicConstant are SET and FREED.

2–28

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

vr2
A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction.
Possible values for the SymbolicConstant are SET and FREED.
vr3
A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction.
Possible values for the SymbolicConstant are SET and FREED.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the adaptive
mesh constraint is changed to have no amplitude reference. You should provide the amplitude
argument only if it is valid for the specified step.

Return value
None

Exceptions
None.

2.13.4 Members
The VelocityAdaptiveMeshConstraint object can have the following members:
name
A String specifying the adaptive mesh constraint repository key.
category
A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the adaptive mesh constraint is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the adaptive mesh
constraint’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the
global coordinate system. The default value is None.

2.14 VelocityAdaptiveMeshConstraintState object

The VelocityAdaptiveMeshConstraintState object stores the propagating data for an Arbitrary

Lagrangian Eularian (ALE) style velocity adaptive mesh constraint in a step. One instance of this object

2–29

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

is created internally by the VelocityAdaptiveMeshConstraint object for each step. The instance is also
deleted internally by the VelocityAdaptiveMeshConstraint object.
The VelocityAdaptiveMeshConstraintState object has no constructor or methods.
The VelocityAdaptiveMeshConstraintState object is derived from the
AdaptiveMeshConstraintState object.

Access
import step
mdb.models[name].steps[name].adaptiveMeshConstraintStates[name]

2.14.1 Members
The VelocityAdaptiveMeshConstraintState object has the following members:
v1
A Float specifying the velocity component in the 1-direction.
v2
A Float specifying the velocity component in the 2-direction.
v3
A Float specifying the velocity component in the 3-direction.
vr1
A Float specifying the rotational velocity component about the 1-direction.
vr2
A Float specifying the rotational velocity component about the 2-direction.
vr3
A Float specifying the rotational velocity component about the 3-direction.
v1State
A SymbolicConstant specifying the propagation state of the velocity component in the 1-direction.
Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v2State
A SymbolicConstant specifying the propagation state of the velocity component in the 2-direction.
Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v3State
A SymbolicConstant specifying the propagation state of the velocity component in the 3-direction.
Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr1State
A SymbolicConstant specifying the propagation state of the rotational velocity component about
the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.

2–30

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

vr2State
A SymbolicConstant specifying the propagation state of the rotational velocity component about
the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr3State
A SymbolicConstant specifying the propagation state of the rotational velocity component about
the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values
are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status
A SymbolicConstant specifying the propagation state of the AdaptiveMeshConstraintState object.
Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• PROPAGATED_FROM_BASE_STATE
• MODIFIED_FROM_BASE_STATE
• DEACTIVATED_FROM_BASE_STATE
• BUILT_INTO_MODES

amplitude
A String specifying the name of the amplitude reference. The String is empty if the adaptive mesh
constraint has no amplitude reference.

2.14.2 Corresponding analysis keywords

*ADAPTIVE MESH CONSTRAINT, TYPE=VELOCITY (degree of freedom: 1, 2, 3, 4, 5, or 6)

2–31

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

3. Amplitude commands
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.

3.1 Amplitude 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.

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

3.1.1 Members
The Amplitude object has the following members:
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.

3.2 ActuatorAmplitude object

The ActuatorAmplitude object defines an actuator amplitude curve.

The ActuatorAmplitude object is derived from the Amplitude object.

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

3–1

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

3.2.1 ActuatorAmplitude(...)
This method creates a ActuatorAmplitude object.

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

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

Return value
An ActuatorAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.2.2 setValues(...)
This method modifies the ActuatorAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the ActuatorAmplitude
method, except for the name argument.

Return value
None

Exceptions
RangeError.

3–2

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

3.2.3 Members
The ActuatorAmplitude object has members with the same names and descriptions as the arguments to
the ActuatorAmplitude method.

3.2.4 Corresponding analysis keywords

*AMPLITUDE

3.3 BaselineCorrection 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.

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

3.3.1 BaselineCorrection(...)
This method creates a BaselineCorrection object.

Path
mdb.models[name].amplitudes[name].BaselineCorrection
session.odbs[name].amplitudes[name].BaselineCorrection

Required arguments
None.
Optional argument
intervals
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.

3–3

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Return value
A BaselineCorrection object.

Exceptions
RangeError.

3.3.2 setValues(...)
This method modifies the BaselineCorrection object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the BaselineCorrection
method.

Return value
None

Exceptions
RangeError.

3.3.3 Members
The BaselineCorrection object has members with the same names and descriptions as the arguments to
the BaselineCorrection method.

3.3.4 Corresponding analysis keywords

*BASELINE CORRECTION

3.4 Correlation object

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

3–4

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

The Correlation object is derived from the Amplitude object.

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

3.4.1 Members
The Correlation object has the following members:
name
A String specifying the repository key.
approach
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
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
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and
TOTAL. The default value is STEP.

3.5 DecayAmplitude object

The DecayAmplitude object defines an amplitude curve using an exponential decay.

The DecayAmplitude object is derived from the Amplitude object.

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

3.5.1 DecayAmplitude(...)
This method creates a DecayAmplitude object.

3–5

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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

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

Return value
A DecayAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.5.2 setValues(...)
This method modifies the DecayAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the DecayAmplitude
method, except for the name argument.

3–6

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Return value
None

Exceptions
RangeError.

3.5.3 Members
The DecayAmplitude object has members with the same names and descriptions as the arguments to the
DecayAmplitude method.

3.5.4 Corresponding analysis keywords

*AMPLITUDE

3.6 EquallySpacedAmplitude object

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.

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

3.6.1 EquallySpacedAmplitude(...)
This method creates an EquallySpacedAmplitude object.

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

3–7

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Required arguments
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.
Optional arguments
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.

Return value
An EquallySpacedAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.6.2 setValues(...)
This method modifies the EquallySpacedAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the
EquallySpacedAmplitude method, except for the name argument.

3–8

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Return value
None

Exceptions
RangeError.

3.6.3 Members
The EquallySpacedAmplitude object has members with the same names and descriptions as the
arguments to the EquallySpacedAmplitude method.
In addition, the EquallySpacedAmplitude object can have the following member:
baselineCorrection
A BaselineCorrection object.

3.6.4 Corresponding analysis keywords

*AMPLITUDE

3.7 ModulatedAmplitude object

The ModulatedAmplitude object defines a modulated amplitude curve.

The ModulatedAmplitude object is derived from the Amplitude object.

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

3.7.1 ModulatedAmplitude(...)
This method creates a ModulatedAmplitude object.

Path
mdb.models[name].ModulatedAmplitude

3–9

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

session.odbs[name].ModulatedAmplitude

Required arguments
name
A String specifying the repository key.
initial
A Float specifying the constant .
magnitude
A Float specifying the coefficient .
start
A Float specifying the starting time . Possible values are non-negative numbers.
frequency1
A Float specifying the circular frequency 1 ( ). Possible values are positive numbers.
frequency2
A Float specifying the circular frequency 2 ( ). Possible values are positive numbers.
Optional argument
timeSpan
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and
TOTAL. The default value is STEP.

Return value
A ModulatedAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.7.2 setValues(...)
This method modifies the ModulatedAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the ModulatedAmplitude
method, except for the name argument.

3–10

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Return value
None

Exceptions
RangeError.

3.7.3 Members
The ModulatedAmplitude object has members with the same names and descriptions as the arguments
to the ModulatedAmplitude method.

3.7.4 Corresponding analysis keywords

*AMPLITUDE

3.8 PeriodicAmplitude object

The PeriodicAmplitude object defines an amplitude curve using a Fourier series.

The PeriodicAmplitude object is derived from the Amplitude object.

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

3.8.1 PeriodicAmplitude(...)
This method creates a PeriodicAmplitude object.

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

3–11

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Required arguments
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 . Possible values are positive numbers.
a_0
A Float specifying the constant .
data
A sequence of pairs of Floats specifying and pairs.
Optional argument
timeSpan
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and
TOTAL. The default value is STEP.

Return value
A PeriodicAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.8.2 setValues(...)
This method modifies the PeriodicAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the PeriodicAmplitude
method, except for the name argument.

Return value
None

3–12

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Exceptions
RangeError.

3.8.3 Members
The PeriodicAmplitude object has members with the same names and descriptions as the arguments to
the PeriodicAmplitude method.

3.8.4 Corresponding analysis keywords

*AMPLITUDE

3.9 PsdDefinition object

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

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

3.9.1 PsdDefinition(...)
This method creates a PsdDefinition object.

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

Required arguments
name
A String specifying the repository key.

3–13

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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.
Optional arguments
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.

Return value
A PsdDefinition object.

Exceptions
InvalidNameError and RangeError.

3.9.2 setValues(...)
This method modifies the PsdDefinition object.

Arguments
Required arguments
None.

3–14

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the PsdDefinition method,
except for the name argument.

Return value
None

Exceptions
RangeError.

3.9.3 Members
The PsdDefinition object has members with the same names and descriptions as the arguments to the
PsdDefinition method.

3.9.4 Corresponding analysis keywords

*PSD-DEFINITION

3.10 SmoothStepAmplitude object

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.

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

3.10.1 SmoothStepAmplitude(...)
This method creates a SmoothStepAmplitude object.

3–15

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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

Required arguments
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.
Optional argument
timeSpan
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and
TOTAL. The default value is STEP.

Return value
A SmoothStepAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.10.2 setValues(...)
This method modifies the SmoothStepAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the
SmoothStepAmplitude method, except for the name argument.

Return value
None

Exceptions
RangeError.

3–16

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

3.10.3 Members
The SmoothStepAmplitude object has members with the same names and descriptions as the arguments
to the SmoothStepAmplitude method.

3.10.4 Corresponding analysis keywords

*AMPLITUDE

3.11 SolutionDependentAmplitude object

The SolutionDependentAmplitude object defines a solution-dependent amplitude for superplastic

forming analysis.
The SolutionDependentAmplitude object is derived from the Amplitude object.

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

3.11.1 SolutionDependentAmplitude(...)
This method creates a SolutionDependentAmplitude object.

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

Required argument
name
A String specifying the repository key.
Optional arguments
initial
A Float specifying the initial amplitude value. Possible values are those between minimum and
maximum. The default value is 1.0.

3–17

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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.

Return value
A SolutionDependentAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.11.2 setValues(...)
This method modifies the SolutionDependentAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the
SolutionDependentAmplitude method, except for the name argument.

Return value
None

Exceptions
RangeError.

3.11.3 Members
The SolutionDependentAmplitude object has members with the same names and descriptions as the
arguments to the SolutionDependentAmplitude method.

3–18

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

3.11.4 Corresponding analysis keywords

*AMPLITUDE

3.12 SpectrumAmplitude object

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.

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

3.12.1 SpectrumAmplitude(...)
This method creates a SpectrumAmplitude object.

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

Required arguments
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.

3–19

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Optional arguments
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 oreventUnits = 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.

Return value
A SpectrumAmplitude object.

Exceptions
InvalidNameError and RangeError.

3–20

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

3.12.2 setValues(...)
This method modifies the SpectrumAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the SpectrumAmplitude
method, except for the name argument.

Return value
None

Exceptions
RangeError.

3.12.3 Members
The SpectrumAmplitude object has members with the same names and descriptions as the arguments to
the SpectrumAmplitude method.

3.12.4 Corresponding analysis keywords

*SPECTRUM

3.13 TabularAmplitude object

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.

Access
import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude

3–21

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

session.odbs[name].amplitudes[name]

3.13.1 TabularAmplitude(...)
This method creates a TabularAmplitude object.

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

Required arguments
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.
Optional arguments
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.

Return value
A TabularAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.13.2 setValues(...)
This method modifies the TabularAmplitude object.

Arguments
Required arguments
None.

3–22

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the TabularAmplitude
method, except for the name argument.

Return value
None

Exceptions
RangeError.

3.13.3 Members
The TabularAmplitude object has members with the same names and descriptions as the arguments to
the TabularAmplitude method.
In addition, the TabularAmplitude object can have the following member:
baselineCorrection
A BaselineCorrection object.

3.13.4 Corresponding analysis keywords

*AMPLITUDE

3.14 UserAmplitude object

The UserAmplitude object defines an amplitude curve using the UAMP or VUAMP user subroutine.
The UserAmplitude object is derived from the Amplitude object.

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

3.14.1 UserAmplitude(...)
This method creates a UserAmplitude object.

3–23

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Path
mdb.models[name].UserAmplitude
session.odbs[name].UserAmplitude

Required arguments
name
A String specifying the repository key.
numVariables
An Int specifying the number of variables for the UAMP or VUAMP user subroutine.
Optional argument
timeSpan
A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and
TOTAL. The default value is STEP.

Return value
A UserAmplitude object.

Exceptions
InvalidNameError and RangeError.

3.14.2 setValues(...)
This method modifies the UserAmplitude object.

Arguments
Required arguments
None.
Optional arguments
The optional arguments to setValues are the same as the arguments to the UserAmplitude method,
except for the name argument.

Return value
None

Exceptions
RangeError.

3–24

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

3.14.3 Members
The UserAmplitude object has members with the same names and descriptions as the arguments to the
UserAmplitude method.

3.14.4 Corresponding analysis keywords

*AMPLITUDE

3–25

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

4. Animation commands

4.1 AnimationController object

The AnimationController object controls all object-based animation to be displayed in the viewports.
The AnimationController object has no constructor. Abaqus creates the animationController member
when it creates the Session object.

Access
import animation
session.animationController

4.1.1 play(...)
This method begins the animation.

Arguments
Required arguments
None.
Optional argument
duration
The SymbolicConstant UNLIMITED or an Int specifying how many seconds to play the animation.
The default value is UNLIMITED.

Return value
None

Exceptions
If animationType=NONE:
AnimationError: animationType not set

4.1.2 stop()
This method stops the animation.

4–1

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

4.1.3 incrementFrame()
This method increments the animation frame.

Arguments
None.

Return value
None

Exceptions
None.

4.1.4 decrementFrame()
This method decrements the animation frame.

Arguments
None.

Return value
None

Exceptions
None.

4–2

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

4.1.5 showFrame(...)
This method renders the specified frame of the animation.

Arguments
Required arguments
None.
Optional arguments
frame
An Int specifying the frame number.
value
A Float specifying the frame: for animationType=TIME_HISTORY the frame with the time
nearest to this value, for animationType=HARMONIC the frame with the angle nearest to this
value, for animationType=SCALE_FACTOR the frame with the scale value nearest to this value.

Return value
None

Exceptions
None.

4.1.6 showFirstFrame()
This method renders the first frame of the animation.

Arguments
None.

Return value
None

Exceptions
None.

4.1.7 showLastFrame()
This method renders the last frame of the animation.

4–3

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

4.1.8 setValues(...)
This method modifies the AnimationController object.

Arguments
Required arguments
None.
Optional arguments
animationType
A SymbolicConstant specifying the type of movie to play. Possible values are SCALE_FACTOR,
HARMONIC, TIME_HISTORY, and NONE. The default value is NONE.
viewports
A sequence of pairs of Strings specifying the name of a viewport where the animation is active
followed by a layer name, or the SymbolicConstant ALL. If a layer name is not supplied, the
current layer is used. If the viewport is in single display mode, the layer name is ignored if it is
specified. The default value is an empty sequence.

Return value
None

Exceptions
RangeError.

4.1.9 Members
The AnimationController object can have the following members:
animationType
A SymbolicConstant specifying the type of movie to play. Possible values are SCALE_FACTOR,
HARMONIC, TIME_HISTORY, and NONE. The default value is NONE.

4–4

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

state
A SymbolicConstant specifying the state of the animation controller. Possible values are STOP
and PLAY. The default value is STOP.
animationOptions
An AnimationOptions object.
viewports
A tuple of pairs of Strings specifying the name of a viewport where the animation is active followed
by a layer name, or the SymbolicConstant ALL. If a layer name is not supplied, the current layer
is used. If the viewport is in single display mode, the layer name is ignored if it is specified. The
default value is an empty sequence.

4.2 AnimationOptions object

The AnimationOptions object is used to store values and attributes associated with an
AnimationController object.
The AnimationOptions object has no constructor command. Abaqus creates the animationOptions
member when it creates the AnimationController object.

Access
import animation
session.animationController.animationOptions

4.2.1 setValues(...)
This method modifies the AnimationOptions object.

Arguments
Required arguments
None.
Optional arguments
mode
A SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP,
LOOP_BACKWARD, and SWING. The default value is LOOP.
frameRate
An Int specifying the animation rate in frames/second. Possible values are 1 frameRate 100.
The default value is 50.
frameCounter
A Boolean specifying whether to show the frame counter. The default value is ON.

4–5

Abaqus ID:
Printed on:
ANIMATION COMMANDS

relativeScaling
A SymbolicConstant specifying the relative scaling when the AnimationController object’s
animationType=SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE and
HALF_CYCLE. The default value is HALF_CYCLE.
numScaleFactorFrames
An Int specifying the number of frames to be used when the AnimationController object’s
animationType=SCALE_FACTOR or HARMONIC. The default value is 7.
timeHistoryMode
A SymbolicConstant specifying whether the time history animation is time based or frame based.
Possible values are FRAME_BASED and TIME_BASED. The default value is FRAME_BASED.
maxTime
A Float specifying the maximum time for time based time history animation when
maxTimeAutoCompute = False.
maxTimeAutoCompute
A Boolean specifying whether the animation maximum time value should be computed from the
active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.
minTime
A Float specifying the minimum time for time based time history animation when
minTimeAutoCompute = False.
minTimeAutoCompute
A Boolean specifying whether the animation minimum time value should be computed from the
active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.
timeIncrement
A Float specifying the time increment for frame selection when timeHistoryMode is set to
TIME_BASED.
xyUseHighlightMethod
A Boolean specifying whether to use the highlight method to draw the time tracker line and
symbols. The default value is ON.
xyShowLine
A Boolean specifying whether to show the time tracker line. The default value is ON.
xyLineStyle
A SymbolicConstant specifying the X–Y time tracker line style. Possible values are SOLID,
DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
xyLineThickness
A SymbolicConstant specifying the X–Y time tracker line thickness. Possible values are
VERY_THIN, THIN, MEDIUM, and THICK. The default value is MEDIUM.
xyLineColor
A String specifying the color used to plot the X–Y time tracker line when xyUseHighlightMethod
= False. The default value is "Yellow".

4–6

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

xyShowSymbol
A Boolean specifying whether to show the time tracker symbols. The default value is ON.
xySymbolMarker
A SymbolicConstant specifying the marker type to be used for all animation capable X–Y curve
or the SymbolicConstant DEFAULT specifying that the system will take the marker associated to
each curve Possible values are:
• FILLED_CIRCLE
• FILLED_SQUARE
• FILLED_DIAMOND
• FILLED_TRI
• HOLLOW_CIRCLE
• HOLLOW_SQUARE
• HOLLOW_DIAMOND
• HOLLOW_TRI
• CROSS
• XMARKER
• DEFAULT
The default value is DEFAULT.
xySymbolSize
A SymbolicConstant specifying the size of the markers. Possible values are SMALL, MEDIUM,
and LARGE. The default value is MEDIUM.
xySymbolColor
A String specifying the color used to plot X–Y time tracker symbols when xyUseHighlightMethod
= False. When setting the color to ’Default’ the system will take the color associated to each curve.
The default value is "Default".

Return value
None

Exceptions
None.

4.2.2 Members
The AnimationOptions object can have the following members:
mode
A SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP,
LOOP_BACKWARD, and SWING. The default value is LOOP.

4–7

Abaqus ID:
Printed on:
ANIMATION COMMANDS

frameRate
An Int specifying the animation rate in frames/second. Possible values are 1 frameRate 100.
The default value is 50.
frameCounter
A Boolean specifying whether to show the frame counter. The default value is ON.
relativeScaling
A SymbolicConstant specifying the relative scaling when the AnimationController object’s
animationType=SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE and
HALF_CYCLE. The default value is HALF_CYCLE.
numScaleFactorFrames
An Int specifying the number of frames to be used when the AnimationController object’s
animationType=SCALE_FACTOR or HARMONIC. The default value is 7.
timeHistoryMode
A SymbolicConstant specifying whether the time history animation is time based or frame based.
Possible values are FRAME_BASED and TIME_BASED. The default value is FRAME_BASED.
maxTime
A Float specifying the maximum time for time based time history animation when
maxTimeAutoCompute = False.
maxTimeAutoCompute
A Boolean specifying whether the animation maximum time value should be computed from the
active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.
maxTimeAutoValue
A Float specifying the maximum time when timeHistoryMode is set to TIME_BASED and the
maxTimeAutoCompute value is True. This value is computed as the maximum time of all active
frames displayed in viewports where the animation is active.
minTime
A Float specifying the minimum time for time based time history animation when
minTimeAutoCompute = False.
minTimeAutoCompute
A Boolean specifying whether the animation minimum time value should be computed from the
active frames when timeHistoryMode is set to TIME_BASED. The default value is ON.
minTimeAutoValue
A Float specifying the minimum time when timeHistoryMode is set to TIME_BASED and the
minTimeAutoCompute value is True. This value is computed as the minimum time of all active
frames displayed in viewports where the animation is active.
timeIncrement
A Float specifying the time increment for frame selection when timeHistoryMode is set to
TIME_BASED.

4–8

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

xyUseHighlightMethod
A Boolean specifying whether to use the highlight method to draw the time tracker line and
symbols. The default value is ON.
xyShowLine
A Boolean specifying whether to show the time tracker line. The default value is ON.
xyLineStyle
A SymbolicConstant specifying the X–Y time tracker line style. Possible values are SOLID,
DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
xyLineThickness
A SymbolicConstant specifying the X–Y time tracker line thickness. Possible values are
VERY_THIN, THIN, MEDIUM, and THICK. The default value is MEDIUM.
xyShowSymbol
A Boolean specifying whether to show the time tracker symbols. The default value is ON.
xySymbolMarker
A SymbolicConstant specifying the marker type to be used for all animation capable X–Y curve
or the SymbolicConstant DEFAULT specifying that the system will take the marker associated to
each curve Possible values are:

• FILLED_CIRCLE
• FILLED_SQUARE
• FILLED_DIAMOND
• FILLED_TRI
• HOLLOW_CIRCLE
• HOLLOW_SQUARE
• HOLLOW_DIAMOND
• HOLLOW_TRI
• CROSS
• XMARKER
• DEFAULT