Abaqus Scripting Reference Manual

Abaqus ID:
Printed on:
 Abaqus Scripting Reference Manual

Abaqus ID:
Printed on:
 Legal Notices
CAUTION: This documentation is intended for qualified users who will exercise sound engineering judgment and expertise in the use of the Abaqus
Software. The Abaqus Software is inherently complex, and the examples and procedures in this documentation are not intended to be exhaustive or to apply
to any particular situation. Users are cautioned to satisfy themselves as to the accuracy and results of their analyses.
Dassault Systèmes and its subsidiaries, including Dassault Systèmes Simulia Corp., shall not be responsible for the accuracy or usefulness of any analysis
performed using the Abaqus Software or the procedures, examples, or explanations in this documentation. Dassault Systèmes and its subsidiaries shall not
be responsible for the consequences of any errors or omissions that may appear in this documentation.
The Abaqus Software is available only under license from Dassault Systèmes or its subsidiary and may be used or reproduced only in accordance with the
terms of such license. This documentation is subject to the terms and conditions of either the software license agreement signed by the parties, 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.
No part of this documentation may be reproduced or distributed in any form without prior written permission of Dassault Systèmes or its subsidiary.
The Abaqus Software is a product of Dassault Systèmes Simulia Corp., Providence, RI, USA.
© Dassault Systèmes, 2010
Abaqus, the 3DS logo, SIMULIA, CATIA, and Unified FEA are trademarks or registered trademarks of Dassault Systèmes or its subsidiaries in the United
States and/or other countries.
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 6.10 Release Notes and the notices at:
http://www.simulia.com/products/products_legal.html.

Abaqus ID:
Printed on:
 Locations
SIMULIA Worldwide Headquarters Rising Sun Mills, 166 Valley Street, Providence, RI 02909–2499, Tel: +1 401 276 4400,
Fax: +1 401 276 4408, [email protected] http://www.simulia.com
SIMULIA European Headquarters Gaetano Martinolaan 95, P. O. Box 1637, 6201 BP Maastricht, The Netherlands, Tel: +31 43 356 6906,
Fax: +31 43 356 6908, [email protected]

Technical Support Centers

United States Fremont, CA, Tel: +1 510 794 5891, [email protected]
West Lafayette, IN, Tel: +1 765 497 1373, [email protected]
Northville, MI, Tel: +1 248 349 4669, [email protected]
Woodbury, MN, Tel: +1 612 424 9044, [email protected]
Beachwood, OH, Tel: +1 216 378 1070, [email protected]
West Chester, OH, Tel: +1 513 275 1430, [email protected]
Warwick, RI, Tel: +1 401 739 3637, [email protected]
Lewisville, TX, Tel: +1 972 221 6500, [email protected]
Australia Richmond VIC, Tel: +61 3 9421 2900, [email protected]
Austria Vienna, Tel: +43 1 22 707 200, [email protected]
Benelux Huizen, The Netherlands, Tel: +31 35 52 58 424, [email protected]
Canada Toronto, ON, Tel: +1 416 402 2219, [email protected]
China Beijing, P. R. China, Tel: +8610 6536 2288, [email protected]
Shanghai, P. R. China, Tel: +8621 3856 8000, [email protected]
Czech & Slovak Republics Synerma s. r. o., Psáry, Prague-West, Tel: +420 603 145 769, [email protected]
Finland Vantaa, Tel: +358 46 712 2247, [email protected]
France Velizy Villacoublay Cedex, Tel: +33 1 61 62 72 72, [email protected]
Germany Aachen, Tel: +49 241 474 01 0, [email protected]
Munich, Tel: +49 89 543 48 77 0, [email protected]
Greece 3 Dimensional Data Systems, Crete, Tel: +30 2821040012, [email protected]
India Chennai, Tamil Nadu, Tel: +91 44 43443000, [email protected]
Israel ADCOM, Givataim, Tel: +972 3 7325311, [email protected]
Italy Lainate MI, Tel: +39 02 39211211, [email protected]
Japan Tokyo, Tel: +81 3 5442 6300, [email protected]
Osaka, Tel: +81 6 4803 5020, [email protected]
Yokohama-shi, Kanagawa, Tel: +81 45 470 9381, [email protected]
Korea Mapo-Gu, Seoul, Tel: +82 2 785 6707/8, [email protected]
Latin America Puerto Madero, Buenos Aires, Tel: +54 11 4312 8700, [email protected]
Malaysia WorleyParsons Advanced Analysis, Kuala Lumpur, Tel: +603 2039 9000, [email protected]
New Zealand Matrix Applied Computing Ltd., Auckland, Tel: +64 9 623 1223, [email protected]
Poland BudSoft Sp. z o.o., Poznań, Tel: +48 61 8508 466, [email protected]
Russia, Belarus & Ukraine TESIS Ltd., Moscow, Tel: +7 495 612 44 22, [email protected]
Scandinavia Västerås, Sweden, Tel: +46 21 150870, [email protected]
Singapore WorleyParsons Advanced Analysis, Singapore, Tel: +65 6735 8444, [email protected]
South Africa Finite Element Analysis Services (Pty) Ltd., Parklands, Tel: +27 21 556 6462, [email protected]
Spain & Portugal Principia Ingenieros Consultores, S.A., Madrid, Tel: +34 91 209 1482, [email protected]
Taiwan Simutech Solution Corporation, Taipei, R.O.C., Tel: +886 2 2507 9550, [email protected]
Thailand WorleyParsons Advanced Analysis, Singapore, Tel: +65 6735 8444, [email protected]
Turkey A-Ztech Ltd., Istanbul, Tel: +90 216 361 8850, [email protected]
United Kingdom Warrington, Tel: +44 1 925 830900, [email protected]
Sevenoaks, Tel: +44 1 732 834930, [email protected]

Complete contact information is available at http://www.simulia.com/locations/locations.html.

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

Support

Both technical engineering 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 network of local support offices. Regional contact information is listed in the front of each Abaqus manual
and is accessible from the Locations page at www.simulia.com.

SIMULIA Online Support System

The SIMULIA Online Support System (SOSS) provides a knowledge database of SIMULIA Answers. The
SIMULIA Answers are solutions to questions that we have had to answer or guidelines on how to use Abaqus,
SIMULIA SLM, Isight, and other SIMULIA products. You can also submit new requests for support in the
SOSS. All support incidents are tracked in the SOSS. If you are contacting us by means outside the SOSS
to discuss an existing support problem and you know the incident number, please mention it so that we can
consult the database to see what the latest action has been.
To use the SOSS, you need to register with the system. Visit the My Support page at www.simulia.com
to register.
Many questions about Abaqus can also be answered by visiting the Products page and the Support
page at www.simulia.com.

Anonymous ftp site

To facilitate data transfer with SIMULIA, an anonymous ftp account is available on the computer
ftp.simulia.com. Login as user anonymous, and type your e-mail address as your password. Contact support
before placing files on the site.

Training

All offices and representatives offer regularly scheduled public training classes. 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
www.simulia.com or call your local office or representative.

Feedback

We welcome any suggestions for improvements to Abaqus software, the support program, 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.simulia.com. Complaints should be addressed
by contacting your local office or through www.simulia.com by visiting the Quality Assurance section of
the Support page.

Abaqus ID:
Printed on:
Part I: Python commands

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

1. 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)

1.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]

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

1–1

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

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

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

1–2

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

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

Arguments
None.

Return value
None

Exceptions
None.

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

Arguments
None.

Return value
None

Exceptions
None.

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

1–3

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Return value
None

Exceptions
None.

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

1.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]

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

1–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.

1.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]

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

Path
mdb.models[name].AdaptiveMeshControl

1–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.

1–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.

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

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

1–7

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

1.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]

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

1–8

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Exceptions
RangeError.

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

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

1.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]

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

1–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.

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

1.6 AdaptivityProcess object

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

1–10

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Access
import job
mdb.adaptivityProcesses[name]

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

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

1–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.

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

1–12

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Exceptions

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

1.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]

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

1–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.

1–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.

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

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

1–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.

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

1–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.

1.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]

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

1–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

1–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.

1.8.2 Corresponding analysis keywords

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

or 6)

1.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]

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

1–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.

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

1.10 Model object

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

Access
import mesh

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

1–20

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

Return value
An AdaptivityIteration Object.

Exceptions
None.

1.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]

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

1–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.

1–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.

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

Arguments
None.

Return value
None

Exceptions
None.

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

1–23

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

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

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

1–24

Abaqus ID:
Printed on:
 ADAPTIVITY COMMANDS

1.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]

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

1–25

Abaqus ID:
Printed on:
ADAPTIVITY COMMANDS

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

1.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]

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

1–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.

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

1–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.

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

1–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.

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

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

1–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]

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

1–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.

1.14.2 Corresponding analysis keywords

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

1–31

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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

2.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]

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

2.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]

2–1

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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

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

2–2

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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

2.2.4 Corresponding analysis keywords

*AMPLITUDE

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

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

2–3

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Return value
A BaselineCorrection object.

Exceptions
RangeError.

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

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

2.3.4 Corresponding analysis keywords

*BASELINE CORRECTION

2.4 DecayAmplitude object

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

2–4

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

The DecayAmplitude object is derived from the Amplitude object.

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

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

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.

2–5

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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

Return value
None

Exceptions
RangeError.

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

2.4.4 Corresponding analysis keywords

*AMPLITUDE

2.5 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

2–6

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

session.odbs[name].amplitudes[name]

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

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

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.

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

2–7

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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.

Return value
None

Exceptions
RangeError.

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

2.5.4 Corresponding analysis keywords

*AMPLITUDE

2.6 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]

2–8

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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

Path
mdb.models[name].ModulatedAmplitude
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.

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

2–9

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

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.

Return value
None

Exceptions
RangeError.

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

2.6.4 Corresponding analysis keywords

*AMPLITUDE

2.7 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]

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

2–10

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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

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.

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

2–11

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

Return value
None

Exceptions
RangeError.

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

2.7.4 Corresponding analysis keywords

*AMPLITUDE

2.8 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]

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

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

2–12

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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.

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

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

2–13

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

2.8.4 Corresponding analysis keywords

*AMPLITUDE

2.9 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]

2.9.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.
minimum
A Float specifying the minimum amplitude value. Possible values are those smaller than maximum
and initial. The default value is 0.1.

2–14

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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.

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

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

2.9.4 Corresponding analysis keywords

*AMPLITUDE

2–15

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

2.10 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
session.odbs[name].amplitudes[name]

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

2–16

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

Return value
A TabularAmplitude object.

Exceptions
InvalidNameError and RangeError.

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

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

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

2.10.4 Corresponding analysis keywords

*AMPLITUDE

2–17

Abaqus ID:
Printed on:
AMPLITUDE COMMANDS

2.11 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]

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

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.

2–18

Abaqus ID:
Printed on:
 AMPLITUDE COMMANDS

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

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

2.11.4 Corresponding analysis keywords

*AMPLITUDE

2–19

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

3. Animation commands

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

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

3.1.2 stop()
This method stops the animation.

3–1

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

3.1.3 incrementFrame()
This method increments the animation frame.

Arguments
None.

Return value
None

Exceptions
None.

3.1.4 decrementFrame()
This method decrements the animation frame.

Arguments
None.

Return value
None

Exceptions
None.

3–2

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

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

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

Arguments
None.

Return value
None

Exceptions
None.

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

3–3

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

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

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

3–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.

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

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

3–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".

3–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_TRIANGLE
• 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.

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

3–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.

3–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_TRIANGLE
• 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.
xyLineColor
A String specifying the color used to plot the X–Y time tracker line when xyUseHighlightMethod
= False. The default value is "Yellow".

3–9

Abaqus ID:
Printed on:
ANIMATION COMMANDS

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

3.3 AVIOptions object

The AVIOptions object is used to store values and attributes to be used in generating AVI animation.
The AVIOptions object has no constructor. Abaqus creates the aviOptions member when the animation
module is imported.

Access
import animation
session.aviOptions

3.3.1 setValues(...)
This method modifies the AVIOptions object.

Arguments
Required arguments
None.
Optional arguments
compressionMethod
A SymbolicConstant specifying the compression method for the AVI format. Possible values are:
• RAW8, specifying an uncompressed format of 8 bits per pixel.
• RAW32, specifying an uncompressed format of 32 bits per pixel.
• RLE8, specifying a run length encoded format of 8 bits per pixel.
• CODEC, specifying a format defined by CODEC (encoder/decoder). The availability of the
CODEC is system dependent
The default value is RLE8.
compressionQuality
An Int specifying the quality of the compression as a percentage when the compressionMethod is
set to CODEC.
codecOptions
A String specifying the system specific options defining the CODEC when the compressionMethod
is set to CODEC.

3–10

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

sizeDefinition
A SymbolicConstant specifying how the width and height of the image are specified. Possible
values are SIZE_ON_SCREEN and USER_DEFINED. The default value is SIZE_ON_SCREEN.
imageSize
A pair of Ints specifying the width and height of the image in pixels when
sizeDefinition=USER_DEFINED. Possible values are Ints in the range (minWidth, minHeight)
(width, height) (maxWidth, maxHeight). The default value is the screen size.
Note: The values of the minimum width (minWidth) and height (minHeight) depend on the
following:
• viewport font size,
• whether decorations are printed,
• decoration size, and
• screen resolution.
The minimum width and height are normally < 50 pixels. The values of the maximum width
(maxWidth) and height (maxHeight) depend on the graphics capabilities of the system. The
maximum width and height will be at least as large as the screen dimensions.

Return value
None

Exceptions
None.

3.3.2 Members
The AVIOptions object has members with the same names and descriptions as the arguments to the
setValues method.

3.4 ImageAnimationOptions object

The ImageAnimationOptions object is used to store values and attributes associated with saving
viewport animations. The ImageAnimationOptions object has no constructor. Abaqus creates the
imageAnimationOptions member when the animation module is imported.

Access
import animation

3–11

Abaqus ID:
Printed on:
ANIMATION COMMANDS

session.imageAnimationOptions

3.4.1 setValues(...)
This method modifies the ImageAnimationOptions object.

Arguments
Required arguments
None.
Optional arguments
frameRate
An Int specifying the frame rate to record on the saved animation file. The effective frame rate in
frames per second will be obtained by dividing the given frame rate by the time scale.
timeScale
An Int specifying the time scale to apply to the frame rate.
vpDecorations
A Boolean specifying whether to capture the viewport border and title. The default value is ON.
vpBackground
A Boolean specifying whether to capture viewport backgrounds. The default value is OFF.
compass
A Boolean specifying whether to capture the view compass. The default value is OFF.

Return value
None

Exceptions
None.

3.4.2 Members
The ImageAnimationOptions object has members with the same names and descriptions as the arguments
to the setValues method.

3.5 ImageAnimation object

The ImageAnimation object is used to build frame by frame animation.

3–12

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

Access
import animation
session.imageAnimation

3.5.1 ImageAnimation(...)
This method creates an ImageAnimation object from the specified filename and format.

Path
session.ImageAnimation

Required arguments
fileName
A String specifying the name of the animation file to generate.
format
A SymbolicConstant specifying the format of the generated file. Possible values are AVI,
QUICKTIME.
Optional arguments
None.

Return value
An ImageAnimation object.

Exceptions
None.

3.5.2 writeFrame(...)
This method adds a frame to the ImageAnimation object.

Arguments
Required arguments
None.
Optional argument
canvasObjects
A sequence specifying the canvas objects to capture. The default is to capture all canvas objects.

3–13

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Return value
None

Exceptions
None.

3.5.3 close()
This method closes the ImageAnimation object.

Arguments
None.

Return value
None

Exceptions
None.

3.5.4 closed()
This method indicates if the ImageAnimation is open or closed for writing animation frames.

Arguments
None.

Return value
None

Exceptions
None.

3.5.5 Members
The ImageAnimation object has the following member:
fileName
A String specifying the file to which the animation frames is to be written.

3–14

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

3.6 QuickTimeOptions object

The QuickTimeOptions object is used to store values and attributes to be used in generating QuickTime
animation. The QuickTimeOptions object has no constructor. Abaqus creates the quickTimeOptions
member when the animation module is imported.

Access
import animation
session.quickTimeOptions

3.6.1 setValues(...)
This method modifies the QuickTimeOptions object.

Arguments
Required arguments
None.
Optional arguments
compressionMethod
A SymbolicConstant specifying the compression method for the QuickTime format. Possible
values are:
• RAW24, specifying an uncompressed format of 24 bits per pixel.
• RLE24, specifying a run length encoded format of 24 bits per pixel.
The default value is RLE24.
sizeDefinition
A SymbolicConstant specifying how the width and height of the image are specified. Possible
values are SIZE_ON_SCREEN and USER_DEFINED. The default value is SIZE_ON_SCREEN.
imageSize
A pair of Ints specifying the width and height of the image in pixels when
sizeDefinition=USER_DEFINED. Possible values are Ints in the range (minWidth, minHeight)
(width, height) (maxWidth, maxHeight). The default value is the screen size.
Note: The values of the minimum width (minWidth) and height (minHeight) depend on the
following:
• viewport font size,
• whether decorations are printed,
• decoration size, and

3–15

Abaqus ID:
Printed on:
ANIMATION COMMANDS

• screen resolution.
The minimum width and height are normally < 50 pixels. The values of the maximum width
(maxWidth) and height (maxHeight) depend on the graphics capabilities of the system. The
maximum width and height will be at least as large as the screen dimensions.

Return value
None

Exceptions
None.

3.6.2 Members
The QuickTimeOptions object has members with the same names and descriptions as the arguments to
the setValues method.

3.7 Movie object

The Movie object is used to store values and attributes associated with a movie file. Upon creation, the
Movie object is added to the session.movies repository.

Access
import animation
session.movies[name]

3.7.1 Movie(...)
This method creates a Movie object from the contents of the specified file.

Path
session.Movie

Required arguments
name
A String specifying the repository name for the movie.
fileName
A String specifying the file from which the movie is to be read. The file extension must be specified
and indicates the movie format (.avi, .mov, .mpeg, or .wmv).

3–16

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

Optional arguments
startFrame
An Int specifying the first frame to be displayed from this movie. The default value is 0.
endFrame
An Int specifying the last frame to be displayed from this movie. A negative number will indicate
reverse numbering: -1 is the last frame of the movie. The default value is −1.
timelineStartFrame
An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0
will indicate the first frame to be displayed in the viewport. The default value is 0.
timelineEndFrame
An Int specifying the global timeline frame number that corresponds to endFrame. A negative
number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport.
The default value is −1.
timelineStartTime
A Float specifying the global timeline time that corresponds to the time of startFrame. The default
value is 0.0.
timelineEndTime
The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that
corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the
time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

Return value
A Movie object.

Exceptions
ValueError.
If fileName does not exist or can not be read:
ValueError: Unable to open movie file
If fileName references an unsupported movie file format:
ValueError: Unsupported movie format
If the contents of fileName are corrupt or can not be decoded:
ValueError: Unable to decode movie file

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

3–17

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Arguments
Required arguments
None.
Optional arguments
startFrame
An Int specifying the first frame to be displayed from this movie. The default value is 0.
endFrame
An Int specifying the last frame to be displayed from this movie. A negative number will indicate
reverse numbering: -1 is the last frame of the movie. The default value is −1.
timelineStartFrame
An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0
will indicate the first frame to be displayed in the viewport. The default value is 0.
timelineEndFrame
An Int specifying the global timeline frame number that corresponds to endFrame. A negative
number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport.
The default value is −1.
timelineStartTime
A Float specifying the global timeline time that corresponds to the time of startFrame. The default
value is 0.0.
timelineEndTime
The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that
corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the
time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

Return value
None

Exceptions
RangeError.
If startFrame,endFrame,timelineStartFrame,timelineEndFrame,timelineStartTime, ortimelineEndTime
are outside their respective valid range.
RangeError: startFrame must be an Integer in the range: 0 to numFrames-1

3.7.3 Members
The Movie object has members with the same names and descriptions as the arguments to the Movie
method.
In addition, the Movie object has the following members:

3–18

Abaqus ID:
Printed on:
 ANIMATION COMMANDS

width
An Int specifying the width of the movie in pixels.
height
An Int specifying the height of the movie in pixels.
numFrames
An Int specifying the total number of frames on the movie file.
duration
A Float specifying the duration of the movie in seconds.
memory
An Int specifying the memory taken by the movie frames as selected.

3.8 Session object

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

Access
import animation

3.8.1 writeImageAnimation(...)
This method writes the animations present in the list of canvas objects to a file. It generates an animation
file using the given file name and file format and uses the values in the appropriate options object.

Arguments
Required arguments
fileName
A String specifying the name of the animation file to generate.
format
A SymbolicConstant specifying the format of the generated file. Possible values are AVI,
QUICKTIME, VRML, and COMPRESSED_VRML.
Optional argument
canvasObjects
A sequence specifying the canvas objects to capture. The default is to capture all canvas objects.

Return value
None

3–19

Abaqus ID:
Printed on:
ANIMATION COMMANDS

Exceptions
None.

3–20

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

4. Annotation commands
Annotation commands are used to create, position, and modify viewport annotations.

4.1 Annotation object

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

Access
import annotationToolset
mdb.annotations[name]
session.odbs[name].userData.annotations[name]
session.viewports[name].annotationsToPlot[i]

4.1.1 bringToFront()
This method brings the Annotation object to the top of the annotation stack.

Arguments
None.

Return value
None

Exceptions
None.

4.1.2 sendToBack()
This method sends the Annotation object to the bottom of the annotation stack.

Arguments
None.

4–1

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

Return value
None

Exceptions
None.

4.1.3 bringForward()
This method brings the Annotation object one position up in the annotation stack.

Arguments
None.

Return value
None

Exceptions
None.

4.1.4 sendBackward()
This method sends the Annotation object one position down in the annotation stack.

Arguments
None.

Return value
None

Exceptions
None.

4.1.5 moveBefore(...)
This method moves the Annotation object before another object in the same repository.

4–2

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

Arguments
Required argument
name
A String specifying the name of the other Annotation object.
Optional arguments
None.

Return value
None

Exceptions
None.

4.1.6 moveAfter(...)
This method moves the Annotation object after another object in the same repository.

Arguments
Required argument
name
A String specifying the name of the other Annotation object.
Optional arguments
None.

Return value
None

Exceptions
None.

4.1.7 translate(...)
This method translates the Annotation object on the viewport plane.

Arguments
Required arguments
None.

4–3

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

Optional arguments
x
A Float specifying the X translation amount in millimeters.
y
A Float specifying the Y translation amount in millimeters.

Return value
None

Exceptions
None.

4.1.8 Members
The Annotation object has the following member:
name
A String specifying the annotation repository key.

4.2 AnnotationsToPlotArray object

The AnnotationsToPlotArray object is a sequence that stores references to plotted annotations. By adding
annotations to and removing annotations from this sequence, you can control which annotations are
displayed in a particular viewport.

Access
import annotationToolset
session.viewports[name].annotationsToPlot

4.2.1 bringForward(...)
This method brings the Annotation object one position forward in the AnnotationsToPlotArray sequence.

Arguments
Required argument
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
Optional arguments
None.

4–4

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

Return value
None

Exceptions
None.

4.2.2 bringToFront(...)
This method brings the Annotation object to the beginning of the AnnotationsToPlotArray sequence.

Arguments
Required argument
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
Optional arguments
None.

Return value
None

Exceptions
None.

4.2.3 moveAfter(...)
This method moves the Annotation object after another object in the same AnnotationsToPlotArray
sequence.

Arguments
Required arguments
index
An Integer specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
other
An Integer specifying the index of the other Annotation object in the AnnotationsToPlotArray
sequence after which this object will be moved.
Optional arguments
None.

4–5

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

Return value
None

Exceptions
None.

4.2.4 moveBefore(...)
This method moves the Annotation object before another object in the same AnnotationsToPlotArray
sequence.

Arguments
Required arguments
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
other
An Int specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence
before which this object will be moved.
Optional arguments
None.

Return value
None

Exceptions
None.

4.2.5 sendBackward(...)
This method sends the Annotation object one position backward in the AnnotationsToPlotArray
sequence.

Arguments
Required argument
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

4–6

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

Optional arguments
None.

Return value
None

Exceptions
None.

4.2.6 sendToBack(...)
This method sends the Annotation object to the end of the AnnotationsToPlotArray sequence.

Arguments
Required argument
index
An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.
Optional arguments
None.

Return value
None

Exceptions
None.

4.2.7 Members
The AnnotationsToPlotArray object has no members.

4.3 Arrow object

The Arrow object stores the visual settings and location of an arrow annotation.
The Arrow object is derived from the Annotation object.

Access
import annotationToolset
mdb.annotations[name]

4–7

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

session.odbs[name].userData.annotations[name]
session.viewports[name].annotationsToPlot[i]

4.3.1 Arrow(...)
This method creates an Arrow object.

Path
mdb.Arrow
session.odbs[name].userData.Arrow

Required argument
name
A String specifying the annotation repository key.
Optional arguments
startPoint
A pair of Floats specifying the start point X- and Y-offsets in millimeters from startAnchor. The
default value is (0, 0).
endPoint
A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor. The
default value is (0, 0).
startAnchor
A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats
specifies the X and Y coordinates as percentages of the viewport width and height. A sequence of
three Floats specifies the X, Y and Z coordinates of a point in the model coordinate system. A
SymbolicConstant indicates a relative position. Possible values are:
• BOTTOM_LEFT
• BOTTOM_CENTER
• BOTTOM_RIGHT
• CENTER_LEFT
• CENTER
• CENTER_RIGHT
• TOP_LEFT
• TOP_CENTER
• TOP_RIGHT
The default value is BOTTOM_LEFT.

4–8

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

endAnchor
A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats
specifies the X and Y coordinates as percentages of the viewport width and height. A Sequence
of three Floats specifies the X, Y and Z coordinates of a point in the model coordinate system. A
SymbolicConstant indicates a relative position. Possible values are:
• BOTTOM_LEFT
• BOTTOM_CENTER
• BOTTOM_RIGHT
• CENTER_LEFT
• CENTER
• CENTER_RIGHT
• TOP_LEFT
• TOP_CENTER
• TOP_RIGHT
The default value is BOTTOM_LEFT.
startHeadStyle
A SymbolicConstant specifying the style of the start head. Possible values are:
• ARROW
• FILLED_ARROW
• HOLLOW_CIRCLE
• FILLED_CIRCLE
• HOLLOW_DIAMOND
• FILLED_DIAMOND
• HOLLOW_SQUARE
• FILLED_SQUARE
• NONE
The default value is NONE.
endHeadStyle
A SymbolicConstant specifying the style of the end head. Possible values are:
• ARROW
• FILLED_ARROW
• HOLLOW_ CIRCLE
• FILLED_CIRCLE
• HOLLOW_DIAMOND
• FILLED_DIAMOND
• HOLLOW_SQUARE

4–9

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

• FILLED_SQUARE
• NONE
The default value is FILLED_ARROW.
startGap
A Float specifying the distance in millimeters between the arrow start point and the arrow start
head. The default value is 0.0.
endGap
A Float specifying the distance in millimeters between the arrow end point and the arrow end head.
The default value is 0.0.
color
A String specifying the color of the arrow. Possible string values are any valid color. The default
value is "White".
lineStyle
A SymbolicConstant specifying the line style of the arrow. Possible values are SOLID, DASHED,
DOTTED, and DOT_DASH. The default value is SOLID.
lineThickness
A SymbolicConstant specifying the line thickness of the arrow. Possible values are VERY_THIN,
THIN, MEDIUM, and THICK. The default value is VERY_THIN.

Return value
An Arrow object.

Exceptions
InvalidNameError.

4.3.2 translateStartPoint(...)
This method translates the start point of the Arrow object on the viewport plane.

Arguments
Required arguments
None.
Optional arguments
x
A Float specifying the X translation amount in millimeters.
y
A Float specifying the Y translation amount in millimeters.

4–10

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

Return value
None

Exceptions
None.

4.3.3 translateEndPoint(...)
This method translates the end point of the Arrow object on the viewport plane.

Arguments
Required arguments
None.
Optional arguments
x
A Float specifying the X translation amount in millimeters.
y
A Float specifying the Y translation amount in millimeters.

Return value
None

Exceptions
None.

4.3.4 setValues(...)
This method modifies the Arrow object.

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

4–11

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

Return value
None

Exceptions
None.

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

4.4 Text object

The Text object stores the text settings and location of a text annotation.
The Text object is derived from the Annotation object.

Access
import annotationToolset
mdb.annotations[name]
session.odbs[name].userData.annotations[name]
session.viewports[name].annotationsToPlot[i]

4.4.1 Text(...)
This method creates a Text object.

Path
mdb.Text
session.odbs[name].userData.Text

Required argument
name
A String specifying the annotation repository key.
Optional arguments
text
A String specifying the text of the Text object. The default value is an empty string.

4–12

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

offset
A pair of Floats specifying the X- and Y-offsets in millimeters of the Text object from anchor. The
default value is (0, 0).
anchor
A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats
specifies the X and Y coordinates as percentages of the viewport width and height. A Sequence
of three Floats specifies the X, Y and Z coordinates of a point in the model coordinate system. A
SymbolicConstant specifies a relative position. Possible values are:
• BOTTOM_LEFT
• BOTTOM_CENTER
• BOTTOM_RIGHT
• CENTER_LEFT
• CENTER
• CENTER_RIGHT
• TOP_LEFT
• TOP_CENTER
• TOP_RIGHT
The default value is BOTTOM_LEFT.
referencePoint
A SymbolicConstant or a sequence of Floats specifying a point. The sequence of two Floats
specifies the X- and Y-coordinates of the reference point of the Text annotation given as percentages
of its width and height. The SymbolicConstant indicates a relative position. Possible values are:
• BOTTOM_LEFT
• BOTTOM_CENTER
• BOTTOM_RIGHT
• CENTER_LEFT
• CENTER
• CENTER_RIGHT
• TOP_LEFT
• TOP_CENTER
• TOP_RIGHT
The default value is BOTTOM_LEFT.
rotationAngle
A Float specifying the amount of rotation in degrees about referencePoint. The default value is
0.0.

4–13

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

color
A String specifying the color of the Text object. Possible string values are any valid color. The
default value is "White".
font
A String specifying the font of the Text object. Possible string values are any valid font
specification. The default value is "-*-helvetica-medium-r-normal--12-*".
backgroundStyle
A SymbolicConstant specifying the Text object background style. Possible values are MATCH,
TRANSPARENT, and OTHER. The default value is TRANSPARENT.
backgroundColor
A String specifying the color of the Text object background. Possible string values are any valid
color. The default value matches the viewport background.
box
A Boolean specifying whether the box around the text is shown. The default value is OFF.
justification
A SymbolicConstant specifying the Text object justification for multiline text. Possible
values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT. The default value is
JUSTIFY_LEFT.

Return value
A Text object.

Exceptions
None.

4.4.2 setValues(...)
This method modifies the Text object.

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

Return value
None

4–14

Abaqus ID:
Printed on:
 ANNOTATION COMMANDS

Exceptions
None.

4.4.3 Members
The Text object has members with the same names and descriptions as the arguments to the Text method.
In addition, the Text object has the following members:
width
A Float specifying the width in millimeters of the Text object.
height
A Float specifying the height in millimeters of the Text object.

4.5 Viewport object

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

Access
import annotationToolset

4.5.1 plotAnnotation(...)
This method plots an Annotation object in a Viewport.

Arguments
Required argument
annotation
An Annotation object to plot.
Optional argument
index
An Int specifying the index of the Annotation object in the sequence of annotations to plot. The
default value is zero.

Return value
None

4–15

Abaqus ID:
Printed on:
ANNOTATION COMMANDS

Exceptions
None.

4–16

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

5. Assembly commands

5.1 Assembly object

An Assembly object is a container for instances of parts. The Assembly object has no constructor
command. Abaqus creates the rootAssembly member when a Model object is created.

Access
import assembly
mdb.models[name].rootAssembly

5.1.1 backup()
This method makes a backup copy of the features in the assembly. The backup() method is used in
conjunction with the restore() method.

Arguments
None.

Return value
None

Exceptions
None.

5.1.2 clearGeometryCache()
This method deletes the geometry cache. Deleting the geometry cache reduces the amount of memory
being used.

Arguments
None.

Return value
None

5–1

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Exceptions
None.

5.1.3 deleteAllFeatures()
This method deletes all the features in the assembly.

Arguments
None.

Return value
None

Exceptions
None.

5.1.4 deleteFeatures(...)
This method deletes specified features from the assembly.

Arguments
Required argument
featureNames
A sequence of Strings specifying the feature names that will be deleted from the assembly.
Optional arguments
None.

Return value
None

Exceptions
None.

5.1.5 excludeFromSimulation(...)
This method excludes the specified part instances from the analysis.

5–2

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Arguments
Required arguments
instances
A sequence of PartInstance objects to be excluded from the analysis.
exclude
A Bool specifying whether to exclude the selected instances from the analysis or include them.
Optional arguments
None.

Return value
None

Exceptions
None.

5.1.6 featurelistInfo()
This method prints the name and status of all the features in the feature lists.

Arguments
None.

Return value
None

Exceptions
None.

5.1.7 getMassProperties(...)
This method returns the mass properties of the assembly, or instances or regions. Only beams, trusses,
shells, solids, point, nonstructural mass, and rotary inertia elements are supported.

Arguments
Required arguments
None.

5–3

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Optional arguments
regions
A sequence of PartInstance objects or a sequence of Region objects specifying the part instances
or regions whose mass properties are to be queried. The whole assembly is queried by default.
relativeAccuracy
A SymbolicConstant specifying the relative accuracy for geometry computation. Possible values
are LOW, MEDIUM and HIGH. The default value is LOW.
useMesh
A Boolean specifying whether the mesh should be used in the computation if the geometry is
meshed. The default value is False.
specifyDensity
A Boolean specifying whether a user-specified density should be used in regions with density
errors such as undefined material density. The default value is False.
density
A double value specifying the user-specified density value to be used in regions with density errors.
The user-specified density should be greater than 0.
specifyThickness
A Boolean specifying whether a user-specified thickness should be used in regions with thickness
errors such as undefined thickness. The default value is False.
thickness
A double value specifying the user-specified thickness value to be used in regions with thickness
errors. The user-specified thickness should be greater than 0.
miAboutCenterOfMass
A Boolean specifying if the moments of inertia should be evaluated about the center of mass. The
default value is True.
miAboutPoint
A tuple of three floats specifying the coordinates of the point about which to evaluate the moment
of inertia. By default if the moments of inertia are not being evaluated about the center of mass,
they will be evaluated about the origin.

Return value
A Dictionary object with the following items:
area: None or a Float specifying the sum of the area of the specified faces. The area is computed
only for one side for shells.
areaCentroid: None or a tuple of three Floats representing the coordinates of the area centroid.
volume: None or a Float specifying the volume of the specified regions.
volumeCentroid: None or a tuple of three Floats representing the coordinates of the volume
centroid.

5–4

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

massFromMassPerUnitSurfaceArea: None or a Float specifying the mass due to mass per unit
surface area.
mass: None or a Float specifying the mass of the specified regions. It is the total mass and includes
mass from quantities such as mass per unit surface area.
centerOfMass: None or a tuple of three Floats representing the coordinates of the center of mass.
momentOfInertia: None or a tuple of six Floats representing the moments of inertia about the center
of mass or about the point specified.
warnings: A tuple of SymbolicConstants representing the problems encountered while computing
the mass properties. Possible SymbolicConstants are:
UNSUPPORTED_ENTITIES: Some unsupported entities exist in the specified regions. The mass
properties are computed only for beams, trusses, shells, solids, point and non-structural mass elements
and rotary inertia elements. The mass properties are not computed for axisymmetric elements, springs,
connectors, gaskets or any other elements.
MISSING_THICKNESS: For some regions, the section definitions are missing thickness values.
ZERO_THICKNESS: For some regions, the section definitions have a zero thickness value.
VARIABLE_THICKNESS: The nodal thickness or field thickness specified for some regions has
been ignored.
NON_APPLICABLE_THICKNESS: For some regions, the thickness value is not applicable to the
corresponding sections specified on the regions.
MISSING_DENSITY: For some regions, the section definitions are missing material density
values.
MISSING_MATERIAL_DEFINITION: For some regions, the material definition is missing.
ZERO_DENSITY: For some regions, the section definitions have a zero material density value.
UNSUPPORTED_DENSITY: For some regions, either a negative material density or a temperature
dependent density has been specified, or the material value is missing for one or more plies in the
composite section.
SHELL_OFFSETS: For shells, this method does not account for any offsets specified.
MISSING_SECTION_DEFINITION: For some regions, the section definition is missing.
UNSUPPORTED_SECTION_DEFINITION: The section definition provided for some regions is
not supported.
REINFORCEMENTS: This method does not account for any reinforcements specified on the
model.
SMEARED_PROPERTIES: For regions with composite section assignments, the density is
smeared across the thickness. The volume centroid and center of mass computations for a composite
shell use a lumped mass approach where the volume and mass is assumed to be lumped in the plane
of the shell. As a result of these approximations the volume centroid, center of mass and moments of
inertia may be slightly inaccurate for regions with composite section assignments.
UNSUPPORTED_NON_STRUCTURAL_MASS_ENTITIES: This method does not account for
any non-structural mass on wires.
INCORRECT_MOMENT_OF_INERTIA: For geometry regions with non-structural mass per
volume, the non-structural mass is assumed to be a point mass at the centroid of the regions. Thus, the

5–5

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

moments of inertia may be inaccurate as the distribution of the non-structural mass is not accounted for.
Use the mesh for accurately computing the moments of inertia.
MISSING_BEAM_ORIENTATIONS: For some regions with beam section assignments, the beam
section orientations are missing.
UNSUPPORTED_BEAM_PROFILES: This method supports the Box, Pipe, Circular, Rectangular,
Hexagonal, Trapezoidal, I, L, T, and Arbitrary beam profiles. Any other beam profile is not supported.

Exceptions
None.

5.1.8 getAngle(...)
This method returns the angle between the specified entities.

Arguments
Required arguments
plane1
A Face , MeshFace , or a Datum object specifying the first plane. The Datum object must represent
a datum plane. The plane1 and line1 arguments are mutually exclusive. One of them must be
specified.
plane2
A Face , MeshFace , or a Datum object specifying the second plane. The Datum object must
represent a datum plane. The plane2 and line2 arguments are mutually exclusive. One of them
must be specified.
line1
An Edge , MeshEdge , or a Datum object specifying the first line. The Datum object must represent
a datum axis. The plane1 and line1 arguments are mutually exclusive. One of them must be
specified.
line2
An Edge , MeshEdge , or a Datum object specifying the second line. The Datum object must
represent a datum axis. The plane2 and line2 arguments are mutually exclusive. One of them
must be specified.
Optional arguments
None.

Return value
A Float specifying the angle between the specified entities. If you provide a plane as an argument,
Abaqus/CAE computes the angle using the normal to the plane.

5–6

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Exceptions
None.

5.1.9 getCoordinates(...)
This method returns the coordinates of specified point.

Arguments
Required argument
entity
A Vertex , Datum point, MeshNode , or ReferencePoint specifying the entity to query.
Optional arguments
None.

Return value
A tuple of three Floats representing the coordinates of the specified point.

Exceptions
None.

5.1.10 getDistance(...)
Depending on the arguments provided, this method returns one of the following:
• The distance between two points.
• The minimum distance between a point and an edge.
• The minimum distance between two edges.

Arguments
Required arguments
entity1
A Vertex , Datum point, MeshNode , or Edge specifying the first entity from which to measure.
entity2
A Vertex , Datum point, MeshNode , or Edge specifying the second entity to which to measure.
Optional argument
printResults
A Boolean that determines whether a verbose output is to be printed. The default is True

5–7

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Return value
A Float specifying the calculated distance.

Exceptions
None.

5.1.11 getFacesAndVerticesOfAttachmentLines(...)
Given an array of edge objects, this method returns a tuple of dictionary objects. Each object consists of
five members including the attachment line and associated face and vertex objects.

Arguments
Required argument
edges
An EdgeArray object which is a sequence of Edge objects.
Optional arguments
None.

Return value
A tuple of dictionary objects. Each dictionary contains five items with the following keys:
edge: An Edge object specifying the attachment line.
startFace: A Face object specifying the face associated with one end of the attachment line.
endFace: A Face object specifying the face associated with the other end of the attachment line.
startVertex: A Vertex object specifying the vertex associated with one end of the attachment line.
This end is also associated with the startFace.
endVertex: A Vertex object specifying the vertex associated with the other end of the attachment
line. This end is also associated with the endFace.

Exceptions
None.

5.1.12 importEafFile(...)
This method imports an assembly from an EAF file into the root assembly.

5–8

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Arguments
Required argument
filename
A String specifying the path to the EAF file from which to import the assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.
ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

Return value
None

Exceptions
None.

5.1.13 importParasolidFile(...)
This method imports an assembly from the Parasolid file into the root assembly.

Arguments
Required argument
filename
A String specifying the path to a Parasolid file from which to import the assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.
ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

Return value
None

Exceptions
None.

5–9

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

5.1.14 importCatiaV4File(...)
This method imports an assembly from a CATIA V4 file into the root assembly.

Arguments
Required argument
filename
A String specifying the path to the CATIA V4 file from which to import the assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.
ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

Return value
None

Exceptions
None.

5.1.15 importCatiaV5File(...)
This method imports an assembly from a CATIA V5 Elysium Neutral file into the root assembly.

Arguments
Required argument
filename
A String specifying the path to the CATIA V5 Elysium Neutral file from which to import the
assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.
ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

5–10

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Return value
None

Exceptions
None.

5.1.16 importEnfFile(...)
This method imports an assembly from an Elysium Neutral file created by Pro/ENGINEER, I-DEAS, or
CATIA V5 into the root assembly.

Arguments
Required argument
filename
A String specifying the path to the Elysium Neutral file from which to import the assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.
ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

Return value
None

Exceptions
None.

5.1.17 importIdeasFile(...)
This method imports an assembly from an I-DEAS Elysium Neutral file into the root assembly.

Arguments
Required argument
filename
A String specifying the path to the I-DEAS Elysium Neutral file from which to import the assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.

5–11

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

Return value
None

Exceptions
None.

5.1.18 importProEFile(...)
This method imports an assembly from a Pro/ENGINEER Elysium Neutral file into the root assembly.

Arguments
Required argument
filename
A String specifying the path to the Pro/ENGINEER Elysium Neutral file from which to import the
assembly.
Optional argument
You use the following optional argument only to import specific instances and their associated parts.
ids
A sequence of Ints. Each Int in the sequence is a unique identifier of the occurrence in the assembly
tree or component identifier associated with the part in the EAF file. If ids is an empty sequence,
all occurrences or parts will be imported. The default value is an empty sequence.

Return value
None

Exceptions
None.

5.1.19 makeDependent(...)
This method converts the specified part instances from independent to dependent part instances.

5–12

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Arguments
Required argument
instances
A sequence of PartInstance objects to convert to dependent part instances.
Optional arguments
None.

Return value
None

Exceptions
None.

5.1.20 makeIndependent(...)
This method converts the specified part instances from dependent to independent part instances.

Arguments
Required argument
instances
A sequence of PartInstance objects to convert to independent part instances.
Optional arguments
None.

Return value
None

Exceptions
None.

5.1.21 projectReferencesOntoSketch(...)
This method projects the specified edges, vertices, and datum points from the assembly onto the specified
ConstrainedSketch object. The edges, vertices, and datum points appear on the sketch as reference
geometry.

5–13

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Arguments
Required argument
sketch
The ConstrainedSketch object on which the edges, vertices, and datum points are projected.
Optional arguments
filter
A SymbolicConstant specifying how to limit the amount of projection. Possible values are
ALL_EDGES and COPLANAR_EDGES. If filter=COPLANAR_EDGES, edges that are
coplanar to the sketching plane are the only candidates for projection. The default value is
ALL_EDGES.
upToFeature
A Feature object specifying a marker in the feature-based history of the part. Abaqus/CAE projects
onto the sketch only the part entities that were created before the feature specified by this marker.
By default, all part entities are candidates for projection.
edges
A sequence of candidate edges to be projected onto the sketch. By default, all edges are candidates
for projection.
vertices
A sequence of candidate vertices to be projected onto the sketch. By default, all vertices are
candidates for projection.

Return value
None

Exceptions
None.

5.1.22 queryCachedStates()
This method displays the position of geometric states relative to the sequence of features in the assembly
cache. The output is displayed in the message area.

Arguments
None.

Return value
None

5–14

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Exceptions
None.

5.1.23 regenerate()
This method regenerates the assembly and brings it up to date with the latest values of the assembly
parameters. When you modify features of an assembly, it may be convenient to postpone regeneration
until you make all your changes, since regeneration can be time consuming. In contrast, when you
modify features of a part that is included in the assembly, you should use this command to regenerate the
assembly. When you regenerate the assembly, it will reflect the changes that you made to the part.

Arguments
None.

Return value
None

Exceptions
None.

5.1.24 regenerationWarnings()
This method prints any regeneration warnings associated with the features.

Arguments
None.

Return value
None

Exceptions
None.

5.1.25 restore()
This method restores the parameters of all features in the assembly to the value they had before a failed
regeneration. Use the restore method after a failed regeneration, followed by a regenerate
command.

5–15

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

5.1.26 resumeAllFeatures()
This method resumes all the suppressed features in the part or assembly.

Arguments
None.

Return value
None

Exceptions
None.

5.1.27 resumeFeatures(...)
This method resumes the specified suppressed features in the assembly.

Arguments
Required argument
featureNames
A sequence of Strings specifying the names of features to resume.
Optional arguments
None.

Return value
None

5–16

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Exceptions
None.

5.1.28 resumeLastSetFeatures()
This method resumes the last set of features to be suppressed in the assembly.

Arguments
None.

Return value
None

Exceptions
None.

5.1.29 rotate(...)
This method rotates given instances by the specified amount.

Arguments
Required arguments
instanceList
A sequence of Strings specifying the names of instances to rotate.
axisPoint
A sequence of three Floats specifying the coordinates of a point on the axis.
axisDirection
A sequence of three Floats specifying the direction of the axis.
angle
A Float specifying the rotation angle in degrees. Use the right-hand rule to determine the direction.
Optional arguments
None.

Return value
None

5–17

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Exceptions
None.

5.1.30 translate(...)
This method translates given instances by the specified amount.

Arguments
Required arguments
instanceList
A sequence of Strings specifying the names of instances to translate.
vector
A sequence of three Floats specifying a translation vector.
Optional arguments
None.

Return value
None

Exceptions
None.

5.1.31 saveGeometryCache()
This method caches the current geometry, which improves regeneration performance.

Arguments
None.

Return value
None

Exceptions
None.

5–18

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

5.1.32 setValues(...)
This method modifies the behavior associated with the specified assembly.

Arguments
Required argument
regenerateConstraintsTogether
A Boolean specifying whether the positioning constraints in the assembly should be regenerated
together before regenerating other assembly features. The default value is ON.
If the assembly has position constraint features and you modify the value of
regenerateConstraintsTogether, Abaqus/CAE will regenerate the assembly features.
Optional arguments
None.

Return value
None

Exceptions
If one or more features in the assembly fails to regenerate:
FeatureError: Regeneration failed

5.1.33 suppressFeatures(...)
This method suppresses specified features.

Arguments
Required argument
featureNames
A sequence of Strings specifying the names of features to suppress in the assembly.
Optional arguments
None.

Return value
None

Exceptions
None.

5–19

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

5.1.34 unlinkInstances(...)
This method converts the specified PartInstance objects from linked child instances to regular instances.
The parts associated with the selected instances will be converted to regular parts as well.

Arguments
Required argument
instances
A sequence of PartInstance objects to be converted to regular part instances.
Optional arguments
None.

Return value
None

Exceptions
None.

5.1.35 writeAcisFile(...)
This method exports the assembly to a named file in ACIS format.

Arguments
Required argument
fileName
A String specifying the name of the file to which to write.
Optional argument
version
A Float specifying the ACIS version. For example, the Float “12.0” corresponds to ACIS Version
12.0. The default value is the current version of ACIS.

Return value
None

Exceptions
None.

5–20

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

5.1.36 writeCADParameters(...)
This method writes the parameters that were imported from the CAD system to a parameter file.

Arguments
Required argument
parameterFile
A String specifying the parameter file name.
Optional arguments
modifiedParams
A tuple of tuples each containing the part name, the parameter name and the modified parameter
value. Default is an empty tuple.
updatePaths
A Bool specifying whether to update the path of the CAD model file specified in the parameterFile
to the current directory, if the CAD model is present in the current directory.

Return value
None

Exceptions
None.

5.1.37 lock()
This method locks the assembly. Locking the assembly prevents any further changes to the assembly
that can trigger regeneration of the assembly.

Arguments
None.

Return value
None

Exceptions
None.

5–21

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

5.1.38 unlock()
This method unlocks the assembly. Unlocking the assembly allows it to be regenerated after any
modifications to the assembly.

Arguments
None.

Return value
None

Exceptions
None.

5.1.39 setMeshNumberingControl(...)
This method changes the start node and/or element labels on the specified independent part instances
before or after Abaqus/CAE generates the meshes. For the meshed instances, Abaqus/CAE changes the
node and/or element labels while preserving the original order and incrementation.

Arguments
Required argument
instances
A sequence of PartInstance objects to change the start node and/or element labels.
Optional arguments
startNodeLabel
A positive Integer specifying the new start node label.
startElemLabel
A positive Integer specifying the new start element label.

Return value
None

Exceptions
None.

5–22

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

5.1.40 Members
The Assembly object can have the following members:
isOutOfDate
An Int specifying that feature parameters have been modified but that the assembly has not been
regenerated. Possible values are 0 and 1.
timeStamp
A Float specifying which gives an indication when the assembly was last modified.
isLocked
An Int specifying whether the assembly is locked or not. Possible values are 0 and 1.
regenerateConstraintsTogether
A Boolean specifying whether the positioning constraints in the assembly should be regenerated
together before regenerating other assembly features. The default value is ON.
If the assembly has position constraint features and you modify the value of
regenerateConstraintsTogether, Abaqus/CAE will regenerate the assembly features.
vertices
A VertexArray object specifying all the vertices existing at the assembly level. This member does
not provide access to the vertices at the instance level.
edges
An EdgeArray object specifying all the edges existing at the assembly level. This member does
not provide access to the edges at the instance level.
elements
A MeshElementArray object specifying all the elements existing at the assembly level. This
member does not provide access to the elements at the instance level.
nodes
A MeshNodeArray object specifying all the nodes existing at the assembly level. This member
does not provide access to the nodes at the instance level.
instances
A repository of PartInstance objects.
datums
A repository of Datum objects specifying all Datum objects in the assembly.
features
A repository of Feature objects specifying all Feature objects in the assembly.
featuresById
A repository of Feature objects specifying all Feature objects in the assembly.
The Feature objects in the featuresById repository are the same as the Feature objects
in the features repository. However, the key to the objects in the featuresById repository
is an integer specifying the ID, whereas the key to the objects in the features repository is a
string specifying the name.

5–23

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

surfaces
A repository of Surface objects specifying for more information, see Chapter 41, “Region
commands.”
allSurfaces
A repository of Surface objects specifying for more information, see Chapter 41, “Region
commands.”
allInternalSurfaces
A repository of Surface objects specifying picked regions.
sets
A repository of Set objects.
allSets
A repository of Set objects specifying for more information, see Chapter 41, “Region commands.”
allInternalSets
A repository of Set objects specifying picked regions.
skins
A repository of Skin objects specifying for more information, see Chapter 41, “Region
commands.”
stringers
A repository of Stringer objects specifying for more information, see Chapter 41, “Region
commands.”
referencePoints
A repository of ReferencePoint objects.
engineeringFeatures
An EngineeringFeature object.
modelName
A String specifying the name of the model to which the assembly belongs.
connectorOrientations
A ConnectorOrientationArray object.
sectionAssignments
A SectionAssignmentArray object.

5.2 ConnectorOrientation object

The ConnectorOrientation object is used to assign a connector orientation to a connector.

Access
import assembly

5–24

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

mdb.models[name].rootAssembly.connectorOrientations[i]
import odbAccess
session.odbs[name].rootAssembly.connectorOrientations[i]

5.2.1 ConnectorOrientation(...)
This method creates a ConnectorOrientation object.

Path
mdb.models[name].rootAssembly.ConnectorOrientation
session.odbs[name].rootAssembly.ConnectorOrientation

Required argument
region
A Set object specifying the region to which the orientation is assigned.
Optional arguments
localCsys1
A DatumCsys object specifying the local coordinate system of the first connector point. This value
may be None, indicating the global coordinate system.
axis1
A SymbolicConstant specifying the axis of a datum coordinate system about which an additional
rotation is applied. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is
AXIS_1.
angle1
A Float specifying the angle of the additional rotation. The default value is 0.0.
orient2sameAs1
A Boolean specifying whether or not the second connector point is to use the same local coordinate
system, axis, and angle as the first point. The default value is ON.
localCsys2
A DatumCsys object specifying the local coordinate system of the second connector point. This
value may be None, indicating the global coordinate system.
axis2
A SymbolicConstant specifying the axis of a datum coordinate system about which an additional
rotation is applied. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is
AXIS_1.
angle2
A Float specifying the angle of the additional rotation. The default value is 0.0.

5–25

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Return value
A ConnectorOrientation object.

Exceptions
None.

5.2.2 setValues(...)
This method modifies the ConnectorOrientation object.

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

Return value
None

Exceptions
None.

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

5.3 Feature object

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

Access
import assembly

5–26

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

5.3.1 AttachmentLines(...)
This method creates a Feature object by creating attachment lines between the given set of source and
target faces. The given points are first projected onto the source faces using the specified projection
method. The points are then projected normal to the source faces onto the target faces. The user can
specify the number of projections or the length of projection vector for projection onto the target faces.
The lines are then created between the source face and the closest target face. Subsequent lines are
created between the target faces.

Path
mdb.models[name].rootAssembly.AttachmentLines

Required arguments
name
A String specifying a unique Feature name.
points
A tuple of points. Each point can be a Vertex, Datum point, Reference point, an Attachment point,
orphan mesh Node, or an Interesting point object.
sourceFaces
A sequence of Face objects specifying the geometry faces onto which the points are to be projected.
sourceElementFaces
A sequence of MeshFace objects specifying the orphan mesh element faces onto which the points
are to be projected.
targetFaces
A sequence of Face objects specifying the geometry faces on which the attachment lines will
terminate.
targetElementFaces
A sequence of MeshFace objects specifying the orphan mesh element faces on which the
attachment lines will terminate.
Optional arguments
projectionMethod
A SymbolicConstant specifying the method to be used to project onto source faces. Possible
values are PROJECT_BY_PROXIMITY and PROJECT_BY_DIRECTION. The default value is
PROJECT_BY_PROXIMITY.
projectionDirStartPt
A point specifying the start point of the projection direction to project onto source faces. The point
can be a Vertex, Datum point, Reference point, Attachment point, orphan mesh Node, Interesting
Point object, or a tuple of Floats representing the coordinates of a point.

5–27

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

projectionDirEndPt
A point specifying the end point of the projection direction to project onto source faces. The point
can be a Vertex, Datum point, Reference point, Attachment point, orphan mesh Node, Interesting
point object, or a tuple of Floats representing the coordinates of a point.
sourceToTargetProjMethod
A SymbolicConstant specifying the method to be used to project onto target faces. Possible
values are PROJECT_BY_NUMBER and PROJECT_BY_DISTANCE. The default value is
PROJECT_BY_NUMBER.
numProjections
An integer specifying the maximum number of layers each point should be projected onto when
the source to target projection method is PROJECT_BY_NUMBER.
projectionDistance
A float specifying the maximum distance of the projection vector when the source to target
projection method is PROJECT_BY_DISTANCE.
flipSourceToTargetDirection
A Boolean specifying whether the computed projection direction from the source to the target faces
should be flipped.
setName
A String specifying a unique set name.

Return value
A Feature object.

Exceptions
None.

5.3.2 Coaxial(...)
This method moves an instance so that its selected face is coaxial with the selected face of a fixed instance.

Path
mdb.models[name].rootAssembly.Coaxial

Required arguments
movableAxis
A cylindrical or conical Face on the part instance to be moved.
fixedAxis
A cylindrical or conical Face on the part instance that remains fixed.

5–28

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

flip
A Boolean specifying whether the axes are forward aligned (OFF) or reverse aligned (ON).
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

5.3.3 CoincidentPoint(...)
This method moves an instance so that a specified point is coincident with a specified point of a fixed
instance.

Path
mdb.models[name].rootAssembly.CoincidentPoint

Required arguments
movablePoint
A Vertex, a Datum point, or a ReferencePoint or a mesh node from an orphan mesh on the part
instance to be moved.
fixedPoint
A Vertex, a Datum point, or a ReferencePoint or a mesh node from an orphan mesh on the part
instance to remain fixed.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

5.3.4 EdgeToEdge(...)
This method moves an instance so that its edge is parallel to an edge of a fixed instance.

5–29

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Path
mdb.models[name].rootAssembly.EdgeToEdge

Required arguments
movableAxis
A straight Edge, a Datum axis, or an element edge from an orphan mesh on the part instance to be
moved.
fixedAxis
A straight Edge, a Datum axis, or an element edge from an orphan mesh on the part instance to
remain fixed.
flip
A Boolean specifying whether the edges are forward aligned (OFF) or reverse aligned (ON).
clearance
A Float specifying the distance between the two edges (for two-dimensional and axisymmetric
instances only).
Optional arguments
None.

Return value
A Feature Object.

Exceptions
AbaqusException.

5.3.5 FaceToFace(...)
This method moves an instance so that its face is coincident with a face of a fixed instance.

Path
mdb.models[name].rootAssembly.FaceToFace

Required arguments
movablePlane
A planar face, a Datum plane, or a face from an orphan mesh on the part instance to be moved.
fixedPlane
A planar face, a Datum plane, or a face from an orphan mesh on the part instance to remain fixed.

5–30

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

flip
A Boolean specifying whether the normals to the faces are forward aligned (OFF) or reverse
aligned (ON).
clearance
A Float specifying the distance between the two faces.
Optional arguments
None.

Return value
A Feature Object.

Exceptions
AbaqusException.

5.3.6 ParallelCsys(...)
This method moves an instance so that its Datum coordinate system is parallel to a Datum coordinate
system of a fixed instance.

Path
mdb.models[name].rootAssembly.ParallelCsys

Required arguments
movableCsys
A Datum coordinate system on the part instance to be moved.
fixedCsys
A Datum coordinate system on the part instance to remain fixed.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

5–31

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

5.3.7 ParallelEdge(...)
This method moves an instance so that its edge is parallel to an edge of a fixed instance.

Path
mdb.models[name].rootAssembly.ParallelEdge

Required arguments
movableAxis
A straight Edge, a Datum axis, or an element edge from an orphan mesh on the part instance to be
moved.
fixedAxis
A straight Edge, a Datum axis, or an element edge from an orphan mesh on the part instance to
remain fixed.
flip
A Boolean specifying whether the edges are forward aligned (OFF) or reverse aligned (ON).
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

5.3.8 ParallelFace(...)
This method moves an instance so that its face is parallel to a face of a fixed instance.

Path
mdb.models[name].rootAssembly.ParallelFace

Required arguments
movablePlane
A planar face, a Datum plane, or a face from an orphan mesh on the part instance to be moved.
fixedPlane
A planar face, a Datum plane, or a face from an orphan mesh on the part instance to remain fixed.

5–32

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

flip
A Boolean specifying whether the normals to the faces are forward aligned (OFF) or reverse
aligned (ON).
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

5.4 PartInstance object

A PartInstance object is an instance of a Part object.

Access
import assembly
mdb.models[name].rootAssembly.instances[name]

5.4.1 Instance(...)
This method creates a PartInstance object and puts it into the instances repository.

Path
mdb.models[name].rootAssembly.Instance

Required arguments
name
A String specifying the repository key. The name must be a valid Abaqus object name.
part
A Part object to be instanced. If the part does not exist, no PartInstance object is created.
Optional arguments
autoOffset
A Boolean specifying whether to apply an auto offset to the new part instance that will offset it
from existing part instances. The default value is OFF.

5–33

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

dependent
A Boolean specifying whether the part instance is dependent or independent. If dependent=OFF,
the part instance is independent. The default value is OFF.

Return value
A PartInstance object.

Exceptions
None.

5.4.2 InstanceFromBooleanCut(...)
This method creates a PartInstance in the instances repository after subtracting or cutting the
geometries of a group of part instances from that of a base part instance.

Path
mdb.models[name].rootAssembly.InstanceFromBooleanCut

Required arguments
name
A String specifying the repository key. The name must be a valid Abaqus object name.
instanceToBeCut
A PartInstance specifying the base instance from which to cut other instances.
cuttingInstances
A sequence of PartInstance objects specifying the instances with which to cut the base instance.
Optional argument
originalInstances
A SymbolicConstant specifying whether the original instances should be suppressed or deleted
after the merge operation. Possible values are SUPPRESS or DELETE. The default value is
SUPPRESS.

Return value
A PartInstance object.

Exceptions
None.

5–34

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

5.4.3 InstanceFromBooleanMerge(...)
This method creates a PartInstance in the instances repository after merging two or more part
instances. Only Abaqus native parts are supported by this method.

Path
mdb.models[name].rootAssembly.InstanceFromBooleanMerge

Required arguments
name
A String specifying the repository key. The name must be a valid Abaqus object name.
instances
A sequence of PartInstance objects specifying the part instances to merged.
Optional arguments
keepIntersections
A Boolean specifying whether the boundary intersections of Abaqus native part instances should
be retained after the merge operation. The default value is False.
originalInstances
A SymbolicConstant specifying whether the original instances should be suppressed or deleted
after the merge operation. Possible values are SUPPRESS or DELETE. The default value is
SUPPRESS.

Return value
A PartInstance object.

Exceptions
None.

5.4.4 LinearInstancePattern(...)
This method creates multiple PartInstance objects in a linear pattern and puts them into the instances
repository.

Path
mdb.models[name].rootAssembly.LinearInstancePattern

5–35

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Required arguments
instanceList
A sequence of Strings specifying the names of instances to pattern.
number1
An Int specifying the total number of instances, including the original instances, that appear along
the first direction in the pattern.
spacing1
A Float specifying the spacing between instances along the first direction in the pattern.
number2
An Int specifying the total number of instances, including the original instances, that appear along
the second direction in the pattern.
spacing2
A Float specifying the spacing between instances along the second direction in the pattern.
Optional arguments
direction1
A sequence of three Floats specifying a vector along the first direction. The default value is (1.0,
0.0, 0.0).
direction2
A sequence of three Floats specifying a vector along the second direction. The default value is
(0.0, 1.0, 0.0).

Return value
A sequence of PartInstance objects.

Exceptions
None.

5.4.5 RadialInstancePattern(...)
This method creates multiple PartInstance objects in a radial pattern and puts them into the instances
repository.

Path
mdb.models[name].rootAssembly.RadialInstancePattern

5–36

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Required arguments
instanceList
A sequence of Strings specifying the names of instances to pattern.
number
An Int specifying the total number of instances, including the original instances, that appear in the
radial pattern.
totalAngle
A Float specifying the total angle in degrees between the first and last instance in the pattern. A
positive angle corresponds to a counter-clockwise direction. The values 360° and −360° represent
a special case where the pattern makes a full circle. In this case, because the copy would overlay
the original, the copy is not placed at the last position. Possible values are −360.0 totalAngle
360.0.
Optional arguments
point
A sequence of three Floats specifying the center of the radial pattern. The default value is (0.0,
0.0, 0.0).
axis
A sequence of three Floats specifying the central axis of the radial pattern. The default value is
(0.0, 0.0, 1.0).

Return value
A sequence of PartInstance objects.

Exceptions
None.

5.4.6 checkGeometry(...)
This method checks the validity of the geometry of the part instance and prints a count of all topological
entities on the part instance (faces, edges, vertices, etc.).

Arguments
Required arguments
None.
Optional arguments
detailed
A Boolean specifying whether detailed output will be printed to the replay file. The default value
is OFF.

5–37

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

level
An Int specifying which level of checking is performed. Values can range from 20 to 70, with
higher values reporting less and less important errors. The default value is 20, which reports all
critical errors. When the default value is used, the stored validity status is updated to agree with
the result of this check.

Return value
None

Exceptions
None.
An exception is thrown if this is a dependent part instance and level was either not specified or was
set to 20, because the validity status cannot be updated for a dependent part instance. In this case, this
command should be called on the Part instead.
The geometry of dependent part instances cannot be changed.

5.4.7 Contact(...)
This method translates an instance along the specified direction until it is in contact with a fixed instance.

Arguments
Required arguments
movableList
A sequence of Face or Edge objects on the part instance to be moved.
fixedList
A sequence of Face or Edge objects on the part instance to remain fixed.
direction
A sequence of three Floats specifying the direction of contact.
clearance
A Float specifying the distance between the two faces along the direction of contact.
Optional argument
isFaceEdges
A Boolean specifying how Abaqus calculates the contact. If isFaceEdges is OFF, contact is
computed from the movable face to the fixed face. If isFaceEdges is ON, contact is computed
using only the edges of the movable face and not its interior. The default value is OFF.

Return value
A Feature object.

5–38

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Exceptions
None.

5.4.8 ConvertConstraints()
This method converts the position constraints of an instance to absolute positions. The method deletes
the constraint features on the instance but preserves the position in space.

Arguments
None.

Return value
None

Exceptions
None.

5.4.9 getPosition()
This method prints the sum of the translations and rotations applied to the PartInstance object.

Arguments
None.

Return value
None

Exceptions
None.

5.4.10 getRotation()
This method returns a tuple including the point of rotation, axis of rotation, and rotation angle (in
degrees).

Arguments
None.

5–39

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Return value
A tuple including the point of rotation, axis of rotation, and rotation angle (in degrees).

Exceptions
None.

5.4.11 getTranslation()
This method returns a tuple of three Floats representing translation in the X-, Y-, and Z-directions.

Arguments
None.

Return value
A tuple of three Floats representing the translation.

Exceptions
None.

5.4.12 replace(...)
This method replaces one instance with an instance of another part.

Arguments
Required argument
instanceOf
A Part object specifying which Part will be instanced in place of the original Part .
Optional argument
applyConstraints
A Boolean specifying whether to apply existing constraints on the new instance or to position the
new instance in the same place as the original instance. The default value is True. A value of False
indicates that constraints applies to the instance are deleted will be deleted from the feature list.

Return value
None

5–40

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Exceptions
None.

5.4.13 rotateAboutAxis(...)
This method translates an instance by the specified amount.

Arguments
Required arguments
axisPoint
A sequence of three Floats specifying the X-, Y-, and Z-coordinates of a point on the axis.
axisDirection
A sequence of three Floats specifying the direction vector of the axis.
angle
A Float specifying the rotation angle in degrees. Use the right-hand rule to determine the direction.
Optional arguments
None.

Return value
None

Exceptions
None.

5.4.14 translate(...)
This method translates an instance by the specified amount.

Arguments
Required argument
vector
A sequence of three Floats specifying a translation vector.
Optional arguments
None.

Return value
None

5–41

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Exceptions
None.

5.4.15 translateTo(...)
This method translates an instance along the specified direction until it is in contact with a fixed instance.

Arguments
Required arguments
movableList
A sequence of Face or Edge objects on the part instance to be moved.
fixedList
A sequence of Face or Edge objects on the part instances to remain fixed.
direction
A sequence of three Floats specifying the direction of contact.
clearance
A Float specifying the distance between the two faces along the direction of contact.
Optional argument
vector
A sequence of three Floats specifying a translation vector. If this argument is specified, the movable
instance will be translated by the specified amount without solving for the actual contact.

Return value
A Feature object.

Exceptions
None.

5.4.16 Members
The PartInstance object can have the following members:
name
A String specifying the repository key. The name must be a valid Abaqus object name.
dependent
A Boolean specifying whether the part instance is dependent or independent. If dependent=OFF,
the part instance is independent. The default value is OFF.

5–42

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

geometryValidity
A Boolean specifying the validity of the geometry of the instance. The value is computed, but
it can be set to ON to perform feature and mesh operations on an invalid instance. There is no
guarantee that such operations will work if the instance was originally invalid.
analysisType
A SymbolicConstant specifying the part type. Possible values are DEFORMABLE_BODY,
EULERIAN, DISCRETE_RIGID_SURFACE, and ANALYTIC_RIGID_SURFACE.
referenceNode
An Int specifying the reference node number. This member is valid only if
analysisType=DISCRETE_RIGID_SURFACE or ANALYTIC_RIGID_SURFACE.
part
A Part object specifying the instanced part.
sets
A repository of Set objects specifying the sets created on the part. For more information, see
Chapter 41, “Region commands.”
surfaces
A repository of Surface objects specifying the sets created on the part. For more information, see
Chapter 41, “Region commands.”
skins
A repository of Skin objects specifying the skins created on the part. For more information, see
Chapter 41, “Region commands.”
stringers
A repository of Stringer objects specifying the stringers created on the part. For more information,
see Chapter 41, “Region commands.”
vertices
A VertexArray object.
ignoredVertices
An IgnoredVertexArray object.
edges
An EdgeArray object.
ignoredEdges
An IgnoredEdgeArray object.
faces
A FaceArray object.
cells
A CellArray object.
datums
A repository of Datum objects.

5–43

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

elements
A MeshElementArray object.
nodes
A MeshNodeArray object.
elemFaces
A MeshFaceArray object.
elementFaces
A MeshFaceArray object.
elemEdges
A MeshEdgeArray object.
elementEdges
A MeshEdgeArray object.
referencePoints
A repository of ReferencePoint objects.
partName
A String specifying the name of the part from which the instance was created.

5.5 Model object

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

Access
import assembly

5.5.1 Instance(...)
This method copies a PartInstance object from the specified model and creates a new PartInstance object.

Path
mdb.models[name].Instance

Required arguments
name
A String specifying the repository key.
objectToCopy
A PartInstance object to be copied.

5–44

Abaqus ID:
Printed on:
 ASSEMBLY COMMANDS

Optional arguments
None.

Return value
A Model object.

Exceptions
None.

5.5.2 convertAllSketches(...)
This method converts all sketches from Abaqus 6.5 or earlier to the equivalent ConstrainedSketch objects.

Arguments
Required arguments
None.
Optional arguments
regenerate
A Boolean specifying if all the features in assembly as well as in all the parts in the model should
be regenerated after the conversion. The default value is True.
convertReversedSketches
A Boolean specifying whether sketches in analytic rigid parts should be converted even if they
cause the orientation of surfaces defined on them to be flipped. The default value is True.

Return value
A list of strings describing any warnings or errors encountered during the conversion process.

Exceptions
None.

5.5.3 linkInstances(...)
This method links the selected PartInstance objects to the corresponding PartInstance objects from the
specified models. If all instances of a Part are selected for linking, the Part will be linked as well. If not,
a new linked child Part object will be created and added to the repository.

5–45

Abaqus ID:
Printed on:
ASSEMBLY COMMANDS

Arguments
Required argument
instancesMap
A tuple of tuples containing the instance name to be linked and the corresponding PartInstance
object to which it will be linked.
Optional arguments
None.

Return value
A list of strings describing any warnings or errors encountered during the conversion process.

Exceptions
None.

5–46

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

6. Basic geometry commands

The basic geometry commands create geometric entities that are referenced by Part objects, Instance
objects, and GeometrySet objects.

6.1 Cell object

Cells are volumetric regions of geometry.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].cells[i]
mdb.models[name].parts[name].allSets[name].cells[i]
mdb.models[name].parts[name].cells[i]
mdb.models[name].parts[name].sets[name].cells[i]
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].cells[i]
mdb.models[name].rootAssembly.allSets[name].cells[i]
mdb.models[name].rootAssembly.instances[name].cells[i]
mdb.models[name].rootAssembly.instances[name].sets[name].cells[i]
mdb.models[name].rootAssembly.sets[name].cells[i]

6.1.1 getSize(...)
This method returns a Float indicating the volume of the cell.

Arguments
Required arguments
None.
Optional argument
printResults
A Boolean that determines whether a verbose output is to be printed. The default is True.

Return value
A Float.

6–1

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Exceptions
None.

6.1.2 getFaces()
This method returns a sequence consisting of the face ids of the faces which bound the cell.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.1.3 getEdges()
This method returns a sequence consisting of the edge ids of the edges on the cell.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.1.4 getVertices()
This method returns a sequence consisting of the vertex ids of the vertices on the cell.

Arguments
None.

6–2

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Return value
A tuple of integers.

Exceptions
None.

6.1.5 getAdjacentCells()
This method returns an array of cell objects that share at least one face of the cell.

Arguments
None.

Return value
A CellArray object which is a sequence of Cell objects.

Exceptions
None.

6.1.6 getNodes()
This method returns an array of node objects that are associated with the cell.

Arguments
None.

Return value
A MeshNodeArray object which is a sequence of MeshNode objects.

Exceptions
None.

6.1.7 getElements()
This method returns an array of element objects that are associated with the cell.

6–3

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Arguments
None.

Return value
A MeshElementArray object which is a sequence of MeshElement objects.

Exceptions
None.

6.1.8 Members
The Cell object has the following members:
index
An Int specifying the index of the cell in the CellArray.
isReferenceRep
A Boolean specifying whether the cell belongs to the reference representation of the Part or
Instance.
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of a point located on the cell.
featureName
A tuple of Floats specifying the name of the feature that created this cell.
instanceName
A tuple of Floats specifying the name of the part instance for this cell (if applicable).

6.2 CellArray object

The CellArray is a sequence of Cell objects.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].cells
mdb.models[name].parts[name].allSets[name].cells
mdb.models[name].parts[name].cells
mdb.models[name].parts[name].sets[name].cells
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].cells
mdb.models[name].rootAssembly.allSets[name].cells

6–4

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

mdb.models[name].rootAssembly.instances[name].cells
mdb.models[name].rootAssembly.instances[name].sets[name].cells
mdb.models[name].rootAssembly.sets[name].cells

6.2.1 findAt(...)
This method returns the object or objects in the CellArray located at the given coordinates. findAt
initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any entity that is at the arbitrary
point specified or at a distance of less than 1E-6 from the arbitrary point. If nothing is found, findAt
uses the tolerance for imprecise geometry (applicable only for imprecise geometric entities). The
arbitrary point must not be shared by a second cell. If two cells intersect or coincide at the arbitrary
point, findAt chooses the first cell that it encounters, and you should not rely on the return value
being consistent.
findAt will always try to find objects among all the cells in the part or assembly instance and
will not restrict itself to a subset even if the CellArray represents such subset.

Arguments
Required argument
coordinates
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.
findAt returns either a Cell object or a sequence of Cell objects based on the type of
input. If coordinates is a sequence of Floats, findAt returns the Cell object at that point. If
coordinates is a sequence of sequence of Floats, findAt returns a sequence of Cell objects at the
given locations. The sequence of sequence of Floats must be a sequence of sequence of point and
normal data, not a sequence of point data. For example,
cells1 = myCrackedBlockInstance.cells.findAt(((5.5, -8.3, 294.2),),
((12.1, -8.3, 287.8),), ((14.4, -10.4, 285.5),),)

Optional argument
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the
specified location. The default value is True.

Return value
A Cell object.

Exceptions
None.

6–5

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.2.2 getSequenceFromMask(...)
This method returns the object or objects in the CellArray identified using the specified mask. This
command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large number
of objects are involved, this method is highly efficient.

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A Cell object or a sequence of Cell objects.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

6.2.3 getByBoundingBox(...)
This method returns an array of cell objects that lie within the specified bounding box.

Arguments
Required arguments
None.
Optional arguments
xMin
A float specifying the minimum X boundary of the bounding box.
yMin
A float specifying the minimum Y boundary of the bounding box.
zMin
A float specifying the minimum Z boundary of the bounding box.
xMax
A float specifying the maximum X boundary of the bounding box.
yMax
A float specifying the maximum Y boundary of the bounding box.

6–6

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

zMax
A float specifying the maximum Z boundary of the bounding box.

Return value
A CellArray object, which is a sequence of Cell objects.

Exceptions
None.

6.2.4 getByBoundingCylinder(...)
This method returns an array of cell objects that lie within the specified bounding cylinder.

Arguments
Required arguments
origin1
A tuple of the X-, Y-, and Z-coordinates of the center of the first end of the cylinder.
origin2
A tuple of the X-, Y-, and Z-coordinates of the center of the second end of the cylinder.
radius
A float specifying the radius of the cylinder.
Optional arguments
None.

Return value
A CellArray object, which is a sequence of Cell objects.

Exceptions
None.

6.2.5 getByBoundingSphere(...)
This method returns an array of cell objects that lie within the specified bounding sphere.

Arguments
Required arguments
origin
A tuple of the X-, Y-, and Z-coordinates of the center of the sphere.

6–7

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

radius
A float specifying the radius of the sphere.
Optional arguments
None.

Return value
A CellArray object, which is a sequence of Cell objects.

Exceptions
None.

6.2.6 getBoundingBox()
This method returns a dictionary of two tuples representing minimum and maximum boundary values of
the bounding box of the minimum size containing the cell sequence.

Arguments
None.

Return value
A Dictionary object with the following items:
low: a tuple of three floats representing the minimum x, y and z boundary values of the bounding
box.
high: a tuple of three floats representing the maximum x, y and z boundary values of the bounding
box.

Exceptions
None.

6.2.7 Members
The CellArray object has no members.

6.3 Edge object

Edges are one-dimensional regions of geometry.

6–8

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Access
import part
mdb.models[name].parts[name].allInternalSets[name].edges[i]
mdb.models[name].parts[name].allInternalSurfaces[name].edges[i]
mdb.models[name].parts[name].allSets[name].edges[i]
mdb.models[name].parts[name].allSurfaces[name].edges[i]
mdb.models[name].parts[name].edges[i]
mdb.models[name].parts[name].sets[name].edges[i]
mdb.models[name].parts[name].surfaces[name].edges[i]
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].edges[i]
mdb.models[name].rootAssembly.allInternalSurfaces[name].edges[i]
mdb.models[name].rootAssembly.allSets[name].edges[i]
mdb.models[name].rootAssembly.allSurfaces[name].edges[i]
mdb.models[name].rootAssembly.edges[i]
mdb.models[name].rootAssembly.instances[name].edges[i]
mdb.models[name].rootAssembly.instances[name].sets[name].edges[i]
mdb.models[name].rootAssembly.instances[name].surfaces[name].edges[i]
mdb.models[name].rootAssembly.sets[name].edges[i]
mdb.models[name].rootAssembly.surfaces[name].edges[i]

6.3.1 getCurvature(...)
This method returns curvature information at a location on the edge.

Arguments
Required arguments
parameter
A Float specifying the normalized parameter location on the edge where the curvature is to be
computed. This argument is mutually exclusive with the argument point.
point
A tuple of X-, Y-, and Z-coordinates of a point at which the curvature is to be computed. If point
does not lie on the edge an attempt is made to project it onto the edge and use the projected point.
Optional arguments
None.

Return value
A dictionary with keys ’evaluationPoint’, ’curvature’, ’radius’, ’tangent’. Where ’evaluationPoint’
specifies the location at which the curvature was computed. ’curvature’ specifies the curvature vector at

6–9

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

that location. ’radius’ is the Radius of curvature and ’tangent’ specifies the tangent to the edge at that
location.

Exceptions
The given edge is straight.

6.3.2 getFaces()
This method returns a sequence consisting of the face ids of the faces which share this edge.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.3.3 getAdjacentEdges()
This method returns an array of edge objects that share at least one vertex of the edge.

Arguments
None.

Return value
An EdgeArray object which is a sequence of Edge objects.

Exceptions
None.

6.3.4 getNodes()
This method returns an array of node objects that are associated with the edge.

Arguments
None.

6–10

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Return value
A MeshNodeArray object which is a sequence of MeshNode objects.

Exceptions
None.

6.3.5 getElements()
This method returns an array of element objects that are associated with the edge.

Arguments
None.

Return value
A MeshElementArray object which is a sequence of MeshElement objects.

Exceptions
None.

6.3.6 getRadius()
This method returns the radius of circular edges.

Arguments
None.

Return value
A Float specifying the radius.

Exceptions
The given edges is not circular.

6.3.7 getSize(...)
This method returns a Float indicating the length of the edge.

6–11

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Arguments
Required arguments
None.
Optional argument
printResults
A Bool specifying whether verbose output is printed. The default is True.

Return value
A Float.

Exceptions
None.

6.3.8 getVertices()
This method returns a sequence consisting of the vertex ids of the vertices which bound this edge.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.3.9 Members
The Edge object has the following members:
index
An Int specifying the index of the edge in the EdgeArray.
isReferenceRep
A Boolean specifying whether the edge belongs to the reference representation of the Part or
Instance.
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of a point located on the edge.
featureName
A tuple of Floats specifying the name of the feature that created this edge.

6–12

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

instanceName
A tuple of Floats specifying the name of the part instance for this edge (if applicable).

6.4 EdgeArray object

The EdgeArray is a sequence of Edge objects.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].edges
mdb.models[name].parts[name].allInternalSurfaces[name].edges
mdb.models[name].parts[name].allSets[name].edges
mdb.models[name].parts[name].allSurfaces[name].edges
mdb.models[name].parts[name].edges
mdb.models[name].parts[name].sets[name].edges
mdb.models[name].parts[name].surfaces[name].edges
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].edges
mdb.models[name].rootAssembly.allInternalSurfaces[name].edges
mdb.models[name].rootAssembly.allSets[name].edges
mdb.models[name].rootAssembly.allSurfaces[name].edges
mdb.models[name].rootAssembly.edges
mdb.models[name].rootAssembly.instances[name].edges
mdb.models[name].rootAssembly.instances[name].sets[name].edges
mdb.models[name].rootAssembly.instances[name].surfaces[name].edges
mdb.models[name].rootAssembly.sets[name].edges
mdb.models[name].rootAssembly.surfaces[name].edges

6.4.1 findAt(...)
This method returns the object or objects in the EdgeArray located at the given coordinates.
findAt initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any edge that
is at the arbitrary point specified or at a distance of less than 1E-6 from the arbitrary point. If nothing
is found, findAt uses the tolerance for imprecise geometry (applicable only for imprecise geometric
entities). The arbitrary point must not be shared by a second edge. If two edges intersect or coincide
at the arbitrary point, findAt chooses the first edge that it encounters, and you should not rely on the
return value being consistent.
findAt will always try to find objects among all the edges in the part or assembly instance and
will not restrict itself to a subset even if the EdgeArray represents such subset.

6–13

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Arguments
Required argument
coordinates
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.
findAt returns either an Edge object or a sequence of Edge objects based on the type of
input.
• If coordinates is a sequence of Floats, findAt returns the Edge object at that point.
• If you omit the coordinates keyword argument, findAt accepts as arguments a sequence of
sequence of floats in the following format:
edges = e.findAt(((20.19686, -169.513997, 27.798593), ),
((19.657627, -167.295749, 27.056402), ),
((18.274129, -157.144741, 25.15218), ))

Optional argument
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the
specified location. The default value is True.

Return value
An Edge object or a sequence of Edge objects.

Exceptions
None.

6.4.2 getClosest(...)
This method returns an object or objects in the EdgeArray closest to the given set of points, where the
given points need not lie on the edges in the EdgeArray.

Arguments
Required argument
coordinates
A sequence of a sequence of floats, where each sequence of floats describes the X-, Y-, and Z
coordinates of a point.
r=e.getClosest(coordinates=((20.0,20.0,10.0),(-1.0, -15.0, 15),))

r.keys()

6–14

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

[0, 1]

r[0]

(mdb.models['Model-1'].parts['Part-1'].edges[3], (15.7090625762939, 20.0

Optional arguments
None.

Return value
This method returns a dictionary object. The key to the dictionary object is the position of the input point
in the tuple specified in the coordinates starting at index 0. If a closest edge could be found then the value
is a sequence consisting of two objects. The first object in the sequence is an Edge that is close to the
input point referred to by the key. The second object in the sequence is a sequence of floats that specifies
the X-, Y-, and Z location of the closest point on the Edge to the given point. See program listing above.

Exceptions
None.

6.4.3 getSequenceFromMask(...)
This method returns the object or objects in the EdgeArray identified using the specified mask. This
command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large number
of objects are involved, this method is highly efficient.

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
An Edge object or a sequence of Edge objects.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

6–15

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.4.4 getByBoundingBox(...)
This method returns an array of edge objects that lie within the specified bounding box.

Arguments
Required arguments
None.
Optional arguments
xMin
A float specifying the minimum X boundary of the bounding box.
yMin
A float specifying the minimum Y boundary of the bounding box.
zMin
A float specifying the minimum Z boundary of the bounding box.
xMax
A float specifying the maximum X boundary of the bounding box.
yMax
A float specifying the maximum Y boundary of the bounding box.
zMax
A float specifying the maximum Z boundary of the bounding box.

Return value
An EdgeArray object, which is a sequence of Edge objects.

Exceptions
None.

6.4.5 getByBoundingCylinder(...)
This method returns an array of edge objects that lie within the specified bounding cylinder.

Arguments
Required arguments
origin1
A tuple of the X-, Y-, and Z-coordinates of the center of the first end of the cylinder.
origin2
A tuple of the X-, Y-, and Z-coordinates of the center of the second end of the cylinder.

6–16

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

radius
A float specifying the radius of the cylinder.
Optional arguments
None.

Return value
An EdgeArray object, which is a sequence of Edge objects.

Exceptions
None.

6.4.6 getByBoundingSphere(...)
This method returns an array of edge objects that lie within the specified bounding sphere.

Arguments
Required arguments
origin
A tuple of the X-, Y-, and Z-coordinates of the center of the sphere.
radius
A float specifying the radius of the sphere.
Optional arguments
None.

Return value
An EdgeArray object, which is a sequence of Edge objects.

Exceptions
None.

6.4.7 getBoundingBox()
This method returns a dictionary of two tuples representing minimum and maximum boundary values of
the bounding box of the minimum size containing the edge sequence.

Arguments
None.

6–17

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Return value
A Dictionary object with the following items:
low: a tuple of three floats representing the minimum x, y and z boundary values of the bounding
box.
high: a tuple of three floats representing the maximum x, y and z boundary values of the bounding
box.

Exceptions
None.

6.4.8 Members
The EdgeArray object has no members.

6.5 Face object

Faces are two-dimensional regions of geometry.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].faces[i]
mdb.models[name].parts[name].allInternalSurfaces[name].faces[i]
mdb.models[name].parts[name].allSets[name].faces[i]
mdb.models[name].parts[name].allSurfaces[name].faces[i]
mdb.models[name].parts[name].faces[i]
mdb.models[name].parts[name].sets[name].faces[i]
mdb.models[name].parts[name].surfaces[name].faces[i]
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].faces[i]
mdb.models[name].rootAssembly.allInternalSurfaces[name].faces[i]
mdb.models[name].rootAssembly.allSets[name].faces[i]
mdb.models[name].rootAssembly.allSurfaces[name].faces[i]
mdb.models[name].rootAssembly.instances[name].faces[i]
mdb.models[name].rootAssembly.instances[name].sets[name].faces[i]
mdb.models[name].rootAssembly.instances[name].surfaces[name].faces[i]
mdb.models[name].rootAssembly.sets[name].faces[i]
mdb.models[name].rootAssembly.surfaces[name].faces[i]

6–18

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

6.5.1 getCentroid()
This method returns the centroid of a face.

Arguments
None.

Return value
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the centroid of the face.

Exceptions
None.

6.5.2 getCurvature(...)
This method returns information about the curvature at a location on the face.

Arguments
Required arguments
point
A tuple specifying the X-, Y-, and Z coordinates of the point where the curvature is desired. If the
point does not lie on the face it will be projected onto the face. This argument and uParam and
vParam are mutually exclusive.
uParam
A Float specifying the normalized U parameter value at which the curvature is to be computed.
This value must lie between (0,1). vParam must also be specified. This argument is mutually
exclusive with point.
vParam
A Float specifying the normalized V parameter value at which the curvature is to be computed.
This value must lie between (0,1).
Optional arguments
None.

Return value
A dictionary with keys ’evaluationPoint’, ’principalAxis1’, ’principalAxis2’, ’curvature1’, ’curvature2’
and ’gaussianCurvature’. Where the evaluationPoint specifies the location at which the curvature was
evaluated. ’principalAxis1’ and ’principalAxis2’ refer to the vectors specifying the two principal axes
of the face. ’curvature1’ and ’curvature2’ specify the curvatures along the two principal axes.

6–19

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Exceptions
None.

6.5.3 getElements()
This method returns an array of element objects that are associated with the face.

Arguments
None.

Return value
A MeshElementArray object which is a sequence of MeshElement objects.

Exceptions
None.

6.5.4 getElementFaces(...)
This method returns an array of mesh face objects. Each mesh face object contains the element label and
the side of the element that lies on the geometric face.

Arguments
Required arguments
None.
Optional argument
side
A symbolic constant specifying the side of the geometric face from which the element faces
should be retrieved. Possible values are SIDE1, SIDE2, and BOTH_SIDES. The default value is
BOTH_SIDES.

Return value
A MeshFaceArray object which is a sequence of MeshFace objects.

Exceptions
None.

6–20

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

6.5.5 getNodes(...)
This method returns an array of mesh node objects. Each mesh node object contains the label of the node
that lies on the geometric face.

Arguments
Required arguments
None.
Optional argument
side
A symbolic constant specifying the side of the geometric face from which the nodes should
be retrieved. Possible values are SIDE1, SIDE2, and BOTH_SIDES. The default value is
BOTH_SIDES. If the meshes on the two sides of the face are compatible, this option is ignored.
Otherwise, the nodes on the specified side(s) of the face are output.

Return value
A MeshNodeArray object which is a sequence of MeshNode objects.

Exceptions
None.

6.5.6 getNormal(...)
This method returns the normal to a face at the location specified by the pointOn member. The normal
at a different location on the face can be obtained by specifying the optional point argument.

Arguments
Required arguments
None.
Optional argument
point
A tuple specifying the X-, Y-, and Z coordinates of the point where the normal to the face is desired.
If the point does not lie on the face it will be projected onto the face.

Return value
A sequence of Floats specifying the X-, Y-, and Z-components of the normal to the face.

6–21

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Exceptions
None.
An exception is raised if the optional argument point is provided but the point cannot be projected onto
the face.

6.5.7 getSize(...)
This method returns a Float indicating the area of the face.

Arguments
Required arguments
None.
Optional argument
printResults
A Bool specifying whether verbose output is printed. The default value is True.

Return value
A Float.

Exceptions
None.

6.5.8 getEdges()
This method returns a sequence consisting of the edge ids of the edges on the face.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.5.9 getVertices()
This method returns a sequence consisting of the vertex ids of the vertices of the face.

6–22

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.5.10 getCells()
This method returns a sequence consisting of the cell ids of the cells to which this face belongs.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.5.11 getAdjacentFaces()
This method returns an array of face objects that share at least one edge of the face.

Arguments
None.

Return value
A FaceArray object which is a sequence of Face objects.

Exceptions
None.

6–23

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.5.12 getFacesByFaceAngle(...)
This method returns an array of Face objects that are obtained by recursively finding adjacent faces that
are at an angle of less than or equal to the specified angle.

Arguments
Required arguments
None.
Optional argument
angle
A float specifying the value of the face angle.

Return value
A FaceArray object which is a sequence of Face objects.

Exceptions
None.

6.5.13 isNormalFlipped()
This method determines whether the normal to the face is flipped from its default direction by the use of
the FlipNormal method on a Part object.

Arguments
None.

Return value
A Boolean value of True if the normal is flipped and False if not.

Exceptions
None.

6.5.14 Members
The Face object has the following members:
index
An Int specifying the index of the face in the FaceArray.

6–24

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

isReferenceRep
A Boolean specifying whether the face belongs to the reference representation of the Part or
Instance.
pointOn
A tuple of tuples of Floats specifying the coordinates. For a face of a shell pointOn specifies the
X-, Y-, and Z-coordinates of a point located on the face and the X-, Y-, and Z-components of the
normal to the face.
For a face of a solid pointOn specifies the X-, Y-, and Z-coordinates of a point located on the
face.
featureName
A tuple of Floats specifying the name of the feature that created this face.
instanceName
A tuple of Floats specifying the name of the part instance for this face (if applicable).

6.6 FaceArray object

The FaceArray is a sequence of Face objects.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].faces
mdb.models[name].parts[name].allInternalSurfaces[name].faces
mdb.models[name].parts[name].allSets[name].faces
mdb.models[name].parts[name].allSurfaces[name].faces
mdb.models[name].parts[name].faces
mdb.models[name].parts[name].sets[name].faces
mdb.models[name].parts[name].surfaces[name].faces
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].faces
mdb.models[name].rootAssembly.allInternalSurfaces[name].faces
mdb.models[name].rootAssembly.allSets[name].faces
mdb.models[name].rootAssembly.allSurfaces[name].faces
mdb.models[name].rootAssembly.instances[name].faces
mdb.models[name].rootAssembly.instances[name].sets[name].faces
mdb.models[name].rootAssembly.instances[name].surfaces[name].faces
mdb.models[name].rootAssembly.sets[name].faces
mdb.models[name].rootAssembly.surfaces[name].faces

6–25

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.6.1 findAt(...)
This method returns the object or objects in the FaceArray located at the given coordinates.
findAt initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any face that is at
the arbitrary point specified or at a distance of less than 1E-6 from the arbitrary point. If nothing is found,
findAt uses the tolerance for imprecise geometry (applicable only for imprecise geometric entities).
The arbitrary point must not be shared by a second face. If two faces intersect or coincide at the arbitrary
point, findAt chooses the first face that it encounters, and you should not rely on the return value being
consistent.
findAt will always try to find objects among all the faces in the part or assembly instance and
will not restrict itself to a subset even if the FaceArray represents such subset.

Arguments
Required argument
coordinates
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.
findAt returns either a Face object or a sequence of Face objects based on the type of input.
• If coordinates is a sequence of Floats, findAt returns the Face object at that point.
• If you omit the coordinates keyword argument, findAt accepts as arguments a sequence
of pairs of sequences describing each face’s coordinate and normal, and findAt returns
a sequence of Face objects at the given locations. If you omit the coordinates keyword
argument, you must also omit the normal argument.

faces = f.findAt(((-16.438578, -41.835673, -24.19804), ),

((25.210364, -35.689868, 1.860314), ),
((26.727683, -38.207055, 4.164759), ))

Optional arguments
normal
A sequence of Floats specifying the X-, Y-, and Z-components of a vector indicating the face
normal.
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the
specified location. The default value is True.

Return value
A Face object.

6–26

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Exceptions
None.

6.6.2 getSequenceFromMask(...)
This method returns the object or objects in the FaceArray identified using the specified mask. This
command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large number
of objects are involved, this method is highly efficient.

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A Face object or a sequence of Face objects.

Exceptions
None.

6.6.3 getByBoundingBox(...)
This method returns an array of face objects that lie within the specified bounding box.

Arguments
Required arguments
None.
Optional arguments
xMin
A float specifying the minimum X boundary of the bounding box.
yMin
A float specifying the minimum Y boundary of the bounding box.
zMin
A float specifying the minimum Z boundary of the bounding box.
xMax
A float specifying the maximum X boundary of the bounding box.

6–27

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

yMax
A float specifying the maximum Y boundary of the bounding box.
zMax
A float specifying the maximum Z boundary of the bounding box.

Return value
A FaceArray object, which is a sequence of Face objects.

Exceptions
None.

6.6.4 getByBoundingCylinder(...)
This method returns an array of face objects that lie within the specified bounding cylinder.

Arguments
Required arguments
origin1
A tuple of the X-, Y-, and Z-coordinates of the center of the first end of the cylinder.
origin2
A tuple of the X-, Y-, and Z-coordinates of the center of the second end of the cylinder.
radius
A float specifying the radius of the cylinder.
Optional arguments
None.

Return value
A FaceArray object, which is a sequence of Face objects.

Exceptions
None.

6.6.5 getByBoundingSphere(...)
This method returns an array of face objects that lie within the specified bounding sphere.

6–28

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Arguments
Required arguments
origin
A tuple of the X-, Y-, and Z-coordinates of the center of the sphere.
radius
A float specifying the radius of the sphere.
Optional arguments
None.

Return value
A FaceArray object, which is a sequence of Face objects.

Exceptions
None.

6.6.6 getBoundingBox()
This method returns a dictionary of two tuples representing minimum and maximum boundary values of
the bounding box of the minimum size containing the face sequence.

Arguments
None.

Return value
A Dictionary object with the following items:
low: a tuple of three floats representing the minimum x, y and z boundary values of the bounding
box.
high: a tuple of three floats representing the maximum x, y and z boundary values of the bounding
box.

Exceptions
None.

6.6.7 getClosest(...)
This method returns an object or objects in the FaceArray closest to the given set of points, where the
given points need not lie on the faces in the FaceArray.

6–29

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Arguments
Required argument
coordinates
A sequence of a sequence of floats, where each sequence of floats describes the X-, Y-, and Z
coordinates of a point.
r=f.getClosest(coordinates=((20.0,20.0,10.0),(-1.0, -15.0, 15),))

r.keys()

[0, 1]

r[0]

(mdb.models['Model-1'].parts['Part-1'].faces[0], (15.7090625762939, 20.

Optional arguments
None.

Return value
This method returns a dictionary object. The key to the dictionary object is the position of the input point
in the tuple specified in the coordinates starting at index 0. If a closest face could be found then the value
is a sequence consisting of two objects. The first object in the sequence is a Face that is close to the input
point referred to by the key. The second object in the sequence is a sequence of floats that specifies the
X-, Y-, and Z location of the closest point on the Face to the given point. See program listing above.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

6.6.8 Members
The FaceArray object has no members.

6.7 IgnoredEdge object

An IgnoredEdge object is a one-dimensional region of geometry that has been abstracted away by a
virtual topology feature.

6–30

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Access
import part
mdb.models[name].parts[name].ignoredEdges[i]
import assembly
mdb.models[name].rootAssembly.instances[name].ignoredEdges[i]

6.7.1 getSize(...)
This method returns a Float indicating the length of the edge.

Arguments
Required arguments
None.
Optional argument
printResults
A Bool specifying whether verbose output is printed. The default is True.

Return value
A Float.

Exceptions
None.

6.7.2 getRadius()
This method returns the radius of a circular IgnoredEdge object.

Arguments
None.

Return value
A Float specifying the radius.

Exceptions
The given IgnoredEdge object is not circular.

6–31

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.7.3 getCurvature(...)
This method returns curvature information at a location on the IgnoredEdge object.

Arguments
Required arguments
parameter
A Float specifying the normalized parameter location on the IgnoredEdge where the curvature is
to be computed. This argument is mutually exclusive with the argument point.
point
A tuple of X-, Y-, and Z coordinates of a point at which the curvature is to be computed. If point
does not lie on the IgnoredEdge an attempt is made to project it onto the IgnoredEdge and use the
projected point.
Optional arguments
None.

Return value
A dictionary with keys ’evaluationPoint’, ’curvature’, ’radius’, ’tangent’. Where ’evaluationPoint’
specifies the location at which the curvature was computed. ’curvature’ specifies the curvature vector at
that location. ’radius’ is the Radius of curvature and ’tangent’ specifies the tangent to the IgnoredEdge
at that location.

Exceptions
The given IgnoredEdge is straight.

6.7.4 Members
The IgnoredEdge object has the following members:
index
An Int specifying the index of the IgnoredEdge in the IgnoredEdgeArray .
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of a point located on the edge.

6.8 IgnoredEdgeArray object

The IgnoredEdgeArray is a sequence of IgnoredEdge objects.

6–32

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Access
import part
mdb.models[name].parts[name].ignoredEdges
import assembly
mdb.models[name].rootAssembly.instances[name].ignoredEdges

6.8.1 findAt(...)
This method returns the object or objects in the IgnoredEdgeArray located at the given coordinates.
findAt initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any IgnoredEdge
that is at the arbitrary point specified or at a distance of less than 1E-6 from the arbitrary point. If nothing
is found, findAt uses the tolerance for imprecise geometry (applicable only for imprecise geometric
entities). The arbitrary point must not be shared by a second IgnoredEdge . If two IgnoredEdge objects
intersect or coincide at the arbitrary point, findAt chooses the first IgnoredEdge that it encounters, and
you should not rely on the return value being consistent.
findAt will always try to find objects among all the ignored edges in the part or assembly instance
and will not restrict itself to a subset even if the IgnoredEdgeArray represents such subset.

Arguments
Required argument
coordinates
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.
findAt returns either an IgnoredEdge object or a sequence of IgnoredEdge objects based
on the type of input.
• If coordinates is a sequence of Floats, findAt returns the IgnoredEdge object at that point.
• If you omit the coordinates keyword argument, findAt accepts as arguments a sequence of
sequence of floats in the following format:
ignoredEdges = e.findAt(((20.19686, -169.513997, 27.798593), ),
((19.657627, -167.295749, 27.056402), ),
((18.274129, -157.144741, 25.15218), ))

Optional argument
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the
specified location. The default value is True.

Return value
An IgnoredEdge object or a sequence of IgnoredEdge objects.

6–33

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Exceptions
None.

6.8.2 getSequenceFromMask(...)
This method returns the object or objects in the IgnoredEdgeArray identified using the specified mask.
This command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large
number of objects are involved, this method is highly efficient.

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
An IgnoredEdge object or a sequence of IgnoredEdge objects.

Exceptions
None.

6.8.3 getClosest(...)
This method returns a object or objects in the IgnoredEdgeArray closest to the given set of points, where
the given points need not lie on the edges in the IgnoredEdgeArray.

Arguments
Required argument
coordinates
A sequence of a sequence of floats, where each sequence of floats describes the X-, Y-, and Z
coordinates of a point.
r=e.getClosest(coordinates=((20.0,20.0,10.0),(-1.0, -15.0, 15),))

r.keys()

[0, 1]

6–34

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

r[0]

(mdb.models['Model-1'].parts['Part-1'].ignoredEdges[3],
(15.7090625762939, 20.0, 10.0))

Optional arguments
None.

Return value
This method returns a dictionary object. The key to the dictionary object is the position of the input point
in the tuple specified in the coordinates starting at index 0. If a closest IgnoredEdge could be found then
the value is a sequence consisting of two objects. The first object in the sequence is an IgnoredEdge that
is close to the input point referred to by the key. The second object in the sequence, is a sequence of
floats which specify the X-, Y-, and Z location of the closest point on the IgnoredEdge to the given point.
See program listing above.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

6.8.4 Members
The IgnoredEdgeArray object has no members.

6.9 IgnoredVertex object

An IgnoredVertex object is a point region of the geometry that was abstracted away by a virtual topology
feature.

Access
import part
mdb.models[name].parts[name].ignoredVertices[i]
import assembly
mdb.models[name].rootAssembly.instances[name].ignoredVertices[i]

6.9.1 Members
The IgnoredVertex object has the following members:

6–35

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

index
An Int specifying the index of the IgnoredVertex in the IgnoredVertexArray.
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of the vertex.

6.10 IgnoredVertexArray object

The IgnoredVertexArray is a sequence of IgnoredVertex objects.

Access
import part
mdb.models[name].parts[name].ignoredVertices
import assembly
mdb.models[name].rootAssembly.instances[name].ignoredVertices

6.10.1 findAt(...)
This method returns the object or objects in the IgnoredVertexArray located at the given coordinates.
findAt initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any IgnoredVertex
object that is at the arbitrary point specified or at a distance of less than 1E-6 from the arbitrary point.
If nothing is found, findAt uses the tolerance for imprecise geometry (applicable only for imprecise
geometric entities).
findAt will always try to find objects among all the ignored vertices in the part or assembly
instance and will not restrict itself to a subset even if the IgnoredVertexArray represents such subset.

Arguments
Required argument
coordinates
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.
findAt returns either a IgnoredVertex object or a sequence of IgnoredVertex objects based
on the type of input.
• If coordinates is a sequence of Floats, findAt returns the IgnoredVertex object at that point.
• If you omit the coordinates keyword argument, findAt accepts as arguments a sequence of
sequence of floats in the following format:
verts = v.findAt(((20.19686, -169.513997, 27.798593), ),
((19.657627, -167.295749, 27.056402), ),
((18.274129, -157.144741, 25.15218), ))

6–36

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Optional argument
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the
specified location. The default value is True.

Return value
An IgnoredVertex object or a sequence of IgnoredVertex objects.

Exceptions
None.

6.10.2 getSequenceFromMask(...)
This method returns the object or objects in the IgnoredVertexArray identified using the specified mask.
This command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large
number of objects are involved, this method is highly efficient.

Arguments

Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
An IgnoredVertex object or a sequence of IgnoredVertex objects.

Exceptions
None.

6.10.3 getClosest(...)
This method returns a object or objects in the IgnoredVertexArray closest to the given set of points, where
the given points need not lie on the vertices in the IgnoredVertexArray.

6–37

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Arguments
Required argument
coordinates
A sequence of a sequence of floats, where each sequence of floats describes the X-, Y-, and Z
coordinates of a point.
r=e.getClosest(coordinates=((20.0,20.0,10.0),(-1.0, -15.0, 15),))

r.keys()

[0, 1]

r[0]

(mdb.models['Model-1'].parts['Part-1'].ignoredVertices[3],
(15.7090625762939, 20.0, 10.0))

Optional arguments
None.

Return value
This method returns a dictionary object. The key to the dictionary object is the position of the input point
in the tuple specified in the coordinates starting at index 0. If a closest IgnoredVertex could be found
then the value is a sequence consisting of two objects. The first object in the sequence is a IgnoredVertex
that is close to the input point referred to by the key. The second object in the sequence, is a sequence of
floats which specify the X-, Y-, and Z location of the IgnoredVertex . See program listing above.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

6.10.4 Members
The IgnoredVertexArray object has no members.

6.11 InterestingPoint object

Interesting points can be located at the following:

6–38

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

• The middle of an edge.

• The middle of an arc.
• The center of an arc.
An InterestingPoint object is a temporary object and cannot be accessed from the Mdb object.

Access
import part
import assembly

6.11.1 InterestingPoint(...)
This method creates an interesting point along an edge. An InterestingPoint is a temporary object.

Path
mdb.models[name].parts[name].InterestingPoint
mdb.models[name].rootAssembly.instances[name].InterestingPoint

Required arguments
edge
An Edge object specifying the edge on which the interesting point is positioned.
rule
A SymbolicConstant specifying the position of the interesting point. Possible values are MIDDLE
or CENTER.
Optional arguments
None.

Return value
An InterestingPoint object.

Exceptions
None.

6.11.2 Members
The InterestingPoint object has no members.

6–39

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.12 ModelDot object

The ModelDot object can be used to access an actual MeshNode , ReferencePoint , or Vertex object.

6.12.1 Members
The ModelDot object has no members.

6.13 ReferencePoint object

The ReferencePoint object has no direct constructor; it is created when a Feature object is created. The
ReferencePoint method creates a Feature object that creates a ReferencePoint object.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].referencePoints[i]
mdb.models[name].parts[name].allSets[name].referencePoints[i]
mdb.models[name].parts[name].referencePoints[i]
mdb.models[name].parts[name].sets[name].referencePoints[i]
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].referencePoints[i]
mdb.models[name].rootAssembly.allSets[name].referencePoints[i]
mdb.models[name].rootAssembly.instances[name].referencePoints[i]
mdb.models[name].rootAssembly.instances[name].sets[name]\
.referencePoints[i]
mdb.models[name].rootAssembly.referencePoints[i]
mdb.models[name].rootAssembly.sets[name].referencePoints[i]

6.13.1 Members
The ReferencePoint object has no members.

6.14 Transform object

The MakeSketchTransform method creates a Transform object. The Transform object has no direct
constructor. A Transform object is a 4×3 matrix of Floats that represents the transformation from sketch
coordinates to assembly coordinates or to part coordinates.

6–40

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Access
import part
import assembly

6.14.1 matrix()
This method returns the transformation matrix as a tuple of 12 Floats.

Arguments
None.

Return value
A tuple of 12 Floats.

Exceptions
None.

6.14.2 Members
The Transform object has no members.

6.15 Vertex object

Vertices are point regions of geometry.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].vertices[i]
mdb.models[name].parts[name].allSets[name].vertices[i]
mdb.models[name].parts[name].sets[name].vertices[i]
mdb.models[name].parts[name].vertices[i]
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].vertices[i]
mdb.models[name].rootAssembly.allSets[name].vertices[i]
mdb.models[name].rootAssembly.instances[name].sets[name].vertices[i]
mdb.models[name].rootAssembly.instances[name].vertices[i]
mdb.models[name].rootAssembly.sets[name].vertices[i]
mdb.models[name].rootAssembly.vertices[i]

6–41

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

6.15.1 getEdges()
This method returns a sequence consisting of the edge ids of the edges which share this vertex.

Arguments
None.

Return value
A tuple of integers.

Exceptions
None.

6.15.2 getNodes()
This method returns an array of node objects that are associated with the vertex.

Arguments
None.

Return value
A MeshNodeArray object which is a sequence of MeshNode objects.

Exceptions
None.

6.15.3 getElements()
This method returns an array of element objects that are associated with the vertex.

Arguments
None.

Return value
A MeshElementArray object which is a sequence of MeshElement objects.

Exceptions
None.

6–42

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

6.15.4 Members
The Vertex object has the following members:
index
An Int specifying the index of the Vertex in the VertexArray.
isReferenceRep
A Boolean specifying whether the vertex belongs to the reference representation of the Part or
Instance.
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of the vertex.
featureName
A tuple of Floats specifying the name of the feature that created this vertex.
instanceName
A tuple of Floats specifying the name of the part instance for this vertex (if applicable).

6.16 VertexArray object

The VertexArray is a sequence of Vertex objects.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].vertices
mdb.models[name].parts[name].allSets[name].vertices
mdb.models[name].parts[name].sets[name].vertices
mdb.models[name].parts[name].vertices
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].vertices
mdb.models[name].rootAssembly.allSets[name].vertices
mdb.models[name].rootAssembly.instances[name].sets[name].vertices
mdb.models[name].rootAssembly.instances[name].vertices
mdb.models[name].rootAssembly.sets[name].vertices
mdb.models[name].rootAssembly.vertices

6.16.1 findAt(...)
This method returns the object or objects in the VertexArray located at the given coordinates.
findAt initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any Vertex object
that is at the arbitrary point specified or at a distance of less than 1E-6 from the arbitrary point. If nothing

6–43

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

is found, findAt uses the tolerance for imprecise geometry (applicable only for imprecise geometric
entities).
findAt will always try to find objects among all the vertices in the part or assembly instance and
will not restrict itself to a subset even if the VertexArray represents such subset.

Arguments

Required argument
coordinates
A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.
findAt returns either a Vertex object or a sequence of Vertex objects based on the type of
input.

• If coordinates is a sequence of Floats, findAt returns the Vertex object at that point.
• If you omit the coordinates keyword argument, findAt accepts as arguments a sequence of
sequence of floats in the following format:

verts = v.findAt(((20.19686, -169.513997, 27.798593), ),

((19.657627, -167.295749, 27.056402), ),
((18.274129, -157.144741, 25.15218), ))

Optional argument
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the
specified location. The default value is True.

Return value
A Vertex object or a sequence of Vertex objects.

Exceptions
None.

6.16.2 getSequenceFromMask(...)
This method returns the object or objects in the VertexArray identified using the specified mask. This
command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large number
of objects are involved, this method is highly efficient.

6–44

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A Vertex object or a sequence of Vertex objects.

Exceptions
None.

6.16.3 getByBoundingBox(...)
This method returns an array of vertex objects that lie within the specified bounding box.

Arguments
Required arguments
None.
Optional arguments
xMin
A float specifying the minimum X boundary of the bounding box.
yMin
A float specifying the minimum Y boundary of the bounding box.
zMin
A float specifying the minimum Z boundary of the bounding box.
xMax
A float specifying the maximum X boundary of the bounding box.
yMax
A float specifying the maximum Y boundary of the bounding box.
zMax
A float specifying the maximum Z boundary of the bounding box.

Return value
A VertexArray object, which is a sequence of Vertex objects.

6–45

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

Exceptions
None.

6.16.4 getByBoundingCylinder(...)
This method returns an array of vertex objects that lie within the specified bounding cylinder.

Arguments
Required arguments
origin1
A tuple of the X-, Y-, and Z-coordinates of the center of the first end of the cylinder.
origin2
A tuple of the X-, Y-, and Z-coordinates of the center of the second end of the cylinder.
radius
A float specifying the radius of the cylinder.
Optional arguments
None.

Return value
A VertexArray object, which is a sequence of Vertex objects.

Exceptions
None.

6.16.5 getByBoundingSphere(...)
This method returns an array of vertex objects that lie within the specified bounding sphere.

Arguments
Required arguments
origin
A tuple of the X-, Y-, and Z-coordinates of the center of the sphere.
radius
A float specifying the radius of the sphere.
Optional arguments
None.

6–46

Abaqus ID:
Printed on:
 BASIC GEOMETRY COMMANDS

Return value
A VertexArray object, which is a sequence of Vertex objects.

Exceptions
None.

6.16.6 getBoundingBox()
This method returns a dictionary of two tuples representing minimum and maximum boundary values of
the bounding box of the minimum size containing the vertex sequence.

Arguments
None.

Return value
A Dictionary object with the following items:
low: a tuple of three floats representing the minimum x, y and z boundary values of the bounding
box.
high: a tuple of three floats representing the maximum x, y and z boundary values of the bounding
box.

Exceptions
None.

6.16.7 getClosest(...)
This method returns a object or objects in the VertexArray closest to the given set of points, where the
given points need not lie on Vertex objects in the VertexArray.

Arguments
Required argument
coordinates
A sequence of a sequence of floats, where each sequence of floats describes the X-, Y-, and Z
coordinates of a point.
r=v.getClosest(coordinates=((20.0,20.0,10.0),(-1.0, -15.0, 15),))

r.keys()

6–47

Abaqus ID:
Printed on:
BASIC GEOMETRY COMMANDS

[0, 1]

r[0]

(mdb.models['Model-1'].parts['Part-1'].vertices[0],
(15.7090625762939, 29.1666641235352, 20.0))

Optional arguments
None.

Return value
This method returns a dictionary object. The key to the dictionary object is the position of the input point
in the tuple specified in the coordinates starting at index 0. If a closest vertex could be found then the
value is a sequence consisting of two objects. The first object in the sequence is a Vertex that is close
to the input point referred to by the key. The second object in the sequence is a sequence of floats that
specifies the X-, Y-, and Z location of the Vertex . See program listing above.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

6.16.8 Members
The VertexArray object has no members.

6–48

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

7. Beam Section profile commands

The Beam Section profile commands are used to create profiles. A profile definition specifies the
properties of a beam that are related to its cross-section geometry. When you define a beam section, you
must include a reference to a profile in the section definition.

7.1 Profile object

The Profile object defines the geometrical properties of a beam cross-section. Profile is an abstract base
type.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.1.1 beamProfilesFromOdb(...)
This method creates Profile objects by reading an output database. The new profiles are placed in the
profiles repository.

Path
mdb.models[name].beamProfilesFromOdb

Required argument
fileName
A String specifying the name of the output database file (including the .odb extension) to be read.
The String can also be the full path to the output database file if it is located in another directory.
Optional arguments
None.

Return value
A list of Profile objects.

7–1

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

Exceptions
None.

7.1.2 Members
The Profile object has the following member:
name
A String specifying the repository key.

7.2 ArbitraryProfile object

The ArbitraryProfile object defines the properties of an arbitrary profile.

The ArbitraryProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.2.1 ArbitraryProfile(...)
This method creates a ArbitraryProfile object.

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

Required arguments
name
A String specifying the repository key.
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data
The first sequence in the table specifies the following:

7–2

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

• 1-coordinate of the first point defining the profile.

• 2-coordinate of the first point defining the profile.
All other sequences in the table specify the following:
• 1–coordinate of the next point defining the profile.
• 2–coordinate of the next point defining the profile.
• The thickness of the segment ending at that point.

Return value
An ArbitraryProfile object.

Exceptions
RangeError.

7.2.2 setValues(...)
This method modifies the ArbitraryProfile object.

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

Return value
None

Exceptions
RangeError.

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

7.2.4 Corresponding analysis keywords

7–3

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

*BEAM SECTION, SECTION=ARBITRARY

7.3 BoxProfile object

The BoxProfile object defines the properties of a box profile.

The BoxProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.3.1 BoxProfile(...)
This method creates a BoxProfile object.

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

Required arguments
name
A String specifying the repository key.
a
A Float specifying the a dimension of the box profile. For more information, see “Beam cross-
section library,” Section 26.3.9 of the Abaqus Analysis User’s Manual.
b
A Float specifying the b dimension of the box profile.
uniformThickness
A Boolean specifying whether the thickness is uniform.
t1
A Float specifying the uniform wall thickness if uniformThickness=ON, and the wall thickness of
the first segment if uniformThickness=OFF.

7–4

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

Optional arguments
t2
A Float specifying the wall thickness of the second segment. t2 is required only when
uniformThickness=OFF. The default value is 0.0.
t3
A Float specifying the wall thickness of the third segment. t3 is required only when
uniformThickness=OFF. The default value is 0.0.
t4
A Float specifying the wall thickness of the fourth segment. t4 is required only when
uniformThickness=OFF. The default value is 0.0.

Return value
A BoxProfile object.

Exceptions
RangeError.

7.3.2 setValues(...)
This method modifies the BoxProfile object.

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

Return value
None

Exceptions
RangeError.

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

7–5

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

7.3.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=BOX

7.4 CircularProfile object

The CircularProfile object defines the properties of a solid circular profile.

The CircularProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.4.1 CircularProfile(...)
This method creates a CircularProfile object.

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

Required arguments
name
A String specifying the repository key.
r
A positive Float specifying the r dimension (outer radius) of the circular profile. For more
information, see “Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis User’s
Manual.
Optional arguments
None.

Return value
A CircularProfile object.

7–6

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

Exceptions
RangeError.

7.4.2 setValues(...)
This method modifies the CircularProfile object.

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

Return value
None

Exceptions
RangeError.

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

7.4.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=CIRC

7.5 GeneralizedProfile object

The GeneralizedProfile object defines the properties of a profile via its area, moment of inertia, etc.
The GeneralizedProfile object is derived from the Profile object.

7–7

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.5.1 GeneralizedProfile(...)
This method creates a GeneralizedProfile object.

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

Required arguments
name
A String specifying the repository key.
area
A Float specifying the cross-sectional area for the profile.
i11
A Float specifying the moment of inertia for bending about the 1-axis, .
i12
A Float specifying the moment of inertia for cross bending, .
i22
A Float specifying the moment of inertia for bending about the 2-axis, .
j
A Float specifying the torsional constant, .
gammaO
A Float specifying the sectorial moment, .
gammaW
A Float specifying the warping constant, .
Optional arguments
None.

Return value
A GeneralizedProfile object.

7–8

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

Exceptions
RangeError.

7.5.2 setValues(...)
This method modifies the GeneralizedProfile object.

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

Return value
None

Exceptions
RangeError.

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

7.5.4 Corresponding analysis keywords

*BEAM GENERAL SECTION, SECTION=GENERAL or NONLINEAR GENERAL

7.6 HexagonalProfile object

The HexagonalProfile object defines the properties of a hexagonal profile.

The HexagonalProfile object is derived from the Profile object.

7–9

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.6.1 HexagonalProfile(...)
This method creates a HexagonalProfile object.

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

Required arguments
name
A String specifying the repository key.
r
A positive Float specifying the r dimension (outer radius) of the hexagonal profile. For more
information, see “Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis User’s
Manual.
t
A positive Float specifying the t dimension (wall thickness) of the hexagonal profile, t <
(sqrt(3)/2)r.
Optional arguments
None.

Return value
A HexagonalProfile object.

Exceptions
RangeError.

7.6.2 setValues(...)
This method modifies the HexagonalProfile object.

7–10

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

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

Return value
None

Exceptions
RangeError.

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

7.6.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=HEX

7.7 IProfile object

The IProfile object defines the properties of an I profile.

The IProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.7.1 IProfile(...)
This method creates an IProfile object.

7–11

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

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

Required arguments
name
A String specifying the repository key.
l
A Float specifying the l dimension (offset of 1–axis from the bottom flange surface) of the I profile.
For more information, see “Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis
User’s Manual.
h
A Float specifying the h dimension (height) of the I profile.
b1
A Float specifying the b1 dimension (bottom flange width) of the I profile.
b2
A Float specifying the b2 dimension (top flange width) of the I profile.
t1
A Float specifying the t1 dimension (bottom flange thickness) of the I profile.
t2
A Float specifying the t2 dimension (top flange thickness) of the I profile.
t3
A Float specifying the t3 dimension (web thickness) of the I profile.
Optional arguments
None.

Return value
An IProfile object.

Exceptions
RangeError.

7.7.2 setValues(...)
This method modifies the IProfile object.

7–12

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

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

Return value
None

Exceptions
RangeError.

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

7.7.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=I

7.8 LProfile object

The LProfile object defines the properties of a L profile.

The LProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.8.1 LProfile(...)
This method creates a LProfile object.

7–13

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

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

Required arguments
name
A String specifying the repository key.
a
A positive Float specifying the a dimension (flange length) of the L profile. For more information,
see “Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis User’s Manual.
b
A positive Float specifying the b dimension (flange length) of the L profile.
t1
A positive Float specifying the t1 dimension (flange thickness) of the L profile (t1 < b).
t2
A positive Float specifying the t2 dimension (flange thickness) of the L profile (t2< a).
Optional arguments
None.

Return value
A LProfile object.

Exceptions
RangeError.

7.8.2 setValues(...)
This method modifies the LProfile object.

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

7–14

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

Return value
None

Exceptions
RangeError.

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

7.8.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=L

7.9 PipeProfile object

The PipeProfile object defines the properties of a circular pipe profile.

The PipeProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.9.1 PipeProfile(...)
This method creates a PipeProfile object.

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

7–15

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

Required arguments
name
A String specifying the repository key.
r
A Float specifying the outer radius of the pipe. For more information, see “Beam cross-section
library,” Section 26.3.9 of the Abaqus Analysis User’s Manual.
t
A Float specifying the wall thickness of the pipe.
Optional arguments
None.

Return value
A PipeProfile object.

Exceptions
RangeError.

7.9.2 setValues(...)
This method modifies the PipeProfile object.

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

Return value
None

Exceptions
RangeError.

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

7–16

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

7.9.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=PIPE

7.10 RectangularProfile object

The RectangularProfile object defines the properties of a solid rectangular profile.

The RectangularProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.10.1 RectangularProfile(...)
This method creates a RectangularProfile object.

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

Required arguments
name
A String specifying the repository key.
a
A positive Float specifying the a dimension of the rectangular profile. For more information, see
“Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis User’s Manual.
b
A positive Float specifying the b dimension of the rectangular profile.
Optional arguments
None.

7–17

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

Return value
A RectangularProfile object.

Exceptions
RangeError.

7.10.2 setValues(...)
This method modifies the RectangularProfile object.

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

Return value
None

Exceptions
RangeError.

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

7.10.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=RECT

7.11 TProfile object

The TProfile object defines the properties of a T profile.

7–18

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

The TProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7.11.1 TProfile(...)
This method creates a TProfile object.

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

Required arguments
name
A String specifying the repository key.
b
A positive Float specifying the b dimension (flange width) of the T profile. For more information,
see “Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis User’s Manual.
h
A positive Float specifying the h dimension (height) of the T profile.
l
A positive Float specifying the l dimension (offset of 1–axis from the edge of web) of the T profile.
tf
A positive Float specifying the tf dimension (flange thickness) of the T profile (tf < h).
tw
A positive Float specifying the tw dimension (web thickness) of the T profile (tw< b).
Optional arguments
None.

Return value
A TProfile object.

Exceptions
RangeError.

7–19

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

7.11.2 setValues(...)
This method modifies the TProfile object.

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

Return value
None

Exceptions
RangeError.

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

7.11.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=I

7.12 TrapezoidalProfile object

The TrapezoidalProfile object defines the properties of a trapezoidal profile.

The TrapezoidalProfile object is derived from the Profile object.

Access
import section
mdb.models[name].profiles[name]
import odbSection
session.odbs[name].profiles[name]

7–20

Abaqus ID:
Printed on:
 BEAM SECTION PROFILE COMMANDS

7.12.1 TrapezoidalProfile(...)
This method creates a TrapezoidalProfile object.

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

Required arguments
name
A String specifying the repository key.
a
A positive Float specifying the a dimension of the Trapezoidal profile. For more information, see
“Beam cross-section library,” Section 26.3.9 of the Abaqus Analysis User’s Manual.
b
A positive Float specifying the b dimension of the Trapezoidal profile.
c
A positive Float specifying the c dimension of the Trapezoidal profile.
d
A Float specifying the d dimension of the Trapezoidal profile.
Optional arguments
None.

Return value
A TrapezoidalProfile object.

Exceptions
RangeError.

7.12.2 setValues(...)
This method modifies the TrapezoidalProfile object.

Arguments
Required arguments
None.

7–21

Abaqus ID:
Printed on:
BEAM SECTION PROFILE COMMANDS

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

Return value
None

Exceptions
RangeError.

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

7.12.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=TRAPEZOID

7–22

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8. Boundary Condition commands

A specific type of boundary condition object and a specific type of boundary condition state
object are designed for each type of boundary condition. A BoundaryCondition object stores the
non-propagating data of a boundary condition as well as a number of instances of the corresponding
BoundaryConditionState object, each of which stores the propagating data of the boundary condition in
a single step. Instances of the BoundaryConditionState object are created and deleted internally by its
corresponding BoundaryCondition object.

8.1 BoundaryCondition object

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

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

8.1.1 deactivate(...)
This method deactivates the boundary condition in the specified step and all subsequent steps.

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is deactivated.
Optional arguments
None.

Return value
None

Exceptions
TextError.

8–1

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.1.2 move(...)
This method moves the boundary condition state from one step to a different step.

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

Return value
None

Exceptions
TextError.

8.1.3 reset(...)
This method resets the boundary condition 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 boundary condition state is reset.
Optional arguments
None.

Return value
None

Exceptions
TextError.

8–2

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.1.4 resume()
This method resumes the boundary condition that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

8.1.5 suppress()
This method suppresses the boundary condition.

Arguments
None.

Return value
None

Exceptions
None.

8.1.6 delete(...)
This method allows you to delete existing boundary conditions.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each boundary condition to delete.
Optional arguments
None.

8–3

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Return value
None

Exceptions
None.

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

8.2 AccelerationBC object

The AccelerationBC object stores the data for an acceleration boundary condition.
The AccelerationBC object is derived from the BoundaryCondition object.

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

8.2.1 AccelerationBC(...)
This method creates an AccelerationBC object.

Path
mdb.models[name].AccelerationBC

8–4

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
a1
A Float or a SymbolicConstant specifying the acceleration component in the 1-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.

Note: Although a1, a2, a3, ar1, ar2, and ar3 are optional arguments, at least one of them must
be specified.

a2
A Float or a SymbolicConstant specifying the acceleration component in the 2-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
a3
A Float or a SymbolicConstant specifying the acceleration component in the 3-direction. Possible
values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar1
A Float or a SymbolicConstant specifying the rotational acceleration component about the 1-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
ar2
A Float or a SymbolicConstant specifying the rotational acceleration component about the 2-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
ar3
A Float or a SymbolicConstant specifying the rotational acceleration component about the 3-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.

8–5

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition 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 boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

Return value
An AccelerationBC object.

Exceptions
None.

8.2.2 setValues(...)
This method modifies the data for an existing AccelerationBC 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 AccelerationBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

8–6

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
a1
A Float or a SymbolicConstant specifying the acceleration component in the 1-direction. Possible
values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a2
A Float or a SymbolicConstant specifying the acceleration component in the 2-direction. Possible
values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a3
A Float or a SymbolicConstant specifying the acceleration component in the 3-direction. Possible
values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar1
A Float or a SymbolicConstant specifying the rotational acceleration component about the 1-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar2
A Float or a SymbolicConstant specifying the rotational acceleration component about the 2-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar3
A Float or a SymbolicConstant specifying the rotational acceleration 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 boundary
condition 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.

8–7

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.2.4 Members
The AccelerationBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.3 AccelerationBCState object

The AccelerationBCState object stores the propagating data of an acceleration boundary condition in a
step. One instance of this object is created internally by the AccelerationBC object for each step. The
instance is also deleted internally by the AccelerationBC object.
The AccelerationBCState object has no constructor or methods.
The AccelerationBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.3.1 Members
The AccelerationBCState object has the following members:

8–8

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

a1
A Float specifying the acceleration component in the 1-direction.
a2
A Float specifying the acceleration component in the 2-direction.
a3
A Float specifying the acceleration component in the 3-direction.
ar1
A Float specifying the rotational acceleration component about the 1-direction.
ar2
A Float specifying the rotational acceleration component about the 2-direction.
ar3
A Float specifying the rotational acceleration component about the 3-direction.
a1State
A SymbolicConstant specifying the propagation state of the acceleration component in the 1-
direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
a2State
A SymbolicConstant specifying the propagation state of the acceleration component in the 2-
direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
a3State
A SymbolicConstant specifying the propagation state of the acceleration component in the 3-
direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar1State
A SymbolicConstant specifying the propagation state of the rotational acceleration component
about the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ar2State
A SymbolicConstant specifying the propagation state of the rotational acceleration component
about the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ar3State
A SymbolicConstant specifying the propagation state of the rotational acceleration 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 BoundaryConditionState object.
Possible values are:

8–9

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

• 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 boundary
condition has no amplitude reference.

8.3.2 Corresponding analysis keywords

*BOUNDARY, TYPE=ACCELERATION (degree of freedom: 1, 2, 3, 4, 5, or 6)

8.4 AcousticPressureBC object

The AcousticPressureBC object stores the data for an acoustic pressure boundary condition.
The AcousticPressureBC object is derived from the BoundaryCondition object.

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

8.4.1 AcousticPressureBC(...)
This method creates a AcousticPressureBC object.

8–10

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Path
mdb.models[name].AcousticPressureBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
magnitude
A Float specifying the acoustic pressure magnitude. The default value is 0. The magnitude
argument is optional if distributionType=USER_DEFINED.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.

Return value
An AcousticPressureBC object.

Exceptions
None.

8–11

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.4.2 setValues(...)
This method modifies the data for an existing AcousticPressureBC 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 AcousticPressureBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
magnitude
A Float or the SymbolicConstant FREED specifying the acoustic pressure magnitude.
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 boundary
condition 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

8–12

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Exceptions
None.

8.4.4 Members
The AcousticPressureBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.5 AcousticPressureBCState object

The AcousticPressureBCState object stores the propagating data for an acoustic pressure boundary
condition in a step. One instance of this object is created internally by the AcousticPressureBC object
for each step. The instance is also deleted internally by the AcousticPressureBC object.
The AcousticPressureBCState object has no constructor or methods.
The AcousticPressureBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8–13

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.5.1 Members
The AcousticPressureBCState object has the following members:
magnitude
A Float specifying the acoustic pressure magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the acoustic pressure magnitude. 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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.5.2 Corresponding analysis keywords

*BOUNDARY (degree of freedom: 8)

8–14

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.6 BoundaryConditionState object

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

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.6.1 Members
The BoundaryConditionState 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.
status
A SymbolicConstant specifying the propagation state of the BoundaryConditionState 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 boundary
condition has no amplitude reference.

8–15

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.7 ConcentrationBC object

The ConcentrationBC object stores the data for a concentration boundary condition.
The ConcentrationBC object is derived from the BoundaryCondition object.

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

8.7.1 ConcentrationBC(...)
This method creates a ConcentrationBC object.

Path
mdb.models[name].ConcentrationBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
magnitude
A Float specifying the concentration magnitude. The default value is 0. The magnitude argument
is optional if distributionType=USER_DEFINED.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

8–16

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.

Return value
A ConcentrationBC object.

Exceptions
None.

8.7.2 setValues(...)
This method modifies the data for an existing ConcentrationBC 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 ConcentrationBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.

8–17

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Optional arguments
magnitude
A Float or the SymbolicConstant FREED specifying the concentration magnitude.
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 boundary
condition 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.

8.7.4 Members
The ConcentrationBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8–18

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.8 ConcentrationBCState object

The ConcentrationBCState object stores the propagating data for a concentration boundary condition in
a step. One instance of this object is created internally by the ConcentrationBC object for each step. The
instance is also deleted internally by the ConcentrationBC object.
The ConcentrationBCState object has no constructor or methods.
The ConcentrationBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.8.1 Members
The ConcentrationBCState object has the following members:
magnitude
A Float specifying the concentration magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the concentration magnitude. 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 BoundaryConditionState 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

8–19

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

• BUILT_INTO_MODES

amplitude
A String specifying the name of the amplitude reference. The String is empty if the boundary
condition has no amplitude reference.

8.8.2 Corresponding analysis keywords

*BOUNDARY (degree of freedom: 11)

8.9 ConnAccelerationBC object

The ConnAccelerationBC object stores the data for a connector acceleration boundary condition.
The ConnAccelerationBC object is derived from the BoundaryCondition object.

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

8.9.1 ConnAccelerationBC(...)
This method creates an ConnAccelerationBC object.

Path
mdb.models[name].ConnAccelerationBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
connectors
A sequence of Strings specifying the names of the connectors to which the boundary condition is
applied.

8–20

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Optional arguments
a1
A Float or a SymbolicConstant specifying the acceleration component in the connector’s local
1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.

Note: Although a1, a2, a3, ar1, ar2, and ar3 are optional arguments, at least one of them must
be specified.

a2
A Float or a SymbolicConstant specifying the acceleration component in the connector’s local
2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
a3
A Float or a SymbolicConstant specifying the acceleration component in the connector’s local
3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.
ar1
A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s
local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default
value is UNSET.
ar2
A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s
local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default
value is UNSET.
ar3
A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s
local 6-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 boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

Return value
A ConnAccelerationBC object.

8–21

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Exceptions
None.

8.9.2 setValues(...)
This method modifies the data for an existing ConnAccelerationBC 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 ConnAccelerationBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
a1
A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s
local 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a2
A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s
local 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.

8–22

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

a3
A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s
local 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar1
A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s
local 4-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar2
A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s
local 5-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar3
A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s
local 6-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 boundary
condition 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.

8.9.4 Members
The ConnAccelerationBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
connectors
A tuple of Strings specifying the names of the connectors to which the boundary condition is
applied.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.

8–23

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.10 ConnAccelerationBCState object

The ConnAccelerationBCState object stores the propagating data of a connector acceleration boundary
condition in a step. One instance of this object is created internally by the ConnAccelerationBC object
for each step. The instance is also deleted internally by the ConnAccelerationBC object.
The ConnAccelerationBCState object has no constructor or methods.
The ConnAccelerationBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.10.1 Members
The ConnAccelerationBCState object has the following members:
a1
A Float specifying the connector acceleration component in the connector’s local 1-direction.
a2
A Float specifying the connector acceleration component in the connector’s local 2-direction.
a3
A Float specifying the connector acceleration component in the connector’s local 3-direction.
ar1
A Float specifying the connector acceleration component in the connector’s local 4-direction.
ar2
A Float specifying the connector acceleration component in the connector’s local 5-direction.
ar3
A Float specifying the connector acceleration component in the connector’s local 6-direction.
a1State
A SymbolicConstant specifying the propagation state of the connector acceleration component in
the connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.

8–24

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

a2State
A SymbolicConstant specifying the propagation state of the connector acceleration component in
the connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
a3State
A SymbolicConstant specifying the propagation state of the connector acceleration component in
the connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ar1State
A SymbolicConstant specifying the propagation state of the connector acceleration component in
the connector’s local 4-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ar2State
A SymbolicConstant specifying the propagation state of the connector acceleration component in
the connector’s local 5-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ar3State
A SymbolicConstant specifying the propagation state of the connector acceleration component in
the connector’s local 6-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 BoundaryConditionState 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

8–25

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

amplitude
A String specifying the name of the amplitude reference. The String is empty if the boundary
condition has no amplitude reference.

8.10.2 Corresponding analysis keywords

*CONNECTOR MOTION, TYPE=ACCELERATION (degree of freedom: 1, 2, 3, 4, 5, or 6)

8.11 ConnDisplacementBC object

The ConnDisplacementBC object stores the data for a connector displacement/rotation boundary
condition.
The ConnDisplacementBC object is derived from the BoundaryCondition object.

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

8.11.1 ConnDisplacementBC(...)
This method creates a ConnDisplacementBC object.

Path
mdb.models[name].ConnDisplacementBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
connectors
A sequence of Strings specifying the names of the connectors to which the boundary condition is
applied.

8–26

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Optional arguments
u1
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the
connector’s local 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, a Complex, or a SymbolicConstant specifying the displacement component in the
connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET.
The default value is UNSET.
u3
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the
connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET.
The default value is UNSET.
ur1
A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s
local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default
value is UNSET.
ur2
A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s
local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default
value is UNSET.
ur3
A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s
local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default
value is UNSET.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

8–27

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A ConnDisplacementBC object.

Exceptions
None.

8.11.2 setValues(...)
This method modifies the data for an existing ConnDisplacementBC 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 ConnDisplacementBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.

8–28

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Optional arguments
u1
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the
connector’s local 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED,
and FREED.
u2
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the
connector’s local 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED,
and FREED.
u3
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the
connector’s local 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED,
and FREED.
ur1
A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s
local 4-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur2
A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s
local 5-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur3
A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s
local 6-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 boundary
condition is changed to have no amplitude reference. You should provide the amplitude argument
only if it is valid for the specified step.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
None

Exceptions
None.

8–29

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.11.4 Members
The ConnDisplacementBC object can have the following members:
name
A String specifying the boundary condition repository key.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
connectors
A tuple of Strings specifying the names of the connectors to which the boundary condition is
applied.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.12 ConnDisplacementBCState object

The ConnDisplacementBCState object stores the propagating data for a connector displacement/rotation
boundary condition in a step. One instance of this object is created internally by the
ConnDisplacementBC object for each step. The instance is also deleted internally by the
ConnDisplacementBC object.
The ConnDisplacementBCState object has no constructor or methods.
The ConnDisplacementBCState object is derived from the BoundaryConditionState object.

8–30

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.12.1 Members
The ConnDisplacementBCState object has the following members:

u1
A Float or a Complex specifying the displacement component in the connector’s local 1-direction.
u2
A Float or a Complex specifying the displacement component in the connector’s local 2-direction.
u3
A Float or a Complex specifying the displacement component in the connector’s local 3-direction.
ur1
A Float or a Complex specifying the rotational component in the connector’s local 4-direction.
ur2
A Float or a Complex specifying the rotational component in the connector’s local 5-direction.
ur3
A Float or a Complex specifying the rotational component in the connector’s local 6-direction.
u1State
A SymbolicConstant specifying the propagation state of the displacement component in the
connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
u2State
A SymbolicConstant specifying the propagation state of the displacement component in the
connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
u3State
A SymbolicConstant specifying the propagation state of the displacement component in the
connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ur1State
A SymbolicConstant specifying the propagation state of the rotational component in the
connector’s local 4-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.

8–31

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

ur2State
A SymbolicConstant specifying the propagation state of the rotational component in the
connector’s local 5-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
ur3State
A SymbolicConstant specifying the propagation state of the rotational component in the
connector’s local 6-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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.12.2 Corresponding analysis keywords

*CONNECTOR MOTION, TYPE=DISPLACEMENT (degree of freedom: 1, 2, 3, 4, 5, or 6)

8–32

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.13 ConnVelocityBC object

The ConnVelocityBC object stores the data for a connector velocity boundary condition.
The ConnVelocityBC object is derived from the BoundaryCondition object.

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

8.13.1 ConnVelocityBC(...)
This method creates a ConnVelocityBC object.

Path
mdb.models[name].ConnVelocityBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
connectors
A sequence of Strings specifying the names of the connectors to which the boundary condition is
applied.
Optional arguments
v1
A Float or a SymbolicConstant specifying the velocity component in the connector’s local 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.

v2
A Float or a SymbolicConstant specifying the velocity component in the connector’s local 2-
direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is
UNSET.

8–33

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

v3
A Float or a SymbolicConstant specifying the velocity component in the connector’s local 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 in the connector’s
local 4-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 in the connector’s
local 5-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 in the connector’s
local 6-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 boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

Return value
A ConnVelocityBC object.

Exceptions
None.

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

Arguments
Required arguments
None.

8–34

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the ConnVelocityBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
v1
A Float or a SymbolicConstant specifying the velocity component in the connector’s local 1-
direction. Possible values for the SymbolicConstant are SET and FREED.
v2
A Float or a SymbolicConstant specifying the velocity component in the connector’s local 2-
direction. Possible values for the SymbolicConstant are SET and FREED.
v3
A Float or a SymbolicConstant specifying the velocity component in the connector’s local 3-
direction. Possible values for the SymbolicConstant are SET and FREED.
vr1
A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s
local 4-direction. Possible values for the SymbolicConstant are SET and FREED.
vr2
A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s
local 5-direction. Possible values for the SymbolicConstant are SET and FREED.
vr3
A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s
local 6-direction. Possible values for the SymbolicConstant are SET and FREED.

8–35

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

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 boundary
condition 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.

8.13.4 Members
The ConnVelocityBC object can have the following members:

name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
connectors
A tuple of Strings specifying the names of the connectors to which the boundary condition is
applied.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8–36

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.14 ConnVelocityBCState object

The ConnVelocityBCState object stores the propagating data for a velocity boundary condition in a step.
One instance of this object is created internally by the ConnVelocityBC object for each step. The instance
is also deleted internally by the ConnVelocityBC object.
The ConnVelocityBCState object has no constructor or methods.
The ConnVelocityBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.14.1 Members
The ConnVelocityBCState object has the following members:
v1
A Float specifying the velocity component in the connector’s local 1-direction.
v2
A Float specifying the velocity component in the connector’s local 2-direction.
v3
A Float specifying the velocity component in the connector’s local 3-direction.
vr1
A Float specifying the rotational velocity component in the connector’s local 4-direction.
vr2
A Float specifying the rotational velocity component in the connector’s local 5-direction.
vr3
A Float specifying the rotational velocity component in the connector’s local 6-direction.
v1State
A SymbolicConstant specifying the propagation state of the velocity component in the connector’s
local 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v2State
A SymbolicConstant specifying the propagation state of the velocity component in the connector’s
local 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v3State
A SymbolicConstant specifying the propagation state of the velocity component in the connector’s
local 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.

8–37

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

vr1State
A SymbolicConstant specifying the propagation state of the rotational velocity component in the
connector’s local 4–direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
vr2State
A SymbolicConstant specifying the propagation state of the rotational velocity component in the
connector’s local 5–direction. Possible values are UNSET, SET, UNCHANGED, FREED, and
MODIFIED.
vr3State
A SymbolicConstant specifying the propagation state of the rotational velocity component in the
connector’s local 6–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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.14.2 Corresponding analysis keywords

*CONNECTOR MOTION, TYPE=VELOCITY (degree of freedom: 1, 2, 3, 4, 5, or 6)

8–38

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.15 DisplacementBC object

The DisplacementBC object stores the data for a displacement/rotation boundary condition.
The DisplacementBC object is derived from the BoundaryCondition object.

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

8.15.1 DisplacementBC(...)
This method creates a DisplacementBC object.

Path
mdb.models[name].DisplacementBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField or DiscreteField object associated with this
boundary condition. The fieldName argument applies only when distributionType=FIELD or
distributionType=DISCRETE_FIELD. The default value is an empty string.
u1
A Float, a Complex, 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.

8–39

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

u2
A Float, a Complex, 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, a Complex, 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, a Complex, 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, a Complex, 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, a Complex, 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.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value
is UNIFORM.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

8–40

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Return value
A DisplacementBC object.

Exceptions
None.

8.15.2 setValues(...)
This method modifies the data for an existing DisplacementBC 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 DisplacementBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
u1
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 1-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u2
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 2-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.

8–41

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

u3
A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 3-
direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur1
A Float, a Complex, 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, a Complex, 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, a Complex, 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 boundary
condition is changed to have no amplitude reference. You should provide the amplitude argument
only if it is valid for the specified step.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
None

Exceptions
None.

8.15.4 Members
The DisplacementBC object can have the following members:
name
A String specifying the boundary condition repository key.

8–42

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value
is UNIFORM.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
fieldName
A String specifying the name of the AnalyticalField or DiscreteField object associated with this
boundary condition. The fieldName argument applies only when distributionType=FIELD or
distributionType=DISCRETE_FIELD. The default value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.16 DisplacementBCState object

The DisplacementBCState object stores the propagating data for a displacement/rotation boundary
condition in a step. One instance of this object is created internally by the DisplacementBC object for
each step. The instance is also deleted internally by the DisplacementBC object.
The DisplacementBCState object has no constructor or methods.
The DisplacementBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8–43

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.16.1 Members
The DisplacementBCState 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.
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.

8–44

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

status
A SymbolicConstant specifying the propagation state of the BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.16.2 Corresponding analysis keywords

*BOUNDARY, TYPE=DISPLACEMENT (degree of freedom: 1, 2, 3, 4, 5, or 6)

8.17 ElectricPotentialBC object

TheElectricPotentialBC object stores the data for an electrical potential boundary condition.
The ElectricPotentialBC object is derived from the BoundaryCondition object.

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

8.17.1 ElectricPotentialBC(...)
This method creates a ElectricPotentialBC object.

8–45

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Path
mdb.models[name].ElectricPotentialBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
magnitude
A Float specifying the electrical potential magnitude. The default value is 0. The magnitude
argument is optional if distributionType=USER_DEFINED.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.

Return value
An ElectricPotentialBC object.

Exceptions
None.

8–46

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.17.2 setValues(...)
This method modifies the data for an existing ElectricPotentialBC 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
ElectricPotentialBC method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
magnitude
A Float or the SymbolicConstant FREED specifying the electrical potential magnitude.
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 boundary
condition 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

8–47

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Exceptions
None.

8.17.4 Members
The ElectricPotentialBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.18 ElectricPotentialBCState object

The ElectricPotentialBCState object stores the propagating data for a electrical potential boundary
condition in a step. One instance of this object is created internally by the ElectricPotentialBC object
for each step. The instance is also deleted internally by the ElectricPotentialBC object.
The ElectricPotentialBCState object has no constructor or methods.
The ElectricPotentialBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8–48

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.18.1 Members
The ElectricPotentialBCState object has the following members:
magnitude
A Float specifying the electrical potential magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the electrical potential magnitude.
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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.18.2 Corresponding analysis keywords

*BOUNDARY (degree of freedom: 9)

8–49

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.19 EulerianBC object

The EulerianBC object stores the data for an Eulerian boundary condition.
The EulerianBC object is derived from the BoundaryCondition object.

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

8.19.1 EulerianBC(...)
This method creates a EulerianBC object.

Path
mdb.models[name].EulerianBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
definition
A SymbolicConstant specifying the flow conditions to be defined. Possible values are INFLOW,
OUTFLOW, and BOTH. The default value is INFLOW.
inflowType
A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible
values are FREE, NONE, and VOID. The default value is FREE.
outflowType
A SymbolicConstant specifying the control of flow of material out of the Eulerian domain. Possible
values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default
value is ZERO_PRESSURE.

Return value
An EulerianBC object.

8–50

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Exceptions
None.

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

Arguments
Required arguments
None.
Optional arguments
region
A Region object specifying the region to which the boundary condition is applied.
definition
A SymbolicConstant specifying the material flow conditions to be defined. Possible values are
INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
inflowType
A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible
values are FREE, NONE, and VOID. The default value is FREE.
outflowType
A SymbolicConstant specifying the control of material flow out of the Eulerian domain. Possible
values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default
value is ZERO_PRESSURE.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.

8–51

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Optional arguments
definition
A SymbolicConstant specifying the material flow conditions to be defined. Possible values are
INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
inflowType
A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible
values are FREE, NONE, and VOID. The default value is FREE.
outflowType
A SymbolicConstant specifying the control of material flow out of the Eulerian domain. Possible
values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default
value is ZERO_PRESSURE.

Return value
None

Exceptions
None.

8.19.4 Members
The EulerianBC object can have the following members:
name
A String specifying the boundary condition repository key.
definition
A SymbolicConstant specifying the flow conditions to be defined. Possible values are INFLOW,
OUTFLOW, and BOTH. The default value is INFLOW.
inflowType
A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible
values are FREE, NONE, and VOID. The default value is FREE.
outflowType
A SymbolicConstant specifying the control of flow of material out of the Eulerian domain. Possible
values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default
value is ZERO_PRESSURE.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.

8–52

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

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

8.20 EulerianBCState object

The EulerianBCState object stores the propagating data for an Eulerian boundary condition in a step.
One instance of this object is created internally by the EulerianBC object for each step. The instance is
also deleted internally by the EulerianBC object.
The EulerianBCState object has no constructor or methods.
The EulerianBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.20.1 Members
The EulerianBCState object has the following members:
definition
A SymbolicConstant specifying the material flow conditions to be defined. Possible values are
INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
definitionState
A SymbolicConstant specifying the propagation state of the definition member. Possible values
are UNSET, SET, and UNCHANGED.
inflowType
A SymbolicConstant specifying the material flow conditions to be defined. Possible values are
FREE, NONE, and VOID. The default value is FREE.
inflowTypeState
A SymbolicConstant specifying the propagation state of the definition member. Possible values
are UNSET, SET, and UNCHANGED.
outflowType
A SymbolicConstant specifying the material flow conditions to be defined. Possible values are
ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default value is
ZERO_PRESSURE.
outflowTypeState
A SymbolicConstant specifying the propagation state of the definition member. Possible values
are UNSET, SET, and UNCHANGED.

8–53

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.20.2 Corresponding analysis keywords

*EULERIAN BOUNDARY

8.21 EulerianMotionBC object

The EulerianMotionBC object stores the data for an Eulerian mesh motion boundary condition.
The EulerianMotionBC object is derived from the BoundaryCondition object.

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

8–54

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.21.1 EulerianMotionBC(...)
This method creates an EulerianMotionBC object.

Path
mdb.models[name].EulerianMotionBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
instanceName
A String specifying the name of the Eulerian part instance.
Optional arguments
followRegion
A Boolean specifying whether the mesh will follow a regular surface region or an Eulerian surface.
The default value is ON.
region
A Region object specifying the region to which the boundary condition is applied.
materialName
A String specifying the name of the Eulerian surface to follow. This argument applies only when
followRegion=False.
ctrPosition1
A SymbolicConstant specifying the 1-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction.
If expansionRatio1=None, then there is no upper limit. The default value is None.
contractRatio1
A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The
default value is 0.0.

8–55

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

ctrPosition2
A SymbolicConstant specifying the 2-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition2
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio2
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction.
If expansionRatio2=None, then there is no upper limit. The default value is None.
contractRatio2
A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The
default value is 0.0.
ctrPosition3
A SymbolicConstant specifying the 3-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition3
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio3
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction.
If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio3
A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The
default value is 0.0.
allowContraction
A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit
A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects,
1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor
A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.

8–56

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

volThreshold
A Float specifying the lower bounds on the volume fraction when determining which nodes to
include in the surface bounding box calculation for an Eulerian material surface. This argument
applies only when followRegion=False. The default value is 0.5.
bufferSize
None or a Float specifying the buffer between the surface box and the Eulerian section mesh
bounding box. The default value is 2.0.

Return value
An EulerianMotionBC object.

Exceptions
None.

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

Arguments
Required arguments
None.
Optional arguments
instanceName
A String specifying the name of the Eulerian part instance.
followRegion
A Boolean specifying whether the mesh will follow a regular surface region or an Eulerian surface.
The default value is ON.
region
A Region object specifying the region to which the boundary condition is applied.
materialName
A String specifying the name of the Eulerian surface to follow. This argument applies only when
followRegion=False.
ctrPosition1
A SymbolicConstant specifying the 1-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.

8–57

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

negPosition1
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction.
If expansionRatio1=None, then there is no upper limit. The default value is None.
contractRatio1
A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The
default value is 0.0.
ctrPosition2
A SymbolicConstant specifying the 2-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition2
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio2
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction.
If expansionRatio2=None, then there is no upper limit. The default value is None.
contractRatio2
A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The
default value is 0.0.
ctrPosition3
A SymbolicConstant specifying the 3-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition3
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio3
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction.
If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio3
A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The
default value is 0.0.

8–58

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

allowContraction
A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit
A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects,
1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor
A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold
A Float specifying the lower bounds on the volume fraction when determining which nodes to
include in the surface bounding box calculation for an Eulerian material surface. This argument
applies only when followRegion=False. The default value is 0.5.
bufferSize
None or a Float specifying the buffer between the surface box and the Eulerian section mesh
bounding box. The default value is 2.0.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
ctrPosition1
A SymbolicConstant specifying the 1-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.

8–59

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

expansionRatio1
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction.
If expansionRatio1=None, then there is no upper limit. The default value is None.
contractRatio1
A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The
default value is 0.0.
ctrPosition2
A SymbolicConstant specifying the 2-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition2
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio2
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction.
If expansionRatio2=None, then there is no upper limit. The default value is None.
contractRatio2
A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The
default value is 0.0.
ctrPosition3
A SymbolicConstant specifying the 3-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition3
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio3
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction.
If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio3
A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The
default value is 0.0.
allowContraction
A Boolean specifying whether the mesh is allowed to contract . The default value is ON.

8–60

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

aspectLimit
A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects,
1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor
A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold
A Float specifying the lower bounds on the volume fraction when determining which nodes to
include in the surface bounding box calculation for an Eulerian material surface. This argument
applies only when followRegion=False. The default value is 0.5.
bufferSize
None or a Float specifying the buffer between the surface box and the Eulerian section mesh
bounding box. The default value is 2.0.

Return value
None

Exceptions
None.

8.21.4 Members
The EulerianMotionBC object can have the following members:
name
A String specifying the boundary condition repository key.
followRegion
A Boolean specifying whether the mesh will follow a regular surface region or an Eulerian surface.
The default value is ON.
ctrPosition1
A SymbolicConstant specifying the 1-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition2
A SymbolicConstant specifying the 2-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition3
A SymbolicConstant specifying the 3-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.

8–61

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

posPosition2
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition3
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction.
If expansionRatio1=None, then there is no upper limit. The default value is None.
expansionRatio2
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction.
If expansionRatio2=None, then there is no upper limit. The default value is None.
expansionRatio3
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction.
If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio1
A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The
default value is 0.0.
contractRatio2
A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The
default value is 0.0.
contractRatio3
A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The
default value is 0.0.
allowContraction
A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit
A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects,
1-2, 2-3, 3-1). The default value is 10.0.

8–62

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

vmaxFactor
A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold
A Float specifying the lower bounds on the volume fraction when determining which nodes to
include in the surface bounding box calculation for an Eulerian material surface. This argument
applies only when followRegion=False. The default value is 0.5.
bufferSize
None or a Float specifying the buffer between the surface box and the Eulerian section mesh
bounding box. The default value is 2.0.
instanceName
A String specifying the name of the Eulerian part instance.
materialName
A String specifying the name of the Eulerian surface to follow. This argument applies only when
followRegion=False.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.22 EulerianMotionBCState object

The EulerianMotionBCState object stores the propagating data for an Eulerian mesh motion boundary
condition in a step. One instance of this object is created internally by the EulerianMotionBC object for
each step. The instance is also deleted internally by the EulerianMotionBC object.
The EulerianMotionBCState object has no constructor or methods.
The EulerianMotionBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.22.1 Members
The EulerianMotionBCState object has the following members:

8–63

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

ctrPosition1
A SymbolicConstant specifying the 1-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition2
A SymbolicConstant specifying the 2-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition3
A SymbolicConstant specifying the 3-direction translational constraint on the center of the
Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition2
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition3
A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3
A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of
the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction.
If expansionRatio1=None, then there is no upper limit. The default value is None.
expansionRatio2
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction.
If expansionRatio2=None, then there is no upper limit. The default value is None.
expansionRatio3
None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction.
If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio1
A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The
default value is 0.0.

8–64

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

contractRatio2
A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The
default value is 0.0.
contractRatio3
A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The
default value is 0.0.
allowContraction
A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit
A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects,
1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor
A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold
A Float specifying the lower bounds on the volume fraction when determining which nodes to
include in the surface bounding box calculation for an Eulerian material surface. This argument
applies only when followRegion=False. The default value is 0.5.
bufferSize
None or a Float specifying the buffer between the surface box and the Eulerian section mesh
bounding box. The default value is 2.0.
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 BoundaryConditionState 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

8–65

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

amplitude
A String specifying the name of the amplitude reference. The String is empty if the boundary
condition has no amplitude reference.

8.22.2 Corresponding analysis keywords

*EULERIAN MESH MOTION

8.23 FluidInletOutletBC object

The FluidInletOutletBC object stores the data for a fluid inlet/outlet boundary condition.
The FluidInletOutletBC object is derived from the BoundaryCondition object.

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

8.23.1 FluidInletOutletBC(...)
This method creates a FluidInletOutletBC object.

Path
mdb.models[name].FluidInletOutletBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
momentumType
A SymbolicConstant specifying the type of boundary condition defined on momentum equation.
Possible values are PRESSURE, UNSET and VELOCITY. The default value is UNSET.

8–66

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

pressure
A Float or the SymbolicConstant UNSET specifying the pressure magnitude. Use a numeric value
if momentumType=PRESSURE. The default value is UNSET.
v1
A Float or the SymbolicConstant UNSET specifying the velocity component in the 1-direction of
the global coordinate system. The default value is UNSET.
Note: Although v1, v2, v3 are optional arguments, at least one of them must be specified with
numeric value when momentumType=VELOCITY.

v2
A Float or the SymbolicConstant UNSET specifying the velocity component in the 2-direction of
the global coordinate system. The default value is UNSET.
v3
A Float or the SymbolicConstant UNSET specifying the velocity component in the 3-direction of
the global coordinate system. The default value is UNSET.
momentumAmplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that
gives the variation of the boundary condition values with time on momentum equation. UNSET
should be used if the boundary condition has no amplitude reference. The default value is UNSET.
temperature
A Float or the SymbolicConstant UNSET specifying the temperature magnitude. The default value
is UNSET.
temperatureAmplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that
gives the variation of the temperature with time. UNSET should be used if the boundary condition
has no amplitude reference. The default value is UNSET.
eddyViscosity
A Float or the SymbolicConstant UNSET specifying the eddy viscosity magnitude. The default
value is UNSET.
eddyViscosityAmplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that
gives the variation of the eddy viscosity with time. UNSET should be used if the boundary
condition has no amplitude reference. The default value is UNSET.

Return value
A FluidInletOutletBC object.

Exceptions
None.

8–67

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.23.2 setValues(...)
This method modifies the data for an existing FluidInletOutletBC 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 FluidInletOutletBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
momentumType
A SymbolicConstant specifying the type of boundary condition defined on momentum equation.
Possible values are FREED, PRESSURE and VELOCITY. Use FREED to remove the previously
defined value.
pressure
A Float or the SymbolicConstant FREED specifying the pressure magnitude. Use a numeric value
if momentumType=PRESSURE. Otherwise, use FREED to remove the previously defined value.
v1
A Float or the SymbolicConstant FREED specifying the velocity component in the 1-direction of
the global coordinate system.

8–68

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Note: Although v1, v2, v3 are optional arguments, at least one of them must be specified
with numeric value when momentumType=VELOCITY. Otherwise, use FREED to remove the
previously defined value.

v2
A Float or the SymbolicConstant FREED specifying the velocity component in the 2-direction of
the global coordinate system. Use FREED to remove the previously defined value.
v3
A Float or the SymbolicConstant FREED specifying the velocity component in the 3-direction of
the global coordinate system. Use FREED to remove the previously defined value.
momentumAmplitude
A String or the SymbolicConstant FREED specifying the name of the amplitude reference that
gives the variation of the boundary condition values with time on momentum equation. FREED
should be used if the boundary condition has no amplitude reference.
temperature
A Float or the SymbolicConstant FREED specifying the temperature magnitude. Use FREED to
remove the previously defined value.
temperatureAmplitude
A String or the SymbolicConstant FREED specifying the name of the amplitude reference that
gives the variation of the temperature with time. FREED should be used if the boundary condition
has no amplitude reference.
eddyViscosity
A Float or the SymbolicConstant FREED specifying the eddy viscosity magnitude. Use FREED
to remove the previously defined value.
eddyViscosityAmplitude
A String or the SymbolicConstant FREED specifying the name of the amplitude reference that
gives the variation of the eddy viscosity with time. FREED should be used if the boundary
condition has no amplitude reference.

Return value
None

Exceptions
None.

8.23.4 Members
The FluidInletOutletBC object can have the following members:
name
A String specifying the boundary condition repository key.

8–69

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

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

8.24 FluidInletOutletBCState object

The FluidInletOutletBCState object stores the propagating data of a fluid inlet/outlet boundary condition
in a step. One instance of this object is created internally by the FluidInletOutletBC object for each step.
The instance is also deleted internally by the FluidInletOutletBC object.
The FluidInletOutletBCState object has no constructor or methods.
The FluidInletOutletBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.24.1 Members
The FluidInletOutletBCState object has the following members:
momentumType
A SymbolicConstant specifying the type of boundary condition defined on momentum equation.
Possible values are NONE, PRESSURE, and VELOCITY. The default value is NONE.
pressure
None or a Float specifying the pressure magnitude. The default value is None.
v1
None or a Float specifying the velocity component in the 1-direction of the global coordinate
system. The default value is None.
v2
None or a Float specifying the velocity component in the 2-direction of the global coordinate
system. The default value is None.
v3
None or a Float specifying the velocity component in the 3-direction of the global coordinate
system. The default value is None.

8–70

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

momentumAmplitude
None or a String specifying the name of the amplitude reference that gives the variation of the
boundary condition values with time on momentum equation. The default value is NONE.
temperature
None or a Float specifying the temperature magnitude. The default value is None.
temperatureAmplitude
None or a String specifying the name of the amplitude reference that gives the variation of the
temperature with time. The default value is NONE.
eddyViscosity
None or a Float specifying the eddy viscosity magnitude. The default value is None.
eddyViscosityAmplitude
None or a String specifying the name of the amplitude reference that gives the variation of the
eddy viscosity with time. The default value is NONE.
momentumTypeState
A SymbolicConstant specifying the propagation state of the momentumType member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
pressureState
A SymbolicConstant specifying the propagation state of the pressure member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
v1State
A SymbolicConstant specifying the propagation state of the v1 member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
v2State
A SymbolicConstant specifying the propagation state of the v2 member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
v3State
A SymbolicConstant specifying the propagation state of the v3 member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
momentumAmplitudeState
A SymbolicConstant specifying the propagation state of the momentumAmplitude member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
temperatureState
A SymbolicConstant specifying the propagation state of the temperature member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
temperatureAmplitudeState
A SymbolicConstant specifying the propagation state of the temperatureAmplitude member.
Possible values are UNSET, SET, UNCHANGED, and FREED.

8–71

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

eddyViscosityState
A SymbolicConstant specifying the propagation state of the eddyViscosity member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
eddyViscosityAmplitudeState
A SymbolicConstant specifying the propagation state of the eddyViscosityAmplitude member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.24.2 Corresponding analysis keywords

*DSLOAD, TYPE=ACCELERATION (load type label: P, TEMP, TURBNU, VELX, VELY, or

VELZ)

8–72

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.25 FluidWallConditionBC object

The FluidWallConditionBC object stores the data for a fluid wall condition boundary condition.
The FluidWallConditionBC object is derived from the BoundaryCondition object.

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

8.25.1 FluidWallConditionBC(...)
This method creates a FluidWallConditionBC object.

Path
mdb.models[name].FluidWallConditionBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
type
A SymbolicConstant specifying the type of fluid wall condition boundary condition. Possible
values are INFILTRATION, NO_SLIP and SHEAR. The default value is NO_SLIP.
v1
A Float or the SymbolicConstant UNSET specifying the velocity component in the 1-direction of
the global coordinate system. The default value is UNSET.
v2
A Float or the SymbolicConstant UNSET specifying the velocity component in the 2-direction of
the global coordinate system. The default value is UNSET.
v3
A Float or the SymbolicConstant UNSET specifying the velocity component in the 3-direction of
the global coordinate system. The default value is UNSET.

8–73

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

velocityAmplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that
gives the variation of the velocities with time. UNSET should be used if the boundary condition
has no amplitude reference. The default value is UNSET.
thermalEnergyType
A SymbolicConstant specifying the type of boundary condition defined on thermal energy
equation. Possible values are HEAT_FLUX, TEMPERATURE and UNSET. The default value
is UNSET.
temperature
A Float or the SymbolicConstant UNSET specifying the temperature magnitude. Use a numeric
value if thermalEnergyType=TEMPERATURE. The default value is UNSET.
heatFlux
A Float or the SymbolicConstant UNSET specifying the heat flux magnitude. Use a numeric value
if thermalEnergyType=HEAT_FLUX. The default value is UNSET.
thermalEnergyAmplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that
gives the variation of the boundary condition values with time on thermal energy equation. UNSET
should be used if the boundary condition has no amplitude reference. The default value is UNSET.
eddyViscosity
A Float or the SymbolicConstant UNSET specifying the eddy viscosity magnitude. The default
value is UNSET.
eddyViscosityAmplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference that
gives the variation of the eddy viscosity with time. UNSET should be used if the boundary
condition has no amplitude reference. The default value is UNSET.

Return value
A FluidWallConditionBC object.

Exceptions
None.

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

Arguments
Required arguments
None.

8–74

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the
FluidWallConditionBC method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
type
A SymbolicConstant specifying the type of fluid wall condition boundary condition. Possible
values are INFILTRATION, NO_SLIP and SHEAR.
v1
A Float or the SymbolicConstant FREED specifying the velocity component in the 1-direction of
the global coordinate system. Use FREED to remove the previously defined value.
v2
A Float or the SymbolicConstant FREED specifying the velocity component in the 2-direction of
the global coordinate system. Use FREED to remove the previously defined value.
v3
A Float or the SymbolicConstant FREED specifying the velocity component in the 3-direction of
the global coordinate system. Use FREED to remove the previously defined value.
velocityAmplitude
A String or the SymbolicConstant FREED specifying the name of the amplitude reference that
gives the variation of the velocities with time. FREED should be used if the boundary condition
has no amplitude reference.

8–75

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

thermalEnergyType
A SymbolicConstant specifying the type of boundary condition defined on thermal energy
equation. Possible values are FREED, HEAT_FLUX and TEMPERATURE. Use FREED to
remove the previously defined value.
temperature
A Float or the SymbolicConstant FREED specifying the temperature magnitude. Use a numeric
value if thermalEnergyType=TEMPERATURE. Otherwise, use FREED to remove the previously
defined value.
heatFlux
A Float or the SymbolicConstant FREED specifying the heat flux magnitude. Use a numeric value
if thermalEnergyType=HEAT_FLUX. Otherwise, use FREED to remove the previously defined
value.
thermalEnergyAmplitude
A String or the SymbolicConstant FREED specifying the name of the amplitude reference that
gives the variation of the boundary condition values with time on thermal energy equation. FREED
should be used if the boundary condition has no amplitude reference.
eddyViscosity
A Float or the SymbolicConstant FREED specifying the eddy viscosity magnitude. Use FREED
to remove the previously defined value.
eddyViscosityAmplitude
A String or the SymbolicConstant FREED specifying the name of the amplitude reference that
gives the variation of the eddy viscosity with time. FREED should be used if the boundary
condition has no amplitude reference.

Return value
None

Exceptions
None.

8.25.4 Members
The FluidWallConditionBC object can have the following members:
name
A String specifying the boundary condition repository key.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.

8–76

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.26 FluidWallConditionBCState object

The FluidWallConditionBCState object stores the propagating data of a fluid wall condition boundary
condition in a step. One instance of this object is created internally by the FluidWallConditionBC object
for each step. The instance is also deleted internally by the FluidWallConditionBC object.
The FluidWallConditionBCState object has no constructor or methods.
The FluidWallConditionBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.26.1 Members
The FluidWallConditionBCState object has the following members:
type
A SymbolicConstant specifying the type of wall condition boundary condition. Possible values
are INFILTRATION, NO_SLIP, and SHEAR. The default value is NO_SLIP.
v1
None or a Float specifying the velocity component in the 1-direction of the global coordinate
system. The default value is None.
v2
None or a Float specifying the velocity component in the 2-direction of the global coordinate
system. The default value is None.
v3
None or a Float specifying the velocity component in the 3-direction of the global coordinate
system. The default value is None.
velocityAmplitude
None or a String specifying the name of the amplitude reference that gives the variation of the
velocities with time. The default value is NONE.

8–77

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

thermalEnergyType
A SymbolicConstant specifying the type of boundary condition defined on thermal energy
equation. Possible values are HEAT_FLUX, NONE, and TEMPERATURE. The default value is
NONE.
temperature
None or a Float specifying the temperature magnitude. The default value is None.
heatFlux
None or a Float specifying the heat flux magnitude. The default value is None.
thermalEnergyAmplitude
None or a String specifying the name of the amplitude reference that gives the variation of the
boundary condition values with time on thermal energy equation. The default value is NONE.
eddyViscosity
None or a Float specifying the eddy viscosity magnitude. The default value is None.
eddyViscosityAmplitude
None or a String specifying the name of the amplitude reference that gives the variation of the
eddy viscosity with time. The default value is NONE.
typeState
A SymbolicConstant specifying the propagation state of the type member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
v1State
A SymbolicConstant specifying the propagation state of the v1 member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
v2State
A SymbolicConstant specifying the propagation state of the v2 member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
v3State
A SymbolicConstant specifying the propagation state of the v3 member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
velocityAmplitudeState
A SymbolicConstant specifying the propagation state of the velocityAmplitude member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
thermalEnergyTypeState
A SymbolicConstant specifying the propagation state of the thermalEnergyType member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
temperatureState
A SymbolicConstant specifying the propagation state of the temperature member. Possible values
are UNSET, SET, UNCHANGED, and FREED.

8–78

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

heatFluxState
A SymbolicConstant specifying the propagation state of the heatFlux member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
thermalEnergyAmplitudeState
A SymbolicConstant specifying the propagation state of the thermalEnergyAmplitude member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
eddyViscosityState
A SymbolicConstant specifying the propagation state of the eddyViscosity member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
eddyViscosityAmplitudeState
A SymbolicConstant specifying the propagation state of the eddyViscosityAmplitude member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.26.2 Corresponding analysis keywords

8–79

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

*DSLOAD, TYPE=ACCELERATION (load type label: DIST, TEMP, TURBNU, VELX, VELY, or
VELZ)

*DSFLUX (load type label: S)

8.27 MaterialFlowBC object

The MaterialFlowBC object stores the data for a connector material flow boundary condition.
The MaterialFlowBC object is derived from the BoundaryCondition object.

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

8.27.1 MaterialFlowBC(...)
This method creates a MaterialFlowBC object.

Path
mdb.models[name].MaterialFlowBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
magnitude
A Float specifying the material flow magnitude. The default value is 0. The magnitude argument
is optional if distributionType=USER_DEFINED.

8–80

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.

Return value
A MaterialFlowBC object.

Exceptions
None.

8.27.2 setValues(...)
This method modifies the data for an existing MaterialFlowBC 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 MaterialFlowBC
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

8–81

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
magnitude
A Float or the SymbolicConstant FREED specifying the material flow magnitude.
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 boundary
condition 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.

8.27.4 Members
The MaterialFlowBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.

8–82

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

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

8.28 MaterialFlowBCState object

The MaterialFlowBCState object stores the propagating data for a connector material flow boundary
condition in a step. One instance of this object is created internally by the MaterialFlowBC object for
each step. The instance is also deleted internally by the MaterialFlowBC object.
The MaterialFlowBCState object has no constructor or methods.
The MaterialFlowBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.28.1 Members
The MaterialFlowBCState object has the following members:
magnitude
A Float specifying the material flow magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the material flow magnitude. 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 BoundaryConditionState object.
Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE

8–83

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

• 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 boundary
condition has no amplitude reference.

8.28.2 Corresponding analysis keywords

*BOUNDARY (degree of freedom: 10)

8.29 PorePressureBC object

The PorePressureBC object stores the data for a pore pressure boundary condition.
The PorePressureBC object is derived from the BoundaryCondition object.

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

8.29.1 PorePressureBC(...)
This method creates a PorePressureBC object.

Path
mdb.models[name].PorePressureBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.

8–84

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
magnitude
A Float specifying the pore pressure magnitude. The default value is 0. The magnitude argument
is optional if distributionType=USER_DEFINED.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.

Return value
A PorePressureBC object.

Exceptions
None.

8.29.2 setValues(...)
This method modifies the data for an existing PorePressureBC 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 PorePressureBC
method, except for the name and createStepName arguments.

8–85

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
magnitude
A Float or the SymbolicConstant FREED specifying the pore pressure magnitude.
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 boundary
condition 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.

8.29.4 Members
The PorePressureBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

8–86

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.30 PorePressureBCState object

The PorePressureBCState object stores the propagating data for a pore pressure boundary condition in a
step. One instance of this object is created internally by the PorePressureBC object for each step. The
instance is also deleted internally by the PorePressureBC object.
The PorePressureBCState object has no constructor or methods.
The PorePressureBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.30.1 Members
The PorePressureBCState object has the following members:
magnitude
A Float specifying the pore pressure magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the pore pressure magnitude. 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.

8–87

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

status
A SymbolicConstant specifying the propagation state of the BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.30.2 Corresponding analysis keywords

*BOUNDARY (degree of freedom: 8)

8.31 SubmodelBC object

The SubmodelBC object stores the data for a submodel boundary condition.
The SubmodelBC object is derived from the BoundaryCondition object.

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

8.31.1 SubmodelBC(...)
This method creates a SubmodelBC object.

8–88

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Path
mdb.models[name].SubmodelBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
dof
A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied.
globalStep
A String specifying the step in the global model from which Abaqus reads the values of the
variables that will drive the submodel analysis. The String indicates the position of the step in
the sequence of analysis steps. For example, globalStep=’1’ indicates the first step.
timeScale
A Boolean specifying whether to scale the time variable for the driven nodes’ amplitude functions
to match the submodel analysis step time. The default value is OFF.
shellThickness
A Float specifying the thickness of the shell in the global model. This argument is required for
shell-to-solid submodeling and is not applicable to other submodels. The default value is 0.0.
Optional arguments
globalDrivingRegion
A String specifying the element set in the global model that will be searched for elements whose
responses will be used to drive the submodel. An empty string indicates that the entire global
model will be searched. The default value is an empty string.
absoluteExteriorTolerance
A Float specifying the absolute value by which a driven node of the submodel can lie outside the
region of the elements of the global model. The default value is 0.0.
exteriorTolerance
A Float specifying the fraction of the average element size in the global model by which a driven
node of the submodel can lie outside the region of the elements of the global model. The default
value is 0.05.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8–89

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

globalIncrement
An Int specifying the increment number in the global model step from which the solution will be
used to specify the values of the driven variables. If globalIncrement=0, the solution from the last
increment will be used. The globalIncrement argument is applicable only for linear perturbation
steps. The default value is 0.
centerZoneSize
A Float specifying the thickness of the center zone size around the shell midsurface. The default
value is None.

Return value
A SubmodelBC object.

Exceptions
None.

8.31.2 setValues(...)
This method modifies the data for an existing SubmodelBC 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 SubmodelBC method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

8–90

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is ON.
dof
A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied.
The dof argument is applicable only if fixed=OFF.
globalStep
A String specifying the step in the global model from which Abaqus reads the values of the
variables that will drive the submodel analysis. The String indicates the position of the step in the
sequence of analysis steps. For example, globalStep=’1’ indicates the first step. The globalStep
argument is applicable only if fixed=OFF.
globalIncrement
An Int specifying the increment number in the global model step at which the solution will be
used to specify the values of the driven variables. If globalIncrement=0, the solution from the last
increment will be used. The globalIncrement argument is applicable only for linear perturbation
steps and if fixed=OFF. The default value is 0.
centerZoneSize
A Float specifying the thickness of the center zone size around the shell midsurface. The default
value is None.
The centerZoneSize argument is applicable only if fixed=OFF.

Return value
None

Exceptions
None.

8.31.4 Members
The SubmodelBC object can have the following members:
name
A String specifying the boundary condition repository key.

8–91

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

shellThickness
A Float specifying the thickness of the shell in the global model. This argument is required for
shell-to-solid submodeling and is not applicable to other submodels. The default value is 0.0.
absoluteExteriorTolerance
A Float specifying the absolute value by which a driven node of the submodel can lie outside the
region of the elements of the global model. The default value is 0.0.
exteriorTolerance
A Float specifying the fraction of the average element size in the global model by which a driven
node of the submodel can lie outside the region of the elements of the global model. The default
value is 0.05.
globalDrivingRegion
A String specifying the element set in the global model that will be searched for elements whose
responses will be used to drive the submodel. An empty string indicates that the entire global
model will be searched. The default value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.32 SubmodelBCState object

The SubmodelBCState object stores the propagating data for a Submodel boundary condition in a step.
One instance of this object is created internally by the SubmodelBC object for each step. The instance
is also deleted internally by the SubmodelBC object.
The SubmodelBCState object has no constructor or methods.
The SubmodelBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.32.1 Members
The SubmodelBCState object has the following members:

8–92

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

dofState
A SymbolicConstant specifying the propagation state of the dof member. Possible values are SET
and UNCHANGED.
globalStepState
A SymbolicConstant specifying the propagation state of the globalStep member. Possible values
are SET and UNCHANGED.
globalIncrement
An Int specifying the increment number in the global model step at which the solution will be
used to specify the values of the driven variables. This argument is applicable only for linear
perturbation steps.
globalIncrementState
A SymbolicConstant specifying the propagation state of the globalIncrement member. Possible
values are SET and UNCHANGED.
centerZoneSize
None or a Float specifying the thickness of the center zone size around the shell midsurface. The
default value is None.
centerZoneSizefState
A SymbolicConstant specifying the propagation state of the centerZoneSize member. Possible
values are SET and UNCHANGED.
scale
None or a Float specifying a scaling value applied to the applied displacements at the interface.
The default value is 1.0.
scaleState
A SymbolicConstant specifying the propagation state of the scale member. Possible values are
SET and UNCHANGED.
globalStep
A String specifying the step in the global model from which Abaqus reads the values of the
variables that will drive the submodel analysis. The String indicates the position of the step in
the sequence of analysis steps. For example, globalStep=’1’ indicates the first step.
dof
A tuple of Ints specifying the degrees of freedom to which the boundary condition is applied.
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 BoundaryConditionState object.
Possible values are:
• NOT_YET_ACTIVE
• CREATED

8–93

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

• 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 boundary
condition has no amplitude reference.

8.32.2 Corresponding analysis keywords

*SUBMODEL
*BOUNDARY, SUBMODEL

8.33 TemperatureBC object

The TemperatureBC object stores the data for a temperature boundary condition.
The TemperatureBC object is derived from the BoundaryCondition object.

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

8.33.1 TemperatureBC(...)
This method creates a TemperatureBC object.

Path
mdb.models[name].TemperatureBC

8–94

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
magnitude
A Float specifying the temperature magnitude. The default value is 0.
dof
A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied.
The default value is (11,).
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the boundary condition has no amplitude reference. The default value
is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fixed
A Boolean specifying whether the boundary condition should remain fixed at the current values at
the start of the step. The default value is OFF.

Return value
A TemperatureBC object.

Exceptions
None.

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

8–95

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

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

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.
Optional arguments
magnitude
A Float or the SymbolicConstant FREED specifying the temperature magnitude.
dof
A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied.
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 boundary
condition 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

8–96

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Exceptions
None.

8.33.4 Members
The TemperatureBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.34 TemperatureBCState object

The TemperatureBCState object stores the propagating data for a temperature boundary condition in a
step. One instance of this object is created internally by the TemperatureBC object for each step. The
instance is also deleted internally by the TemperatureBC object.
The TemperatureBCState object has no constructor or methods.
The TemperatureBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8–97

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.34.1 Members
The TemperatureBCState object has the following members:
magnitude
A Float specifying the temperature magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the temperature magnitude. Possible
values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
dofState
A SymbolicConstant specifying the propagation state of the dof member. Possible values are SET
and UNCHANGED.
dof
A tuple of Ints specifying the degrees of freedom to which the boundary condition is applied.
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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.34.2 Corresponding analysis keywords

8–98

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

*BOUNDARY (degree of freedom: 11 for solids; 11, 12, etc. for shells)

8.35 TypeBC object

The TypeBC object stores the data for several types of predefined boundary conditions that are commonly
used in stress/displacement analyses.
The TypeBC object is derived from the BoundaryCondition object.

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

8.35.1 EncastreBC(...)
This method creates an encastre TypeBC object.

Path
mdb.models[name].EncastreBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

8–99

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Exceptions
None.

8.35.2 PinnedBC(...)
This method creates a pinned TypeBC object.

Path
mdb.models[name].PinnedBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

Exceptions
None.

8.35.3 XsymmBC(...)
This method creates a TypeBC object that specifies symmetry about the X-axis.

Path
mdb.models[name].XsymmBC

8–100

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

Exceptions
None.

8.35.4 YsymmBC(...)
This method creates a TypeBC object that specifies symmetry about the Y-axis.

Path
mdb.models[name].YsymmBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.

8–101

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

Exceptions
None.

8.35.5 ZsymmBC(...)
This method creates a TypeBC object that specifies symmetry about the Z-axis.

Path
mdb.models[name].ZsymmBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

Exceptions
None.

8–102

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

8.35.6 XasymmBC(...)
This method creates a TypeBC object that specifies antisymmetry about the X-axis.

Path
mdb.models[name].XasymmBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

Exceptions
None.

8.35.7 YasymmBC(...)
This method creates a TypeBC object that specifies antisymmetry about the Y-axis.

Path
mdb.models[name].YasymmBC

Required arguments
name
A String specifying the boundary condition repository key.

8–103

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

Exceptions
None.

8.35.8 ZasymmBC(...)
This method creates a TypeBC object that specifies antisymmetry about the Z-axis.

Path
mdb.models[name].ZasymmBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional argument
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
A TypeBC object.

8–104

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Exceptions
None.

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

Arguments
Required arguments
None.
Optional arguments
region
A Region object specifying the region to which the boundary condition is applied.
typeName
A SymbolicConstant specifying the predefined boundary condition type. Possible values are
XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, and ENCASTRE.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Return value
None

Exceptions
None.

8.35.10 setValuesInStep(...)
This method always returns a value error for a TypeBC; it is inherited from the BoundaryCondition
object.

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition is modified.

8–105

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

Optional argument
typeName
A SymbolicConstant specifying the predefined boundary condition type. Possible values are
XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, and ENCASTRE.

Return value
None

Exceptions
Value Error:
A Symmetry/Antisymmetry/Encastre BC cannot be edited in a propagated step.

8.35.11 Members
The TypeBC object can have the following members:
name
A String specifying the boundary condition repository key.
buckleCase
A SymbolicConstant specifying how the boundary condition is defined in a *BUCKLE analysis.
Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES,
and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8.36 TypeBCState object

The TypeBCState object stores the propagating data for a predefined boundary condition in a step. One
instance of this object is created internally by the TypeBC object for each step. The instance is also
deleted internally by the TypeBC object.
The TypeBCState object has no constructor or methods.
The TypeBCState object is derived from the BoundaryConditionState object.

8–106

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.36.1 Members
The TypeBCState object has the following members:
typeName
A SymbolicConstant specifying the predefined boundary condition type. Possible values are
XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, and ENCASTRE.
typeNameState
A SymbolicConstant specifying the propagation state of the predefined boundary condition type.
The only possible value is UNCHANGED.
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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.36.2 Corresponding analysis keywords

8–107

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

*BOUNDARY, TYPE=XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM,

PINNED, or ENCASTRE

8.37 VelocityBC object

The VelocityBC object stores the data for a velocity boundary condition.
The VelocityBC object is derived from the BoundaryCondition object.

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

8.37.1 VelocityBC(...)
This method creates a VelocityBC object.

Path
mdb.models[name].VelocityBC

Required arguments
name
A String specifying the boundary condition repository key.
createStepName
A String specifying the name of the step in which the boundary condition is created.
region
A Region object specifying the region to which the boundary condition is applied.
Optional arguments
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
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.

8–108

Abaqus ID:
Printed on:
 BOUNDARY CONDITION 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 boundary condition 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 boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

Return value
A VelocityBC object.

Exceptions
None.

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

8–109

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

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

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the boundary condition 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.
vr2
A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction.
Possible values for the SymbolicConstant are SET and FREED.

8–110

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

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 boundary
condition 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.

8.37.4 Members
The VelocityBC object can have the following members:
name
A String specifying the boundary condition repository key.
distributionType
A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName
A String specifying the name of the AnalyticalField object associated with this boundary
condition. The fieldName argument applies only when distributionType=FIELD. The default
value is an empty string.
category
A SymbolicConstant specifying the category of the boundary condition. Possible values are
MECHANICAL and THERMAL.
region
A Region object specifying the region to which the boundary condition is applied.
localCsys
None or a DatumCsys object specifying the local coordinate system of the boundary condition’s
degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global
coordinate system. The default value is None.

8–111

Abaqus ID:
Printed on:
BOUNDARY CONDITION COMMANDS

8.38 VelocityBCState object

The VelocityBCState object stores the propagating data for a velocity boundary condition in a step. One
instance of this object is created internally by the VelocityBC object for each step. The instance is also
deleted internally by the VelocityBC object.
The VelocityBCState object has no constructor or methods.
The VelocityBCState object is derived from the BoundaryConditionState object.

Access
import load
mdb.models[name].steps[name].boundaryConditionStates[name]

8.38.1 Members
The VelocityBCState 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.

8–112

Abaqus ID:
Printed on:
 BOUNDARY CONDITION COMMANDS

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.
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 BoundaryConditionState 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 boundary
condition has no amplitude reference.

8.38.2 Corresponding analysis keywords

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

8–113

Abaqus ID:
Printed on:
 CANVAS COMMANDS

9. Canvas commands
Canvas commands are used to create, position, and modify canvas objects. The Canvas commands need
only the abaqus module to be imported; no additional modules need to be imported.

9.1 AttributeColorMap object

The AttributeColorMap object is used to store values and attributes associated with AttributeColorMap
type objects. AttributeColorMap objects can be modified using the methods described below. The
methods accessed via the Viewport object cause the AttributeColorMap object to be updated in the
session.viewports[name].colorMappings repository.

Access
session.viewports[name].colorMappings[name]

9.1.1 setDefaults()
This method resets the AttributeColorMap object to its default state.

Arguments
None.

Return value
None

Exceptions
None.

9.1.2 setValues(...)
This method modifies the AttributeColorMap object.

Arguments
Required arguments
None.
Optional arguments
At least one of the following must be provided:

9–1

Abaqus ID:
Printed on:
CANVAS COMMANDS

overrides
A Dictionary object specifying a color mapping. Each key is of String type and specifies an
attribute in the map; the corresponding values specify the color definition to apply to that attribute
in the form (0|1, wire color, edge color, face color). The 0|1 defines the active status for the
attribute. For example:
overrides={
'Part-1':(1,'#00FF00', '#00CCFF',
'#00FF00')}

defaultOverrides
A Dictionary object specifying a custom color mapping similar to overrides. For example:
defaultOverrides={
'Copper':(1,''#00FF00', '#00CCFF',
'#00FF00')}
The color mapping can contain keys that have not been created. When the key is created, it gets
the appropriate values from this mapping.

Return value
None

Exceptions
None.

9.1.3 updateOverrides(...)
This method specifies additional overrides to be added to the current object definition.

Arguments
Required arguments
None.
Optional arguments
At least one of the following must be provided:
overrides
A Dictionary object specifying a color mapping. Each key is of String type and specifies an
attribute in the map; the corresponding values specify the color definition to apply to that attribute
in the form (0|1, wire color, edge color, face color). The 0|1 defines the active status for the
attribute. For example:
overrides={

9–2

Abaqus ID:
Printed on:
 CANVAS COMMANDS

'Part-1':(1,'#00FF00', '#00CCFF',
'#00FF00')}

defaultOverrides
A Dictionary object specifying a custom color mapping similar to overrides. For example:
defaultOverrides={
'Copper':(1,''#00FF00', '#00CCFF',
'#00FF00')}
The color mapping can contain keys that have not been created. When the key is created, it gets
the appropriate values from this mapping.

Return value
None

Exceptions
None.

9.1.4 Members
The AttributeColorMap object has the following members:
mapType
A SymbolicConstant specifying the type of AttributeColorMap. Possible
values are MATERIAL_MAP, SECTION_MAP, PART_MAP, ELSET_MAP,
AVERAGING_REGION_MAP, and ELTYPE_MAP.
overrides
A Dictionary object specifying a color mapping. Each key is of String type and specifies an
attribute in the map; the corresponding values specify the color definition to apply to that attribute
in the form (0|1, wire color, edge color, face color). The 0|1 defines the active status for the
attribute. For example:
overrides={
'Part-1':(1,'#00FF00', '#00CCFF',
'#00FF00')}

defaultOverrides
A Dictionary object specifying a custom color mapping similar to overrides. For example:
defaultOverrides={
'Copper':(1,''#00FF00', '#00CCFF',
'#00FF00')}

9–3

Abaqus ID:
Printed on:
CANVAS COMMANDS

The color mapping can contain keys that have not been created. When the key is created, it gets
the appropriate values from this mapping.
attributeColors
A Dictionary object specifying the color settings of each attribute as described in the
updateOverrides method.

9.2 DrawingArea object

The DrawingArea object specifies the location and size of the drawing area used for placement of
viewports.

Access
session.drawingArea

9.2.1 Members
The DrawingArea object has the following members:
width
A Float specifying the width in millimeters.
height
A Float specifying the height in millimeters.
origin
A pair of Floats specifying the coordinates of the bottom left hand corner in millimeters.

9.3 Layer object

Objects can be superimposed by displaying them in different layers of a viewport.

Access
session.viewports[name].layers[name]

9.3.1 Layer(...)
This method creates a Layer object in the Layer repository.

Path
session.viewports[name].Layer

9–4

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Required argument
name
A String specifying the repository key.
Optional arguments
None.

Return value
A Layer object.

Exceptions
None.

9.3.2 moveBefore(...)
This method moves the layer object before another object in the layer repository.

Arguments
Required argument
name
A String specifying the name of the other Layer object.
Optional arguments
None.

Return value
None

Exceptions
None.

9.3.3 moveAfter(...)
This method moves the layer object after another object in the layer repository.

Arguments
Required argument
name
A String specifying the name of the other Layer object.

9–5

Abaqus ID:
Printed on:
CANVAS COMMANDS

Optional arguments
None.

Return value
None

Exceptions
None.

9.3.4 Members
The Layer object has members with the same names and descriptions as the arguments to the Layer
method.
In addition, the Layer object can have the following members:
displayedObject
A Displayable object specifying the object to be displayed. The Displayable type is an abstract
generalization. The concrete possible types are Part , Assembly , ConstrainedSketch , Odb , or
XYPlot .
view
A View object specifying the object that controls viewing of the layer.
odbDisplay
An OdbDisplay object specifying the display options for the Odb object.
partDisplay
A PartDisplayOptions object specifying the display options for the Part object.
assemblyDisplay
An AssemblyDisplayOptions object specifying the display options for the Assembly object.

9.4 Viewport object

A viewport is the container for the graphics generated by the application. The Viewport object stores the
various settings that determine how objects are displayed within that viewport.

Access
session.viewports[name]

9.4.1 Viewport(...)
This method creates a Viewport object with the specified origin and dimensions.

9–6

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Path
session.Viewport

Required argument
name
A String specifying the repository key.
Optional arguments
origin
A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system
of the lower left corner of the viewport. The default origin is (0, 0).
width
A Float specifying the width in millimeters of the viewport. Possible values are 30 width
(maxWidth). The default value is 120.0.

Note: The maximum value of width (maxWidth) is the width of the screen in millimeters.

height
A Float specifying the height in millimeters of the viewport. This height includes the title bar.
Possible values are 30 height (maxHeight). The default value is 80.0.

Note: The maximum value of height (maxHeight) is the height of the screen in millimeters.

border
A Boolean specifying whether the viewport border is visible in a printed image. The default value
is ON.
titleBar
A Boolean specifying whether the viewport title should be displayed in a printed image. The
default value is ON.
If border=OFF, the title will not be visible, even if titleBar=ON.
titleStyle
A SymbolicConstant specifying which title to use for the viewport title. Possible values are
CUSTOM and SYSTEM. The default value is SYSTEM.
If titleStyle=CUSTOM, customTitleString will be used. If titleStyle=SYSTEM, a system-
generated string will be used.
customTitleString
A String specifying the viewport title when titleStyle=CUSTOM. The default value is an empty
string.

9–7

Abaqus ID:
Printed on:
CANVAS COMMANDS

Return value
A Viewport object.

Exceptions
RangeError.
If the user attempts to delete the only viewport:
SystemError: the current viewport may not be deleted.
If width is out of range:
RangeError: width must be a Float in the range: 30 <= width <= maxWidth
If height is out of range:
RangeError: height must be a Float in the range: 30 <= width <= maxHeight

9.4.2 bringToFront()
This method moves the Viewport object to the front.

Arguments
None.

Return value
None

Exceptions
None.

9.4.3 disableMultipleColors()
This method disables applying multiple color mappings that was enabled using
enableMultipleColors

Arguments
None.

Return value
None

9–8

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Exceptions
None.

9.4.4 disableRefresh()
This method disables Viewport refresh. Some methods that require the Viewport to be up-to-date will
override this setting. It is advisable to use this method sparingly.

Arguments
None.

Return value
None

Exceptions
None.

9.4.5 disableColorCodeUpdates()
This method disables Viewport updates and internal computations triggered because of color coding.
Performance improvement will be significant when color coding is ON and repeating operations are
performed using a script each of which requires color code updates. No benefit will be had when color
coding is OFF.

Arguments
None.

Return value
None

Exceptions
None.

9.4.6 enableMultipleColors()
This method enables multiple color mappings to be applied at the same time. It also ensures that the
Viewport is updated correctly when initialColor is set.

9–9

Abaqus ID:
Printed on:
CANVAS COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

9.4.7 enableRefresh()
This method enables Viewport refresh disabled using disableRefresh.

Arguments
None.

Return value
None

Exceptions
None.

9.4.8 enableColorCodeUpdates()
This method enables Viewport color code updates disabled using disableColorCodeUpdates.

Arguments
None.

Return value
None

Exceptions
None.

9–10

Abaqus ID:
Printed on:
 CANVAS COMMANDS

9.4.9 getActiveElementLabels(...)
This method returns the element labels currently active in the viewport based on the current display
group and optionally based on any active cut if useCut is True. The labels will optionally be printed to
the replay file if printResults is True. The getActiveElementLabels method has the following
arguments:

Arguments
Required arguments
None.
Optional arguments
useCut
A Boolean flag to specify if any active cutting plane is to be considered in determining active
elements.
printResults
A Boolean flag to specify if the active element labels are to be printed to the replay file.

Return value
A Dictionary object of labels for each active part instance.

Exceptions
None.

9.4.10 getActiveNodeLabels(...)
This method returns the node labels currently active in the viewport based on the current display group
and optionally based on any active cut if useCut is True. The labels will optionally be printed to the replay
file if printResults is True. The getActiveNodeLabels method has the following arguments:

Arguments
Required arguments
None.
Optional arguments
useCut
A Boolean flag to specify if any active cutting plane is to be considered in determining active
nodes.
printResults
A Boolean flag to specify if the active node labels are to be printed to the replay file.

9–11

Abaqus ID:
Printed on:
CANVAS COMMANDS

Return value
A Dictionary object of labels for each active part instance.

Exceptions
None.

9.4.11 getPrimVarMinMaxLoc()
This method returns a dictionary containing the minimum, maximum and their location for the current
primary variable. A contour plot should be displayed in the current viewport or else the method will
return None.

Arguments
None.

Return value
A dictionary with keys ’minPartInstanceName’, ’minElementLabel’, ’minNodeLabel’, ’minPosition’,
’maxPartInstanceName’, ’maxElementLabel’, ’maxNodeLabel’, ’maxPosition’

Exceptions
None.

9.4.12 makeCurrent()
This method makes the Viewport object the current viewport.

Arguments
None.

Return value
None

Exceptions
None.

9.4.13 maximize()
This method maximizes the Viewport object to fill the drawing area.

9–12

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

9.4.14 minimize()
This method minimizes the Viewport object to appear as an abbreviated title bar.

Arguments
None.

Return value
None

Exceptions
None.

9.4.15 offset(...)
This method modifies the current X, Y location of the viewport by the specified distance.

Arguments
Required arguments
None.
Optional arguments
deltaX
A Float specifying the offset in millimeters of the X-component of the viewport origin. The default
value is 0.
deltaY
A Float specifying the offset in millimeters of the Y-component of the viewport origin. The default
value is 0.

9–13

Abaqus ID:
Printed on:
CANVAS COMMANDS

Return value
None

Exceptions
None.

9.4.16 restore()
This method restores a maximized or minimized Viewport object to its previous size and location.

Arguments
None.

Return value
None

Exceptions
None.

9.4.17 sendToBack()
This method moves the Viewport object to the back.

Arguments
None.

Return value
None

Exceptions
None.

9.4.18 setColor(...)
This method specifies the color assignment using initialColor and translucency. If initialColor has a
value of ’As is’, translucency has no effect. The setColor method has the following arguments:

9–14

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Arguments
Required argument
initialColor
A string specifying the initial color applied to the objects.
Optional argument
translucency
A float in the range of 0.0 to 1.0 specifying how translucent the objects drawn using initialColor
needs to be.

Return value
None

Exceptions
None.

9.4.19 setColor(...)
This method specifies the color assignment using attributes specified by an AttributeColorMap object.
The setColor method has the following arguments:

Arguments
Required argument
colorMapping
An AttributeColorMap object. Possible values are any AttributeColorMap object.
Optional arguments
None.

Return value
None

Exceptions
None.

9.4.20 setColor(...)
This method specifies the color of a Leaf object.

9–15

Abaqus ID:
Printed on:
CANVAS COMMANDS

Arguments
Required argument
leaf
A Leaf object. Possible values are any Leaf object.
Optional arguments
At least one of the following must be provided:
edgeColorWireHide
A String specifying the color to be used for drawing the edges of the elements contained in leaf
when the render style is wireframe or hidden.
edgeColorFillShade
A String specifying the color to be used for drawing the edges of the elements contained in leaf
when the render style is filled or shaded.
fillColor
A String specifying the color to be used for drawing the faces of the elements contained in leaf
when the render style is filled or shaded.
nodeSymbolColor
A String specifying the color to be used for drawing the nodes contained in leaf.
nodeSymbolType
A SymbolicConstant specifying the node symbol types for the nodes contained in leaf. Possible
values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI,
HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS,
and XMARKER. The default value is HOLLOW_CIRCLE.
nodeSymbolSize
A SymbolicConstant specifying the node symbol size for the nodes contained in leaf. Possible
values are SMALL, MEDIUM, and LARGE. The default value is SMALL.

Return value
None

Exceptions
None.

9.4.21 forceRefresh()
This method causes the Viewport to refresh immediately. It is provided to allow scripts to refresh the
Viewport before the script terminates. Normally, there would only be a single cumulative refresh that
takes place immediately after the script completes.

9–16

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

9.4.22 setValues(...)
This method modifies the Viewport object. The arguments to setValues are the same as the arguments
to the Viewport method, except for the name argument. In addition, the setValues method has the
following arguments:

Arguments
Required arguments
None.
Optional arguments
displayedObject
A Displayable object specifying the object to be displayed. The Displayable type is an abstract
generalization. The concrete possible types are Part , Assembly , ConstrainedSketch , Odb ,
PlyStackPlot , or XYPlot . If displayedObject=None, Abaqus displays an empty viewport.
displayMode
A SymbolicConstant specifying the display mode of the viewport. Possible values are:

• SINGLE, specifying a single displayedObject.

• OVERLAY, specifying one or more layers to be displayed simultaneously—each layer
contains one displayedObject.

visibleLayers
A sequence of Strings specifying the names of layers that will be displayed in the viewport when
displayMode=OVERLAY.
viewManipLayers
A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation
tools when displayMode=OVERLAY. Possible values are ALL and CURRENT.

9–17

Abaqus ID:
Printed on:
CANVAS COMMANDS

currentLayer
A String specifying which layer is affected by options settings when displayMode=OVERLAY.
The current layer is also the only layer affected by view manipulations when
viewManipLayers=CURRENT.
layerOffset
A Float specifying a factor to be used in offsetting layers in the screen Z direction. Possible values
are –1 to 1. A negative value reverses the apparent order in which the layers are plotted.

Return value
None

Exceptions
RangeError.

9.4.23 addDrawings(...)
This method identifies the names of Drawing objects to be rendered in the Viewport.

Arguments
Required arguments
None.
Optional argument
names
A sequence of String values identifying keys in the session.drawings repository.

Return value
None

Exceptions
ValueError.

9.4.24 removeDrawings(...)
This method identifies the names of Drawing objects to no longer be rendered in the Viewport.

Arguments
Required arguments
None.

9–18

Abaqus ID:
Printed on:
 CANVAS COMMANDS

Optional argument
names
A sequence of String values identifying keys in the Viewport sequence.

Return value
None

Exceptions
ValueError.

9.4.25 timeDisplay(...)
This method refreshes the Viewport display numFrames times and then checks to see if numSeconds
seconds have elapsed. If not, it will continue refreshing the Viewport until the time has elapsed. At
completion, the actual number of refreshes (frames) rendered and elapsed time will be reported along
with the calculated frames-per-second (fps).

Arguments
Required arguments
None.
Optional arguments
numFrames
An Int specifying the minimum number of times to refresh the Viewport. The default value is 0.
numSeconds
An Int specifying the minimum number of seconds to spend refreshing the Viewport. The default
value is 10.
degreesPerFrame
A Float specifying the number of degrees to rotate the model view about its Z axis before each
refresh. The default value is 0.0.

Return value
None

Exceptions
None.

9–19

Abaqus ID:
Printed on:
CANVAS COMMANDS

9.4.26 Members
The Viewport object has members with the same names and descriptions as the arguments to the
Viewport method.
In addition, the Viewport object can have the following members:
displayMode
A SymbolicConstant specifying the display mode of the viewport. Possible values are:
• SINGLE, specifying a single displayedObject.
• OVERLAY, specifying one or more layers to be displayed simultaneously—each layer
contains one displayedObject.
viewManipLayers
A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation
tools when displayMode=OVERLAY. Possible values are ALL and CURRENT.
layerOffset
A Float specifying a factor to be used in offsetting layers in the screen Z direction. Possible values
are –1 to 1. A negative value reverses the apparent order in which the layers are plotted.
windowState
A SymbolicConstant specifying the current state of a viewport. Possible values are NORMAL,
MAXIMIZED, and MINIMIZED.
currentWidth
A Float specifying the width in millimeters of the current viewport, regardless of the value of
windowState.
currentHeight
A Float specifying the height in millimeters of the current viewport, regardless of the value of
windowState, and including the title bar.
applyLinkedCommands
A Boolean specifying whether the viewport is linked for synchronization. The default value is ON.
activeColorModes
A SymbolicConstant specifying the currently active color mappings. Possible values are:
• DEFAULT_COLORS
• PART_GEOM_MAP_COLORS
• ASSEMBLY_MAP_COLORS
• PART_MAP_COLORS
• INSTANCE_MAP_COLORS
• INSTANCE_TYPE_MAP_COLORS
• SECTION_MAP_COLORS
• MATERIAL_MAP_COLORS

9–20

Abaqus ID:
Printed on:
 CANVAS COMMANDS

• LOAD_MAP_COLORS
• BC_MAP_COLORS
• INTERACTION_MAP_COLORS
• CONSTRAINT_MAP_COLORS
• SET_MAP_COLORS
• SURFACE_MAP_COLORS
• INTERNAL_SET_MAP_COLORS
• INTERNAL_SURFACE_MAP_COLORS
• DISPLAY_GRP_MAP_COLORS
• SELECTION_GRP_MAP_COLORS
• ELTYPE_MAP_COLORS
• PLOT_MAP_COLORS
• MESH_MAP_COLORS
The default value is DEFAULT_COLORS.
colorMode
A SymbolicConstant specifying the last applied color mapping. Possible values are:
• DEFAULT_COLORS
• PART_GEOM_MAP_COLORS
• ASSEMBLY_MAP_COLORS
• PART_MAP_COLORS
• INSTANCE_MAP_COLORS
• INSTANCE_TYPE_MAP_COLORS
• SECTION_MAP_COLORS
• MATERIAL_MAP_COLORS
• LOAD_MAP_COLORS
• BC_MAP_COLORS
• INTERACTION_MAP_COLORS
• CONSTRAINT_MAP_COLORS
• SET_MAP_COLORS
• SURFACE_MAP_COLORS
• INTERNAL_SET_MAP_COLORS
• INTERNAL_SURFACE_MAP_COLORS
• DISPLAY_GRP_MAP_COLORS
• SELECTION_GRP_MAP_COLORS
• ELTYPE_MAP_COLORS

9–21

Abaqus ID:
Printed on:
CANVAS COMMANDS

• PLOT_MAP_COLORS
• MESH_MAP_COLORS
The default value is DEFAULT_COLORS.
translucency
A Float specifying the translucency that will be applied to objects colored using initialColor and it
needs to be set along with initialColor. If initialColor is set to ’As is’ then translucency will have
no effect.
animationConnect
A Boolean specifying whether an animation is connected to the viewport.
colorMappings
A repository of AttributeColorMap objects specifying the objects cannot be constructed but the
following attribute maps are supported:
– "type"
– "Element set"
– "Material"
– "Section"
– "Default"
– "Part"
– "Part instance"
– "Element type"
– "Averaging region"
– "Assembly"
– "Property"
– "Set"
– "Surface"
– "Skin"
– "Profile"
– "Part shape"
– "Part status"
– "Part geometry"
– "Meshability"
– "Instance type"
– "Load"
– "Boundary condition"
– "Interaction"
– "Constraint"

9–22

Abaqus ID:
Printed on:
 CANVAS COMMANDS

– "Interaction type"
– "Constraint type"
– "Display group"
– "Selection group"
– "Interaction property"
– "Connector"
– "Connector type"
– "Connector property"
– "Internal set"
– "Internal surface"
– "mapColors"
– "autoColors"
– "overrides"
– "defaultAutoColors"
– "defaultOverrides"
– "objectToCopy"
– "colorMapping"
– "colorMappings"
– "colorMode"
– "attributeColors"
– "updateOverrides"
– "colorCodeOverride"
– "initialColor"
– "Layup"
– "Ply"

initialColor
A String specifying the color that will be applied to all objects in the viewport at the start of color
coding. The possible values are ’As is’, ’Default’ or a string with a hexadecimal representation of
a color.
currentLayer
A String specifying which layer is affected by options settings when displayMode=OVERLAY.
The current layer is also the only layer affected by view manipulations when
viewManipLayers=CURRENT.

9–23

Abaqus ID:
Printed on:
CANVAS COMMANDS

displayedObject
A Displayable object specifying the object to be displayed. The Displayable type is an abstract
generalization. The concrete possible types are Part , Assembly , ConstrainedSketch , Odb ,
PlyStackPlot , or XYPlot . If displayedObject=None, Abaqus displays an empty viewport.
layers
A repository of Layer objects specifying the key to the repository is a String with the name of the
layer.
view
A View object specifying the object that controls viewing of the viewport content.
odbDisplay
An OdbDisplay object specifying the display options for the Odb object.
partDisplay
A PartDisplayOptions object specifying the display options for the Part object.
assemblyDisplay
An AssemblyDisplayOptions object specifying the display options for the Assembly object.
viewportAnnotationOptions
A ViewportAnnotationOptions object.
detailPlotOptions
A DetailPlotOptions object.
annotationsToPlot
An AnnotationsToPlotArray object.
visibleLayers
A tuple of Strings specifying the names of layers that will be displayed in the viewport when
displayMode=OVERLAY.
currentOrigin
A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system
of the lower left corner of the current viewport, regardless of the value of windowState.
iconOrigin
A pair of Floats specifying the X- and Y-coordinates in millimeters of the lower left corner of the
current viewport from a coordinate system having its origin in the lower left corner of the drawing
area. This origin refers to the viewport location when windowState=MINIMIZED.
lightOptions
A LightOptions object.
imageOptions
An ImageOptions object.
movieOptions
A MovieOptions object.

9–24

Abaqus ID:
Printed on:
 CANVAS COMMANDS

drawings
A tuple of Strings specifying keys to the session.drawings repository. The default value is an empty
sequence.

9.5 ImageOptions object

The ImageOptions object stores settings that control how an image is rendered in a particular viewport.
ImageOptions objects are accessed from the image options associated with a particular viewport.
The ImageOptions object has no constructor; Abaqus creates the imageOptions member for a
viewport when the viewport is created using the values in the imageOptions member of the current
viewport.

Access
session.viewports[name].imageOptions

9.5.1 setValues(...)
This method modifies the ImageOptions object.

Arguments
Required arguments
None.
Optional arguments
imageName
A String specifying the name of the image. A list of valid image names is in the images repository
in the session object.
showImage
A Boolean specifying whether an image should be displayed in the viewport background. The
default value is OFF.
positionMethod
A SymbolicConstant specifying which positioning method is used to determine how the image
will be scaled and positioned in the viewport. Possible values are:
• FIT_TO_VIEWPORT, specifying a display mode where the image is scaled to fit in the
viewport using the specified fitMethod.
• AUTO_ALIGN, specifying a display mode where the image is scaled as specified by xScale
and yScale and then positioned in the viewport using the specified alignment.
• MANUAL, specifying a display mode where the image is scaled as specified by xScale and
yScale and then positioned in the viewport using the specified origin.

9–25

Abaqus ID:
Printed on:
CANVAS COMMANDS

The default value is FIT_TO_VIEWPORT.

fitMethod
A SymbolicConstant specifying which type of fit is performed to scale and position the image in
the viewport when positionMethod=FIT_TO_VIEWPORT. Possible values are:

• BEST_FIT, specifying a mode where the image is scaled to completely fit within the viewport.
• FIT_WIDTH, specifying a mode where the image width is scaled to match the viewport
width.
• FIT_HEIGHT, specifying a mode where the image height is scaled to match the viewport
height.
The default value is BEST_FIT.
alignment
A SymbolicConstant specifying the relative position of the image in the viewport when
positionMethod=AUTO_ALIGN. Possible values are:

• BOTTOM_LEFT
• BOTTOM_CENTER
• BOTTOM_RIGHT
• CENTER_LEFT
• CENTER
• CENTER_RIGHT
• TOP_LEFT
• TOP_CENTER
• TOP_RIGHT
The default value is CENTER.
xScale
A Float specifying the scale applied to the image width. The xScale argument is ignored when
positionMethod=FIT_TO_VIEWPORT. The default value is 1.0.
When xScale is negative, the image is mirrored about its y-axis but its’ position is not affected.
yScale
A Float specifying the scale applied to the image height. The yScale argument is ignored when
positionMethod=FIT_TO_VIEWPORT. The default value is 1.0.
When yScale is negative, the image is mirrored about its x-axis but its’ position is not affected.
origin
A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the
viewport. The origin argument is ignored unless positionMethod=MANUAL. The default value
is (0, 0).

9–26

Abaqus ID:
Printed on:
 CANVAS COMMANDS

translucency
A Float specifying the translucency factor to use when displaying the image. Possible values are
0.0 translucency 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.
options
None or an ImageOptions object specifying the object from which values are to be copied. If other
arguments are also supplied to setValues, they will override the values in the options member.
The default value is None.

Return value
None

Exceptions
RangeError.

9.5.2 Members
The ImageOptions object has members with the same names and descriptions as the arguments to the
setValues method.

9.6 MovieOptions object

The MovieOptions object stores settings that control how the movie background for an animation is
rendered in a particular viewport. MovieOptions objects are accessed from the movie options associated
with a particular viewport.
The MovieOptions object has no constructor; Abaqus creates the movieOptions member for a
viewport when the viewport is created using the values in the movieOptions member of the current
viewport.

Access
session.viewports[name].movieOptions

9.6.1 setValues(...)
This method modifies the MovieOptions object.

Arguments
Required arguments
None.

9–27

Abaqus ID:
Printed on:
CANVAS COMMANDS

Optional arguments
movieName
A String specifying the name of the movie. A list of valid movie names is in the movies repository
in the session object.
showMovie
A Boolean specifying whether a movie should be displayed in the viewport during an animation.
The default value is OFF.
positionMethod
A SymbolicConstant specifying which positioning method is used to determine how the movie
frames will be scaled and positioned in the viewport. Possible values are:
• FIT_TO_VIEWPORT, specifying a display mode where the movie frame is scaled to fit in
the viewport using the specified fitMethod.
• AUTO_ALIGN, specifying a display mode where the movie frame is scaled as specified by
xScale and yScale and then positioned in the viewport using the specified alignment.
• MANUAL, specifying a display mode where the movie frame is scaled as specified by xScale
and yScale and then positioned in the viewport using the specified origin.
The default value is FIT_TO_VIEWPORT.
fitMethod
A SymbolicConstant specifying which type of fit is performed to scale and position the movie
frame in the viewport when positionMethod=FIT_TO_VIEWPORT. Possible values are:
• BEST_FIT, specifying a mode where the movie frame is scaled to completely fit within the
viewport.
• FIT_WIDTH, specifying a mode where the movie frame width is scaled to match the viewport
width.
• FIT_HEIGHT, specifying a mode where the movie frame height is scaled to match the
viewport height.
The default value is BEST_FIT.
alignment
A SymbolicConstant specifying the relative position of the movie frame in the viewport when
positionMethod=AUTO_ALIGN. Possible values are:
• BOTTOM_LEFT
• BOTTOM_CENTER
• BOTTOM_RIGHT
• CENTER_LEFT
• CENTER
• CENTER_RIGHT
• TOP_LEFT

9–28

Abaqus ID:
Printed on:
 CANVAS COMMANDS

• TOP_CENTER
• TOP_RIGHT
The default value is CENTER.
xScale
A Float specifying the scale applied to the movie frame width. The xScale argument is ignored
when positionMethod=FIT_TO_VIEWPORT. The default value is 1.0.
When xScale is negative, the movie frame is mirrored about its y-axis but its’ position is not
affected.
yScale
A Float specifying the scale applied to the movie frame height. The yScale argument is ignored
when positionMethod=FIT_TO_VIEWPORT. The default value is 1.0.
When yScale is negative, the movie frame is mirrored about its x-axis but its’ position is not
affected.
origin
A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the
viewport. The origin argument is ignored unless positionMethod=MANUAL. The default value
is (0, 0).
translucency
A Float specifying the translucency factor to use when displaying the movie frame. Possible values
are 0.0 translucency 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is
1.0.
options
None or a MovieOptions object specifying the object from which values are to be copied. If other
arguments are also supplied to setValues, they will override the values in the options member.
The default value is None.

Return value
None

Exceptions
RangeError.

9.6.2 Members
The MovieOptions object has members with the same names and descriptions as the arguments to the
setValues method.

9–29

Abaqus ID:
Printed on:
CANVAS COMMANDS

9.7 Highlight commands

The Highlight commands are used to highlight objects in the current viewport and to remove the
highlighting.

9.7.1 highlight(...)
This method highlights an object in the current viewport.

Path
highlight

Arguments
Required argument
object
An object specifying the object in the current viewport to be highlighted. You can specify only a
single object. The following objects are supported:
For the MDB
• Vertex
• Edge
• Face
• Surface
• Cell
• Node
• Element
• Element face
• Element edge
• Feature
• Datum
• Instance
• Set
• Load
• Boundary condition
• Predefined field
• Display group

9–30

Abaqus ID:
Printed on:
 CANVAS COMMANDS

For the ODB

• Node
• Element
• Display group

9.7.2 unhighlight(...)
This method removes highlighting from an object in the current viewport.

Path
unhighlight

Arguments
Required arguments
object
An object specifying the object in the current viewport from which the highlighting will be
removed. You can specify only a single object. See “highlight,” Section 9.7.1 for a list of
supported objects.

9–31

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

10. Connector commands

A connector describes the relative motions between two points. A connector also describes the behavior
associated with the relative motion.

10.1 ConnectorBehaviorOption object

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

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.1.1 Members
The ConnectorBehaviorOption object has no members.

10.2 CDCTerm object

The CDCTerm object is used to create contributing terms for a DerivedComponent object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.cdcTerms[i]
mdb.models[name].sections[name].behaviorOptions[i].derivedComponent\
.cdcTerms[i]
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.cdcTerms[i]
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.cdcTerms[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]\

10–1

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

.connectorPotentials[i].derivedComponent.cdcTerms[i]
session.odbs[name].sections[name].behaviorOptions[i].derivedComponent\
.cdcTerms[i]
session.odbs[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.cdcTerms[i]
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.cdcTerms[i]

10.2.1 CDCTerm(...)
This method creates a CDCTerm object.

Path
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.CDCTerm
mdb.models[name].sections[name].behaviorOptions[i].derivedComponent\
.CDCTerm
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.CDCTerm
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.CDCTerm
session.odbs[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.CDCTerm
session.odbs[name].sections[name].behaviorOptions[i].derivedComponent\
.CDCTerm
session.odbs[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.CDCTerm
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.CDCTerm

Required arguments
intrinsicComponents
A sequence of Ints specifying the components of relative motion for which the contributing term
is defined. Possible values are 1 intrinsicComponents 6. Only available components can be
specified if the DerivedComponent object is being referenced by a Potential object. This is not
the case if the DerivedComponent object is referenced by a ConnectorFriction object directly. The
default value is an empty sequence.
table
A sequence of sequences of Floats specifying components numbers and temperature and field
values. Each sequence of the table data specifies:

10–2

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

• The first intrinsic component number.

• If applicable, the second intrinsic component number.
• Etc.
• If applicable, the first independent component number.
• If applicable, the second independent component number.
• Etc.
• If applicable, the temperature value.
• If applicable, the value of the first field variable.
• If applicable, the value of the second field variable.
• Etc.
The default value is an empty sequence.
Optional arguments
termOperator
A SymbolicConstant specifying the method for combining contributing terms: square root of a sum
of the squares, direct sum, or Macauley sum. Possible values are RSS, SUM, and MACAULEY.
The default value is RSS.
termSign
A SymbolicConstant specifying the overall sign for the contributing term. Possible values are
POSITIVE and NEGATIVE. The default value is POSITIVE.
localDependency
A Boolean specifying whether the table data depend on either components of relative position or
components of constitutive relative motion. The default value is OFF.
indepCompType
A SymbolicConstant specifying whether localDependency refers to components of relative
position or components of constitutive relative motion. Possible values are POSITION and
MOTION. The default value is POSITION.
The indepCompType argument applies only if localDependency=ON.
indepComponents
A sequence of Ints specifying the independent components included in the derived component
definition. Possible values are 1 indepComponents 6. Only available components can be
specified. The indepComponents argument applies only if localDependency=ON. The default
value is an empty sequence.
tempDependency
A Boolean specifying whether the table data depend on temperature. The default value is OFF.
fieldDependencies
An Int specifying the number of field variable dependencies. The default value is 0.

10–3

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

Return value
A CDCTerm object.

Exceptions
ValueError and TextError.

10.2.2 setValues(...)
This method modifies the CDCTerm object.

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

Return value
None

Exceptions
ValueError.

10.2.3 Members
The CDCTerm object has members with the same names and descriptions as the arguments to the
CDCTerm method.
In addition, the CDCTerm object can have the following member:
options
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for
this ConnectorBehaviorOption .

10.3 ConnectorDamage object

The ConnectorDamage object defines damage behavior for one or more components of a connector’s
relative motion.
The ConnectorDamage object is derived from the ConnectorBehaviorOption object.

10–4

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.3.1 ConnectorDamage(...)
This method creates a connector damage behavior option for a ConnectorSection object.

Path
mdb.models[name].sections[name].ConnectorDamage
session.odbs[name].sections[name].ConnectorDamage

Required arguments
None.
Optional arguments
coupling
A SymbolicConstant specifying whether or not the behavior is coupled. Possible values are
UNCOUPLED and COUPLED. The default value is UNCOUPLED.
criterion
A SymbolicConstant specifying the damage initiation criterion to be used. Possible values are
FORCE, MOTION, and PLASTIC_MOTION. The default value is FORCE.
initiationTemperature
A Boolean specifying whether the initiation data depend on temperature. The default value is OFF.
initiationPotentialOperator
A SymbolicConstant specifying the contribution operator for the initiation potential contributions.
Possible values are SUM and MAXIMUM. The default value is SUM.
This argument is only if coupling=COUPLED and if criterion=FORCE or MOTION.
initiationPotentialExponent
A Float specifying the number equal to the inverse of the overall exponent in the initiation potential
definition. The default value is 2.0.
This argument is applicable only if coupling=COUPLED, when
initiationPotentialOperator=SUM, and when criterion=FORCE or MOTION.
initiationDependencies
An Int specifying the number of field variable dependencies for the initiation data. The default
value is 0.

10–5

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

evolution
A Boolean specifying whether damage evolution data will be used. The default value is ON.
evolutionType
A SymbolicConstant specifying the type of damage evolution to be specified. Possible values are
MOTION_TYPE and ENERGY_TYPE. The default value is MOTION_TYPE.
This argument is applicable only if evolution=ON.
softening
A SymbolicConstant specifying the damage evolution law to be specified. Possible values are
LINEAR, EXPONENTIAL, and TABULAR. The default value is LINEAR.
This argument is applicable only if evolution=ON and when
evolutionType=MOTION_TYPE.
useAffected
A Boolean specifying whether or not affectedComponents will be specified. If useAffected=OFF,
then only the components of relative motion specified by components will undergo damage. The
default value is OFF.
This argument is applicable only if evolution=ON.
degradation
A SymbolicConstant specifying the contribution of each damage mechanism when more than one
damage mechanism is defined. Possible values are MAXIMUM and MULTIPLICATIVE. The
default value is MAXIMUM.
This argument is applicable if evolution=ON.
evolutionTemperature
A Boolean specifying whether the evolution data depend on temperature. The default value is
OFF.
This argument is applicable only if evolution=ON.
evolutionDependencies
An Int specifying the number of field variable dependencies for the evolution data. The default
value is 0.
This argument is applicable only if evolution=ON.
evolutionPotentialOperator
A SymbolicConstant specifying the contribution operator for the evolution potential contributions.
Possible values are SUM and MAXIMUM. The default value is SUM.
This argument is applicable only if coupling=COUPLED, when evolution=ON, when
evolutionType=MOTION_TYPE, and when criterion=FORCE or MOTION.
evolutionPotentialExponent
A Float specifying the number equal to the inverse of the overall exponent in the evolution potential
definition. The default value is 2.0.
This argument is applicable only if coupling=COUPLED, when evolution=ON, when
evolutionPotentialOperator=SUM, when evolutionType=MOTION, and when criterion=FORCE
or MOTION.

10–6

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

initiationPotentials
A ConnectorPotentialArray object specifying one ConnectorPotential object for each initiation
potential contribution. This member can be specified only if coupling=COUPLED and if
criterion=FORCE or MOTION.
evolutionPotentials
A ConnectorPotentialArray object specifying one ConnectorPotential object for each evolution
potential contribution). This member can be specified only if coupling=COUPLED, if
evolution=ON, if evolutionType=MOTION, and if criterion=FORCE or MOTION.
initiationTable
A sequence of sequences of Floats specifying the initiation properties. The default value is an
empty sequence.
Items in the initiationTable data are described below.
evolutionTable
A sequence of sequences of Floats specifying the evolution properties. The default value is an
empty sequence.
Items in the evolutionTable data are described below. This argument is only applicable if
evolution=ON.
affectedComponents
A sequence of Ints specifying the components of relative motion that will be damaged. Possible
values are 1 components 6. Only available components can be specified. This argument is
applicable only if evolution=ON and useAffected=ON. The default value is an empty sequence.
components
A sequence of Ints specifying the components of relative motion for which the behavior is
defined. Possible values are 1 components 6. Only available components can be specified.
This argument can be specified only if coupling=UNCOUPLED. The default value is an empty
sequence.
Table data
Table data for initiationTable:
If criterion=FORCE, then each sequence of the table data specifies the following:
• Lower (compression) limiting force or moment. Use -1.0E+36 to indicate an unspecified lower
limit.
• Upper (tension) limiting force or moment. Use 1.0E+36 to indicate an unspecified upper limit. At
least one limit, lower or upper, must be specified.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If criterion=MOTION, then each sequence of the table data specifies the following:

10–7

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

• Lower (compression) limiting connector constitutive relative displacement or rotation. Use

-1.0E+36 to indicate an unspecified lower limit.
• Upper (tension) limiting connector constitutive relative displacement or rotation. Use 1.0E+36 to
indicate an unspecified upper limit. At least one limit, lower or upper, must be specified.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If criterion=PLASTIC_MOTION, then each sequence of the table data specifies the following:
• Relative equivalent plastic displacement/rotation at which damage will be initiated.
• Mode-mix ratio (only if coupling=COUPLED).
• Relative equivalent plastic displacement/rotation rate.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
Table data for evolutionTable:
If evolutionType=MOTION and softening=LINEAR, then each sequence of the table data specifies
the following:
• Post-initiation equivalent relative plastic motion at ultimate failure if
criterion=PLASTIC_MOTION. Otherwise, post-initiation constitutive relative motion
(displacement/rotation) at ultimate failure.
• Mode-mix ratio (only if coupling=COUPLED and criterion=PLASTIC_MOTION).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=MOTION and softening=EXPONENTIAL, then each sequence of the table data
specifies the following:
• Post-initiation equivalent relative plastic motion at ultimate failure if
criterion=PLASTIC_MOTION. Otherwise, post-initiation constitutive relative motion
(displacement/rotation) at ultimate failure.
• Exponential law parameter.
• Mode-mix ratio (only if coupling=COUPLED and criterion=PLASTIC_MOTION).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

10–8

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

• Value of the second field variable.

• Etc.
If evolutionType=MOTION and softening=TABULAR, then each sequence of the table data
specifies the following:
• Damage variable (cannot be less than 0 or greater than 1).
• Post-initiation equivalent relative plastic motion if criterion=PLASTIC_MOTION. Otherwise,
post-initiation constitutive relative motion (displacement/rotation).
• Mode-mix ratio (only if coupling=COUPLED and criterion=PLASTIC_MOTION).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=ENERGY, then each sequence of the table data specifies the following:
• Total energy dissipated by damage at ultimate failure.
• Mode-mix ratio (only if coupling=COUPLED and criterion=PLASTIC_MOTION).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConnectorDamage object.

Exceptions
ValueError and TextError.

10.3.2 setValues(...)
This method modifies the ConnectorDamage object.

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

10–9

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

Return value
None

Exceptions
ValueError.

10.3.3 Members
The ConnectorDamage object has members with the same names and descriptions as the arguments to
the ConnectorDamage method.
In addition, the ConnectorDamage object can have the following members:
initiationOptions
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for the
damage initiation table.
evolutionOptions
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for the
damage evolution table.

10.3.4 Corresponding analysis keywords

*CONNECTOR DAMAGE INITIATION, *CONNECTOR DAMAGE EVOLUTION,

*CONNECTOR POTENTIAL

10.4 ConnectorDamping object

The ConnectorDamping object defines damping behavior for one or more components of a connector’s
relative motion.
The ConnectorDamping object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10–10

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

10.4.1 ConnectorDamping(...)
This method creates a connector damping behavior option for a ConnectorSection object.

Path
mdb.models[name].sections[name].ConnectorDamping
session.odbs[name].sections[name].ConnectorDamping

Required arguments
None.
Optional arguments
behavior
A SymbolicConstant specifying if the damping behavior is linear or nonlinear. Possible values are
LINEAR and NONLINEAR. The default value is LINEAR.
coupling
A SymbolicConstant specifying whether the damping behavior is coupled between the
connector’s components of relative motion. If behavior=LINEAR, then possible values
are UNCOUPLED and COUPLED. If behavior=NONLINEAR, then possible values are
UNCOUPLED, COUPLED_POSITION, and COUPLED_MOTION. Possible values are
UNCOUPLED, COUPLED, COUPLED_POSITION, and COUPLED_MOTION. The default
value is UNCOUPLED.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
temperatureDependency
A Boolean specifying whether the behavior data depend on temperature. The default value is OFF.
frequencyDependency
A Boolean specifying whether the behavior data depend on frequency. This value is applicable
only if behavior= LINEAR and coupling=UNCOUPLED. The default value is OFF.
table
A sequence of sequences of Floats specifying damping properties. Items in the table data are
described below. The default value is an empty sequence.
independentComponents
A sequence of Ints specifying the list of independent components that are included in the definition
of the connector damping data. This argument is applicable only if behavior=NONLINEAR and
coupling=COUPLED_POSITION or COUPLED_MOTION. When this argument is applicable, at
least one value must be specified. Only available components can be specified. The default value
is an empty sequence.

10–11

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

components
A sequence of Ints specifying the components of relative motion for which the behavior is defined.
Possible values are 1 components 6. Only available components can be specified. The default
value is an empty sequence.
Table data
If behavior=LINEAR and coupling=UNCOUPLED, then each sequence of the table data specifies the
following:
• Damping coefficient (force or moment per relative velocity).
• Frequency (cycles/time), if the data depend on frequency.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If behavior=NONLINEAR and coupling=UNCOUPLED, then each sequence of the table data specifies
the following:
• Force or moment.
• Relative displacement or rotation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If behavior=LINEAR and coupling=COUPLED, the table data specify the symmetric portion of the
damping matrix for the specified components followed by any temperature data and then any field data.
For example, if components 2, 3, and 5 are specified, the table portion of the command is as follows:
table=( ( , , , , , ,), )
The following items should then be specified as comma-separated data:
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If behavior=NONLINEAR and coupling=COUPLED_POSITION or COUPLED_MOTION, each
sequence of the table data specifies the following:
• Force or moment for the directions in the components list.
• Relative velocity for the directions in the components list.

10–12

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

• Relative position or angle for the first independentComponents direction if

coupling=COUPLED_POSITION. Relative displacement or rotation for the first
independentComponents direction if coupling=COUPLED_MOTION.
• Relative position or angle for the second independentComponents direction if
coupling=COUPLED_POSITION. Relative displacement or rotation for the second
independentComponents direction if coupling=COUPLED_MOTION.
• Etc. up to the Nth independentComponents direction.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConnectorDamping object.

Exceptions
ValueError and TextError.

10.4.2 setValues(...)
This method modifies the ConnectorDamping object.

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

Return value
None

Exceptions
ValueError.

10–13

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

10.4.3 Members
The ConnectorDamping object has members with the same names and descriptions as the arguments to
the ConnectorDamping method.
In addition, the ConnectorDamping object can have the following member:
options
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for
this ConnectorBehaviorOption .

10.4.4 Corresponding analysis keywords

*CONNECTOR DAMPING

10.5 ConnectorElasticity object

The ConnectorElasticity object defines elastic behavior for one or more components of a connector’s
relative motion.
The ConnectorElasticity object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.5.1 ConnectorElasticity(...)
This method creates a connector elasticity behavior option for a ConnectorSection object.

Path
mdb.models[name].sections[name].ConnectorElasticity
session.odbs[name].sections[name].ConnectorElasticity

Required arguments
None.

10–14

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

Optional arguments
behavior
A SymbolicConstant specifying whether the elastic behavior is linear, nonlinear, or rigid. Possible
values are LINEAR, NONLINEAR, and RIGID. The default value is LINEAR.
coupling
A SymbolicConstant specifying whether the elastic behavior is coupled between the connector’s
components of relative motion. If behavior=LINEAR, then possible values are UNCOUPLED
and COUPLED. If behavior=NONLINEAR, then possible values are UNCOUPLED,
COUPLED_POSITION, and COUPLED_MOTION. Possible values are UNCOUPLED,
COUPLED, COUPLED_POSITION, and COUPLED_MOTION. The default value is
UNCOUPLED.
This argument is not applicable if behavior=RIGID.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
This argument is not applicable if behavior=RIGID.
temperatureDependency
A Boolean specifying whether the behavior data depend on temperature. The default value is OFF.
This argument is not applicable if behavior=RIGID.
frequencyDependency
A Boolean specifying whether the behavior data depend on frequency. This value is applicable
only if behavior=LINEAR and coupling=UNCOUPLED. The default value is OFF.
This argument is not applicable if behavior=RIGID.
table
A sequence of sequences of Floats specifying elasticity properties. Items in the table data are
described below. This argument is not applicable if behavior=RIGID. The default value is an
empty sequence.
independentComponents
A sequence of Ints specifying the list of independent components that are included in the definition
of the connector elasticity data. This argument is applicable only if behavior=NONLINEAR
and coupling=COUPLED_POSITION or COUPLED_MOTION. If this argument is applicable,
at least one value must be specified. Only available components can be specified. The default
value is an empty sequence.
components
A sequence of Ints specifying the components of relative motion for which the behavior is defined.
Possible values are 1 components 6. Only available components can be specified. The default
value is an empty sequence.
Table data
If behavior=LINEAR and coupling=UNCOUPLED, then each sequence of the table data specifies the
following:

10–15

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

• Elastic stiffness (per each specified force/moment component).

• Frequency (cycles/time), if the data depend on frequency.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If behavior=NONLINEAR and coupling=UNCOUPLED, then each sequence of the table data specifies
the following:
• Force or moment.
• Relative displacement or rotation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If behavior=LINEAR and coupling=COUPLED, the table data specify the symmetric portion of the
elastic stiffness matrix for the specified components followed by any temperature data and then any field
data. For example, if components 2, 3, and 5 are specified, the table portion of the command is as follows:
table=( ( , , , , , ,),
)
The following items should then be specified as comma-separated data:
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If behavior=NONLINEAR and coupling=COUPLED_POSITION or COUPLED_MOTION, each
sequence of the table data specifies the following:
• Force or moment for the directions in the components list.
• Relative position or angle for the first independentComponents direction if
coupling=COUPLED_POSITION. Relative displacement or rotation for the first
independentComponents direction if coupling=COUPLED_MOTION.
• Relative position or angle for the second independentComponents direction if
coupling=COUPLED_POSITION. Relative displacement or rotation for the second
independentComponents direction if coupling=COUPLED_MOTION.
• Etc. up to the Nth independentComponents direction.
• Temperature, if the data depend on temperature.

10–16

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConnectorElasticity object.

Exceptions
ValueError and TextError.

10.5.2 setValues(...)
This method modifies the ConnectorElasticity object.

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

Return value
None

Exceptions
ValueError.

10.5.3 Members
The ConnectorElasticity object has members with the same names and descriptions as the arguments to
the ConnectorElasticity method.
In addition, the ConnectorElasticity object can have the following member:
options
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for
this ConnectorBehaviorOption .

10.5.4 Corresponding analysis keywords

10–17

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

*CONNECTOR ELASTICITY

10.6 ConnectorFailure object

The ConnectorFailure object defines failure criteria for one or more components of a connector’s relative
motion.
The ConnectorFailure object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.6.1 ConnectorFailure(...)
This method creates a connector failure behavior option for a ConnectorSection object.

Path
mdb.models[name].sections[name].ConnectorFailure
session.odbs[name].sections[name].ConnectorFailure

Required arguments
None.
Optional arguments
releaseComponent
The SymbolicConstant ALL or an Int specifying the motion components that fail. If an
Int is specified, only that motion component fails when the failure criteria are satisfied. If
releaseComponent=ALL, all motion components fail. The default value is ALL.
minMotion
None or a Float specifying the lower bound for the connector’s relative position for all specified
components, or no lower bound. The default value is None.
maxMotion
None or a Float specifying the upper bound for the connector’s relative position for all specified
components, or no upper bound. The default value is None.

10–18

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

minForce
None or a Float specifying the lower bound of the force or moment in the directions of the specified
components at which locking occurs, or no lower bound. The default value is None.
maxForce
None or a Float specifying the upper bound of the force or moment in the directions of the specified
components at which locking occurs, or no upper bound. The default value is None.
components
A sequence of Ints specifying the components of relative motion for which the behavior is defined.
Possible values are 1 components 6. Only available components can be specified. The default
value is an empty sequence.

Return value
A ConnectorFailure object.

Exceptions
ValueError and TextError.

10.6.2 setValues(...)
This method modifies the ConnectorFailure object.

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

Return value
None

Exceptions
ValueError.

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

10–19

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

10.6.4 Corresponding analysis keywords

*CONNECTOR FAILURE

10.7 ConnectorFriction object

The ConnectorFriction object defines Coulomb-like or hysteretic friction behavior for one or more
components of a connector’s relative motion.
The ConnectorFriction object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.7.1 ConnectorFriction(...)
This method creates a connector friction behavior option for a ConnectorSection object. Depending upon
the arguments provided, the friction behavior can be Coulomb-like or hysteretic in nature.

Path
mdb.models[name].sections[name].ConnectorFriction
session.odbs[name].sections[name].ConnectorFriction

Required arguments
None.
Optional arguments
frictionModel
A SymbolicConstant specifying the desired frictional response model. Possible values are
PREDEFINED and USER_CUSTOMIZED. The default value is PREDEFINED.
slipStyle
A SymbolicConstant specifying the method of indicating the slip direction: either specified or
computed based upon the force potential data. Possible values are SPECIFY and COMPUTE.
The default value is SPECIFY.
This argument is applicable only if frictionModel=USER_CUSTOMIZED.

10–20

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

tangentDirection
None or an Int specifying the direction for which the frictional behavior is specified. Possible
values are 1 tangentDirection 6, indicating an available component of relative motion. This
argument applies only if frictionModel=USER_CUSTOMIZED and if slipStyle=SPECIFY. The
default value is None.
stickStiffness
None or a Float specifying the stick stiffness associated with the frictional behavior in the
direction specified by tangentDirection. If this argument is omitted, Abaqus computes an
appropriate number for the stick stiffness. The default value is None.
componentType
A SymbolicConstant specifying the type of the independentComponents. Possible values
are POSITION, MOTION, and NO_INDEPENDENT_COMPONENTS. The default value is
NO_INDEPENDENT_COMPONENTS.
slipDependency
A Boolean specifying whether the table data depend on accumulated slip. The default value is
OFF.
This argument applies only if frictionModel=USER_CUSTOMIZED.
temperatureDependency
A Boolean specifying whether the table data depend on temperature. The default value is OFF.
This argument applies only if frictionModel=USER_CUSTOMIZED.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
This argument applies only if frictionModel=USER_CUSTOMIZED.
useContactForceComponent
A Boolean specifying whether the contact force component will be defined. The default value is
OFF.
This argument applies only if frictionModel=USER_CUSTOMIZED.
contactForceStyle
A SymbolicConstant specifying the method of indicating the contact force component
direction: either specified or computed based on upon a DerivedComponent. Possible
values are COMPONENT_NUMBER and DERIVED_COMPONENT. The default value is
COMPONENT_NUMBER.
This argument is applicable only if frictionModel=USER_CUSTOMIZED and if
useContactForceComponent=ON.
contactForceComponent
An Int specifying the contact force component direction. This argument applies only
if frictionModel=USER_CUSTOMIZED, if useContactForceComponent=ON, and if
contactForceStyle=COMPONENT_NUMBER. The default value is 0.

10–21

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

forcePotentialOperator
A SymbolicConstant specifying the contribution operator for the force potential contributions.
Possible values are SUM and MAXIMUM. The default value is SUM.
This argument is applicable only if frictionModel=USER_CUSTOMIZED and if
slipStyle=COMPUTE.
forcePotentialExponent
A Float specifying the number equal to the inverse of the overall exponent in the force potential
definition. The default value is 2.0.
This argument is applicable only if frictionModel=USER_CUSTOMIZED, if
slipStyle=COMPUTE, and if forcePotentialOperator=SUM.
connectorPotentials
A ConnectorPotentialArray object specifying one ConnectorPotential object
for each force potential contribution. This member can be specified only if
frictionModel=USER_CUSTOMIZED, and if slipStyle=COMPUTE.
table
A sequence of sequences of Floats specifying friction properties. The default value is an empty
sequence.
If frictionModel=PREDEFINED, each sequence of the table data specifies:
• If applicable, the first geometric scaling constant relevant to frictional interactions.
• Etc., up to as many geometric scaling constants as are associated with this connection type.
• Internal contact force/moment generating friction in the first predefined slip direction.
• If applicable, internal contact force/moment generating friction in the second predefined slip
direction.
• Connector constitutive relative motion in the direction specified by independentComponent.
• Accumulated slip in the first predefined slip direction, if the data depend on accumulated slip.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If frictionModel=USER_CUSTOMIZED, each sequence of the table data specifies:
• Effective radius of the cylindrical or spherical surface over which frictional slip occurs in
the connector associated with frictional effects in the direction specified by tangentDirection.
This radius is relevant only if the connection type includes an available rotational component
of relative motion and tangentDirection=SLIP_DIRECTION.
• Internal contact force/moment generating friction in the direction specified by
tangentDirection.
• Connector constitutive relative motion in the direction specified by independentComponent.

10–22

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

• Accumulated slip in the direction specified by tangentDirection, if the data depend on

accumulated slip.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

independentComponents
A sequence of Ints specifying the independent components. Possible values are 1
independentComponents 6. In addition, each independent component value must be unique.
The independentComponents argument applies only if frictionModel=USER_CUSTOMIZED.
Only available components can be specified. The default value is an empty sequence.

Return value
A ConnectorFriction object.

Exceptions
ValueError and TextError.

10.7.2 setValues(...)
This method modifies the ConnectorFriction object.

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

Return value
None

Exceptions
ValueError.

10–23

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

10.7.3 Members
The ConnectorFriction object has members with the same names and descriptions as the arguments to
the ConnectorFriction method.
In addition, the ConnectorFriction object can have the following members:
tangentialBehavior
A TangentialBehavior object.
derivedComponent
A DerivedComponent object specifying the DerivedComponent used to compute the contact force
component direction. This argument applies only if frictionModel=USER_CUSTOMIZED, if
useContactForceComponent=ON, and if contactForceStyle=DERIVED_COMPONENT.
options
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for
this ConnectorBehaviorOption .

10.7.4 Corresponding analysis keywords

*CONNECTOR FRICTION, *FRICTION, *CONNECTOR POTENTIAL, *CONNECTOR

DERIVED COMPONENT

10.8 ConnectorLock object

The ConnectorLock object defines locking criteria for one or more available components of a connector’s
relative motion.
The ConnectorLock object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.8.1 ConnectorLock(...)
This method creates a connector lock behavior option for a ConnectorSection .

10–24

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

Path
mdb.models[name].sections[name].ConnectorLock
session.odbs[name].sections[name].ConnectorLock

Required arguments
None.
Optional arguments
lockingComponent
The SymbolicConstant ALL or an Int specifying the motion components that are locked. If an
Int is specified, only that motion component is locked when the locking criteria are satisfied. If
lockingComponent=ALL, all motion components are locked. The default value is ALL.
minMotion
None or a Float specifying the lower bound for the connector’s relative position for all specified
components, or no lower bound. The default value is None.
maxMotion
None or a Float specifying the upper bound for the connector’s relative position for all specified
components, or no upper bound. The default value is None.
minForce
None or a Float specifying the lower bound of the force or moment in the directions of the specified
components at which locking occurs, or no lower bound. The default value is None.
maxForce
None or a Float specifying the upper bound of the force or moment in the directions of the specified
components at which locking occurs, or no upper bound. The default value is None.
components
A sequence of Ints specifying the components of relative motion for which the behavior is defined.
Possible values are 1 components 6. Only available components can be specified. The default
value is an empty sequence.

Return value
A ConnectorLock object.

Exceptions
ValueError and TextError.

10.8.2 setValues(...)
This method modifies the ConnectorLock object.

10–25

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

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

Return value
None

Exceptions
ValueError.

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

10.8.4 Corresponding analysis keywords

*CONNECTOR LOCK

10.9 ConnectorOptions object

The ConnectorOptions object is used to define various options for connector behaviors. It can be used
only in conjunction with CDCTerm , ConnectorDamage , ConnectorDamping , ConnectorElasticity ,
ConnectorFriction , and ConnectorPlasticity objects. Because the ConnectorDamage object contains
two separate ConnectorOptions repositories (one for damage initiation and one for damage evolution),
there are two ConnectorOptions constructors associated with that behavior—initiationOptions and
evolutionOptions. The ConnectorPlasticity object also contains two separate ConnectorOptions
repositories (one for isotropic hardening and one for kinematic hardening), so there are two
ConnectorOptions constructors associated with that behavior—isotropicOptions and kinematicOptions.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.cdcTerms[i].options
mdb.models[name].sections[name].behaviorOptions[i].derivedComponent\
.cdcTerms[i].options

10–26

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

mdb.models[name].sections[name].behaviorOptions[i].evolutionOptions
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.cdcTerms[i].options
mdb.models[name].sections[name].behaviorOptions[i].initiationOptions
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.cdcTerms[i].options
mdb.models[name].sections[name].behaviorOptions[i].isotropicOptions
mdb.models[name].sections[name].behaviorOptions[i].kinematicOptions
mdb.models[name].sections[name].behaviorOptions[i].options
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.cdcTerms[i].options
session.odbs[name].sections[name].behaviorOptions[i].derivedComponent\
.cdcTerms[i].options
session.odbs[name].sections[name].behaviorOptions[i].evolutionOptions
session.odbs[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.cdcTerms[i].options
session.odbs[name].sections[name].behaviorOptions[i].initiationOptions
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.cdcTerms[i].options
session.odbs[name].sections[name].behaviorOptions[i].isotropicOptions
session.odbs[name].sections[name].behaviorOptions[i].kinematicOptions
session.odbs[name].sections[name].behaviorOptions[i].options

10.9.1 ConnectorOptions(...)
This method creates a connector options object to be used in conjunction with an allowable connector
behavior option, derived component term, or connector section.

Path
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.cdcTerms[i].ConnectorOptions
mdb.models[name].sections[name].behaviorOptions[i].derivedComponent\
.cdcTerms[i].ConnectorOptions
mdb.models[name].sections[name].behaviorOptions[i].ConnectorOptions
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.cdcTerms[i].ConnectorOptions
mdb.models[name].sections[name].behaviorOptions[i].ConnectorOptions
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.cdcTerms[i].ConnectorOptions
mdb.models[name].sections[name].behaviorOptions[i].ConnectorOptions

10–27

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

session.odbs[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent.cdcTerms[i].ConnectorOptions
session.odbs[name].sections[name].behaviorOptions[i].derivedComponent\
.cdcTerms[i].ConnectorOptions
session.odbs[name].sections[name].behaviorOptions[i].ConnectorOptions
session.odbs[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent.cdcTerms[i].ConnectorOptions
session.odbs[name].sections[name].behaviorOptions[i].ConnectorOptions
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent.cdcTerms[i].ConnectorOptions
session.odbs[name].sections[name].behaviorOptions[i].ConnectorOptions

Required arguments
None.
Optional arguments
useBehRegSettings
A Boolean specifying whether or not to use the behavior-level settings for regularization options.
This argument is applicable only for an Abaqus/Explicit analysis. The default value is ON.
regularize
A Boolean specifying whether or not the tabular data will be regularized. This argument is
applicable only for an Abaqus/Explicit analysis and only if useBehRegSettings=OFF. The default
value is ON.
defaultTolerance
A Boolean specifying whether or not the analysis default regularization tolerance will be used. This
argument is applicable only for an Abaqus/Explicit analysis and only if useBehRegSettings=OFF
and regularize=ON. The default value is ON.
regularization
A Float specifying the regularization increment to be used. This argument is applicable only
for an Abaqus/Explicit analysis and only if useBehRegSettings=OFF, regularize=ON, and
defaultTolerance=OFF. The default value is 0.03.
defaultRateFactor
A Boolean specifying whether or not the analysis default rate filter factor will be used. This
argument is applicable only for an Abaqus/Explicit analysis that includes isotropic hardening with
tabular definition or damage initiation with plastic motion criteria. The default value is ON.
rateFactor
A Float specifying the rate filter factor to be used. This argument is applicable only for
an Abaqus/Explicit analysis that includes isotropic hardening with tabular definition or
damage initiation with plastic motion criteria. This argument is also applicable only if
defaultRateFactor=OFF. The default value is 0.9.

10–28

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

interpolation
A SymbolicConstant specifying the type of interpolation increment to be used on rate-dependent
tabular data. This argument is applicable only for an Abaqus/Explicit analysis that includes
isotropic hardening with tabular definition or damage initiation with plastic motion criteria.
Possible values are LINEAR and LOGARITHMIC. The default value is LINEAR.
useBehExtSettings
A Boolean specifying whether or not to use the behavior-level settings for extrapolation options.
The default value is ON.
extrapolation
A SymbolicConstant specifying the extrapolation technique to be used. This argument is
applicable only if useBehExtSettings=OFF. Possible values are CONSTANT and LINEAR. The
default value is CONSTANT.

Return value
A ConnectorOptions object.

Exceptions
ValueError and TextError.

10.9.2 setValues(...)
This method modifies the ConnectorOptions object.

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

Return value
None

Exceptions
ValueError.

10–29

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

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

10.9.4 Corresponding analysis keywords

*CONNECTOR BEHAVIOR, *CONNECTOR DAMAGE INITIATION, *CONNECTOR

DAMAGE EVOLUTION, *CONNECTOR DAMPING, *CONNECTOR DERIVED
COMPONENT, *CONNECTOR ELASTICITY, *CONNECTOR FRICTION, and *CONNECTOR
PLASTICITY

10.10 ConnectorPlasticity object

The ConnectorPlasticity object defines plastic behavior for one or more components of a connector’s
relative motion.
The ConnectorPlasticity object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.10.1 ConnectorPlasticity(...)
This method creates a connector plasticity behavior option for a ConnectorSection object.

Path
mdb.models[name].sections[name].ConnectorPlasticity
session.odbs[name].sections[name].ConnectorPlasticity

Required arguments
None.

10–30

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

Optional arguments
coupling
A SymbolicConstant specifying whether or not the behavior is coupled. Possible values are
UNCOUPLED and COUPLED. The default value is UNCOUPLED.
isotropic
A Boolean specifying whether isotropic hardening data will be used. The default value is ON.
If isotropic=OFF, then kinematic must be specified as ON.
isotropicType
A SymbolicConstant specifying the type of isotropic hardening to be specified. Possible values
are TABULAR and EXPONENTIAL_LAW. The default value is TABULAR.
This argument is applicable only if isotropic=ON.
isotropicTemperature
A Boolean specifying whether the isotropic data depend on temperature. The default value is OFF.
This argument is applicable only if isotropic=ON.
isotropicDependencies
An Int specifying the number of field variable dependencies for the isotropic data. The default
value is 0.
This argument is applicable only if isotropic=ON.
kinematic
A Boolean specifying whether kinematic hardening data will be used. The default value is OFF.
If kinematic=OFF, then isotropic must be specified as ON.
kinematicType
A SymbolicConstant specifying the type of kinematic hardening to be specified. Possible values
are HALF_CYCLE, STABILIZED, and PARAMETERS. The default value is HALF_CYCLE.
This argument is applicable only if kinematic=ON.
kinematicTemperature
A Boolean specifying whether the kinematic data depend on temperature. The default value is
OFF.
This argument is applicable only if kinematic=ON.
kinematicDependencies
An Int specifying the number of field variable dependencies for the kinematic data. The default
value is 0.
This argument is applicable only if kinematic=ON.
forcePotentialOperator
A SymbolicConstant specifying the contribution operator for the force potential contributions.
Possible values are SUM and MAXIMUM. The default value is SUM.
This argument is applicable only if coupling=COUPLED.

10–31

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

forcePotentialExponent
A Float specifying the number equal to the inverse of the overall exponent in the force potential
definition. The default value is 2.0.
This argument is applicable only if coupling=COUPLED and if
forcePotentialOperator=SUM.
connectorPotentials
A ConnectorPotentialArray object specifying one ConnectorPotential object for each force
potential contribution. This member can be specified only if coupling=COUPLED.
isotropicTable
A sequence of sequences of Floats specifying isotropic plasticity properties. Items in the
isotropicTable data are described below. This argument is applicable only if isotropic=ON. The
default value is an empty sequence.
kinematicTable
A sequence of sequences of Floats specifying kinematic plasticity properties. Items in the
kinematicTable data are described below. This argument is applicable only if kinematic=ON. The
default value is an empty sequence.
components
A sequence of Ints specifying the components of relative motion for which the behavior is
defined. Possible values are 1 components 6. Only available components can be specified.
This argument can be specified only if coupling=UNCOUPLED. The default value is an empty
sequence.
Table data
Table data for isotropicTable:
If isotropicType=TABULAR, then each sequence of the table data specifies the following:
• Equivalent yield force or moment defining the size of the elastic range.
• Equivalent relative plastic motion.
• Equivalent relative plastic motion rate.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If isotropicType=EXPONENTIAL_LAW, then each sequence of the table data specifies the
following:
• Equivalent force or moment defining the size of the elastic range at zero plastic motion.
• Isotropic hardening parameter .
• Isotropic hardening parameter .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

10–32

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

• Value of the second field variable.

• Etc.
Table data for kinematicTable:
If kinematicType=HALF_CYCLE, then each sequence of the table data specifies the following:
• Yield force or moment.
• Connector relative plastic motion.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If kinematicType=STABILIZED, then each sequence of the table data specifies the following:
• Yield force or moment.
• Connector relative plastic motion.
• Connector relative constitutive motion range.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If kinematicType=PARAMETERS, then each sequence of the table data specifies the following:
• Yield force or moment at zero relative plastic motion.
• Kinematic hardening parameter .
• Kinematic hardening parameter . Set =0 to specify linear Ziegler kinematic hardening.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConnectorPlasticity object.

Exceptions
ValueError and TextError.

10–33

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

10.10.2 setValues(...)
This method modifies the ConnectorPlasticity object.

Arguments

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

Return value
None

Exceptions
ValueError.

10.10.3 Members
The ConnectorPlasticity object has members with the same names and descriptions as the arguments to
the ConnectorPlasticity method.
In addition, the ConnectorPlasticity object can have the following members:
isotropicOptions
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for the
isotropic hardening table.
kinematicOptions
A ConnectorOptions object specifying the ConnectorOptions used to define tabular options for the
kinematic hardening table.

10.10.4 Corresponding analysis keywords

*CONNECTOR PLASTICITY, *CONNECTOR HARDENING, *CONNECTOR POTENTIAL

10–34

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

10.11 ConnectorPotential object

The ConnectorPotential object is used to define a restricted set of mathematical functions to represent
yield or limiting surfaces in the space spanned by connector available components. It can be used only
in conjunction with ConnectorDamage , ConnectorFriction , and ConnectorPlasticity objects. Because
the ConnectorDamage object contains two separate ConnectorPotential repositories (one for damage
initiation and one for damage evolution), there are two ConnectorPotential constructors associated with
that behavior—IniPotential and EvoPotential.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i]
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i]
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i]
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i]
session.odbs[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i]
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i]

10.11.1 ConnectorPotential(...)
This method creates a connector potential object to be used in conjunction with an allowable connector
behavior option.

Path
mdb.models[name].sections[name].behaviorOptions[i].ConnectorPotential
session.odbs[name].sections[name].behaviorOptions[i]\
.ConnectorPotential

Required arguments
None.

10–35

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

Optional arguments
componentStyle
A SymbolicConstant specifying whether a component number or the name of the
DerivedComponent object will be used in the contribution. Possible values are
COMPONENT_NUMBER and DERIVED_COMPONENT. The default value is
COMPONENT_NUMBER.
componentNumber
An Int specifying the component number used in the contribution. This argument is applicable
only if componentStyle=COMPONENT_NUMBER. Possible values are 1 componentNumber
6. Only available components can be specified. The default value is 0.
sign
A SymbolicConstant specifying the sign of the contribution. Possible values are POSITIVE and
NEGATIVE. The default value is POSITIVE.
scaleFactor
A Float specifying the scaling factor for the contribution. The default value is 1.0.
positiveExponent
A Float specifying the positive exponent for the contribution. The default value is 2.0.
This argument is ignored if the potential operator of the invoking behavior option is set to
MAXIMUM.
shiftFactor
A Float specifying the shift factor for the contribution. The default value is 0.0.
hFunction
A SymbolicConstant specifying the H function of the contribution: either absolute value,
Macauley bracket, or the identity function. Possible values are ABS, MACAULEY, and
IDENTITY. The default value is ABS.
The value of IDENTITY can be used only if positiveExponent=1.0 and the potential exponent
of the invoking behavior option is also 1.0 (i.e., the potential operator of the invoking behavior
option must be SUM).

Return value
A ConnectorPotential object.

Exceptions
ValueError and TextError.

10.11.2 setValues(...)
This method modifies the ConnectorPotential object.

10–36

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

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

Return value
None

Exceptions
ValueError.

10.11.3 Members
The ConnectorPotential object has members with the same names and descriptions as the arguments to
the ConnectorPotential method.
In addition, the ConnectorPotential object can have the following member:
derivedComponent
A DerivedComponent object specifying the DerivedComponent used in the contribution. This
argument is applicable only if componentStyle=DERIVED_COMPONENT.

10.11.4 Corresponding analysis keywords

*CONNECTOR POTENTIAL

10.12 ConnectorStop object

The ConnectorStop object defines connector stops for one or more components of a connector’s relative
motion.
The ConnectorStop object is derived from the ConnectorBehaviorOption object.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]

10–37

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

import odbSection
session.odbs[name].sections[name].behaviorOptions[i]

10.12.1 ConnectorStop(...)
This method creates a connector stop behavior option for a ConnectorSection object.

Path
mdb.models[name].sections[name].ConnectorStop
session.odbs[name].sections[name].ConnectorStop

Required arguments
None.
Optional arguments
minMotion
None or a Float specifying the lower bound for the connector’s relative position for all specified
components, or no lower bound. The default value is None.
maxMotion
None or a Float specifying the upper bound for the connector’s relative position for all specified
components, or no upper bound. The default value is None.
components
A sequence of Ints specifying the components of relative motion for which the behavior is defined.
Possible values are 1 components 6. Only available components can be specified. The default
value is an empty sequence.

Return value
A ConnectorStop object.

Exceptions
ValueError and TextError.

10.12.2 setValues(...)
This method modifies the ConnectorStop object.

Arguments
Required arguments
None.

10–38

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the ConnectorStop method.

Return value
None

Exceptions
ValueError.

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

10.12.4 Corresponding analysis keywords

*CONNECTOR STOP

10.13 DerivedComponent object

A DerivedComponent object describes user-customized components for use in defining

ConnectorFriction and Potential objects.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent
mdb.models[name].sections[name].behaviorOptions[i].derivedComponent
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].derivedComponent
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].derivedComponent
session.odbs[name].sections[name].behaviorOptions[i].derivedComponent
session.odbs[name].sections[name].behaviorOptions[i]\

10–39

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

.evolutionPotentials[i].derivedComponent
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].derivedComponent

10.13.1 DerivedComponent()
This method creates a DerivedComponent object.

Path
mdb.models[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].DerivedComponent
mdb.models[name].sections[name].behaviorOptions[i].DerivedComponent
mdb.models[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].DerivedComponent
mdb.models[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].DerivedComponent
session.odbs[name].sections[name].behaviorOptions[i]\
.connectorPotentials[i].DerivedComponent
session.odbs[name].sections[name].behaviorOptions[i].DerivedComponent
session.odbs[name].sections[name].behaviorOptions[i]\
.evolutionPotentials[i].DerivedComponent
session.odbs[name].sections[name].behaviorOptions[i]\
.initiationPotentials[i].DerivedComponent

Arguments
None.

Return value
A DerivedComponent object.

Exceptions
ValueError and TextError.

10.13.2 setValues(...)
This method modifies the DerivedComponent object.

Arguments
Required arguments
None.

10–40

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the DerivedComponent
method.

Return value
None

Exceptions
ValueError.

10.13.3 Members
The DerivedComponent object can have the following member:
cdcTerms
A CDCTermArray object.

10.13.4 Corresponding analysis keywords

*CONNECTOR DERIVED COMPONENT

10.14 TangentialBehavior object

The TangentialBehavior object specifies tangential behavior for a connector friction behavior option.

Access
import section
mdb.models[name].sections[name].behaviorOptions[i].tangentialBehavior
import odbSection
session.odbs[name].sections[name].behaviorOptions[i]\
.tangentialBehavior

10.14.1 TangentialBehavior(...)
This method creates a TangentialBehavior object.

10–41

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

Path
mdb.models[name].sections[name].behaviorOptions[i].TangentialBehavior
session.odbs[name].sections[name].behaviorOptions[i]\
.TangentialBehavior

Required arguments
None.
Optional arguments
formulation
A SymbolicConstant specifying the friction coefficient formulation. Possible values are
PENALTY and EXPONENTIAL_DECAY. The default value is PENALTY.
slipRateDependency
A Boolean specifying whether the data depend on slip rate. The default value is OFF.
pressureDependency
A Boolean specifying whether the data depend on contact pressure. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variables for the data. The default value is 0.
exponentialDecayDefinition
A SymbolicConstant specifying the exponential decay definition for the data. Possible values are
COEFFICIENTS and TEST_DATA. The default value is COEFFICIENTS.
shearStressLimit
None or a Float specifying no upper limit or the friction coefficient shear stress limit. The default
value is None.
maximumElasticSlip
A SymbolicConstant specifying the method for modifying the allowable elastic slip. Possible
values are FRACTION and ABSOLUTE_DISTANCE. The default value is FRACTION.
This argument applies only to Abaqus/Standard analyses.
fraction
A Float specifying the ratio of the allowable maximum elastic slip to a characteristic model
dimension. The default value is 10–4 .
This argument applies only to Abaqus/Standard analyses.
absoluteDistance
None or a Float specifying the absolute magnitude of the allowable elastic slip. The default value
is None.
This argument applies only to Abaqus/Standard analyses.

10–42

Abaqus ID:
Printed on:
 CONNECTOR COMMANDS

table
A sequence of sequences of Floats specifying the tangential properties. Items in the table data are
described below. The default value is an empty sequence.
Table data
If formulation=PENALTY, the table data specify the following:
• Friction coefficient in the slip direction, .
• Slip rate, if the data depend on slip rate.
• Contact pressure, if the data depend on contact pressure.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If formulation=EXPONENTIAL_DECAY and exponentialDecayDefinition=COEFFICIENTS, the
table data specify the following:
• Static friction coefficient, .
• Kinetic friction coefficient, .
• Decay coefficient, .
If formulation=EXPONENTIAL_DECAY and exponentialDecayDefinition=TEST_DATA, the
table data specify the following:
• Static coefficient of friction.
• Dynamic friction coefficient measured at the reference slip rate, .
• Reference slip rate, , used to measure the dynamic friction coefficient.
• Kinetic friction coefficient, . This value corresponds to the asymptotic value of the friction
coefficient at infinite slip rate, .

Return value
A TangentialBehavior object.

Exceptions
None.

10.14.2 setValues(...)
This method modifies the TangentialBehavior object.

10–43

Abaqus ID:
Printed on:
CONNECTOR COMMANDS

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

Return value
None

Exceptions
None.

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

10.14.4 Corresponding analysis keywords

*FRICTION

10–44

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11. Constraint commands

The Constraint commands define constraints between regions of the model.

11.1 Constraint object

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

Access
import interaction
mdb.models[name].constraints[name]

11.1.1 resume()
This method resumes the constraint that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

11.1.2 suppress()
This method suppresses the constraint.

Arguments
None.

Return value
None

11–1

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

Exceptions
None.

11.1.3 delete(...)
This method allows you to delete existing constraints.

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

Return value
None

Exceptions
None.

11.1.4 Members
The Constraint object has the following members:
name
A String specifying the constraint repository key.
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.2 Coupling object

The Coupling object defines a constraint between a group of coupling nodes located on a region and a
reference point.
The Coupling object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11–2

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11.2.1 Coupling(...)
This method creates a Coupling object.

Path
mdb.models[name].Coupling

Required arguments
name
A String specifying the constraint repository key.
surface
A Region object specifying the surface on which the coupling nodes are located.
controlPoint
A Region object specifying the constraint control point.
influenceRadius
The SymbolicConstant WHOLE_SURFACE or a Float specifying the influence radius.
couplingType
A SymbolicConstant specifying the coupling constraint type. Possible values are KINEMATIC
and DISTRIBUTING.
Optional arguments
localCsys
None or a DatumCsys object specifying the initial orientation of the local coordinate system for the
coupling’s degrees of freedom. If localCsys=None, the coupling is defined in the global coordinate
system. The default value is None.
u1
A Boolean specifying if the displacement component in the 1-direction is constrained to the
reference node for a kinematic coupling constraint. The default value is ON.
The u1 argument applies only when couplingType=KINEMATIC.
u2
A Boolean specifying if the displacement component in the 2-direction is constrained to the
reference node for a kinematic coupling constraint. The default value is ON.
The u2 argument applies only when couplingType=KINEMATIC.
u3
A Boolean specifying if the displacement component in the 3-direction is constrained to the
reference node for a kinematic coupling constraint. The default value is ON.
The u3 argument applies only when couplingType=KINEMATIC.

11–3

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

ur1
A Boolean specifying if the rotational displacement component about the 1-direction is constrained
to the reference node for a kinematic coupling constraint. The default value is ON.
The ur1 argument applies only when couplingType=KINEMATIC.
ur2
A Boolean specifying if the rotational displacement component about the 2-direction is constrained
to the reference node for a kinematic coupling constraint. The default value is ON.
The ur2 argument applies only when couplingType=KINEMATIC.
ur3
A Boolean specifying if the rotational displacement component about the 3-direction is constrained
to the reference node for a kinematic coupling constraint. The default value is ON.
The ur3 argument applies only when couplingType=KINEMATIC.
weightingMethod
A SymbolicConstant specifying an optional weighting method used for calculating the distributing
weight factors. Possible values are UNIFORM, LINEAR, QUADRATIC, and CUBIC. The default
value is UNIFORM.
The weightingMethod argument applies only when couplingType=DISTRIBUTING.

Return value
A Coupling object.

Exceptions
None.

11.2.2 setValues(...)
This method modifies the Coupling object.

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

Return value
None

11–4

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

Exceptions
None.

11.2.3 Members
The Coupling object has members with the same names and descriptions as the arguments to the
Coupling method.
In addition, the Coupling object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.2.4 Corresponding analysis keywords

*COUPLING

11.3 DisplayBody object

The DisplayBody object defines a constraint such that the specified instance is used for display only and
does not take part in the analysis. However it will still be visible during postprocessing and its position
at any frame will be defined by the translation and rotation of the specified control points.
The DisplayBody object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.3.1 DisplayBody(...)
This method creates a DisplayBody object.

Path
mdb.models[name].DisplayBody

Required arguments
name
A String specifying the constraint repository key.

11–5

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

instance
A PartInstance object specifying the part instance that is to be used for display only.
controlPoints
A ModelDotArray object specifying the motion of the PartInstance . The control points may
be Vertex, ReferencePoint, or MeshNode objects. Their motion will control the motion of the
PartInstance. If this argument is set to an empty sequence, the PartInstance will remain fixed in
space during the analysis. The sequence can have either one object or three objects.
Optional arguments
None.

Return value
A DisplayBody object.

Exceptions
None.

11.3.2 setValues(...)
This method modifies the DisplayBody object.

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

Return value
None

Exceptions
None.

11.3.3 Members
The DisplayBody object has members with the same names and descriptions as the arguments to the
DisplayBody method.
In addition, the DisplayBody object has the following member:

11–6

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.3.4 Corresponding analysis keywords

*DISPLAY BODY

11.4 EmbeddedRegion object

The EmbeddedRegion object allows you to embed a region of the model within a “host” region of the
model or within the whole model.
The EmbeddedRegion object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.4.1 EmbeddedRegion(...)
This method creates a EmbeddedRegion object.

Path
mdb.models[name].EmbeddedRegion

Required arguments
name
A String specifying the constraint repository key.
embeddedRegion
A Region object specifying the body region to be embedded.
hostRegion
A Region object specifying the host region. A value of None indicates that the host region is the
whole model.
Optional arguments
weightFactorTolerance
A Float specifying a small value below which the weighting factors will be zeroed out. The default
value is 10–6 .

11–7

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

toleranceMethod
A SymbolicConstant specifying the method used to determine the embedded element tolerance.
Possible values are ABSOLUTE, FRACTIONAL, and BOTH. The default value is BOTH.
absoluteTolerance
A Float specifying the absolute value by which a node on the embedded region may lie outside
the host region. If absoluteTolerance=0.0, the fractionalTolerance value will be used. The default
value is 0.0.
This argument applies only when toleranceMethod=ABSOLUTE or BOTH.
fractionalTolerance
A Float specifying the fractional value by which a node on the embedded region may lie outside
the host region. The fractional value is based on the average element size within the host region.
The default value is 0.05.
If both tolerance arguments are specified, the smaller value will be used.
This argument applies only when toleranceMethod=FRACTIONAL or BOTH.

Return value
An EmbeddedRegion object.

Exceptions
None.

11.4.2 setValues(...)
This method modifies the EmbeddedRegion object.

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

Return value
None

Exceptions
None.

11–8

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11.4.3 Members
The EmbeddedRegion object has members with the same names and descriptions as the arguments to
the EmbeddedRegion method.
In addition, the EmbeddedRegion object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.4.4 Corresponding analysis keywords

*EMBEDDED ELEMENT

11.5 Equation object

The Equation object defines a linear multi-point constraint between a set of degrees of freedom.
The Equation object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.5.1 Equation(...)
This method creates an Equation object.

Path
mdb.models[name].Equation

Required arguments
name
A String specifying the constraint repository key.
terms
A sequence of (Float, String, Int, Int) sequences specifying a coefficient, Set name, degree of
freedom, and coordinate system ID. The coordinate system ID is optional.
Optional arguments
None.

11–9

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

Return value
An Equation object.

Exceptions
If terms does not contain more than one entry:
Equation must have two or more terms.

11.5.2 setValues(...)
This method modifies the Equation object.

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

Return value
None

Exceptions
If terms does not contain more than one entry:
Equation must have two or more terms.

11.5.3 Members
The Equation object has members with the same names and descriptions as the arguments to the
Equation method.
In addition, the Equation object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.5.4 Corresponding analysis keywords

*EQUATION

11–10

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11.6 MultipointConstraint object

The MultipointConstraint object defines a constraint between a group of MultipointConstraint nodes

located on a region and a reference point.
The MultipointConstraint object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.6.1 MultipointConstraint(...)
This method creates a MultipointConstraint object.

Path
mdb.models[name].MultipointConstraint

Required arguments
name
A String specifying the constraint repository key.
surface
A Region object specifying the surface on which the MultipointConstraint nodes are located.
controlPoint
A Region object specifying the constraint control point.
mpcType
A SymbolicConstant specifying the MPC type of the constraint. Possible values are BEAM_MPC,
ELBOW_MPC, PIN_MPC, LINK_MPC, TIE_MPC, and USER_MPC.
Optional arguments
csys
None or a DatumCsys object specifying the initial orientation of the local coordinate system for
the MultipointConstraint’s degrees of freedom. If localCsys=None, the MultipointConstraint is
defined in the global coordinate system. The default value is None.
userType
An Int specifying to differentiate between different constraint types in a user-defined
MultipointConstraint. The default value is 0.
The userType argument applies only when mpcType=USER_MPC.

11–11

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

userMode
A SymbolicConstant specifying the mode of the constraint when it is user-defined. Possible values
are DOF_MODE_MPC and NODE_MODE_MPC. The default value is DOF_MODE_MPC.
The userMode argument applies only when mpcType=USER_MPC.

Return value
A MultipointConstraint object.

Exceptions
None.

11.6.2 setValues(...)
This method modifies the MultipointConstraint object.

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

Return value
None

Exceptions
None.

11.6.3 Members
The MultipointConstraint object has members with the same names and descriptions as the arguments
to the MultipointConstraint method.
In addition, the MultipointConstraint object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.6.4 Corresponding analysis keywords

*MPC

11–12

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11.7 RigidBody object

The RigidBody object constrains all the degrees of freedom on the specified regions to the degree of
freedom of its associated reference point.
The RigidBody object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.7.1 RigidBody(...)
This method creates a RigidBody object.

Path
mdb.models[name].RigidBody

Required arguments
name
A String specifying the constraint repository key.
refPointRegion
A Region object specifying the reference point.
Optional arguments
bodyRegion
None or a Region object specifying the elements constrained to the movement of the reference
point. The default value is None.
tieRegion
None or a Region object specifying the nodes tied to the movement of the reference point. The
default value is None.
pinRegion
None or a Region object specifying the nodes pinned to the movement of the reference point. The
default value is None.
surfaceRegion
None or a Region object specifying the analytic surface constrained to the movement of the
reference point. The default value is None.

11–13

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

refPointAtCOM
A Boolean specifying whether the analysis product should recompute the reference point position
to be at the center of mass. The default value is OFF.
isothermal
A Boolean specifying whether the temperature degree of freedom should be constrained. The
default value is OFF.

Return value
A RigidBody object.

Exceptions
None.

11.7.2 setValues(...)
This method modifies the RigidBody object.

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

Return value
None

Exceptions
None.

11.7.3 Members
The RigidBody object has members with the same names and descriptions as the arguments to the
RigidBody method.
In addition, the RigidBody object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11–14

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11.7.4 Corresponding analysis keywords

*RIGID BODY

11.8 ShellSolidCoupling object

The ShellSolidCoupling object defines two surfaces to be tied together for the duration of a simulation.
The ShellSolidCoupling object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.8.1 ShellSolidCoupling(...)
This method creates a ShellSolidCoupling object.

Path
mdb.models[name].ShellSolidCoupling

Required arguments
name
A String specifying the constraint repository key.
shellEdge
A Region object specifying the name of the shell edge surface.
solidFace
A Region object specifying the name of the solid surface.
Optional arguments
positionToleranceMethod
A SymbolicConstant specifying the method used to determine the position tolerance. Possible
values are COMPUTED and SPECIFIED. The default value is COMPUTED.
positionTolerance
A Float specifying the position tolerance. The default value is 0.0.
The positionTolerance argument applies only when positionToleranceMethod=SPECIFIED.
Note: Abaqus will not constrain nodes on the solid face region outside the position tolerance.

11–15

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

influenceDistanceMethod
A SymbolicConstant specifying the method used to determine the influence distance. Possible
values are DEFAULT and SPECIFIED. The default value is DEFAULT.
influenceDistance
A Float specifying the influence distance. The influenceDistance argument applies only when
influenceDistanceMethod=SPECIFIED. The default value is 0.0.

Return value
A ShellSolidCoupling object.

Exceptions
None.

11.8.2 setValues(...)
This method modifies the ShellSolidCoupling object.

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

Return value
None

Exceptions
None.

11.8.3 Members
The ShellSolidCoupling object has members with the same names and descriptions as the arguments to
the ShellSolidCoupling method.
In addition, the ShellSolidCoupling object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11–16

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

11.8.4 Corresponding analysis keywords

*SHELL TO SOLID COUPLING

11.9 Tie object

The Tie object defines two surfaces to be tied together for the duration of a simulation.
The Tie object is derived from the Constraint object.

Access
import interaction
mdb.models[name].constraints[name]

11.9.1 Tie(...)
This method creates a Tie object.

Path
mdb.models[name].Tie

Required arguments
name
A String specifying the constraint repository key.
master
A Region object specifying the name of the master surface.
slave
A Region object specifying the name of the slave surface.
Optional arguments
adjust
A Boolean specifying whether initial positions of tied slave nodes are adjusted to lie on the master
surface. The default value is ON.
positionToleranceMethod
A SymbolicConstant specifying the method used to determine the position tolerance. Possible
values are COMPUTED and SPECIFIED. The default value is COMPUTED.

11–17

Abaqus ID:
Printed on:
CONSTRAINT COMMANDS

positionTolerance
A Float specifying the position tolerance. The positionTolerance argument applies only when
positionToleranceMethod=SPECIFIED. The default value is 0.0.
tieRotations
A Boolean specifying whether rotation degrees of freedom should be tied. The default value is
ON.
constraintRatioMethod
A SymbolicConstant specifying the method used to determine the constraint ratio. Possible values
are DEFAULT and SPECIFIED. The default value is DEFAULT.
constraintRatio
A Float specifying the fractional distance between the master reference surface and the slave node
at which the translational constraint should act. The constraintRatio argument applies only when
constraintRatioMethod=SPECIFIED. The default value is 0.0.
constraintEnforcement
A SymbolicConstant specifying the discretization method. Possible values are
SOLVER_DEFAULT, NODE_TO_SURFACE, and SURFACE_TO_SURFACE. The default
value is SOLVER_DEFAULT.
thickness
A Boolean specifying whether shell element thickness is considered. The default value is ON.

Return value
A Tie object.

Exceptions
None.

11.9.2 swapSurfaces()
This method switches the master and slave surfaces of a tied constraint. This command is valid only
during the step in which the interaction is created.

Arguments
None.

Return value
None

11–18

Abaqus ID:
Printed on:
 CONSTRAINT COMMANDS

Exceptions
None.

11.9.3 setValues(...)
This method modifies the Tie object.

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

Return value
None

Exceptions
None.

11.9.4 Members
The Tie object has members with the same names and descriptions as the arguments to the Tie method.
In addition, the Tie object has the following member:
suppressed
A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

11.9.5 Corresponding analysis keywords

*TIE

11–19

Abaqus ID:
Printed on:
 CUSTOMKERNEL MODULE

12. CustomKernel module

The customKernel module augments the mdb and session objects with an object called customData.
The customData object can contain custom data that you created using standard Python objects; for
example, dictionaries, strings, numbers, and classes. In addition, the customData object can contain
objects that you created using the classes described in this section.
All objects that you create under the mdb.customData object will be stored in the Abaqus/CAE
model database when you save the database; all objects that you create under the session.customData
object will be lost when you exit Abaqus/CAE.
The customData object is an instance of the RepositorySupport class; for more information, see
RepositorySupport. The classes described in this section register with the GUI infrastructure when you
create the class. As a result, if you write a custom GUI script, you can query these objects from the
GUI, and you can also be notified when the contents of these objects change so you can update the GUI
accordingly. For more information, see “Extending the Abaqus Scripting Interface,” Section 5.6 of the
Abaqus Scripting User’s Manual and “Accessing kernel data from the GUI,” Section 6.7 of the Abaqus
GUI Toolkit User’s Manual.

12.1 CommandRegister object

This class allows you to derive a general class that can be queried from the GUI and is capable of notifying
the GUI when the contents of the class change.

Access
import customKernel

12.1.1 CommandRegister()
This class allows you to derive a general class that can be queried from the GUI and is capable of notifying
the GUI when the contents of the class change.

Path
customKernel.CommandRegister

Arguments
None.

12–1

Abaqus ID:
Printed on:
CUSTOMKERNEL MODULE

Return value
A CommandRegister object.

Exceptions
None.

12.1.2 Members
The CommandRegister object has no members.

12.2 RepositorySupport object

The RepositorySupport is a base class from which you can derive your own classes that are
designed to contain custom repositories. Instances of this class can be queried from the GUI and are
capable of notifying the GUI when the contents of the instance change.
The RepositorySupport object is derived from the CommandRegister object.

Access
import customKernel
mdb.customData
session.customData

12.2.1 RepositorySupport()
This method creates a RepositorySupport object.

Path
customKernel.RepositorySupport

Arguments
None.

Return value
A RepositorySupport object.

Exceptions
None.

12–2

Abaqus ID:
Printed on:
 CUSTOMKERNEL MODULE

12.2.2 Repository(...)
This method installs a repository on the class. The repository is an instance of a
RegisteredDictionary class. Refer to RegisteredDictionary for details on its methods.
The objects stored in the repository are assumed to have an attribute called name that stores the
key used to access the object in the repository. The name attribute will be modified by the changeKey
method.

Arguments
Required arguments
name
A String specifying the name of the repository.
constructors
A constructor or sequence of constructors specifying which classes will store their instances in the
repository.
Optional arguments
None.

Return value
None

Exceptions
None.

12.2.3 Members
The RepositorySupport object has no members.

12.3 RegisteredDictionary object

This class allows you to create a dictionary that can be queried from the GUI and is capable of notifying
the GUI when the contents of the dictionary change. The keys to a RegisteredDictionary must be either
strings or integers.
The RegisteredDictionary object is derived from the CommandRegister object.

Access
import customKernel

12–3

Abaqus ID:
Printed on:
CUSTOMKERNEL MODULE

12.3.1 RegisteredDictionary()
This method creates a RegisteredDictionary object.

Path
customKernel.RegisteredDictionary

Arguments
None.

Return value
A RegisteredDictionary object.

Exceptions
None.

12.3.2 Methods()
The RegisteredDictionary object supports the same methods as a Python dictionary. In addition, the
RegisteredDictionary object supports the changeKey method.

Arguments
None.

Return value
None

Exceptions
None.

12.3.3 changeKey(...)
This method changes the name of a key in the dictionary.

Arguments
Required arguments
fromName
A String or an integer specifying the name of the key to be changed.

12–4

Abaqus ID:
Printed on:
 CUSTOMKERNEL MODULE

toName
A String or an integer specifying the new name for the key.
Optional arguments
None.

Return value
None

Exceptions
None.

12.3.4 Members
The RegisteredDictionary object has no members.

12.4 RegisteredList object

This class allows you to create a list that can be queried from the GUI and is capable of notifying the
GUI when the contents of the list change.
The RegisteredList object is derived from the CommandRegister object.

Access
import customKernel

12.4.1 RegisteredList()
This method creates a RegisteredList object.

Path
customKernel.RegisteredList

Arguments
None.

Return value
A RegisteredList object.

12–5

Abaqus ID:
Printed on:
CUSTOMKERNEL MODULE

Exceptions
None.

12.4.2 Methods()
The RegisteredList object supports the same methods as a standard Python list object.

Arguments
None.

Return value
None

Exceptions
None.

12.4.3 Members
The RegisteredList object has no members.

12.5 RegisteredTuple object

This class allows you to create a tuple that can be queried from the GUI and is capable of notifying the
GUI when the contents of any of the tuple’s members change.
The RegisteredTuple object is derived from the CommandRegister object.

Access
import customKernel

12.5.1 RegisteredTuple(...)
This method creates a RegisteredTuple object.

Path
customKernel.RegisteredTuple

12–6

Abaqus ID:
Printed on:
 CUSTOMKERNEL MODULE

Required argument
tuple
A tuple of objects. These objects must be derived from the CommandRegister class.
Optional arguments
None.

Return value
A RegisteredTuple object.

Exceptions
None.

12.5.2 Methods()
The RegisteredTuple object supports the same methods as a standard Python list object.

Arguments
None.

Return value
None

Exceptions
None.

12.5.3 Members
The RegisteredTuple object has no members.

12–7

Abaqus ID:
Printed on:
 DATUM COMMANDS

13. Datum commands

Datum commands return Feature objects and inherit the methods of Feature objects; for more details, see
Chapter 18, “Feature commands.” Datums can be created using methods on a Part or Assembly object.
Each command also creates a Datum object in the corresponding datum repository. The Datum
object is used as an argument to other commands, such as Part and Partition commands.

13.1 Datum object

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

Access
import part
mdb.models[name].parts[name].datums[i]
import assembly
mdb.models[name].rootAssembly.datums[i]
mdb.models[name].rootAssembly.instances[name].datums[i]

13.1.1 Members
The Datum object has no members.

13.2 DatumAxis object

The DatumAxis object has no direct constructor; it is created when a Feature object is created. For
example, the DatumAxisByCylFace method creates a Feature object that creates a DatumAxis
object.
The DatumAxis object is derived from the Datum object.

Access
import part
mdb.models[name].parts[name].datums[i]
import assembly
mdb.models[name].rootAssembly.datums[i]
mdb.models[name].rootAssembly.instances[name].datums[i]

13–1

Abaqus ID:
Printed on:
DATUM COMMANDS

13.2.1 Members
The DatumAxis object has the following members:
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of a point located on the datum.
direction
A tuple of Floats specifying a sequence of three Floats specifying the direction of the axis.

13.3 DatumCsys object

The DatumCsys object has no direct constructor; it is created when a Feature object is created. For
example, the DatumCsysByOffset method creates a Feature object that creates a DatumCsys object.
The DatumCsys object is derived from the Datum object.

Access
import part
mdb.models[name].parts[name].datums[i]
import assembly
mdb.models[name].rootAssembly.connectorOrientations[i].localCsys1
mdb.models[name].rootAssembly.connectorOrientations[i].localCsys2
mdb.models[name].rootAssembly.datums[i]
mdb.models[name].rootAssembly.instances[name].datums[i]
import odbAccess
session.odbs[name].rootAssembly.connectorOrientations[i].localCsys1
session.odbs[name].rootAssembly.connectorOrientations[i].localCsys2

13.3.1 Members
The DatumCsys object has the following members:
coordSysType
A SymbolicConstant specifying the type of the coordinate system. Possible values are
CATRESIAN, CYLINDRICAL, and SPHERICAL.
origin
A DatumPoint object specifying the origin of the coordinate system.
axis1
A DatumAxis object specifying the 1-direction of the coordinate system.
axis2
A DatumAxis object specifying the 2-direction of the coordinate system.

13–2

Abaqus ID:
Printed on:
 DATUM COMMANDS

axis3
A DatumAxis object specifying the 3-direction of the coordinate system.

13.4 DatumPlane object

The DatumPlane object has no direct constructor; it is created when a Feature object is created. For
example, the DatumPlaneByPrincipalPlane method creates a Feature object that creates a
DatumPlane object.
The DatumPlane object is derived from the Datum object.

Access
import part
mdb.models[name].parts[name].datums[i]
import assembly
mdb.models[name].rootAssembly.datums[i]
mdb.models[name].rootAssembly.instances[name].datums[i]

13.4.1 Members
The DatumPlane object has the following members:
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of a point located on the datum.
normal
A tuple of Floats specifying a sequence of three Floats specifying the normal.

13.5 DatumPoint object

The DatumPoint object has no direct constructor; it is created when a Feature object is created. For
example, the DatumPointByCoordinate method creates a Feature object that creates a DatumPoint
object.
The DatumPoint object is derived from the Datum object.

Access
import part
mdb.models[name].parts[name].datums[i]
import assembly
mdb.models[name].rootAssembly.datums[i]
mdb.models[name].rootAssembly.instances[name].datums[i]

13–3

Abaqus ID:
Printed on:
DATUM COMMANDS

13.5.1 Members
The DatumPoint object has the following member:
pointOn
A tuple of Floats specifying the X-, Y-, and Z-coordinates of a point located on the datum.

13–4

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14. Display Group commands

14.1 DisplayGroup object

DisplayGroup objects are used to select a subset of the entities displayed in the viewport.

Access
session.displayGroups[name]
import assembly
session.viewports[name].assemblyDisplay.displayGroup
session.viewports[name].layers[name].assemblyDisplay.displayGroup
import visualization
session.viewports[name].layers[name].odbDisplay.displayGroup
import part
session.viewports[name].layers[name].partDisplay.displayGroup
session.viewports[name].odbDisplay.displayGroup
session.viewports[name].partDisplay.displayGroup

14.1.1 DisplayGroup(...)
This method creates a DisplayGroup object.

Path
session.DisplayGroup

Required arguments
name
A String specifying the repository key.
leaf
A Leaf object specifying the items in the display group.
Optional arguments
None.

Return value
A DisplayGroup object.

14–1

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Exceptions
InvalidNameError.

14.1.2 add(...)
This method adds the specified items to the display group.

Arguments
Required argument
leaf
A Leaf object specifying the items to add to the display group.
Optional arguments
None.

Return value
None

Exceptions
None.

14.1.3 either(...)
This method redefines the display group to be only those items that are not shared by the leaf argument
and by the display group.

Arguments
Required argument
leaf
A Leaf object specifying the items to be excluded from the display group.
Optional arguments
None.

Return value
None

Exceptions
None.

14–2

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.1.4 intersect(...)
This method redefines the display group to be only those items that are shared by the leaf argument and
the display group.

Arguments
Required argument
leaf
A Leaf object specifying the items to be included in the display group.
Optional arguments
None.

Return value
None

Exceptions
None.

14.1.5 redoLast()
This method redoes the last undone operation on the display group.

Arguments
None.

Return value
None

Exceptions
None.

14.1.6 remove(...)
This method removes the specified items from the display group.

14–3

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Arguments
Required argument
leaf
A Leaf object specifying the items to remove from the display group.
Optional arguments
None.

Return value
None

Exceptions
None.

14.1.7 replace(...)
This method replaces the contents of the display group with the specified items.

Arguments
Required argument
leaf
A Leaf object specifying the items with which to replace the current display group contents.
Optional arguments
None.

Return value
None

Exceptions
None.

14.1.8 undoLast()
This method undoes the last operation performed on the display group.

Arguments
None.

14–4

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

Return value
None

Exceptions
None.

14.1.9 Members
The DisplayGroup object has the following members:
canUndo
A Boolean specifying whether Undo is possible or not.
canRedo
A Boolean specifying whether Redo is possible or not.
name
A String specifying the repository key.
module
A SymbolicConstant specifying the module in which the display group has been created. The
possible values are PART, ASSEMBLY, PART_ASSEMBLY, ODB, and ALL.
modelName
A String specifying the name of the model to which the display group belongs when the module
is part- or assembly-based.
partName
A String specifying the name of the part to which the display group belongs when the module is
part-based.

14.2 DisplayGroupInstance object

A DisplayGroupInstance object stores the IDs of the entities displayed in a viewport. The
DisplayGroupInstance object has no constructor. When you set a display group to be plotted in a
viewport, Abaqus/CAE creates a DisplayGroupInstance object for each display group and places it in
the DisplayGroupInstanceRepository object.

Access
import assembly
session.viewports[name].assemblyDisplay.displayGroupInstances[name]
session.viewports[name].layers[name].assemblyDisplay\
.displayGroupInstances[name]

14–5

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

import visualization
session.viewports[name].layers[name].odbDisplay\
.displayGroupInstances[name]
import part
session.viewports[name].layers[name].partDisplay\
.displayGroupInstances[name]
session.viewports[name].odbDisplay.displayGroupInstances[name]
session.viewports[name].partDisplay.displayGroupInstances[name]

14.2.1 nodes()
This method is used to obtain the list of nodes present in the DisplayGroupInstance object. It returns a
Dictionary object keyed by part instance names, the value of which is a list of user node labels belonging
to the part instance and contained in the DisplayGroupInstance object. This method is available only
for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of
OdbDisplay object.

Arguments
None.

Return value
A Dictionary object.

Exceptions
None.

14.2.2 elements()
This method returns the list of elements present in the DisplayGroupInstance object. The elements
method returns a Dictionary object that uses part instance names for the keys. The value of the items in
the Dictionary object is a List of user element labels that belong to the part instance and are contained in
the DisplayGroupInstance object. This method is available only for DisplayGroupInstance objects that
are members of the DisplayGroupInstance repository member of the OdbDisplay object.

Arguments
None.

Return value
A Dictionary object.

14–6

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

Exceptions
None.

14.2.3 setValues(...)
This method modifies the DisplayGroupInstance object. The setValues method is available only for
DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the
OdbDisplay object.

Arguments
Required arguments
None.
Optional argument
lockOptions
A Boolean specifying whether the display options stored on the DisplayGroupInstance object
should be synchronized with changes to the viewport display options. This member is available
only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository
member of the OdbDisplay object. The default value is OFF.

Return value
None

Exceptions
None.

14.2.4 Members
The DisplayGroupInstance object can have the following members:
name
A String specifying the repository key.
lockOptions
A Boolean specifying whether the display options stored on the DisplayGroupInstance object
should be synchronized with changes to the viewport display options. This member is available
only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository
member of the OdbDisplay object. The default value is OFF.

14–7

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

odbDisplayOptions
An OdbDisplayOptions object specifying this member is available only for DisplayGroupInstance
objects that are members of the DisplayGroupInstance repository member of the OdbDisplay
object.

14.3 DisplayGroupInstanceRepository object

The DisplayGroupInstanceRepository object stores DisplayGroupInstance objects. In addition to all the

standard Python repository methods, the DisplayGroupInstance repository defines additional methods as
described below.

Access
import visualization
session.viewports[name].layers[name].odbDisplay.displayGroupInstances
session.viewports[name].odbDisplay.displayGroupInstances

14.3.1 syncOptions(...)
This method synchronizes the display options stored on the OdbDisplay object with the display options
stored on the DisplayGroupInstance object.

Arguments
Required argument
name
A String specifying the repository key.
Optional argument
updateInstances
A Boolean specifying whether to synchronize the display options on all the DisplayGroupInstance
objects stored in the DisplayGroupInstanceRepository for which lockOptions is OFF. The default
value of updateInstances is ON.

Return value
None

Exceptions
None.

14–8

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.3.2 Members
The DisplayGroupInstanceRepository object has no members.

14.4 Leaf object

Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
Leaf objects have similarities to Set objects; however, Leaf objects are evaluated when the
DisplayGroup expression is evaluated, and they can have SymbolicConstant values (which are also
evaluated when the DisplayGroup expression is evaluated).

Access
import displayGroupMdbToolset
import displayGroupOdbToolset

14.4.1 Leaf(...)
This method creates a Leaf object.

Path
Leaf

Required argument
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.
Optional arguments
None.

Return value
A Leaf object.

Exceptions
None.

14–9

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

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

14.5 LeafFromDatums object

The LeafFromDatums object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromDatums object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14.5.1 LeafFromDatums(...)
This method creates a Leaf object from a sequence of datum objects. Leaf objects specify the items in
a display group.

Path
LeafFromDatums

Required argument
datumSeq
A sequence of datum objects.
Optional arguments
None.

Return value
A LeafFromDatums object.

Exceptions
None.

14.5.2 Members
The LeafFromDatums object has the following member:

14–10

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.6 LeafFromDisplayGroup object

The LeafFromDisplayGroup object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromDisplayGroup object is derived from the Leaf object.

Access
import displayGroupMdbToolset
import displayGroupOdbToolset

14.6.1 LeafFromDisplayGroup(...)
This method creates a Leaf object from a sequence of Display Group objects.

Path
LeafFromDisplayGroup

Required argument
displayGroup
A DisplayGroupArray object.
Optional arguments
None.

Return value
A LeafFromDisplayGroup object.

Exceptions
None.

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

14–11

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

In addition, the LeafFromDisplayGroup object has the following member:

leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.7 LeafFromElementLabels object

The LeafFromElementLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromElementLabels object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.7.1 LeafFromElementLabels(...)
This method creates a Leaf object from a sequence of element labels that belong to a single part instance.

Path
LeafFromElementLabels

Required arguments
partInstanceName
A String specifying the name of the part instance to which elementLabels refers.
elementLabels
A sequence of Strings specifying expressions that denote element labels. The expression can be
any of the following:
• An Int specifying a single element label; for example, 1.
• A String specifying a single element label; for example, ’7’.
• A String specifying a sequence of element labels; for example, ’3:5’ and ’3:15:3’.

Optional arguments
None.

Return value
A LeafFromElementLabels object.

14–12

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

Exceptions
None.

14.7.2 Members
The LeafFromElementLabels object has members with the same names and descriptions as the arguments
to the LeafFromElementLabels method.
In addition, the LeafFromElementLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.8 LeafFromElementSets object

The LeafFromElementSets object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromElementSets object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.8.1 LeafFromElementSets(...)
This method creates a Leaf object from a sequence of element sets.

Path
LeafFromElementSets

Required argument
elementSets
A sequence of Strings specifying element sets or a String specifying a single element set.
Optional arguments
None.

Return value
A LeafFromElementSets object.

14–13

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Exceptions
None.

14.8.2 Members
The LeafFromElementSets object has members with the same names and descriptions as the arguments
to the LeafFromElementSets method.
In addition, the LeafFromElementSets object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.9 LeafFromElementVarRange object

The LeafFromElementVarRange object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromElementVarRange object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.9.1 LeafFromElementVarRange(...)
This method creates a Leaf object from elements with values lying in a variable range.

Path
LeafFromElementVarRange

Required arguments
None.
Optional arguments
minimumRange
A Float specifying the minimum value for the variable range. The default value is
−3.40282346639E38.

14–14

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

maximumRange
A Float specifying the maximum value for the variable range. The default value is
3.40282346639e+038.
insideRange
A Boolean specifying the method used to evaluate the range. If insideRange=ON, the range falls
inside the specified minimum and maximum values. The default value is ON.

Return value
A LeafFromElementVarRange object.

Exceptions
None.

14.9.2 Members
The LeafFromElementVarRange object has members with the same names and descriptions as the
arguments to the LeafFromElementVarRange method.
In addition, the LeafFromElementVarRange object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.10 LeafFromGeometry object

The LeafFromGeometry object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromGeometry object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14.10.1 LeafFromGeometry(...)
This method creates a Leaf object from a sequence of edge, face and cell geometry objects. Any
combination of edge, face or cell arguments is allowed however the arguments must specify at least one
object--it is not permissible to create an empty leaf.

14–15

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Path
LeafFromGeometry

Required arguments
None.
Optional arguments
edgeSeq
A sequence of geometry edges.
faceSeq
A sequence of geometry faces.
cellSeq
A sequence of geometry cells.

Return value
A LeafFromGeometry object.

Exceptions
If at least one of the sequences is not passed to this method:
Cannot define empty leaf.

14.10.2 Members
The LeafFromGeometry object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.11 LeafFromInstance object

The LeafFromInstance object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromInstance object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–16

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.11.1 LeafFromInstance(...)
This method creates a Leaf object from a sequence of part instance objects.

Path
LeafFromInstance

Required argument
instances
A PartInstance object or a Sequence of PartInstance objects.
Optional arguments
None.

Return value
A LeafFromInstance object.

Exceptions
If an invalid argument is passed to this method:
Cannot define empty leaf.

14.11.2 Members
The LeafFromInstance object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.12 LeafFromInstanceElementLabels object

The LeafFromInstanceElementLabels object can be used whenever a Leaf object is expected as an

argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as
temporary objects, which are then used as arguments to DisplayGroup commands.
The LeafFromInstanceElementLabels object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–17

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.12.1 LeafFromInstanceElementLabels(...)
This method creates a Leaf object from a sequence of Strings specifying the element labels. Leaf objects
specify the items in a display group.

Path
LeafFromInstanceElementLabels

Required argument
elementLabels
A sequence of sequences specifying element labels. Each inner sequence consists of a PartInstance
object followed by a sequence of Strings specifying element labels.
Optional arguments
None.

Return value
A LeafFromInstanceElementLabels object.

Exceptions
None.

14.12.2 Members
The LeafFromInstanceElementLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.13 LeafFromInstanceNodeLabels object

The LeafFromInstanceNodeLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromInstanceNodeLabels object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–18

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.13.1 LeafFromInstanceNodeLabels(...)
This method creates a Leaf object from a sequence of Strings specifying the node labels. Leaf objects
specify the items in a display group.

Path
LeafFromInstanceNodeLabels

Required argument
nodeLabels
A sequence of sequences specifying node labels. Each inner sequence consists of a PartInstance
object followed by a sequence of Strings specifying node labels.
Optional arguments
None.

Return value
A LeafFromInstanceNodeLabels object.

Exceptions
None.

14.13.2 Members
The LeafFromInstanceNodeLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.14 LeafFromMeshElementLabels object

The LeafFromMeshElementLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromMeshElementLabels object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–19

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.14.1 LeafFromMeshElementLabels(...)
This method creates a Leaf object from a sequence of mesh element objects. Leaf objects specify the
items in a display group.

Path
LeafFromMeshElementLabels

Required argument
elementSeq
A sequence of MeshElement objects specifying elements.
Optional arguments
None.

Return value
A LeafFromMeshElementLabels object.

Exceptions
None.

14.14.2 Members
The LeafFromMeshElementLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.15 LeafFromMeshNodeLabels object

The LeafFromMeshNodeLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromMeshNodeLabels object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–20

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.15.1 LeafFromMeshNodeLabels(...)
This method creates a Leaf object from a sequence of mesh node objects. Leaf objects specify the items
in a display group.

Path
LeafFromMeshNodeLabels

Required argument
nodeSeq
A sequence of MeshNode objects specifying nodes.
Optional arguments
None.

Return value
A LeafFromMeshNodeLabels object.

Exceptions
None.

14.15.2 Members
The LeafFromMeshNodeLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.16 LeafFromMeshSurfaceSets object

The LeafFromMeshSurfaceSets object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromMeshSurfaceSets object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–21

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.16.1 LeafFromMeshSurfaceSets(...)
This method creates a Leaf object from a sequence of surface sets.

Path
LeafFromMeshSurfaceSets

Required argument
surfaceSets
A sequence of Surface objects.
Optional arguments
None.

Return value
A LeafFromMeshSurfaceSets object.

Exceptions
None.

14.16.2 Members
The LeafFromMeshSurfaceSets object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.17 LeafFromModelElemLabels object

The LeafFromModelElemLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromModelElemLabels object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–22

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.17.1 LeafFromModelElemLabels(...)
This method creates a Leaf object from a sequence of element labels spanning several part instances.

Path
LeafFromModelElemLabels

Required argument
elementLabels
A sequence of Strings specifying expressions that denote element labels per part
instance in the model. Each part instance element expression is a sequence of a String
specifying the part instance name and a sequence of element expressions; for example,
((’partInstance1’,(1,’7’,’3:15;3’),), (’partInstance2’,’8’),)).
The element expressions can be any of the following:
• An Int specifying a single element label; for example, 1.
• A String specifying a single element label; for example, ’7’.
• A String specifying a sequence of element labels; for example, ’3:5’ and ’3:15:3’.

Optional arguments
None.

Return value
A LeafFromModelElemLabels object.

Exceptions
None.

14.17.2 Members
The LeafFromModelElemLabels object has members with the same names and descriptions as the
arguments to the LeafFromModelElemLabels method.
In addition, the LeafFromModelElemLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14–23

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.18 LeafFromModelNodeLabels object

The LeafFromModelNodeLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromModelNodeLabels object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.18.1 LeafFromModelNodeLabels(...)
This method creates a Leaf object from a sequence of node labels spanning several part instances.

Path
LeafFromModelNodeLabels

Required argument
nodeLabels
A sequence of Strings specifying expressions that denote node labels per part
instance in the model. Each part instance node expression is a sequence of a String
specifying the part instance name and a sequence of node expressions; for example,
((’partInstance1’,(1,’7’,’3:15;3’),), (’partInstance2’,’8’),)).
The node expressions can be any of the following:
• An Int specifying a single node label; for example, 1.
• A String specifying a single node label; for example, ’7’.
• A String specifying a sequence of node labels; for example, ’3:5’ and ’3:15:3’.

Optional arguments
None.

Return value
A LeafFromModelNodeLabels object.

Exceptions
None.

14–24

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.18.2 Members
The LeafFromModelNodeLabels object has members with the same names and descriptions as the
arguments to the LeafFromModelNodeLabels method.
In addition, the LeafFromModelNodeLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.19 LeafFromNodeLabels object

The LeafFromNodeLabels object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromNodeLabels object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.19.1 LeafFromNodeLabels(...)
This method creates a Leaf object from a sequence of node labels that belong to a single part instance.

Path
LeafFromNodeLabels

Required arguments
partInstanceName
A String specifying the name of the part instance to which nodeLabels refers.
nodeLabels
A sequence of Strings specifying expressions that denote node labels. The expression can be any
of the following:
• An Int specifying a single node label; for example, 1.
• A String specifying a single node label; for example, ’7’.
• A String specifying a sequence of node labels; for example, ’3:5’ and ’3:15:3’.

14–25

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Optional arguments
None.

Return value
A LeafFromNodeLabels object.

Exceptions
None.

14.19.2 Members
The LeafFromNodeLabels object has members with the same names and descriptions as the arguments
to the LeafFromNodeLabels method.
In addition, the LeafFromNodeLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.20 LeafFromNodeSets object

The LeafFromNodeSets object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromNodeSets object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.20.1 LeafFromNodeSets(...)
This method creates a Leaf object from a sequence of node sets.

Path
LeafFromNodeSets

Required argument
nodeSets
A sequence of Strings specifying node sets or a String specifying a single node set.

14–26

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

Optional arguments
None.

Return value
A LeafFromNodeSets object.

Exceptions
None.

14.20.2 Members
The LeafFromNodeSets object has members with the same names and descriptions as the arguments to
the LeafFromNodeSets method.
In addition, the LeafFromNodeSets object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.21 LeafFromNodeVarRange object

The LeafFromNodeVarRange object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromNodeVarRange object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14.21.1 LeafFromNodeVarRange(...)
This method creates a Leaf object from nodes with values lying in a variable range.

Path
LeafFromNodeVarRange

Required arguments
None.

14–27

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Optional arguments
minimumRange
A Float specifying the minimum value for the variable range. The default value is
−3.40282346639E38.
maximumRange
A Float specifying the maximum value for the variable range. The default value is
3.40282346639e+038.
insideRange
A Boolean specifying the method used to evaluate the range. If insideRange=ON, the range falls
inside the specified minimum and maximum values. The default value is ON.

Return value
A LeafFromNodeVarRange object.

Exceptions
None.

14.21.2 Members
The LeafFromNodeVarRange object has members with the same names and descriptions as the
arguments to the LeafFromNodeVarRange method.
In addition, the LeafFromNodeVarRange object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.22 LeafFromOdbElementLayups object

The LeafFromOdbElementLayups object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbElementLayups object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–28

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.22.1 LeafFromOdbElementLayups(...)
This method creates a Leaf object from a sequence of Strings specifying layup names. Leaf objects
specify the items in a display group.

Path
LeafFromOdbElementLayups

Required argument
elementLayups
A sequence of Strings specifying element layups.
Optional arguments
None.

Return value
A LeafFromOdbElementLayups object.

Exceptions
None.

14.22.2 Members
The LeafFromOdbElementLayups object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.23 LeafFromOdbElementMaterials object

The LeafFromOdbElementMaterials object can be used whenever a Leaf object is expected as an

argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as
temporary objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbElementMaterials object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–29

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.23.1 LeafFromOdbElementMaterials(...)
This method creates a Leaf object from a sequence of Strings specifying material names. Leaf objects
specify the items in a display group.

Path
LeafFromOdbElementMaterials

Required argument
elementMaterials
A sequence of Strings specifying element materials.
Optional arguments
None.

Return value
A LeafFromOdbElementMaterials object.

Exceptions
None.

14.23.2 Members
The LeafFromOdbElementMaterials object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.24 LeafFromOdbElementPick object

The LeafFromOdbElementPick object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbElementPick object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–30

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.24.1 LeafFromOdbElementPick(...)
This method creates a Leaf object from a tuple containing machine readable, compact strings defining
the elements picked for each part instance. Leaf objects specify the items in a display group.

Path
LeafFromOdbElementPick

Required argument
elementPick
A sequence of tuples of the form [part name, entity count, machine readable pick strings].
Optional arguments
None.

Return value
A LeafFromOdbElementPick object.

Exceptions
None.

14.24.2 Members
The LeafFromOdbElementPick object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.25 LeafFromOdbElementPlies object

The LeafFromOdbElementPlies object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbElementPlies object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–31

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.25.1 LeafFromOdbElementPlies(...)
This method creates a Leaf object from a sequence of Strings specifying ply names. Leaf objects specify
the items in a display group.

Path
LeafFromOdbElementPlies

Required argument
elementPlies
A sequence of Strings specifying element plies.
Optional arguments
None.

Return value
A LeafFromOdbElementPlies object.

Exceptions
None.

14.25.2 Members
The LeafFromOdbElementPlies object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.26 LeafFromOdbElementSections object

The LeafFromOdbElementSections object can be used whenever a Leaf object is expected as an

argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as
temporary objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbElementSections object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–32

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.26.1 LeafFromOdbElementSections(...)
This method creates a Leaf object from a sequence of Strings specifying section names. Leaf objects
specify the items in a display group.

Path
LeafFromOdbElementSections

Required argument
elementSections
A sequence of Strings specifying element Sections.
Optional arguments
None.

Return value
A LeafFromOdbElementSections object.

Exceptions
None.

14.26.2 Members
The LeafFromOdbElementSections object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.27 LeafFromOdbElementTypes object

The LeafFromOdbElementTypes object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbElementTypes object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–33

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.27.1 LeafFromOdbElementTypes(...)
This method creates a Leaf object from a sequence of Strings specifying element names. Leaf objects
specify the items in a display group.

Path
LeafFromOdbElementTypes

Required argument
elementTypes
A sequence of Strings specifying element Types.
Optional arguments
None.

Return value
A LeafFromOdbElementTypes object.

Exceptions
None.

14.27.2 Members
The LeafFromOdbElementTypes object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.28 LeafFromOdbNodePick object

The LeafFromOdbNodePick object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromOdbNodePick object is derived from the Leaf object.

Access
import displayGroupOdbToolset

14–34

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

14.28.1 LeafFromOdbNodePick(...)
This method creates a Leaf object from a tuple containing machine readable, compact strings defining
the nodes picked for each part instance. Leaf objects specify the items in a display group.

Path
LeafFromOdbNodePick

Required argument
nodePick
A sequence of tuples of the form [part name, entity count, machine readable pick strings].
Optional arguments
None.

Return value
A LeafFromOdbNodePick object.

Exceptions
None.

14.28.2 Members
The LeafFromOdbNodePick object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.29 LeafFromPartElementLabels object

The LeafFromPartElementLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromPartElementLabels object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14–35

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

14.29.1 LeafFromPartElementLabels(...)
This method creates a Leaf object from a sequence of Strings specifying element labels. Leaf objects
specify the items in a display group.

Path
LeafFromPartElementLabels

Required arguments
part
A Part object.
elementLabels
A sequence of Strings specifying element labels.
Optional arguments
None.

Return value
A LeafFromPartElementLabels object.

Exceptions
None.

14.29.2 Members
The LeafFromPartElementLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.30 LeafFromPartInstance object

The LeafFromPartInstance object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromPartInstance object is derived from the Leaf object.

14–36

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

Access
import displayGroupOdbToolset

14.30.1 LeafFromPartInstance(...)
This method creates a Leaf object from a list of part instance names.

Path
LeafFromPartInstance

Required argument
partInstanceName
A sequence of Strings specifying the names of the part instances.
Optional arguments
None.

Return value
A LeafFromPartInstance object.

Exceptions
None.

14.30.2 Members
The LeafFromPartInstance object has members with the same names and descriptions as the arguments
to the LeafFromPartInstance method.
In addition, the LeafFromPartInstance object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.31 LeafFromPartNodeLabels object

The LeafFromPartNodeLabels object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromPartNodeLabels object is derived from the Leaf object.

14–37

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Access
import displayGroupMdbToolset

14.31.1 LeafFromPartNodeLabels(...)
This method creates a Leaf object from a sequence of Strings specifying node labels. Leaf objects specify
the items in a display group.

Path
LeafFromPartNodeLabels

Required arguments
part
A Part object.
nodeLabels
A sequence of Strings specifying node labels.
Optional arguments
None.

Return value
A LeafFromPartNodeLabels object.

Exceptions
None.

14.31.2 Members
The LeafFromPartNodeLabels object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.32 LeafFromReferencePoint object

The LeafFromReferencePoint object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.

14–38

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

The LeafFromReferencePoint object is derived from the Leaf object.

Access
import displayGroupMdbToolset

14.32.1 LeafFromReferencePoint(...)
This method creates a Leaf object from a sequence of ReferencePoint objects.

Path
LeafFromReferencePoint

Required argument
refPtSeq
A sequence of Reference Point objects.
Optional arguments
None.

Return value
A LeafFromReferencePoint object.

Exceptions
None.

14.32.2 Members
The LeafFromReferencePoint object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.33 LeafFromSets object

The LeafFromSets object can be used whenever a Leaf object is expected as an argument. Leaf objects
are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which
are then used as arguments to DisplayGroup commands.
The LeafFromSets object is derived from the Leaf object.

14–39

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Access
import displayGroupMdbToolset

14.33.1 LeafFromSets(...)
This method creates a Leaf object from a sequence of Set objects.

Path
LeafFromSets

Required argument
sets
A sequence of Set objects.
Optional arguments
None.

Return value
A LeafFromSets object.

Exceptions
None.

14.33.2 Members
The LeafFromSets object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.34 LeafFromSurfaceSets object

The LeafFromSurfaceSets object can be used whenever a Leaf object is expected as an argument. Leaf
objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects,
which are then used as arguments to DisplayGroup commands.
The LeafFromSurfaceSets object is derived from the Leaf object.

14–40

Abaqus ID:
Printed on:
 DISPLAY GROUP COMMANDS

Access
import displayGroupOdbToolset

14.34.1 LeafFromSurfaceSets(...)
This method creates a Leaf object from a sequence of surface sets.

Path
LeafFromSurfaceSets

Required argument
surfaceSets
A sequence of Strings specifying surface sets, or a String specifying a single surface set.
Optional arguments
None.

Return value
A LeafFromSurfaceSets object.

Exceptions
None.

14.34.2 Members
The LeafFromSurfaceSets object has members with the same names and descriptions as the arguments
to the LeafFromSurfaceSets method.
In addition, the LeafFromSurfaceSets object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14.35 LeafFromSurfaceVarRange object

The LeafFromSurfaceVarRange object can be used whenever a Leaf object is expected as an argument.
Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary
objects, which are then used as arguments to DisplayGroup commands.
The LeafFromSurfaceVarRange object is derived from the Leaf object.

14–41

Abaqus ID:
Printed on:
DISPLAY GROUP COMMANDS

Access
import displayGroupOdbToolset

14.35.1 LeafFromSurfaceVarRange(...)
This method creates a Leaf object from surfaces with values lying in a variable range.

Path
LeafFromSurfaceVarRange

Required arguments
None.
Optional arguments
minimumRange
A Float specifying the minimum value for the variable range. The default value is
−3.40282346639E38.
maximumRange
A Float specifying the maximum value for the variable range. The default value is
3.40282346639e+038.
insideRange
A Boolean specifying the method used to evaluate the range. If insideRange=ON, the range falls
inside the specified minimum and maximum values. The default value is ON.

Return value
A LeafFromSurfaceVarRange object.

Exceptions
None.

14.35.2 Members
The LeafFromSurfaceVarRange object has members with the same names and descriptions as the
arguments to the LeafFromSurfaceVarRange method.
In addition, the LeafFromSurfaceVarRange object has the following member:
leafType
A SymbolicConstant specifying the leaf type. Possible values are EMPTY, DEFAULT_MODEL,
ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

14–42

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

15. Display Options commands

15.1 AssemblyDisplayOptions object

The AssemblyDisplayOptions object stores settings that specify how assemblies are to be displayed in
a particular viewport. The AssemblyDisplayOptions object has no constructor. When you create a new
viewport, the settings are copied from the current viewport.

Access
import assembly
session.viewports[name].assemblyDisplay
session.viewports[name].layers[name].assemblyDisplay

15.1.1 setValues(...)
This method modifies the AssemblyDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
visibleInstances
A sequence of Strings specifying the names of the part instances that are visible in the viewport.
The default value is an empty sequence.
step
A String specifying the step for which objects are to be displayed. Possible values are any valid
step name. The default value is "Initial".
renderStyle
A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are
WIREFRAME, HIDDEN, SHADED, and FILLED. The default value is WIREFRAME.
mesh
A Boolean specifying whether the mesh is shown. The default value is OFF.
loads
A Boolean specifying whether loads are shown. The default value is OFF.
bcs
A Boolean specifying whether boundary conditions are shown. The default value is OFF.

15–1

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

interactions
A Boolean specifying whether interactions are shown. The default value is OFF.
constraints
A Boolean specifying whether constraints are shown. The default value is OFF.
connectors
A Boolean specifying whether connectors are shown. The default value is OFF.
cnxEndPoints
A Boolean specifying whether the connector end points are shown. This member is applicable
only if connectors=ON. The default value is ON.
cnxLocalAxes
A Boolean specifying whether the connector local coordinate system axes are shown. This member
is applicable only if connectors=ON. The default value is ON.
cnxTypeLabels
A Boolean specifying whether the connector section type labels are shown. This member is
applicable only if connectors=ON. The default value is ON.
cnxTagDisplay
A Boolean specifying whether the tag information is displayed along with the connector section
type labels. This member is applicable only if connectors=ON and if cnxTypeLabels=ON. The
default value is OFF.
predefinedFields
A Boolean specifying whether fields and initial conditions are shown. The default value is OFF.
visibleDisplayGroups
A sequence of DisplayGroup objects specifying the DisplayGroups visible in the viewport.
Currently the sequence can contain a maximum of one DisplayGroup object. The default value is
an empty sequence.
engineeringFeatures
A Boolean specifying whether to display engineering features. The default value is OFF.
renderBeamProfiles
A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor
A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero.
The default value is 1.0.

Return value
None

Exceptions
RangeError.

15–2

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

15.1.2 Members
The AssemblyDisplayOptions object can have the following members:
bcs
A Boolean specifying whether boundary conditions are shown. The default value is OFF.
connectors
A Boolean specifying whether connectors are shown. The default value is OFF.
cnxEndPoints
A Boolean specifying whether the connector end points are shown. This member is applicable
only if connectors=ON. The default value is ON.
cnxLocalAxes
A Boolean specifying whether the connector local coordinate system axes are shown. This member
is applicable only if connectors=ON. The default value is ON.
cnxTypeLabels
A Boolean specifying whether the connector section type labels are shown. This member is
applicable only if connectors=ON. The default value is ON.
cnxTagDisplay
A Boolean specifying whether the tag information is displayed along with the connector section
type labels. This member is applicable only if connectors=ON and if cnxTypeLabels=ON. The
default value is OFF.
constraints
A Boolean specifying whether constraints are shown. The default value is OFF.
engineeringFeatures
A Boolean specifying whether to display engineering features. The default value is OFF.
renderBeamProfiles
A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor
A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero.
The default value is 1.0.
predefinedFields
A Boolean specifying whether fields and initial conditions are shown. The default value is OFF.
interactions
A Boolean specifying whether interactions are shown. The default value is OFF.
loads
A Boolean specifying whether loads are shown. The default value is OFF.
mesh
A Boolean specifying whether the mesh is shown. The default value is OFF.

15–3

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

renderStyle
A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are
WIREFRAME, HIDDEN, SHADED, and FILLED. The default value is WIREFRAME.
bcOptions
A BCDisplayOptions object.
constraintOptions
A ConstraintDisplayOptions object.
displayGroup
A DisplayGroup object specifying the current display group and referring to an object in the
displayGroups member of Session .
displayGroupInstances
A repository of DisplayGroupInstance objects.
engineeringFeatureOptions
An EngineeringFeatureDisplayOptions object.
predefinedFieldOptions
A PredefinedFieldDisplayOptions object.
geometryOptions
A GeometryDisplayOptions object.
interactionOptions
An InteractionDisplayOptions object.
loadOptions
A LoadDisplayOptions object.
meshOptions
A MeshDisplayOptions object.
symbolOptions
A SymbolDisplayOptions object.
visibleInstances
A tuple of Strings specifying the names of the part instances that are visible in the viewport. The
default value is an empty sequence.
step
A String specifying the step for which objects are to be displayed. Possible values are any valid
step name. The default value is "Initial".

15.2 BCDisplayOptions object

The BCDisplayOptions object stores settings that specify how assemblies are to be displayed in a
particular viewport when
session.viewports[name].assemblyDisplay.bcs=ON

15–4

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

The BCDisplayOptions object has no constructor. When you create a new viewport, the settings are
copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.bcOptions
session.viewports[name].layers[name].assemblyDisplay.bcOptions

15.2.1 setValues(...)
This method modifies the BCDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
displacement
A Boolean specifying whether displacement symbols are shown. The default value is ON.
velocity
A Boolean specifying whether velocity symbols are shown. The default value is ON.
acceleration
A Boolean specifying whether acceleration symbols are shown. The default value is ON.
symmetry
A Boolean specifying whether symmetry symbols are shown. The default value is ON.
antiSymmetry
A Boolean specifying whether anti- symmetry symbols are shown. The default value is ON.
temperature
A Boolean specifying whether temperature symbols are shown. The default value is ON.
porePressure
A Boolean specifying whether pore pressure symbols are shown. The default value is ON.
fluidCavityPressure
A Boolean specifying whether fluid cavity pressure symbols are shown. The default value is ON.
acousticPressure
A Boolean specifying whether acoustic pressure symbols are shown. The default value is ON.
electricPotential
A Boolean specifying whether electric potential symbols are shown. The default value is ON.
concentration
A Boolean specifying whether concentration mass diffusion symbols are shown. The default value
is ON.

15–5

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

encastre
A Boolean specifying whether encastre symbols are shown. The default value is ON.
pinned
A Boolean specifying whether pinned symbols are shown. The default value is ON.

Return value
None

Exceptions
None.

15.2.2 Members
The BCDisplayOptions object has members with the same names and descriptions as the arguments to
the setValues method.

15.3 ConstraintDisplayOptions object

The ConstraintDisplayOptions object stores settings that specify how assemblies are to be displayed in
a particular viewport when
session.viewports[name].assemblyDisplay.constraints=ON
The ConstraintDisplayOptions object has no constructor. When you create a new viewport, the settings
are copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.constraintOptions
session.viewports[name].layers[name].assemblyDisplay.constraintOptions

15.3.1 setValues(...)
This method modifies the ConstraintDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
constraintEquation
A Boolean specifying whether constraint equation symbols are shown. The default value is ON.

15–6

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

tieConstraint
A Boolean specifying whether tie constraint symbols are shown. The default value is ON.
rigidBodyConstraint
A Boolean specifying whether rigid body constraint symbols are shown. The default value is ON.
displayBodyConstraint
A Boolean specifying whether display body constraint symbols are shown. The default value is
ON.
couplingConstrain
A Boolean specifying whether coupling constraint symbols are shown. The default value is ON.

Return value
None

Exceptions
None.

15.3.2 Members
The ConstraintDisplayOptions object has members with the same names and descriptions as the
arguments to the setValues method.

15.4 EngineeringFeatureDisplayOptions object

The EngineeringFeatureDisplayOptions object stores settings that specify how assemblies are to be
displayed in a particular viewport when
session.viewports[name].assemblyDisplay.engineeringFeatures=ON
The EngineeringFeatureDisplayOptions object has no constructor. When you create a new viewport, the
settings are copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.engineeringFeatureOptions
session.viewports[name].layers[name].assemblyDisplay\
.engineeringFeatureOptions
import part
session.viewports[name].layers[name].partDisplay\
.engineeringFeatureOptions
session.viewports[name].partDisplay.engineeringFeatureOptions

15–7

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

15.4.1 setValues(...)
This method modifies the EngineeringFeatureDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
pointMassInertia
A Boolean specifying whether point mass inertia symbols are shown. The default value is ON.
nonstructuralMass
A Boolean specifying whether nonstructural mass symbols are shown. The default value is ON.
heatCapacitance
A Boolean specifying whether heat capacitance symbols are shown. The default value is ON.
contourIntegral
A Boolean specifying whether contour integral symbols are shown. The default value is ON.
springToGround
A Boolean specifying whether spring-to-ground symbols are shown. The default value is ON.
twoPointSpring
A Boolean specifying whether two-point spring symbols are shown. The default value is ON.

Return value
None

Exceptions
RangeError.

15.4.2 Members
The EngineeringFeatureDisplayOptions object has members with the same names and descriptions as
the arguments to the setValues method.

15.5 PredefinedFieldDisplayOptions object

The PredefinedFieldDisplayOptions object stores settings that specify how assemblies are to be displayed
in a particular viewport when
session.viewports[name].assemblyDisplay.predefinedFields=ON

15–8

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

The PredefinedFieldDisplayOptions object has no constructor. When you create a new viewport, the
settings are copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.predefinedFieldOptions
session.viewports[name].layers[name].assemblyDisplay\
.predefinedFieldOptions

15.5.1 setValues(...)
This method modifies the PredefinedFieldDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
temperatureField
A Boolean specifying whether temperature field symbols are shown. The default value is ON.
velocityField
A Boolean specifying whether translational velocity symbols are shown. The default value is ON.
generalField
A Boolean specifying whether general field symbols are shown. The default value is ON.
stressField
A Boolean specifying whether stress field symbols are shown. The default value is ON.
hardeningField
A Boolean specifying whether hardening field symbols are shown. The default value is ON.

Return value
None

Exceptions
RangeError.

15.5.2 Members
The PredefinedFieldDisplayOptions object has members with the same names and descriptions as the
arguments to the setValues method.

15–9

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

15.6 GeometryDisplayOptions object

The GeometryDisplayOptions object stores settings that specify how assemblies are to be displayed in
a particular viewport. The GeometryDisplayOptions object has no constructor. When you create a new
viewport, the settings are copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.geometryOptions
session.viewports[name].layers[name].assemblyDisplay.geometryOptions
session.viewports[name].layers[name].partDisplay.geometryOptions
session.viewports[name].partDisplay.geometryOptions

15.6.1 setValues(...)
This method modifies the GeometryDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
geometryEdgesInShaded
A Boolean specifying whether geometry edges are displayed in shaded mode. The default value
is ON.
geometryHiddenEdges
A Boolean specifying whether geometry hidden edges are displayed (dotted) in hidden line mode.
The default value is OFF.
geometrySilhouetteEdges
A Boolean specifying whether geometry silhouette edges are displayed. The default value is ON.
datumAxes
A Boolean specifying whether datum axes are shown. The default value is ON.
datumCoordSystems
A Boolean specifying whether datum coordinate systems are shown. The default value is ON.
datumPlanes
A Boolean specifying whether datum planes are shown. The default value is ON.
referencePointLabels
A Boolean specifying whether referencePoint labels are shown. The default value is ON.

15–10

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

referencePointSymbols
A Boolean specifying whether referencePoint symbols are shown. The default value is ON.
referenceRepresentation
A Boolean specifying whether geometry that belongs to the reference representation of the Part or
Instance is shown. The default value is OFF.

Return value
None

Exceptions
RangeError.

15.6.2 Members
The GeometryDisplayOptions object has members with the same names and descriptions as the
arguments to the setValues method.

15.7 GraphicsInfo object

The GraphicsInfo object stores information about the graphics adapter installed in your system. The
GraphicsInfo object has no constructor or methods; Abaqus creates the GraphicsInfo member when a
session is started.
If you execute Abaqus/CAE on a remote system and display the main window locally, the glx server
is your local machine and the glx client is the remote machine. This definition of client and server follows
the X11 naming convention. If you execute and display Abaqus/CAE on the same machine, you will
typically see identical values for both the name of the server and the name of the client.
The members are all read-only.

Access
session.graphicsInfo

15.7.1 Members
The GraphicsInfo object has the following members:
glVersion
A sequence of the type (Int, Int, String) specifying the three components of the OpenGL version.
The sequence consists of an Int with the OpenGL major version number, an Int with the OpenGL
minor version number, and a String with any additional information.

15–11

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

glxServerVersion
A sequence of the type (Int, Int, String) specifying the three components of the glx version of the
server. The sequence consists of an Int with the glx major version number, an Int with the glx
minor version number, and a String with any additional information.
glxClientVersion
A sequence of the type (Int, Int, String) specifying the three components of the of glx version of
the client. The sequence consists of an Int with the glx major version number, an Int with the glx
minor version number, and String with any additional information.
glVendor
A String specifying the graphics adapter vendor. On hardware accelerated systems glVendor
specifies the vendor that manufactured the adapter. On systems without hardware acceleration
glVendor specifies the developer of the software graphics library.
glRenderer
A String specifying the name of the rendering device or the name of the software graphics library.
glxServerVendor
A String specifying the glx developer on the server side.
glxClientVendor
A String specifying the glx developer on the client side.

15.8 GraphicsOptions object

The GraphicsOptions object stores settings that control how objects are rendered in all viewports.
GraphicsOptions objects are accessed in one of two ways:
• The default graphics options. These settings are used as defaults when you start a session and by
the Defaults button on the Graphics Options dialog box.
• The current graphics options.
The GraphicsOptions object has no constructor; Abaqus creates both the defaultGraphicsOptions
and the graphicsOptions members when a session is started.
When you start a session, Abaqus detects the graphics hardware installed on your system and uses
the setValues method in the environment file (abaqus_v6.env) to modify the members of the
GraphicsOptions object. If your graphics hardware is not supported by Abaqus/CAE, or if you wish
to override the default graphics options, you can modify settings in the environment file. For more
information, see “Tuning graphics cards,” Section 5.3 of the Abaqus Installation and Licensing Guide.

Access
session.defaultGraphicsOptions
session.graphicsOptions

15–12

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

15.8.1 setValues(...)
This method modifies the GraphicsOptions object.

Arguments
Required arguments
None.
Optional arguments
graphicsDriver
A SymbolicConstant specifying the graphics driver to use. Abaqus/CAE currently uses OpenGL
exclusively so the only possible value is OPEN_GL. OPEN_GL takes advantage of graphics
adapter hardware acceleration.
doubleBuffering
A Boolean specifying whether double buffering is used. The default value is ON.
Double buffering controls where Abaqus/CAE draws its graphics. When
doubleBuffering=OFF, everything is drawn directly to the screen and on many systems you can
see the progress of the drawing operations. Most users find this distracting, especially in dynamic
situations such as view manipulation or animation of results. When doubleBuffering=ON, the
drawing occurs in a separate graphics buffer that is displayed when all the drawing operations
are complete. This results in a much smoother display during view changes or animation. It is
recommended that you set double buffering to ON.
displayLists
A Boolean specifying whether a display list will be used to accelerate graphics performance. The
default value is ON.
When displayLists=ON, drawing operations are recorded in a list that can be quickly replayed.
This results in faster drawing on most systems but requires extra memory to record the drawing
operations. In the Visualization module, display lists are only used during view manipulations and
then their use is subject to the setting of viewManipDisplayListThreshold.
highlightMethodHint
A sequence of SymbolicConstants specifying a hint used to modify the highlight method. Possible
values are:
• HARDWARE_OVERLAY, specifying a hint of hardware overlay. The best graphics
performance is achieved using hardware overlay, but not all systems and graphics adapters
support hardware overlay.
• XOR, specifying a hint of XOR technique. The XOR technique uses a boolean pixel
operation to simulate the drawing operations but can produce different colors depending on
the color of the underlying pixels.
• SOFTWARE_OVERLAY, specifying a hint of software overlay. The software overlay
method simulates the effect of hardware overlay.

15–13

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

• BLEND, specifying a hint of blend method. The blend method combines the color of the
underlying pixel with the desired color producing an approximation of the transient graphics.
The default value is (HARDWARE_OVERLAY, XOR, SOFTWARE_OVERLAY, BLEND).
The values of this sequence are applied by Abaqus when you start a session in first to last
order. The first successful value becomes the default highlight method. Not all graphics adapters
support the HARDWARE_OVERLAY value and you must use the highlightMethodHint argument
to provide an alternative.
You can use a single value to set the first element of the list, or you can use a tuple with one
to four unique values. Abaqus sets any remaining elements of the tuple to unique values based on
the default order.
dragMode
A SymbolicConstant specifying which rendering is used during dynamic rotations of the view.
Possible values are:

• FAST, specifying a rendering mode where the image is rendered in wireframe.

• AS_IS, specifying a rendering mode where the image is rendered as is.
The default value is AS_IS.
When set to dragMode=FAST, a wireframe outline is drawn during view changes by
rotation, pan, or zoom. When dragMode=AS_IS, everything displayed in the window will be
drawn during view changes; however, the display may lag behind the mouse movement when the
model is complex especially if you are using an older or slower system. For newer systems with
graphics hardware acceleration the AS_IS setting can be accommodated without significant loss
of performance.
antiAlias
A Boolean specifying whether lines will be smoothed to reduce the jagged effect of rasterization.
The default value is ON.
autoFitAfterRotate
A Boolean specifying whether the model is automatically resized to fit the viewport after each
view rotation. The default value is OFF.
polygonOffsetConstant
A Float specifying the offset added when drawing the faces of a polygon. The
polygonOffsetConstant argument affects the behavior of only the OpenGL driver. Possible
values are 0.0 polygonOffsetConstant 100.0. The default value is platform dependent and is
typically between 0.0 and 2.0.
polygonOffsetSlope
A Float specifying the factor that multiplies the slope of each line before the line is added to the
vertexes of a polygon face. The polygonOffsetSlope argument affects the behavior of only the
OpenGL driver. Possible values are 0.0 polygonOffsetSlope 100.0. The default value is
platform dependent and is typically between 0.0 and 2.0.

15–14

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

printPolygonOffsetConstant
A Float specifying the offset added when drawing the faces of a polygon.
printPolygonOffsetConstant is similar to polygonOffsetConstant; however,
printPolygonOffsetConstant is used when printing and polygonOffsetConstant is used
for display. Some systems, especially Windows, use different OpenGL drivers for printing and
display, and you may have to use different offset values for each driver.
printPolygonOffsetSlope
A Float specifying the factor that multiplies the slope of each line before the line is added to the
vertexes of a polygon face. printPolygonOffsetSlope is similar to polygonOffsetSlope; however,
printPolygonOffsetSlope is used when printing and polygonOffsetSlope is used for display. Some
systems, especially Windows, use different OpenGL drivers for printing and display, and you may
have to use different offset values for each driver.
vertexArrays
A Boolean specifying how the three-dimensional vertices of the model are processed. When
vertexArrays=OFF, each vertex of the model is processed separately. When vertexArrays=ON,
the vertices are processed in large blocks resulting in faster display. Not all graphics adapters
support this capability correctly. An indicator that the graphics adapters is not processing three-
dimensional vertices correctly is the absence of graphics during “rubber banding” operations. For
example, when dynamically dragging the radius of a circle in the Sketcher, the circle should be
visible. The default value is ON.
vertexArraysInDisplayLists
A Boolean specifying whether the vertexArrays setting should temporarily be set to OFF when
building a display list. The default value is ON.
Some graphics adapters do not properly support using vertex arrays inside a display list.
Setting vertexArraysInDisplayLists to OFF has a smaller impact on graphics performance than
setting vertexArrays or displayLists to OFF.
viewManipDisplayListThreshold
An Int specifying how large a display list may be created in order to accelerate view manipulation
operations. Increasing this value when viewing large models will increase the delay before a view
manipulation operation begins in order to obtain improved graphics performance during the view
manipulation. If set high with a large model, the delay can be many seconds. In excessive cases,
graphics memory can be exceeded and the result may be an empty display list (no visible model)
for the view manipulation. This setting is treated as 0 if displayLists=OFF. Possible values are 0
viewManipDisplayListThreshold 20000. The default value is 40.
directRendering
A Boolean specifying how Abaqus renders X11 graphics operations. When directRendering=OFF,
the graphics are rendered through the X Server. When directRendering=ON, the graphics
operations are sent directly to the graphics adapter producing faster displays. For maximum
performance, the initial value is ON. This argument is used only when you first start Abaqus/CAE;
you cannot configure directRendering during a session.

15–15

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

hardwareAcceleration
A Boolean specifying whether a hardware accelerated OpenGL graphics driver will be used on
Windows platforms. The default value is ON.
When hardwareAcceleration=OFF, the graphics driver uses a software implementation of
OpenGL that is included with the operating system. This results in slower drawing on most
systems; however, you may have to use the software implementation of OpenGL if the hardware
graphics driver is incompatible with Abaqus/CAE.
hardwareAcceleration is used only when you first start Abaqus/CAE on a Windows platform;
you cannot configure hardwareAcceleration during a session. hardwareAcceleration is not used
when you start Abaqus/CAE on an X-Windows platform and display to a Windows platform
running Exceed or any other X-Windows server.
hardwareOverlay
A Boolean specifying whether hardware overlay planes will be used if available. The default value
is the same value as the hardwareOverlayAvailable member.
When hardwareOverlayAvailable=OFF, it will not be possible to set hardwareOverlay to
ON and the HARDWARE_OVERLAY highlight method will not be available. If viewports
display a solid color and will not display the model, it will be necessary to inhibit hardware
overlay completely by setting the ABAQUS_EMULATE_OVERLAYS environment variable (to
any value) before starting Abaqus/CAE.
hardwareOverlay is used only when you first start Abaqus/CAE; you cannot configure
hardwareOverlay during a session.
textureMapping
A Boolean specifying whether textures will be used to display contour plots. The default value is
ON.
Turning off texture mapping is necessary only if viewports will not correctly display a contour
plot of your model.
printTextureMapping
A Boolean specifying whether textures will be used to display contour plots. The default value is
ON.
Turning off texture mapping for printing is necessary only if printed output does not correctly
display a contour plot of your model. printTextureMapping is similar to textureMapping; however,
printTextureMapping is used when printing and textureMapping is used for display. Some systems,
especially Windows, use different OpenGL drivers for printing and display, and you may have to
use different settings for each driver.
backgroundStyle
A SymbolicConstant specifying the background style to be used for all viewport windows.
Possible values are SOLID and GRADIENT. The default value is SOLID.
If backgroundStyle=SOLID, the viewport background will appear as a solid color as specified
by backgroundColor. If backgroundStyle =GRADIENT, the viewport background will be drawn
as a gradient beginning with the backgroundColor at the top of the viewport and gradually blending
to the backgroundBottomColor at the bottom of the viewport.

15–16

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

backgroundColor
A String specifying one of the two background colors for all viewport windows. The initial color
is black. A list of valid color strings is in the colors map in the Session object.
backgroundBottomColor
A String specifying one of the two background colors for all viewport windows. This color is used
only if backgroundStyle=GRADIENT. The initial color is black. A list of valid color strings is in
the colors map in the Session object.
backgroundOverride
A Boolean specifying whether a viewport background style of GRADIENT can be overridden
when displaying certain objects, such as sketches or XY plots. When overridden, the background
will be the top color of the gradient background.
backfaceCulling
A Boolean specifying whether facets that are determined to be facing away from the viewer will
be drawn. The default value is ON. backfaceCulling provides a performance enhancement when
displaying solid elements where the front side of the element occludes the back side of the element.
Set backfaceCulling=OFF if it appears that you are seeing the back side of an element and the
front side is missing. You should also set backfaceCulling=OFF if you believe the display is not
complete.
accelerateOffScreen
A Boolean specifying whether the hardware accelerated graphics driver will be used for off-screen
rendering. The default value is ON if graphics hardware acceleration is available and has not
been disabled via the hardwareAcceleration option, and the graphics driver supports the underlying
technology. When set to OFF, an alternate (slower) technique will be used to create off-screen
images. Off-screen rendering is used for Printing, Probe, and backing store (viewport refresh).
Setting this value to OFF will force printed images to be rendered without hardware acceleration.
This is useful when writing automated tests to produce raster images that you will want to compare
across multiple machines that may have different graphics environments.
backingStore
A Boolean specifying whether a backing store will be used to refresh a viewport after a window
occluding the viewport is moved or dismissed. The default value is ON.
shadersAvailable
A Boolean specifying if the graphics hardware supports the OpenGL Shading Language (GLSL).
translucencyMode
An Int specifying whether speed or accuracy is more important when drawing translucent objects.
Lower values optimize for speed while higher values optimize for accuracy. The actual meaning
of each setting will depend on the setting of shadersAvailable and the capabilities of the graphics
hardware and driver. Possible values are 1 translucencyMode 6. The default value is 4.

15–17

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

options
None or a GraphicsOptions object specifying the object from which values are to be copied. If
other arguments are also supplied to setValues, they will override the values in the options
member. The default value is None.

Return value
None

Exceptions
RangeError.

15.8.2 Members
The GraphicsOptions object can have the following members:
backgroundOverride
A Boolean specifying whether a viewport background style of GRADIENT can be overridden
when displaying certain objects, such as sketches or XY plots. When overridden, the background
will be the top color of the gradient background.
backfaceCulling
A Boolean specifying whether facets that are determined to be facing away from the viewer will
be drawn. The default value is ON. backfaceCulling provides a performance enhancement when
displaying solid elements where the front side of the element occludes the back side of the element.
Set backfaceCulling=OFF if it appears that you are seeing the back side of an element and the
front side is missing. You should also set backfaceCulling=OFF if you believe the display is not
complete.
graphicsDriver
A SymbolicConstant specifying the graphics driver to use. Abaqus/CAE currently uses OpenGL
exclusively so the only possible value is OPEN_GL. OPEN_GL takes advantage of graphics
adapter hardware acceleration.
doubleBuffering
A Boolean specifying whether double buffering is used. The default value is ON.
Double buffering controls where Abaqus/CAE draws its graphics. When
doubleBuffering=OFF, everything is drawn directly to the screen and on many systems you can
see the progress of the drawing operations. Most users find this distracting, especially in dynamic
situations such as view manipulation or animation of results. When doubleBuffering=ON, the
drawing occurs in a separate graphics buffer that is displayed when all the drawing operations
are complete. This results in a much smoother display during view changes or animation. It is
recommended that you set double buffering to ON.

15–18

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

displayLists
A Boolean specifying whether a display list will be used to accelerate graphics performance. The
default value is ON.
When displayLists=ON, drawing operations are recorded in a list that can be quickly replayed.
This results in faster drawing on most systems but requires extra memory to record the drawing
operations. In the Visualization module, display lists are only used during view manipulations and
then their use is subject to the setting of viewManipDisplayListThreshold.
dragMode
A SymbolicConstant specifying which rendering is used during dynamic rotations of the view.
Possible values are:
• FAST, specifying a rendering mode where the image is rendered in wireframe.
• AS_IS, specifying a rendering mode where the image is rendered as is.
The default value is AS_IS.
When set to dragMode=FAST, a wireframe outline is drawn during view changes by
rotation, pan, or zoom. When dragMode=AS_IS, everything displayed in the window will be
drawn during view changes; however, the display may lag behind the mouse movement when the
model is complex especially if you are using an older or slower system. For newer systems with
graphics hardware acceleration the AS_IS setting can be accommodated without significant loss
of performance.
antiAlias
A Boolean specifying whether lines will be smoothed to reduce the jagged effect of rasterization.
The default value is ON.
autoFitAfterRotate
A Boolean specifying whether the model is automatically resized to fit the viewport after each
view rotation. The default value is OFF.
polygonOffsetConstant
A Float specifying the offset added when drawing the faces of a polygon. The
polygonOffsetConstant argument affects the behavior of only the OpenGL driver. Possible
values are 0.0 polygonOffsetConstant 100.0. The default value is platform dependent and is
typically between 0.0 and 2.0.
polygonOffsetSlope
A Float specifying the factor that multiplies the slope of each line before the line is added to the
vertexes of a polygon face. The polygonOffsetSlope argument affects the behavior of only the
OpenGL driver. Possible values are 0.0 polygonOffsetSlope 100.0. The default value is
platform dependent and is typically between 0.0 and 2.0.
printPolygonOffsetConstant
A Float specifying the offset added when drawing the faces of a polygon.
printPolygonOffsetConstant is similar to polygonOffsetConstant; however,
printPolygonOffsetConstant is used when printing and polygonOffsetConstant is used

15–19

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

for display. Some systems, especially Windows, use different OpenGL drivers for printing and
display, and you may have to use different offset values for each driver.
printPolygonOffsetSlope
A Float specifying the factor that multiplies the slope of each line before the line is added to the
vertexes of a polygon face. printPolygonOffsetSlope is similar to polygonOffsetSlope; however,
printPolygonOffsetSlope is used when printing and polygonOffsetSlope is used for display. Some
systems, especially Windows, use different OpenGL drivers for printing and display, and you may
have to use different offset values for each driver.
vertexArrays
A Boolean specifying how the three-dimensional vertices of the model are processed. When
vertexArrays=OFF, each vertex of the model is processed separately. When vertexArrays=ON,
the vertices are processed in large blocks resulting in faster display. Not all graphics adapters
support this capability correctly. An indicator that the graphics adapters is not processing three-
dimensional vertices correctly is the absence of graphics during “rubber banding” operations. For
example, when dynamically dragging the radius of a circle in the Sketcher, the circle should be
visible. The default value is ON.
vertexArraysInDisplayLists
A Boolean specifying whether the vertexArrays setting should temporarily be set to OFF when
building a display list. The default value is ON.
Some graphics adapters do not properly support using vertex arrays inside a display list.
Setting vertexArraysInDisplayLists to OFF has a smaller impact on graphics performance than
setting vertexArrays or displayLists to OFF.
viewManipDisplayListThreshold
An Int specifying how large a display list may be created in order to accelerate view manipulation
operations. Increasing this value when viewing large models will increase the delay before a view
manipulation operation begins in order to obtain improved graphics performance during the view
manipulation. If set high with a large model, the delay can be many seconds. In excessive cases,
graphics memory can be exceeded and the result may be an empty display list (no visible model)
for the view manipulation. This setting is treated as 0 if displayLists=OFF. Possible values are 0
viewManipDisplayListThreshold 20000. The default value is 40.
directRendering
A Boolean specifying how Abaqus renders X11 graphics operations. When directRendering=OFF,
the graphics are rendered through the X Server. When directRendering=ON, the graphics
operations are sent directly to the graphics adapter producing faster displays. For maximum
performance, the initial value is ON. This argument is used only when you first start Abaqus/CAE;
you cannot configure directRendering during a session.
hardwareAcceleration
A Boolean specifying whether a hardware accelerated OpenGL graphics driver will be used on
Windows platforms. The default value is ON.

15–20

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

When hardwareAcceleration=OFF, the graphics driver uses a software implementation of

OpenGL that is included with the operating system. This results in slower drawing on most
systems; however, you may have to use the software implementation of OpenGL if the hardware
graphics driver is incompatible with Abaqus/CAE.
hardwareAcceleration is used only when you first start Abaqus/CAE on a Windows platform;
you cannot configure hardwareAcceleration during a session. hardwareAcceleration is not used
when you start Abaqus/CAE on an X-Windows platform and display to a Windows platform
running Exceed or any other X-Windows server.
hardwareOverlay
A Boolean specifying whether hardware overlay planes will be used if available. The default value
is the same value as the hardwareOverlayAvailable member.
When hardwareOverlayAvailable=OFF, it will not be possible to set hardwareOverlay to
ON and the HARDWARE_OVERLAY highlight method will not be available. If viewports
display a solid color and will not display the model, it will be necessary to inhibit hardware
overlay completely by setting the ABAQUS_EMULATE_OVERLAYS environment variable (to
any value) before starting Abaqus/CAE.
hardwareOverlay is used only when you first start Abaqus/CAE; you cannot configure
hardwareOverlay during a session.
textureMapping
A Boolean specifying whether textures will be used to display contour plots. The default value is
ON.
Turning off texture mapping is necessary only if viewports will not correctly display a contour
plot of your model.
printTextureMapping
A Boolean specifying whether textures will be used to display contour plots. The default value is
ON.
Turning off texture mapping for printing is necessary only if printed output does not correctly
display a contour plot of your model. printTextureMapping is similar to textureMapping; however,
printTextureMapping is used when printing and textureMapping is used for display. Some systems,
especially Windows, use different OpenGL drivers for printing and display, and you may have to
use different settings for each driver.
backgroundStyle
A SymbolicConstant specifying the background style to be used for all viewport windows.
Possible values are SOLID and GRADIENT. The default value is SOLID.
If backgroundStyle=SOLID, the viewport background will appear as a solid color as specified
by backgroundColor. If backgroundStyle =GRADIENT, the viewport background will be drawn
as a gradient beginning with the backgroundColor at the top of the viewport and gradually blending
to the backgroundBottomColor at the bottom of the viewport.

15–21

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

accelerateOffScreen
A Boolean specifying whether the hardware accelerated graphics driver will be used for off-screen
rendering. The default value is ON if graphics hardware acceleration is available and has not
been disabled via the hardwareAcceleration option, and the graphics driver supports the underlying
technology. When set to OFF, an alternate (slower) technique will be used to create off-screen
images. Off-screen rendering is used for Printing, Probe, and backing store (viewport refresh).
Setting this value to OFF will force printed images to be rendered without hardware acceleration.
This is useful when writing automated tests to produce raster images that you will want to compare
across multiple machines that may have different graphics environments.
backingStore
A Boolean specifying whether a backing store will be used to refresh a viewport after a window
occluding the viewport is moved or dismissed. The default value is ON.
highlightMethod
A SymbolicConstant specifying the highlight method. For the GraphicsOptions object, possible
values of the member are HARDWARE_OVERLAY, XOR, SOFTWARE_OVERLAY, and
BLEND.
hardwareOverlayAvailable
A Boolean specifying if the graphics hardware supports hardware overlay.
shadersAvailable
A Boolean specifying if the graphics hardware supports the OpenGL Shading Language (GLSL).
translucencyMode
An Int specifying whether speed or accuracy is more important when drawing translucent objects.
Lower values optimize for speed while higher values optimize for accuracy. The actual meaning
of each setting will depend on the setting of shadersAvailable and the capabilities of the graphics
hardware and driver. Possible values are 1 translucencyMode 6. The default value is 4.
options
None or a GraphicsOptions object specifying the object from which values are to be copied. If
other arguments are also supplied to setValues, they will override the values in the options
member. The default value is None.
highlightMethodHint
A tuple of SymbolicConstants specifying a hint used to modify the highlight method. Possible
values are:

• HARDWARE_OVERLAY, specifying a hint of hardware overlay. The best graphics

performance is achieved using hardware overlay, but not all systems and graphics adapters
support hardware overlay.
• XOR, specifying a hint of XOR technique. The XOR technique uses a boolean pixel
operation to simulate the drawing operations but can produce different colors depending on
the color of the underlying pixels.

15–22

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

• SOFTWARE_OVERLAY, specifying a hint of software overlay. The software overlay

method simulates the effect of hardware overlay.
• BLEND, specifying a hint of blend method. The blend method combines the color of the
underlying pixel with the desired color producing an approximation of the transient graphics.
The default value is (HARDWARE_OVERLAY, XOR, SOFTWARE_OVERLAY, BLEND).
The values of this sequence are applied by Abaqus when you start a session in first to last
order. The first successful value becomes the default highlight method. Not all graphics adapters
support the HARDWARE_OVERLAY value and you must use the highlightMethodHint argument
to provide an alternative.
You can use a single value to set the first element of the list, or you can use a tuple with one
to four unique values. Abaqus sets any remaining elements of the tuple to unique values based on
the default order.
backgroundColor
A String specifying one of the two background colors for all viewport windows. The initial color
is black. A list of valid color strings is in the colors map in the Session object.
backgroundBottomColor
A String specifying one of the two background colors for all viewport windows. This color is used
only if backgroundStyle=GRADIENT. The initial color is black. A list of valid color strings is in
the colors map in the Session object.

15.9 InteractionDisplayOptions object

The InteractionDisplayOptions object stores settings that specify how assemblies are to be displayed in
a particular viewport when
session.viewports[name].assemblyDisplay.interactions=ON
The InteractionDisplayOptions object has no constructor. When you create a new viewport, the settings
are copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.interactionOptions
session.viewports[name].layers[name].assemblyDisplay\
.interactionOptions

15.9.1 setValues(...)
This method modifies the InteractionDisplayOptions object.

15–23

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

Arguments

Required arguments
None.
Optional arguments
surfaceContact
A Boolean specifying whether surface contact symbols are shown. The default value is ON.
selfContact
A Boolean specifying whether self contact symbols are shown. The default value is ON.
elasticFoundation
A Boolean specifying whether elastic foundation symbols are shown. The default value is ON.
actuatorSensor
A Boolean specifying whether actuator/sensor symbols are shown. The default value is ON.
radiationAmbient
A Boolean specifying whether surface radiation-to-ambient symbols are shown. The default value
is ON.
filmCondition
A Boolean specifying whether surface film condition symbols are shown. The default value is ON.
concentratedRadiationToAmbient
A Boolean specifying whether concentrated radiation-to-ambient symbols are shown. The default
value is ON.
concentratedFilmCondition
A Boolean specifying whether concentrated film condition symbols are shown. The default value
is ON.

Return value
None

Exceptions
RangeError.

15.9.2 Members
The InteractionDisplayOptions object has members with the same names and descriptions as the
arguments to the setValues method.

15–24

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

15.10 Light object

The Light object stores settings that control how objects are lit when the renderStyle is set to SHADED.
The Light object has no constructor; Abaqus creates them as part of the defaultLightOptions and
the lightOptions objects when a session is started.

Access
session.defaultLightOptions.lights[i]
session.viewports[name].lightOptions.lights[i]

15.10.1 setValues(...)
This method modifies the Light object.

Arguments
Required arguments
None.
Optional arguments
enabled
A Boolean specifying whether the light is on or off. The default value is OFF.
type
A SymbolicConstant specifying how the effect of the light should be calculated. Possible values
are:
• DIRECTIONAL, specifying a constant vector should be used for the direction from the light
to a vertex.
• POINT, specifying the vector from the light to each vertex should be calculated.
The default value is DIRECTIONAL.
When set to type=DIRECTIONAL, a constant vector is used for the direction from the light
to a vertex. When type=POINT, the result is more realistic because the actual vector from the light
to each vertex is calculated. However, overall performance is decreased.
latitude
A Float specifying the altitude of the light above or below the camera. Possible values are -90.0
latitude 90.0. The default value is 0.0.
longitude
A Float specifying the east/west position of the light to the left or right of the camera. Possible
values are -90.0 longitude 90.0. The default value is 0.0.

15–25

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

diffuseColor
A String specifying the color of the light added to the scene by this light source. The initial value
is 70% gray. A list of valid color strings is in the colors map in the session object.
specularColor
A String specifying the color of the specular highlights created by this light source. The initial
value is 36% gray. A list of valid color strings is in the colors map in the session object.

Return value
None

Exceptions
RangeError.

15.10.2 Members
The Light object has members with the same names and descriptions as the arguments to the setValues
method.

15.11 LightOptions object

The LightOptions object stores settings that control how objects are lit when the renderStyle is set to
SHADED. LightOptions objects are accessed in one of two ways:
• The default light options. These settings are used as defaults when you start a session and by the
Defaults button on the Light Options dialog box.
• The light options associated with a particular viewport.
The LightOptions object has no constructor; Abaqus creates the defaultLightOptions member when
a session is started. When a new viewport is created, the lightOptions member is copied from the current
viewport.

Access
session.defaultLightOptions
session.viewports[name].lightOptions

15.11.1 setValues(...)
This method modifies the LightOptions object.

15–26

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

Arguments

Required arguments
None.
Optional arguments
shading
A SymbolicConstant specifying the shading technique that should be used to fill facets for
geometric bodies when renderStyle=SHADED. The lighting of facets for meshed geometry is not
affected by this setting. Possible values are:

• GOURAUD, specifying that lighting values should be computed for each corner of a facet
and interpolated to fill the remainder of the facet.
• PHONG, specifying that lighting values should be computed for each pixel of a facet.
The default value is GOURAUD.
When set to shading=GOURAUD, lighting values are computed for each corner of a facet
and the lighting for the remainder of the facet is interpolated from the corner values. When
shading=PHONG, lighting values are computed for each pixel of a facet.

Note: The shading technique can only be set to PHONG when the shadersAvailable member of
GraphicsOptions is True.
Printed output will only contain Phong shading if the output format is raster and the
accelerateOffScreen member of GraphicsOptions is ON.

The renderStyle setting is part of AssemblyDisplayOptions , PartDisplayOptions , and various

other options objects not listed here since they are generally used for meshed geometry.
viewpoint
A SymbolicConstant specifying how specular highlights should be calculated. Possible values are:

• INFINITE, specifying that a constant vector should be used for the direction from the camera
to a vertex when computing specular highlights.
• LOCAL, specifying that the vector from the camera to each vertex should be calculated when
computing specular highlights.
The default value is INFINITE.
When set to viewpoint=INFINITE, a constant vector is used for the direction from the camera
(viewpoint) to a vertex. When viewpoint=LOCAL, the result is more realistic because the actual
vector from the camera to each vertex is calculated. However, overall performance is decreased.
ambientColor
A String specifying the light applied evenly to the entire scene independent of any individual light.
The initial value is 20% gray. A list of valid color strings is in the colors map in the session object.

15–27

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

materialShininess
A Float specifying the degree to which specular reflection is focused. The higher the
materialShininess argument, the more focused the specular highlight. Possible values are 0.0
polygonOffsetConstant 128.0. The default value is 105.0.

Return value
None

Exceptions
RangeError.

15.11.2 Members
The LightOptions object has the following members:
shading
A SymbolicConstant specifying the shading technique that should be used to fill facets for
geometric bodies when renderStyle=SHADED. The lighting of facets for meshed geometry is not
affected by this setting. Possible values are:
• GOURAUD, specifying that lighting values should be computed for each corner of a facet
and interpolated to fill the remainder of the facet.
• PHONG, specifying that lighting values should be computed for each pixel of a facet.
The default value is GOURAUD.
When set to shading=GOURAUD, lighting values are computed for each corner of a facet
and the lighting for the remainder of the facet is interpolated from the corner values. When
shading=PHONG, lighting values are computed for each pixel of a facet.
Note: The shading technique can only be set to PHONG when the shadersAvailable member of
GraphicsOptions is True.
Printed output will only contain Phong shading if the output format is raster and the
accelerateOffScreen member of GraphicsOptions is ON.
The renderStyle setting is part of AssemblyDisplayOptions , PartDisplayOptions , and various
other options objects not listed here since they are generally used for meshed geometry.
viewpoint
A SymbolicConstant specifying how specular highlights should be calculated. Possible values are:
• INFINITE, specifying that a constant vector should be used for the direction from the camera
to a vertex when computing specular highlights.
• LOCAL, specifying that the vector from the camera to each vertex should be calculated when
computing specular highlights.
The default value is INFINITE.

15–28

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

When set to viewpoint=INFINITE, a constant vector is used for the direction from the camera
(viewpoint) to a vertex. When viewpoint=LOCAL, the result is more realistic because the actual
vector from the camera to each vertex is calculated. However, overall performance is decreased.
materialShininess
A Float specifying the degree to which specular reflection is focused. The higher the
materialShininess argument, the more focused the specular highlight. Possible values are 0.0
polygonOffsetConstant 128.0. The default value is 105.0.
lights
A LightArray object of length 8.
ambientColor
A String specifying the light applied evenly to the entire scene independent of any individual light.
The initial value is 20% gray. A list of valid color strings is in the colors map in the session object.

15.12 LoadDisplayOptions object

The LoadDisplayOptions object stores settings that specify how assemblies are to be displayed in a
particular viewport when
session.viewports[name].assemblyDisplay.loads=ON
The LoadDisplayOptions object has no constructor. When you create a new viewport, the settings are
copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.loadOptions
session.viewports[name].layers[name].assemblyDisplay.loadOptions

15.12.1 setValues(...)
This method modifies the LoadDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
concentratedForce
A Boolean specifying whether concentrated force symbols are shown. The default value is ON.
moment
A Boolean specifying whether moment symbols are shown. The default value is ON.

15–29

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

pressure
A Boolean specifying whether pressure symbols are shown. The default value is ON.
pipePressure
A Boolean specifying whether pipe pressure symbols are shown. The default value is ON.
bodyForce
A Boolean specifying whether body force symbols are shown. The default value is ON.
lineLoad
A Boolean specifying whether line load symbols are shown. The default value is ON.
gravity
A Boolean specifying whether gravity symbols are shown. The default value is ON.
boltLoad
A Boolean specifying whether bolt load symbols are shown. The default value is ON.
pegLoad
A Boolean specifying whether PEG load symbols are shown. The default value is ON.
connectorForce
A Boolean specifying whether connector force symbols are shown. The default value is ON.
connectorMoment
A Boolean specifying whether connector moment symbols are shown. The default value is ON.
inertiaRelief
A Boolean specifying whether inertia relief symbols are shown. The default value is ON.
rotationalIntertiaLoad
A Boolean specifying whether rotational inertia load symbols are shown. The default value is ON.
coriolisForce
A Boolean specifying whether coriolis force symbols are shown. The default value is ON.
bodyHeatFlux
A Boolean specifying whether body heat flux symbols are shown. The default value is ON.
surfaceHeatFlux
A Boolean specifying whether surface heat flux symbols are shown. The default value is ON.
concentratedHeatFlux
A Boolean specifying whether concentrated heat flux symbols are shown. The default value is ON.
concentratedPoreFluid
A Boolean specifying whether concentrated pore fluid symbols are shown. The default value is
ON.
surfacePoreFluid
A Boolean specifying whether surface pore fluid symbols are shown. The default value is ON.
hydroFluidFlow
A Boolean specifying whether hydro fluid flow symbols are shown. The default value is ON.

15–30

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

concentratedCharge
A Boolean specifying whether concentrated charge symbols are shown. The default value is ON.
concentratedCurrent
A Boolean specifying whether concentrated current symbols are shown. The default value is ON.
surfaceCharge
A Boolean specifying whether surface charge symbols are shown. The default value is ON.
surfaceCurrent
A Boolean specifying whether surface current symbols are shown. The default value is ON.
bodyCharge
A Boolean specifying whether body charge symbols are shown. The default value is ON.
bodyCurrent
A Boolean specifying whether body current symbols are shown. The default value is ON.
inwardVolAccel
A Boolean specifying whether inward volume acceleration symbols are shown. The default value
is ON.
bodyConcentrationFlux
A Boolean specifying whether body concentration flux symbols are shown. The default value is
ON.
surfaceConcentrationFlux
A Boolean specifying whether surface concentration flux symbols are shown. The default value
is ON.
concentratedConcentrationFlux
A Boolean specifying whether concentrated concentration flux symbols are shown. The default
value is ON.

Return value
None

Exceptions
RangeError.

15.12.2 Members
The LoadDisplayOptions object has members with the same names and descriptions as the arguments to
the setValues method.

15–31

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

15.13 MeshDisplayOptions object

The MeshDisplayOptions object stores settings that specify how the assembly is displayed in a particular
viewport when
session.viewports[name].assemblyDisplay.mesh=ON
The MeshDisplayOptions object has no constructor. When you create a new viewport, the settings are
copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.meshOptions
session.viewports[name].layers[name].assemblyDisplay.meshOptions
session.viewports[name].layers[name].partDisplay.meshOptions
session.viewports[name].partDisplay.meshOptions

15.13.1 setValues(...)
This method modifies the MeshDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
nodeLabels
A Boolean specifying whether node labels are shown. The default value is OFF.
elementLabels
A Boolean specifying whether element labels are shown. The default value is OFF.
meshVisibleEdges
A SymbolicConstant specifying how the mesh’s edges are drawn. Possible values are:
• ALL, specifying that all edges are shown.
• EXTERIOR, specifying that only exterior edges are shown.
• FEATURE, specifying that edges are shown based on featureAngle.
• FREE, specifying that only free edges are shown.
• NONE, specifying that no display edges are shown.
The default value is EXTERIOR.

15–32

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

featureAngle
A Float specifying the angle in degrees to be used in calculating a feature edge plot. Possible
values are 0 featureAngle 90. The default value is 20.0.
meshEdgesInShaded
A Boolean specifying whether mesh edges are displayed in shaded mode. The default value is ON.
meshTechnique
A Boolean specifying whether the regions of the assembly will be color coded based on the
meshing technique assigned to the regions. This argument is ignored in partDisplay. The default
value is OFF.
seeds
A Boolean specifying whether seeds are shown. This argument is ignored in partDisplay. The
default value is OFF.

Return value
None

Exceptions
RangeError.

15.13.2 Members
The MeshDisplayOptions object has members with the same names and descriptions as the arguments
to the setValues method.

15.14 PartDisplayOptions object

The PartDisplayOptions object stores settings that specify how parts are to be displayed in a particular
viewport. The PartDisplayOptions object has no constructor. When you create a new viewport, the
settings are copied from the current viewport.

Access
session.viewports[name].layers[name].partDisplay
import part
session.viewports[name].partDisplay

15.14.1 setValues(...)
This method modifies the PartDisplayOptions object.

15–33

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

Arguments
Required arguments
None.
Optional arguments
renderStyle
A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are
WIREFRAME, HIDDEN, and SHADED. The default value is WIREFRAME.
visibleDisplayGroups
A sequence of DisplayGroup objects specifying the DisplayGroups visible in the viewport.
Currently the sequence can contain a maximum of one DisplayGroup object. The default value is
an empty sequence.
engineeringFeatures
A Boolean specifying whether engineering features are shown. The default value is OFF.
renderBeamProfiles
A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor
A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero.
The default value is 1.0.

Return value
None

Exceptions
RangeError.

15.14.2 Members
The PartDisplayOptions object can have the following members:
engineeringFeatures
A Boolean specifying whether engineering features are shown. The default value is OFF.
renderBeamProfiles
A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor
A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero.
The default value is 1.0.
mesh
A Boolean specifying whether the mesh should be displayed.

15–34

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

renderStyle
A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are
WIREFRAME, HIDDEN, and SHADED. The default value is WIREFRAME.
displayGroup
A DisplayGroup object specifying the current display group and referring to an object in the
displayGroups member of Session .
displayGroupInstances
A repository of DisplayGroupInstance objects.
engineeringFeatureOptions
An EngineeringFeatureDisplayOptions object.
geometryOptions
A GeometryDisplayOptions object.
meshOptions
A MeshDisplayOptions object.

15.15 SymbolDisplayOptions object

The SymbolDisplayOptions object stores settings that specify how the assembly is displayed in a
particular viewport. The SymbolDisplayOptions object has no constructor. When you create a new
viewport, the settings are copied from the current viewport.

Access
session.viewports[name].assemblyDisplay.symbolOptions
session.viewports[name].layers[name].assemblyDisplay.symbolOptions

15.15.1 setValues(...)
This method modifies the SymbolDisplayOptions object.

Arguments
Required arguments
None.
Optional arguments
otherSymbolSize
An Int specifying the size of the scalar attribute symbols. Possible values are 1 scalarSymbolSize
30. The default value is 6.

15–35

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

arrowSymbolSize
An Int specifying the size of the vector and tensor attribute symbols. Possible values are 1
vectorSymbolSize 30. The default value is 6.
faceSymbolDensity
An Int specifying the relative density of the attribute symbols drawn on geometric faces. Possible
values are 1 faceSymbolDensity 10. The default value is 5.
edgeSymbolDensity
An Int specifying the relative density of the attribute symbols drawn on geometric edges. Possible
values are 1 edgeSymbolDensity 10. The default value is 5.
meshSymbolFraction
A Float specifying the fraction of the attribute symbols drawn on orphan mesh regions. Possible
values are 0.0 meshSymbolFraction 1.0. The default value is 1.0.
showFields
A Boolean specifying whether symbols should be scaled based on analytical field value. The
default value is ON.

Return value
None

Exceptions
None.

15.15.2 Members
The SymbolDisplayOptions object has members with the same names and descriptions as the arguments
to the setValues method.

15.16 ViewportAnnotationOptions object

The ViewportAnnotationOptions object stores settings that control how annotations are rendered in a
particular viewport. ViewportAnnotationOptions objects are accessed in one of two ways:
• The default viewport annotations. These settings are used as defaults when other
viewportAnnotationOptions members are created and can be set to customize user preferences.
• The viewport annotations associated with a particular viewport.
The ViewportAnnotationOptions object has no constructor; Abaqus creates the
defaultViewportAnnotationOptions member when a session is started. When a new viewport is created,
the settings are copied from the current viewport.

15–36

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

Access
session.defaultViewportAnnotationOptions
session.viewports[name].viewportAnnotationOptions

15.16.1 setValues(...)
This method modifies the ViewportAnnotationOptions object.

Arguments
Required arguments
None.
Optional arguments
triad
A Boolean specifying whether the view orientation triad is shown. The default value is ON.
triadPosition
A pair of Ints specifying the position of the view orientation triad as a percentage of the viewport
size. Possible values are (0, 0) triadPosition (100, 100). The default value is (6, 12).
triadColor
A String specifying the color of the view orientation triad. Possible values are any valid color.
The default value is "White".
triadLabels
A SymbolicConstant specifying how the view orientation triad is labeled. Possible values are:
• NUMBERS, specifying the label axes 1, 2, 3.
• LETTERS, specifying the label axes X, Y, Z.
The default value is NUMBERS.
triadFont
A String specifying the font of the view orientation triad labels. Possible values are any valid font.
The default value is "-*-helvetica-bold-r-normal--12-*".
triadSize
An Int specifying the length of each triad axis as a percentage of the viewport size. Possible values
are 1 legendDecimalPlaces 50. The default value is 4.
legend
A Boolean specifying whether the legend is shown. The default value is ON.
legendMinMax
A Boolean specifying whether the minimum and maximum values for X–Y and contour plots are
shown. The default value is OFF.

15–37

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

legendBox
A Boolean specifying whether the box around the legend is shown. The default value is ON.
legendDecimalPlaces
An Int specifying the number of decimal places to display in the legend. Possible values are 0
legendDecimalPlaces 9. The default value is 3.
legendPosition
A pair of Ints specifying the position of the legend as a percentage of the viewport size. Possible
values are (0, 0) legendPosition (100, 100). The default value is (2, 98).
legendFont
A String specifying the font of the legend labels. Possible values are any valid font. The default
value is "-*-courier-medium-r-*-*-*-80-*-*-*-*-iso8859-1".
legendTextColor
A String specifying the color of the legend. Possible values are any valid color. The default value
is "White".
legendBackgroundStyle
A SymbolicConstant specifying the legend background style. Possible values are MATCH,
TRANSPARENT, and OTHER. The default value is TRANSPARENT.
The default color when OTHER is specified is the background color (black).
legendBackgroundColor
A String specifying the color of the legend background. Possible values are any valid color. The
initial value matches the viewport background.
title
A Boolean specifying whether the title block is shown. The default value is ON.
titleBox
A Boolean specifying whether the box around the title block is shown. The default value is OFF.
titlePosition
A pair of Ints specifying the position of the title block as a percentage of the viewport size. Possible
values are (0, 0) titlePosition (100, 100). The default value is (13, 20).
titleFont
A String specifying the font of the title. Possible values are any valid font. The default value is
"-*-courier-medium-r-*-*-*-80-*-*-*-*-iso8859-1".
titleTextColor
A String specifying the color of the title. Possible values are any valid color. The default value is
"White".
titleBackgroundStyle
A SymbolicConstant specifying the title block background style. Possible values are MATCH,
TRANSPARENT, and OTHER. The default value is TRANSPARENT.
The default color when OTHER is specified is the background color (black).

15–38

Abaqus ID:
Printed on:
 DISPLAY OPTIONS COMMANDS

titleBackgroundColor
A String specifying the color of the title block background. Possible values are any valid color.
The initial value matches the viewport background.
state
A Boolean specifying whether the state block is shown. The default value is ON.
stateBox
A Boolean specifying whether the box around the state block is shown. The default value is OFF.
statePosition
A pair of Ints specifying the position of the state block as a percentage of the viewport size. Possible
values are (0, 0) statePosition (100, 100). The default value is (13, 12).
stateFont
A String specifying the font of the state label. Possible values are any valid font. The default value
is "-*-courier-medium-r-*-*-*-80-*-*-*-*-iso8859-1".
stateTextColor
A String specifying the color of the state block label. Possible values are any valid color. The
default value is "White".
stateBackgroundStyle
A SymbolicConstant specifying the state block background style. Possible values are MATCH,
TRANSPARENT, and OTHER. The default value is TRANSPARENT.
The default color when OTHER is specified is the background color (black).
stateBackgroundColor
A String specifying the color of the state block background. Possible values are any valid color.
The initial value matches the viewport background.
compass
A Boolean specifying whether the 3D Compass is shown. The default value is ON.
compassScale
A Float specifying the relative size of the 3D Compass in the viewport. Possible values are 0.5
compassScale 2.0. The default value is 0.8.
compassPrivilegedPlane
A SymbolicConstant specifying the plane that will be used for the base of the 3D Compass.
Possible values are XYPLANE, XZPLANE, and YZPLANE. The default value is XZPLANE.

Return value
None

Exceptions
RangeError.

15–39

Abaqus ID:
Printed on:
DISPLAY OPTIONS COMMANDS

15.16.2 Members
The ViewportAnnotationOptions object has members with the same names and descriptions as the
arguments to the setValues method.

15–40

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

16. Edit mesh commands

Edit mesh commands are used to edit an orphan mesh part or part instance or an Abaqus native mesh.

16.1 Assembly object

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

Access
import meshEdit

16.1.1 collapseMeshEdge(...)
This method collapses an edge of a quadrilateral or triangular element of a part instance.

Arguments
Required arguments
edge
A single MeshEdge object specifying the element edge to collapse.
collapseMethod
A SymbolicConstant specifying the method used to collapse the edge. Possible values are
FORWARD, REVERSE, and AVERAGE.
Optional arguments
None.

Return value
None

Exceptions
None.

16.1.2 combineElement(...)
This method combines two triangular elements of a part instance.

16–1

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Arguments
Required argument
elements
A sequence of triangular MeshElement objects specifying the elements to combine.
Optional arguments
None.

Return value
None

Exceptions
None.

16.1.3 deleteElement(...)
This method deletes the given elements from a part instance. The elements must have been generated
using the bottom-up meshing technique.

Arguments
Required argument
elements
A sequence of MeshElement objects or a Set object containing elements.
Optional argument
deleteUnreferencedNodes
A Boolean specifying whether to delete all those associated nodes that become unreferenced after
the given elements are deleted. The default value is OFF.

Return value
None

Exceptions
None.

16.1.4 projectNode(...)
This method projects the given nodes of a part instance onto a mesh entity, geometric entity, or a datum
object.

16–2

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Arguments
Required arguments
nodes
A sequence of MeshNode objects to be projected
projectionReference
An object specifying the target for the node projection operation. The projectionReference can
be any one of the following objects: MeshNode , MeshEdge , MeshFace , Vertex , Edge , Face ,
DatumPoint , DatumAxis , or DatumPlane .
Optional arguments
None.

Return value
None

Exceptions
None.

16.1.5 editNode(...)
This method changes the coordinates of the given nodes on a part instance.

Arguments
Required argument
nodes
A sequence of MeshNode objects or a Set object containing nodes.
Optional arguments
coordinate1
A Float specifying the value of the first coordinate. If coordinate1 and offset1 are unspecified, the
existing value does not change.
coordinate2
A Float specifying the value of the second coordinate. If coordinate2 and offset2 are unspecified,
the existing value does not change.
coordinate3
A Float specifying the value of the third coordinate. If coordinate3 and offset3 are unspecified,
the existing value does not change.
coordinates
A sequence of three-dimensional coordinate tuples specifying the coordinates for each of the
given nodes. When specified, the number of coordinate tuples must match the number of given

16–3

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

nodes, and be ordered to correspond to the given nodes in ascending order according to index.
Furthermore, coordinate1, coordinate2, coordinate3, offset1, offset2, or offset3 may not be
specified.
offset1
A Float specifying an offset to apply to the value of the first coordinate of the specified nodes.
offset2
A Float specifying an offset to apply to the value of the second coordinate of the specified nodes.
offset3
A Float specifying an offset to apply to the value of the third coordinate of the specified nodes.
localCsys
A DatumCsys object specifying the local coordinate system. If unspecified, the global coordinate
system will be used.
projectToGeometry
A Boolean specifying whether to project nodes back to their original geometry. For example, if a
node is on a face, this method first positions the node at the new location and then projects it back
to the original face. The default value is ON.

Return value
None

Exceptions
A coordinate and an offset may not both be specified for the same coordinate component.

16.1.6 mergeNodes(...)
Merge the nodes of a part instance. The nodes must have been generated using the bottom-up meshing
technique.

Arguments
Required argument
nodes
A sequence of MeshNode objects specifying the nodes to merge.
Optional arguments
tolerance
A Float specifying the maximum distance between nodes that will be merged to a single node. The
location of the new node is the average position of the merged nodes. The default value is 10–6 .
removeDuplicateElements
A Boolean specifying whether elements with the same connectivity after the merge will merged
into a single element. The default value is True.

16–4

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Return value
None

Exceptions
None.

16.1.7 mergeNodes(...)
Merge two nodes of a part instance. At least one of the two nodes must have been generated using the
bottom-up meshing technique.

Arguments
Required arguments
node1
A MeshNode object specifying the first node to merge.
node2
A MeshNode object specifying the second node to merge.
Optional argument
removeDuplicateElements
A Boolean specifying whether elements with the same connectivity after the merge will merged
into a single element. The default value is True.

Return value
None

Exceptions
None.

16.1.8 splitElement(...)
This method splits quadrilateral elements into triangular elements.

Arguments
Required argument
elements
A sequence of quadrilateral MeshElement objects specifying the elements to split. Each
quadrilateral element is split into two triangular elements by the shorter diagonal.

16–5

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Optional arguments
None.

Return value
None

Exceptions
None.

16.1.9 splitMeshEdge(...)
This method splits an edge of a quadrilateral or triangular element of a part instance.

Arguments
Required argument
edge
A single MeshEdge object specifying the element edge to split.
Optional argument
parameter
A Float specifying the normalized distance along edge at which to split. Possible values are 0.0
parameter 1.0. The default value is 0.5.

Return value
None

Exceptions
None.

16.1.10 swapMeshEdge(...)
This method swaps the diagonal of two adjacent triangular elements of a part instance.

Arguments
Required argument
edge
A single MeshEdge object specifying the element edge to swap.
Optional arguments
None.

16–6

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Return value
None

Exceptions
None.

16.1.11 redoMeshEdit()
This method executes the edit mesh or the bottom-up meshing operation most recently undone by the
undoMeshEdit method on an assembly. A redo action must be currently available for the assembly.
This implies that the user must have executed the undoMeshEdit method on the assembly and that
the user has not subsequently executed any further edit mesh commands on the assembly. It also implies
that the user provided a sufficient cache allowance to store the undo operation.

Arguments
None.

Return value
None

Exceptions
None.

16.1.12 undoMeshEdit()
This method undoes the most recent edit mesh or the bottom-up meshing operation on an assembly and
restores the mesh on the affected part instance to its previous state. An edit mesh undo action must be
available for the assembly. This implies that prior to executing an edit mesh command on the assembly,
the user enabled edit mesh undo with a sufficient cache allowance to store the edit mesh operation.

Arguments
None.

Return value
None

16–7

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Exceptions
None.

16.2 Part object

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

Access
import meshEdit

16.2.1 adjustMidsideNode(...)
This method is used to adjust the midside node of second-order elements of an orphan mesh part.

Arguments
Required arguments
cornerNodes
A sequence of Node objects specifying the nodes towards which connected midside nodes will be
biased.
parameter
A Float specifying the normalized distance along the edge of the midside nodes. Possible values
are 0.0 parameter 1.0, where 0.0 specifies the position of the corner node. The default value
is 0.5.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.2 cleanMesh(...)
This method is used to perform automated mesh cleanup operations on an orphan mesh part composed
of linear triangular elements.

16–8

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Arguments
Required argument
mergeTolerance
The element size tolerance for removal of small elements. Elements containing edges whose length
is shorter than this value will be collapsed.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.3 collapseMeshEdge(...)
This method collapses an edge of a quadrilateral or triangular element of an orphan mesh part or part
instance.

Arguments
Required arguments
edge
A single MeshEdge object specifying the element edge to collapse.
collapseMethod
A SymbolicConstant specifying the method used to collapse the edge. Possible values are
FORWARD, REVERSE, and AVERAGE.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.4 combineElement(...)
This method combines two triangular elements of an orphan mesh part or an Abaqus native mesh.

16–9

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Arguments
Required argument
elements
A sequence of triangular MeshElement objects specifying the elements to combine.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.5 convertSolidMeshToShell()
This method removes all solid elements from an orphan mesh part and creates triangular or quadrilateral
shell elements along their outer faces.

Arguments
None.

Return value
None

Exceptions
None.

16.2.6 deleteElement(...)
This method deletes the given elements from an orphan mesh part or an Abaqus native mesh. If the
elements belong to an Abaqus native mesh then the elements must have been generated using the bottom-
up meshing technique.

Arguments
Required argument
elements
A sequence of MeshElement objects or a Set object containing elements.

16–10

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Optional argument
deleteUnreferencedNodes
A Boolean specifying whether to delete all those associated nodes that become unreferenced after
the given elements are deleted. The default value is OFF.

Return value
None

Exceptions
None.

16.2.7 deleteNode(...)
This method deletes the given nodes from an orphan mesh part.

Arguments

Required argument
nodes
A sequence of MeshNode objects or a Set object containing nodes.
Optional argument
deleteUnreferencedNodes
A Boolean specifying whether to delete all those associated nodes that become unreferenced after
the given nodes and the connected elements are deleted. The default value is OFF.

Return value
None

Exceptions
None.

16.2.8 editNode(...)
This method changes the coordinates of the given nodes on an orphan mesh part or on an Abaqus native
mesh.

16–11

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Arguments
Required argument
nodes
A sequence of MeshNode objects or a Set object containing nodes.
Optional arguments
coordinate1
A Float specifying the value of the first coordinate. If coordinate1 and offset1 are unspecified, the
existing value does not change.
coordinate2
A Float specifying the value of the second coordinate. If coordinate2 and offset2 are unspecified,
the existing value does not change.
coordinate3
A Float specifying the value of the third coordinate. If coordinate3 and offset3 are unspecified,
the existing value does not change.
coordinates
A sequence of three-dimensional coordinate tuples specifying the coordinates for each of the
given nodes. When specified, the number of coordinate tuples must match the number of given
nodes, and be ordered to correspond to the given nodes in ascending order according to index.
Furthermore, coordinate1, coordinate2, coordinate3, offset1, offset2, or offset3 may not be
specified.
offset1
A Float specifying an offset to apply to the value of the first coordinate of the specified nodes.
offset2
A Float specifying an offset to apply to the value of the second coordinate of the specified nodes.
offset3
A Float specifying an offset to apply to the value of the third coordinate of the specified nodes.
localCsys
A DatumCsys object specifying the local coordinate system. If unspecified, the global coordinate
system will be used.
projectToGeometry
A Boolean specifying whether to project nodes back to their original geometry. For example, if a
node is on a face, this method first positions the node at the new location and then projects it back
to the original face. The default value is ON.

Return value
None

16–12

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Exceptions
A coordinate and an offset may not both be specified for the same coordinate component.

16.2.9 projectNode(...)
This method projects the given nodes onto a mesh entity, geometric entity, or a datum object. The nodes
may belong to an orphan mesh part or to an Abaqus native mesh.

Arguments
Required arguments
nodes
A sequence of MeshNode objects to be projected
projectionReference
An object specifying the target for the node projection operation. The projectionReference can
be any one of the following objects: MeshNode , MeshEdge , MeshFace , Vertex , Edge , Face ,
DatumPoint , DatumAxis , or DatumPlane .
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.10 generateMesh(...)
This method generates a new mesh on an orphan mesh part based on the original mesh.

Arguments
Required arguments
None.
Optional argument
elemShape
A SymbolicConstant specifying the element shape to be used for meshing. Possible values are:

16–13

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

TRI
Refine a planar triangular mesh and replace it with a new one. If no element sizes are attached,
the new mesh will be governed by the sizes of the boundary edges in the old mesh.

TET
Create a tetrahedral mesh from a closed shell of triangular elements.

Return value
None

Exceptions
None.

16.2.11 generateMeshByOffset(...)
This method generates a solid or shell mesh from an orphan mesh surface by generating layers of elements
that propagate out normal to the surface boundary.

Arguments

Required arguments
region
A Region object specifying the domain to be offset.
meshType
A Symbolic Constant specifying the type of mesh to be generated. Possible values are SOLID or
SHELL.
totalThickness
A Float specifying the total thickness of the solid layers. This argument applies only when
meshType=SOLID.
distanceBetweenLayers
A Float specifying the distance between shell layers. This argument applies only when
meshType=SHELL.
numLayers
An Int specifying the number of element layers to be generated.

16–14

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Optional arguments
offsetDirection
A Symbolic Constant specifying the direction of the offset. This argument is required only when
the given region relates to a shell mesh. Possible values are OUTWARD, INWARD, and BOTH.
The default value is OUTWARD.
initialOffset
A Float specifying the magnitude of the initial offset. The default value is zero.
shareNodes
Boolean specifying whether the first layer of nodes should be shared with nodes on the base surface.
The default value is False.
deleteBaseElements
A Boolean specifying whether to delete the shell elements after the offset layers are generated.
The default value is False. This argument applies only when meshType=SHELL.
constantThicknessCorners
A Boolean specifying whether to use element-based thickness or nodal-based thickness. The
default value is False.

Return value
None

Exceptions
None.

16.2.12 mergeNodes(...)
Merge the nodes of an orphan mesh part, or nodes that were generated using the bottom-up meshing
technique.

Arguments
Required argument
nodes
A sequence of Node objects specifying the nodes to merge.
Optional arguments
tolerance
A Float specifying the maximum distance between nodes that will be merged to a single node. The
location of the new node is the average position of the merged nodes. The default value is 10–6 .
removeDuplicateElements
A Boolean specifying whether elements with the same connectivity after the merge will merged
into a single element. The default value is True.

16–15

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

keepHighLabels
A Boolean specifying which node labels will remain after nodes are merged. If True then the
highest node labels are kept; when False the lowest node labels are kept. The default value is
False. This argument applies only to merging of orphan mesh nodes.

Return value
None

Exceptions
None.

16.2.13 mergeNodes(...)
Merge two nodes of an orphan mesh part or an Abaqus native mesh. If the nodes belong to an Abaqus
native mesh then at least one of the two nodes must have been generated using the bottom-up meshing
technique.

Arguments
Required arguments
node1
A MeshNode object specifying the first node to merge.
node2
A MeshNode object specifying the second node to merge.
Optional arguments
removeDuplicateElements
A Boolean specifying whether elements with the same connectivity after the merge will merged
into a single element. The default value is True.
keepHighLabels
A Boolean specifying which node label will remain after nodes are merged. If True then the higher
node label is kept; when False the lower node label is kept. The default value is False. This
argument applies only to merging of orphan mesh nodes.

Return value
None

Exceptions
None.

16–16

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

16.2.14 orientElements(...)
This method orients the stack direction of elements in a continuum shell or gasket mesh.

Arguments
Required arguments
pickedElements
A sequence of MeshElement objects specifying the elements to orient.
referenceRegion
A MeshFace object specifying a reference top face that indicates the desired orientation.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.15 removeElementSize()
This method removes the global element size from an orphan mesh part.

Arguments
None.

Return value
None

Exceptions
None.

16.2.16 renumberElement(...)
This method assigns new labels to orphan mesh elements.

16–17

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Arguments
Required arguments
startLabel
A positive Int specifying the new label for the first element in elements.
increment
A positive Int specifying the increment used for computation of new labels for all consecutive
elements in elements.
offset
An Int by which labels of elements in elements will be offset.
Note: Either both startLabel and increment or offset must be specified.
Optional argument
elements
A tuple or a sequence of MeshElement objects or a Set object containing elements to be renumbered
or offset. If unspecified, the entire part will be renumbered.

Return value
None

Exceptions
Renumbering is attempted on a native part:
Error: Renumbering can be applied to orphan mesh parts only
Renumbering data is specified incorrectly:
Error: Either startLabel and increment or offset must be specified
Renumbering will result in invalid labels:
Error: Specified data will result in invalid labels
Renumbering will result in conflicting labels:
Error: Specified data will result in conflicting labels

16.2.17 renumberNode(...)
This method assigns new labels to orphan mesh nodes.

Arguments
Required arguments
startLabel
A positive Int specifying the new label for the first node in nodes.

16–18

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

increment
A positive Int specifying the increment used for computation of new labels for all consecutive
nodes in nodes.
offset
An Int by which labels of nodes in nodes will be offset.
Note: Either both startLabel and increment or offset must be specified.
Optional argument
nodes
A tuple or a sequence of MeshNode objects or a Set object containing nodes to be renumbered or
offset. If unspecified, the entire part will be renumbered.

Return value
None

Exceptions
Renumbering is attempted on a native part:
Error: Renumbering can be applied to orphan mesh parts only
Renumbering data is specified incorrectly:
Error: Either startLabel and increment or offset must be specified
Renumbering will result in invalid labels:
Error: Specified data will result in invalid labels
Renumbering will result in conflicting labels:
Error: Specified data will result in conflicting labels

16.2.18 setElementSize(...)
This method sets the global element size for an orphan mesh part.

Arguments
Required argument
size
A Float specifying the desired element size.
Optional arguments
None.

Return value
None

16–19

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Exceptions
None.

16.2.19 splitElement(...)
This method splits quadrilateral elements of an orphan mesh part or a Abaqus native mesh into triangular
elements.

Arguments
Required argument
elements
A sequence of quadrilateral MeshElement objects specifying the elements to split. Each
quadrilateral element is split into two triangular elements by the shorter diagonal.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.20 splitMeshEdge(...)
This method splits an edge of a quadrilateral or triangular element of an orphan mesh part or an Abaqus
native mesh.

Arguments
Required argument
edge
A single MeshEdge object specifying the element edge to split.
Optional argument
parameter
A Float specifying the normalized distance along edge at which to split. Possible values are 0.0
parameter 1.0. The default value is 0.5.

16–20

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Return value
None

Exceptions
None.

16.2.21 swapMeshEdge(...)
This method swaps the diagonal of two adjacent triangular elements of an orphan mesh part or an Abaqus
native mesh.

Arguments
Required argument
edge
A single MeshEdge object specifying the element edge to swap.
Optional arguments
None.

Return value
None

Exceptions
None.

16.2.22 wrapMesh(...)
This method wraps a planar orphan mesh part about the Z-axis.

Arguments
Required argument
radius
A Float specifying the radius of the cylinder about which the part is to be wrapped. The wrapping
procedure will relocate a node at point ( , ) on the planar mesh to ( ), where is the specified
radius, = , and = .
Optional arguments
None.

16–21

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Return value
None

Exceptions
None.

16.2.23 redoMeshEdit()
This method executes the edit mesh or the bottom-up meshing operation most recently undone by the
undoMeshEdit method on an part. A redo action must be currently available for the part. This implies
that the user must have executed the undoMeshEdit method on the part and that the user has not
subsequently executed any further edit mesh commands on the assembly. It also implies that the user
provided a sufficient cache allowance to store the undo operation.

Arguments
None.

Return value
None

Exceptions
None.

16.2.24 undoMeshEdit()
This method undoes the most recent edit mesh or the bottom-up meshing operation on a part and restores
the mesh to its previous state. An edit mesh undo action must be available for the part. This implies that
prior to executing an edit mesh command on the part, the user enabled edit mesh undo with a sufficient
cache allowance to store the edit mesh operation.

Arguments
None.

Return value
None

16–22

Abaqus ID:
Printed on:
 EDIT MESH COMMANDS

Exceptions
None.

16.3 MeshEditOptions object

The MeshEditOptions object stores settings that specify the behavior when editing meshes on parts or
part instances.
The MeshEditOptions object has no constructor. Abaqus creates the MeshEditOptions member
when a session is started.

Access
mdb.meshEditOptions

16.3.1 setValues(...)
This method modifies the MeshEditOptions object.

Arguments
Required arguments
None.
Optional arguments
maxUndoCacheElements
A Float specifying the maximum allowable mesh edit undo cache size in millions of elements. If
this value is set to at least the number of elements on a given part or part instance, at least one
level of undo/redo capability is assured for subsequent mesh edit operations on that part or part
instance. The default value is 0.0.
enableUndo
A Boolean specifying whether undo/redo of mesh edit operations will be enabled. If
enableUndo=OFF any existing cache for undo/redo operations will be cleared for all parts and
assemblies in all models. The default value is OFF.
_suspendUndo
A Boolean specifying the suspension of undo/redo for mesh edit operations. When undo/redo is
suspended, undo/redo will not be available after subsequent mesh edit operations on a given part
or part instances. Any pre-existing cache for mesh edit operations on other parts or assemblies in
any model will be unaffected. The default value is OFF.
If you change the value of enableUndo to True, Abaqus sets _suspendUndo to False.

16–23

Abaqus ID:
Printed on:
EDIT MESH COMMANDS

Return value
None

Exceptions
None.

16.3.2 Members
The MeshEditOptions object has members with the same names and descriptions as the arguments to the
setValues method.

16–24

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

17. Engineering Feature commands

A specific type of engineering feature object is designed for each type of engineering feature.

17.1 EngineeringFeature object

The EngineeringFeature object is a container for various specific engineering feature repositories. The
EngineeringFeature object has no explicit constructor or methods.

Access
import part
mdb.models[name].parts[name].engineeringFeatures
import assembly
mdb.models[name].rootAssembly.engineeringFeatures

17.1.1 assignSeam(...)
This method creates a seam crack along an edge or a face.

Arguments
Required argument
regions
A sequence of Region objects specifying the domain of the seam crack. The Region objects must
be faces or edges.
Optional arguments
None.

Return value
None

Exceptions
None.

17.1.2 deleteSeam(...)
This method deletes a seam crack.

17–1

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Arguments
Required argument
regions
A sequence of Region objects specifying the domain of the seam crack. The Region objects must
be faces or edges.
Optional arguments
None.

Return value
None

Exceptions
None.

17.1.3 Members
The EngineeringFeature object can have the following members:
inertias
A repository of Inertia objects.
cracks
A repository of Crack objects.
fasteners
A repository of Fastener objects.
springDashpots
A repository of SpringDashpot objects.

17.2 ContourIntegral object

The ContourIntegral object defines contour integral objects on an region. Currently only assembly
regions are supported.
The ContourIntegral object is derived from the Crack object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.cracks[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.cracks[name]

17–2

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

17.2.1 ContourIntegral(...)
This method creates a ContourIntegral object. Although the constructor is available both for parts and
for the assembly, ContourIntegral objects are currently supported only under the assembly.

Path
mdb.models[name].parts[name].engineeringFeatures.ContourIntegral
mdb.models[name].rootAssembly.engineeringFeatures.ContourIntegral

Required arguments
name
A String specifying the repository key.
crackFront
A RegionArray object specifying the crack-front region to which the contour integral is applied. If
the crack-front consists of a single region, a Region object may be specified instead of a sequence
with a single item in it.
crackTip
A RegionArray object specifying the crack-tip region to which the contour integral is applied. If
the crack-tip consists of a single region, a Region object may be specified instead of a sequence
with a single item in it.
extensionDirectionMethod
A SymbolicConstant specifying how the virtual crack extension direction vectors are defined.
Possible values are CRACK_NORMAL and Q_VECTORS.
Optional arguments
symmetric
A Boolean specifying whether the crack is defined on a half model (about a symmetry plane) or
whether it is defined on the whole model. The default value is OFF.
listOfRegions
A Boolean specifying whether the regions specified by crackFront and crackTip are specified using
a single region or tuples of region objects. The default value is OFF.
crackFrontName
A String specifying the name of the crack-front region generated from the tuple of regions
specifying the crack-front region. This argument is valid only when listOfRegions is ON. The
default value is name+“Front.”
crackTipName
A String specifying the name of the crack-tip region generated from the tuple of regions specifying
the crack-tip region. This parameter is valid only when listOfRegions=ON. The default value is
name+“Tip.”

17–3

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

crackNormal
A sequence of sequences of Floats specifying the two points of the vector that describes the
crack normal direction. Each point is defined by a tuple of two or three coordinates indicating its
position. This argument is required only when extensionDirectionMethod=CRACK_NORMAL.
The default value is an empty sequence.
qVectors
A sequence of sequences of sequences of Floats specifying the vectors that indicate the set of crack
extension directions. Each vector is described by a tuple of two points, and each point is described
by a tuple of two or three coordinates indicating its position. This argument is required only when
extensionDirectionMethod=Q_VECTORS. The default value is an empty sequence.
midNodePosition
A Float specifying the position of the midside node along the edges of the second-order elements
that radiate from the crack tip. Possible values are 0.0 midNodeParameter 1.0. The default
value is 0.5.
collapsedElementAtTip
A SymbolicConstant specifying the crack-tip singularity. Possible values are NONE,
SINGLE_NODE, and DUPLICATE_NODES. The default value is NONE.

Return value
A ContourIntegral object.

Exceptions
None.

17.2.2 setValues(...)
This method modifies the ContourIntegral object.

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

Return value
None

17–4

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

Exceptions
None.

17.2.3 Members
The ContourIntegral object has members with the same names and descriptions as the arguments to the
ContourIntegral method.
In addition, the ContourIntegral object has the following member:
suppressed
A Boolean specifying whether the crack is suppressed or not. The default value is OFF.

17.2.4 Corresponding analysis keywords

*CONTOUR INTEGRAL

17.3 Crack object

The Crack object is the abstract base type for ContourIntegral and future crack objects.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.cracks[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.cracks[name]

17.3.1 resume()
This method resumes the crack that was previously suppressed.

Arguments
None.

Return value
None

17–5

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Exceptions
None.

17.3.2 suppress()
This method suppresses the crack.

Arguments
None.

Return value
None

Exceptions
None.

17.3.3 Members
The Crack object has the following members:
name
A String specifying the repository key.
suppressed
A Boolean specifying whether the crack is suppressed or not. The default value is OFF.

17.4 DiscreteFastener object

The DiscreteFastener object defines a discrete fastener.

The DiscreteFastener object is derived from the Fastener object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.fasteners[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.fasteners[name]

17–6

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

17.4.1 DiscreteFastener(...)
This method creates a DiscreteFastener object. Although the constructor is available both for parts and
for the assembly, DiscreteFastener objects are currently supported only under the assembly.

Path
mdb.models[name].parts[name].engineeringFeatures.DiscreteFastener
mdb.models[name].rootAssembly.engineeringFeatures.DiscreteFastener

Required arguments
name
A String specifying the repository key.
region
A Region object specifying the region to which the fastener is applied.
influenceRadius
The SymbolicConstant WHOLE_SURFACE or a Float specifying the coupling influence radius.
Optional arguments
ur1
A Boolean specifying whether to constrain rotational displacement component about the
1-direction. The default value is ON.
ur2
A Boolean specifying whether to constrain rotational displacement component about the
2-direction. The default value is ON.
ur3
A Boolean specifying whether to constrain rotational displacement component about the
3-direction. The default value is ON.
coupling
A SymbolicConstant specifying the coupling method used to couple the displacement and rotation
of each attachment point to the average motion of the surface nodes within the radius of influence
from the fastening point. Possible values are CONTINUUM and STRUCTURAL. The default
value is CONTINUUM.
weightingMethod
A SymbolicConstant specifying the weighting scheme to be used to weight the contribution
of the displacements of the surface nodes within the radius of influence to the motion of the
fastening point. UNIFORM, LINEAR, QUADRATIC, and CUBIC indicate uniform, linear
decreasing, quadratic polynomial decreasing, and cubic polynomial monotonic decreasing weight
distributions. Possible values are UNIFORM, LINEAR, QUADRATIC, and CUBIC. The default
value is UNIFORM.

17–7

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

localCsys
None or a DatumCsys object specifying the local coordinate system of fastener couplings. If
localCsys=None, couplings are defined in the global coordinate system. When this member is
queried, it returns an Int. The default value is None.

Return value
A DiscreteFastener object.

Exceptions
None.

17.4.2 setValues(...)
This method modifies the DiscreteFastener object.

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

Return value
None

Exceptions
None.

17.4.3 Members
The DiscreteFastener object has members with the same names and descriptions as the arguments to the
DiscreteFastener method.
In addition, the DiscreteFastener object has the following member:
suppressed
A Boolean specifying whether the fastener is suppressed or not. The default value is OFF.

17.4.4 Corresponding analysis keywords

*COUPLING, *DISTRIBUTING

17–8

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

17.5 Fastener object

The Fastener object is the abstract base type for PointFastener and DiscreteFastener .

Access
import part
mdb.models[name].parts[name].engineeringFeatures.fasteners[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.fasteners[name]

17.5.1 resume()
This method resumes the fastener that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

17.5.2 suppress()
This method suppresses the fastener.

Arguments
None.

Return value
None

Exceptions
None.

17–9

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

17.5.3 Members
The Fastener object has the following members:
name
A String specifying the repository key.
suppressed
A Boolean specifying whether the fastener is suppressed or not. The default value is OFF.

17.6 HeatCapacitance object

The HeatCapacitance object defines point heat capacitance on a part or an assembly region.
The HeatCapacitance object is derived from the Inertia object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.inertias[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.inertias[name]

17.6.1 HeatCapacitance(...)
This method creates a HeatCapacitance object.

Path
mdb.models[name].parts[name].engineeringFeatures.HeatCapacitance
mdb.models[name].rootAssembly.engineeringFeatures.HeatCapacitance

Required arguments
name
A String specifying the repository key.
region
A Region object specifying the region to which the heat capacitance is applied.
table
A sequence of sequences of Floats specifying heat capacitance properties. The items in the table
data are described below.

17–10

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
The table data specify the following:
• Heat capacitance magnitude, (density × specific heat × volume).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A HeatCapacitance object.

Exceptions
None.

17.6.2 setValues(...)
This method modifies the HeatCapacitance object.

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

Return value
None

Exceptions
None.

17–11

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

17.6.3 Members
The HeatCapacitance object has members with the same names and descriptions as the arguments to the
HeatCapacitance method.
In addition, the HeatCapacitance object has the following member:
suppressed
A Boolean specifying whether the inertia is suppressed or not. The default value is OFF.

17.6.4 Corresponding analysis keywords

*HEATCAP

17.7 Inertia object

The Inertia object is the abstract base type for HeatCapacitance , NonstructuralMass , and
PointMassInertia .

Access
import part
mdb.models[name].parts[name].engineeringFeatures.inertias[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.inertias[name]

17.7.1 resume()
This method resumes the inertia that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

17–12

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

17.7.2 suppress()
This method suppresses the inertia.

Arguments
None.

Return value
None

Exceptions
None.

17.7.3 Members
The Inertia object has the following members:
name
A String specifying the repository key.
suppressed
A Boolean specifying whether the inertia is suppressed or not. The default value is OFF.

17.8 NonstructuralMass object

The NonstructuralMass object defines the mass contribution from nonstructural features into the model.
The NonstructuralMass object is derived from the Inertia object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.inertias[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.inertias[name]

17.8.1 NonstructuralMass(...)
This method creates a NonstructuralMass object.

17–13

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Path
mdb.models[name].parts[name].engineeringFeatures.NonstructuralMass
mdb.models[name].rootAssembly.engineeringFeatures.NonstructuralMass

Required arguments
name
A String specifying the repository key.
region
A Region object specifying the region to which the mass is applied.
units
A SymbolicConstant specifying the units used to specify the nonstructural mass. Possible values
are TOTAL_MASS, MASS_PER_VOLUME, MASS_PER_AREA, and MASS_PER_LENGTH.
magnitude
A Float specifying the mass magnitude.
Optional argument
distribution
A SymbolicConstant specifying the distribution of the nonstructural mass. Possible values
are MASS_PROPORTIONAL and VOLUME_PROPORTIONAL. The default value is
MASS_PROPORTIONAL.
The distribution argument applies only when units=TOTAL_MASS.

Return value
A NonstructuralMass object.

Exceptions
None.

17.8.2 setValues(...)
This method modifies the NonstructuralMass object.

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

17–14

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

Return value
None

Exceptions
None.

17.8.3 Members
The NonstructuralMass object has members with the same names and descriptions as the arguments to
the NonstructuralMass method.
In addition, the NonstructuralMass object has the following member:
suppressed
A Boolean specifying whether the inertia is suppressed or not. The default value is OFF.

17.8.4 Corresponding analysis keywords

*NONSTRUCTURAL MASS

17.9 PointFastener object

The PointFastener object defines a point fastener.

The PointFastener object is derived from the Fastener object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.fasteners[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.fasteners[name]

17.9.1 PointFastener(...)
This method creates a PointFastener object. Although the constructor is available both for parts and for
the assembly, PointFastener objects are currently supported only under the assembly.

17–15

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Path
mdb.models[name].parts[name].engineeringFeatures.PointFastener
mdb.models[name].rootAssembly.engineeringFeatures.PointFastener

Required arguments
name
A String specifying the repository key.
region
A Region object specifying the region to which fasteners are applied.
physicalRadius
A Float specifying the physical fastener radius.
Optional arguments
directionVector
A VertexArray object of length 2 specifying the direction of projection. Instead of through a Vertex
, each point may be specified through a tuple of coordinates. The default value is None.
targetSurfaces
The SymbolicConstant MODEL or a Region object specifying surfaces to be fastened. The default
value is MODEL.
ur1
A Boolean specifying whether to constrain rotational displacement component about the
1-direction. The default value is ON.
ur2
A Boolean specifying whether to constrain rotational displacement component about the
2-direction. The default value is ON.
ur3
A Boolean specifying whether to constrain rotational displacement component about the
3-direction. The default value is ON.
attachmentMethod
A SymbolicConstant specifying the method used to locate points for attaching fasteners. Possible
values are FACETOFACE, EDGETOFACE, FACETOEDGE, and EDGETOEDGE. The default
value is FACETOFACE.
influenceRadius
The SymbolicConstant DEFAULT or a Float specifying the maximum distance from the projection
point on a connected surface within which the nodes on that surface must lie to contribute to the
motion of the projection point. If the value is DEFAULT, a radius is computed from the fastener
diameter and the surface facet lengths. The default value is DEFAULT.

17–16

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

searchRadius
The SymbolicConstant DEFAULT or a Float specifying the distance from the positioning points
within which the connected points must lie. The default value is DEFAULT.
maximumLayers
The SymbolicConstant ALL or an Int specifying the maximum number of layers for each fastener.
If the value is ALL, the maximum possible number of layers within the searchRadius will be used
for each fastener. The default value is ALL.
coupling
A SymbolicConstant specifying the coupling method used to couple the displacement and rotation
of each attachment point to the average motion of the surface nodes within the radius of influence
from the fastener projection point. Possible values are CONTINUUM and STRUCTURAL. The
default value is CONTINUUM.
weightingMethod
A SymbolicConstant specifying the weighting scheme to be used to weight the contribution of
the displacements of the surface nodes within the radius of influence to the motion of the fastener
projection point. UNIFORM, LINEAR, QUADRATIC, and CUBIC indicate uniform, linear
decreasing, quadratic polynomial decreasing, and cubic polynomial monotonic decreasing weight
distributions. Possible values are UNIFORM, LINEAR, QUADRATIC, and CUBIC. The default
value is UNIFORM.
additionalMass
A Float specifying the mass that will be distributed to fastener attachment points. The default
value is 0.0.
adjustOrientation
A Boolean specifying whether to adjust localCsys such that the local z-axis for each fastener is
normal to the surface that is closest to the reference node for that fastener. The default value is ON.
localCsys
None or a DatumCsys object specifying the local coordinate system. If localCsys=None, the
global coordinate system is used. When this member is queried, it returns an Int. The default
value is None.
connectionType
A SymbolicConstant specifying the fastener connection type. Possible values are CONNECTOR
and BEAM_MPC. The default value is CONNECTOR.
sectionName
A String specifying the connector section assigned to generated connectors. The default value is
an empty string.
connectorOrientationLocalCsys1
None or a DatumCsys object specifying the local coordinate system of the first connector point
in generated connectors. If connectorOrientationLocalCsys1=None, the degrees of freedom are
defined in the global coordinate system. When this member is queried, it returns an Int. The default
value is None.

17–17

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

axis1
A SymbolicConstant specifying the axis of a datum coordinate system about which an additional
rotation is applied for the first point in generated connectors. Possible values are AXIS_1, AXIS_2,
and AXIS_3. The default value is AXIS_1.
angle1
A Float specifying the angle of the additional rotation for the first point in generated connectors.
The default value is 0.0.
orient2SameAs1
A Boolean specifying whether or not the second connector point in generated connectors is to use
the same local coordinate system, axis, and angle as the first point. The default value is ON.
connectorOrientationLocalCsys2
None or a DatumCsys object specifying the local coordinate system of the second connector point
in generated connectors. If connectorOrientationLocalCsys2=None, the degrees of freedom are
defined in the global coordinate system. When this member is queried, it returns an Int. The default
value is None.
axis2
A SymbolicConstant specifying the axis of a datum coordinate system about which an additional
rotation is applied for the second point in generated connectors. Possible values are AXIS_1,
AXIS_2, and AXIS_3. The default value is AXIS_1.
angle2
A Float specifying the angle of the additional rotation for the second point in generated connectors.
The default value is 0.0.
unsorted
A Boolean specifying whether the analysis product should leave targetSurfaces in the given
unsorted order, or sort them by proximity to determine the connectivity of fastening points. The
default value is OFF.

Return value
A PointFastener object.

Exceptions
None.

17.9.2 setValues(...)
This method modifies the PointFastener object.

17–18

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

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

Return value
None

Exceptions
None.

17.9.3 Members
The PointFastener object has members with the same names and descriptions as the arguments to the
PointFastener method.
In addition, the PointFastener object has the following member:
suppressed
A Boolean specifying whether the fastener is suppressed or not. The default value is OFF.

17.9.4 Corresponding analysis keywords

*FASTENER

17.10 PointMassInertia object

The PointMassInertia object defines point masses and point rotary inertia on a part or an assembly region.
The PointMassInertia object is derived from the Inertia object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.inertias[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.inertias[name]

17–19

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

17.10.1 PointMassInertia(...)
This method creates a PointMassInertia object.

Path
mdb.models[name].parts[name].engineeringFeatures.PointMassInertia
mdb.models[name].rootAssembly.engineeringFeatures.PointMassInertia

Required arguments
name
A String specifying the repository key.
region
A Region object specifying the region to which the mass or rotary inertia is applied.
Optional arguments
mass
A Float specifying the mass magnitude. The default value is 0.0.
i11
A Float specifying the rotary inertia about the local 1-axis, . The default value is 0.0.
i22
A Float specifying the rotary inertia about the local 2-axis, . The default value is 0.0.
i33
A Float specifying the rotary inertia about the local 3-axis, . The default value is 0.0.
i12
A Float specifying the product of inertia, . The default value is 0.0.
i13
A Float specifying the product of inertia, . The default value is 0.0.
i23
A Float specifying the product of inertia, . The default value is 0.0.
localCsys
None or a DatumCsys object specifying the local coordinate system for the rotary inertia. If
localCsys=None, the rotary inertia data are defined in the global coordinate system. The default
value is None.
alpha
A Float specifying the alpha damping magnitude. The default value is 0.0.
This argument applies only to Abaqus/Standard analyses.
composite
A Float specifying the composite damping magnitude. The default value is 0.0.
This argument applies only to Abaqus/Standard analyses.

17–20

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

Return value
A PointMassInertia object.

Exceptions
None.

17.10.2 setValues(...)
This method modifies the PointMassInertia object.

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

Return value
None

Exceptions
None.

17.10.3 Members
The PointMassInertia object has members with the same names and descriptions as the arguments to the
PointMassInertia method.
In addition, the PointMassInertia object has the following member:
suppressed
A Boolean specifying whether the inertia is suppressed or not. The default value is OFF.

17.10.4 Corresponding analysis keywords

*MASS, *ROTARY INERTIA

17–21

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

17.11 SpringDashpot object

The SpringDashpot object is the abstract base type for the SpringDashpotToGround and
TwoPointSpringDashpot objects.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.springDashpots[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.springDashpots[name]

17.11.1 resume()
This method resumes the spring/dashpot that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

17.11.2 suppress()
This method suppresses the spring/dashpot.

Arguments
None.

Return value
None

Exceptions
None.

17–22

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

17.11.3 Members
The SpringDashpot object has the following members:
name
A String specifying the repository key.
suppressed
A Boolean specifying whether the spring/dashpot is suppressed or not. The default value is OFF.

17.12 SpringDashpotToGround object

The SpringDashpotToGround object defines springs and/or dashpots between points and ground on a
part or an assembly region.
The SpringDashpotToGround object is derived from the SpringDashpot object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.springDashpots[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.springDashpots[name]

17.12.1 SpringDashpotToGround(...)
This method creates a SpringDashpotToGround object.

Path
mdb.models[name].parts[name].engineeringFeatures.SpringDashpotToGround
mdb.models[name].rootAssembly.engineeringFeatures\
.SpringDashpotToGround

Required arguments
name
A String specifying the repository key.
region
A Region object specifying the region to which the springs and/or dashpots are applied.
dof
An Int specifying the degree of freedom associated with the spring and dashpot behaviors.

17–23

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Optional arguments
orientation
None or a DatumCsys object specifying the local directions for the spring and/or dashpot. If
orientation=None, the spring and/or dashpot data are defined in the global coordinate system.
The default value is None.
springBehavior
A Boolean specifying whether to apply spring behavior to the selected points. The default value
is OFF.
At least one of the arguments springBehavior=ON or dashpotBehavior=ON must be
specified.
dashpotBehavior
A Boolean specifying whether to apply dashpot behavior to the selected points. The default value
is OFF.
At least one of the arguments springBehavior=ON or dashpotBehavior=ON must be
specified.
springStiffness
A Float specifying the force per relative displacement for the spring. The default value is 0.0.
dashpotCoefficient
A Float specifying the force per relative velocity for the dashpot. The default value is 0.0.

Return value
A SpringDashpotToGround object.

Exceptions
None.

17.12.2 setValues(...)
This method modifies the SpringDashpotToGround object.

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

Return value
None

17–24

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

Exceptions
None.

17.12.3 Members
The SpringDashpotToGround object has members with the same names and descriptions as the arguments
to the SpringDashpotToGround method.
In addition, the SpringDashpotToGround object has the following member:
suppressed
A Boolean specifying whether the spring/dashpot is suppressed or not. The default value is OFF.

17.12.4 Corresponding analysis keywords

*ELEMENT, TYPE=SPRING1; *ELEMENT, TYPE=DASHPOT1; *SPRING; *DASHPOT

17.13 TwoPointSpringDashpot object

The TwoPointSpringDashpot object defines springs and/or dashpots between two points on a part or an
assembly.
The TwoPointSpringDashpot object is derived from the SpringDashpot object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.springDashpots[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.springDashpots[name]

17.13.1 TwoPointSpringDashpot(...)
This method creates a TwoPointSpringDashpot object.

Path
mdb.models[name].parts[name].engineeringFeatures.TwoPointSpringDashpot
mdb.models[name].rootAssembly.engineeringFeatures\
.TwoPointSpringDashpot

17–25

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Required arguments
name
A String specifying the repository key.
regionPairs
A sequence of pairs of Region objects specifying the points between which the springs and/or
dashpots are applied.
axis
A SymbolicConstant specifying whether the axis of the springs and/or dashpots follows the rotation
of the nodes or is in a specified direction. Possible values are NODAL_LINE and FIXED_DOF.
Optional arguments
dof1
An Int specifying the degree of freedom with which the springs and/or dashpots are associated at
their first points. The dof1 argument applies only when axis=FIXED_DOFS. The default value is
0.
dof2
An Int specifying the degree of freedom with which the springs and/or dashpots are associated at
their second points. The dof2 argument applies only when axis=FIXED_DOFS. The default value
is 0.
orientation
None or a DatumCsys object specifying the local directions for the spring and/or dashpot. If
orientation=None, the spring and/or dashpot data are defined in the global coordinate system.
The default value is None.
The orientation argument applies only when axis=FIXED_DOFS.
springBehavior
A Boolean specifying whether to apply spring behavior to the selected point pairs. The default
value is OFF.
At least one of the arguments springBehavior=ON or dashpotBehavior=ON must be
specified.
dashpotBehavior
A Boolean specifying whether to apply dashpot behavior to the selected point pairs. The default
value is OFF.
At least one of the arguments springBehavior=ON or dashpotBehavior=ON must be
specified.
springStiffness
A Float specifying the force per relative displacement for the springs. The default value is 0.0.
dashpotCoefficient
A Float specifying the force per relative velocity for the dashpots. The default value is 0.0.

17–26

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

Return value
A TwoPointSpringDashpot object.

Exceptions
None.

17.13.2 setValues(...)
This method modifies the TwoPointSpringDashpot object.

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

Return value
None

Exceptions
None.

17.13.3 Members
The TwoPointSpringDashpot object has members with the same names and descriptions as the arguments
to the TwoPointSpringDashpot method.
In addition, the TwoPointSpringDashpot object has the following member:
suppressed
A Boolean specifying whether the spring/dashpot is suppressed or not. The default value is OFF.

17.13.4 Corresponding analysis keywords

*ELEMENT, TYPE=SPRINGA; *ELEMENT, TYPE=SPRING2; *ELEMENT,

TYPE=DASHPOTA; *ELEMENT, TYPE=DASHPOT2; *SPRING; *DASHPOT

17–27

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

17.14 XFEMCrack object

The XFEMCrack object defines the parameters needed to model crack initiation or crack growth using
XFEM technology. Currently only assembly regions are supported.
The XFEMCrack object is derived from the Crack object.

Access
import part
mdb.models[name].parts[name].engineeringFeatures.cracks[name]
import assembly
mdb.models[name].rootAssembly.engineeringFeatures.cracks[name]

17.14.1 XFEMCrack(...)
This method creates a XFEMCrack object. Although the constructor is available both for parts and for
the assembly, XFEMCrack objects are currently supported only under the assembly.

Path
mdb.models[name].parts[name].engineeringFeatures.XFEMCrack
mdb.models[name].rootAssembly.engineeringFeatures.XFEMCrack

Required arguments
name
A String specifying the repository key.
crackDomain
A Region object specifying the region that contains the crack or is likely to contain the crack.
Optional arguments
allowCrackGrowth
A Boolean specifying whether the crack is allowed to propagate (grow). The default value is ON.
crackLocation
A Region object specifying the initial crack location. This parameter is required when
allowCrackGrowth=OFF.
singularityCalcRadius
None or a Float specifying the radius from the crack tips within which the elements are used for
crack singularity calculations. This argument applies only when allowCrackGrowth=OFF. The
default value is None.

17–28

Abaqus ID:
Printed on:
 ENGINEERING FEATURE COMMANDS

interactionProperty
A String specifying the name of the ContactProperty object that defines the contact properties for
the crack surfaces. The default value is an empty string.
elemId
A sequence of Ints specifying the labels of the elements that are intersected by the initial crack
location. This argument is used only by the input file reader.
nodeId
A sequence of Ints specifying the position of a node in the corresponding element connectivity.
This argument is used only by the input file reader.
hasCrackFront
A sequence of Ints specifying the values indicating the inclusion/exclusion of the crackFrontDist
values. A zero value indicates that crackFrontDist is not specified for the ith pair elemId and
nodeId. This argument is used only by the input file reader.
crackPlaneDist
A sequence of Floats specifying the values of the first signed distance function. This argument is
used by the input file reader.
crackFrontDist
A sequence of Floats specifying the values of the second signed distance function. This argument
is used only by the input file reader.

Return value
A XFEMCrack object.

Exceptions
None.

17.14.2 setValues(...)
This method modifies the XFEMCrack object.

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

Return value
None

17–29

Abaqus ID:
Printed on:
ENGINEERING FEATURE COMMANDS

Exceptions
None.

17.14.3 Members
The XFEMCrack object has members with the same names and descriptions as the arguments to the
XFEMCrack method.
In addition, the XFEMCrack object has the following member:
suppressed
A Boolean specifying whether the crack is suppressed or not. The default value is OFF.

17.14.4 Corresponding analysis keywords

*ENRICHMENT

*INITIAL CONDITIONS, TYPE=ENRICHMENT

17–30

Abaqus ID:
Printed on:
 FEATURE COMMANDS

18. Feature commands

Features in Abaqus/CAE include Parts, Datums, Partitions, and Assembly operations. The commands
that create Feature objects on only the Part object are described in Chapter 33, “Part commands.” The
commands that create Feature objects in only the rootAssembly object are described in Chapter 5,
“Assembly commands.” The commands that create Feature objects on both the Part and the
rootAssembly objects are described here.

18.1 Feature object

Abaqus/CAE is a feature-based modeling system, and features are stored in the Feature object. The
user defines the parameters of the feature, and Abaqus/CAE modifies the model based on the value of
the parameters. This evaluation of the parameters is called regeneration of the feature. Feature objects
contain both the parameters and the resulting model modification.

Access
import part
mdb.models[name].parts[name].features[name]
mdb.models[name].parts[name].featuresById[i]
import assembly
mdb.models[name].rootAssembly.features[name]
mdb.models[name].rootAssembly.featuresById[i]

18.1.1 AttachmentPoints(...)
This method creates an attachment points Feature. Attachment points may be created using datum
points, vertices, reference points, attachment points, interesting points, orphan mesh nodes or
coordinates. Optionally, the attachment points can be projected on geometric faces or element faces.

Path
mdb.models[name].parts[name].AttachmentPoints
mdb.models[name].rootAssembly.AttachmentPoints

Required arguments
name
A String specifying a unique Feature name.

18–1

Abaqus ID:
Printed on:
FEATURE COMMANDS

points
A tuple of points. Each point can be a Vertex, Datum point, Reference point, Attachment point,
orphan mesh Node, Interesting point object, or a tuple of Floats representing the coordinates of a
point.
Optional arguments
projectionMethod
A SymbolicConstant specifying the projection method. Possible values are
PROJECT_BY_PROXIMITY and PROJECT_BY_DIRECTION. The default value is
PROJECT_BY_PROXIMITY.
projectOnFaces
A sequence of Face objects specifying the geometry faces onto which the points are to be projected.
projectOnElementFaces
A sequence of MeshFace objects specifying the orphan mesh element faces onto which the points
are to be projected.
projectionDirStartPt
A point specifying the start point of the projection direction. The point can be a Vertex, Datum
point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or a tuple
of Floats representing the coordinates of a point.
projectionDirEndPt
A point specifying the end point of the projection direction. The point can be a Vertex, Datum
point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or a tuple
of Floats representing the coordinates of a point.
setName
A String specifying a unique set name.

Return value
A Feature object.

Exceptions
None.

18.1.2 AttachmentPointsAlongDirection(...)
This method creates a Feature object by creating attachment points along a direction or between two
points. A Datum point, a Vertex, a Reference point, an Attachment point, an Interesting point, or an
orphan mesh Node can be specified as the start or end point. The direction can be specified using a
straight edge or a datum axis.

18–2

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Path
mdb.models[name].parts[name].AttachmentPointsAlongDirection
mdb.models[name].rootAssembly.AttachmentPointsAlongDirection

Required arguments
name
A String specifying a unique Feature name.
startPoint
A point specifying the start point of the direction along which to create points. The point can be
a Vertex, Datum point, Reference point, Attachment point, orphan mesh Node, Interesting point
object, or a tuple of Floats representing the coordinates of a point.
pointCreationMethod
A SymbolicConstant specifying the point creation method. Possible values are AUTO_FIT,
NUM_PTS_ALONG_DIR, and NUM_PTS_BETWEEN_PTS.
Optional arguments
endPoint
A point specifying the end point if creating points between two points. The point can be a Vertex,
Datum point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or
a tuple of Floats representing the coordinates of a point.
direction
The direction can be specified by a straight edge or a datum axis.
spacing
A float specifying the spacing to be used between two points.
numPtsAlongDir
An integer specifying the number of points to be created along the specified direction.
numPtsBetweenPts
An integer specifying the number of points to be created between the start and end points.
createPtAtStartPt
A Boolean specifying whether to create an attachment point at the start point. The default value is
True.
createPtAtEndPt
A Boolean specifying whether to create an attachment point at the end point. The default value is
True.
projectionMethod
A SymbolicConstant specifying the projection method. Possible values are
PROJECT_BY_PROXIMITY and PROJECT_BY_DIRECTION. The default value is
PROJECT_BY_PROXIMITY.

18–3

Abaqus ID:
Printed on:
FEATURE COMMANDS

projectOnFaces
A sequence of Face objects specifying the geometry faces onto which the points are to be projected.
projectOnElementFaces
A sequence of MeshFace objects specifying the orphan mesh element faces onto which the points
are to be projected.
projectionDirStartPt
A point specifying the start point of the projection direction. The point can be a Vertex, Datum
point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or a tuple
of Floats representing the coordinates of a point.
projectionDirEndPt
A point specifying the end point of the projection direction. The point can be a Vertex, Datum
point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or a tuple
of Floats representing the coordinates of a point.
flipDirection
A Boolean specifying if the direction along which the attachment points are created should be
reversed. This argument is valid only when pointCreationMethod=NUM_PTS_ALONG_DIR.
setName
A String specifying a unique set name.

Return value
A Feature object.

Exceptions
None.

18.1.3 AttachmentPointsOffsetFromEdges(...)
This method creates a Feature object by creating attachment points along or offset from one or more
connected edges.

Path
mdb.models[name].parts[name].AttachmentPointsOffsetFromEdges
mdb.models[name].rootAssembly.AttachmentPointsOffsetFromEdges

Required arguments
name
A String specifying a unique Feature name.

18–4

Abaqus ID:
Printed on:
 FEATURE COMMANDS

edges
A sequence of connected Edge objects specifying the geometry edges from which to offset the
points.
Optional arguments
startPoint
A Vertex of the selected edges that specifies the point from which to create points. This point can
be one of the two end vertices of the connected edges. In case of edges forming a closed loop and
having multiple vertices, this point can be any one of the vertices on the edges.
flipDirection
This parameter is required to indicate the direction in which to create the points. This parameter
is required only in case of edges forming a closed loop.
pointCreationMethod
A SymbolicConstant specifying the point creation method. Possible values are BY_NUMBER or
BY_SPACING.
numberOfPoints
An integer specifying the number of points to be created along the selected edges.
spacingBetweenPoints
A float specifying the spacing to be used between two points while creating the points between the
start and end points of the edges.
offsetFromStartPoint
A float specifying the distance by which to offset the first point from the start vertex of the edge
chain. The default value is 0.0.
offsetFromEndPoint
A float specifying the distance by which to offset the last point from the end vertex of the edge
chain. This parameter should be specified only if the point creation method is BY_NUMBER. The
default value is 0.0.
spacingMethod
A SymbolicConstant specifying the spacing method. Possible values are AUTO_FIT_PTS or
SPECIFY_NUM_PTS. The default value is AUTO_FIT_PTS.
patterningMethod
A SymbolicConstant specifying the method to pattern of points. Possible values are
PATTERN_ORTHOGONALLY or PATTERN_ALONG_DIRECTION.
referenceFace
A geometry Face object adjacent to one of the edges from which to offset the points to create a
pattern of points when the PATTERN_ORTHOGONALLY method is chosen for patterning. The
face is used to identify the patterning direction. If the number of rows is one and the initial offset
is zero, the reference face may not be specified.

18–5

Abaqus ID:
Printed on:
FEATURE COMMANDS

startPointForPatternDirection
A point specifying the start point of the direction along which to create a pattern of points when the
PATTERN_ALONG_DIRECTION method is chosen for patterning. The point can be a Vertex,
Datum point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or
a tuple of Floats representing the coordinates of a point.
endPointForPatternDirection
A point specifying the end point of the direction along which to create a pattern of points when the
PATTERN_ALONG_DIRECTION method is chosen for patterning. The point can be a Vertex,
Datum point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or
a tuple of Floats representing the coordinates of a point.
offsetFromEdges
A float specifying the distance by which to offset the first row of points from the edges.
numberOfRows
An integer specifying the number of rows of points to be created for the pattern. The default value
is 1.
spacingBetweenRows
A float specifying the spacing to be used between two rows while creating a pattern of points.
projectionMethod
A SymbolicConstant specifying the projection method. Possible values are
PROJECT_BY_PROXIMITY and PROJECT_BY_DIRECTION. The default value is
PROJECT_BY_PROXIMITY.
projectOnFaces
A sequence of Face objects specifying the geometry faces onto which the points are to be projected.
projectOnElementFaces
A sequence of MeshFace objects specifying the orphan mesh element faces onto which the points
are to be projected.
projectionDirStartPt
A point specifying the start point of the projection direction. The point can be a Vertex, Datum
point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or a tuple
of Floats representing the coordinates of a point.
projectionDirEndPt
A point specifying the end point of the projection direction. The point can be a Vertex, Datum
point, Reference point, Attachment point, orphan mesh Node, Interesting point object, or a tuple
of Floats representing the coordinates of a point.
setName
A String specifying a unique set name.

Return value
A Feature object.

18–6

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Exceptions
None.

18.1.4 DatumAxisByCylFace(...)
This method creates a Feature object and a DatumAxis object along the axis of a cylinder or cone.

Path
mdb.models[name].rootAssembly.DatumAxisByCylFace
mdb.models[name].parts[name].DatumAxisByCylFace

Required argument
face
A cylindrical or conical Face object.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.5 DatumAxisByNormalToPlane(...)
This method creates a Feature object and a DatumAxis object normal to the specified plane and passing
through the specified point.

Path
mdb.models[name].rootAssembly.DatumAxisByNormalToPlane
mdb.models[name].parts[name].DatumAxisByNormalToPlane

Required arguments
plane
A planar Face, an ElementFace, or a Datum object representing a datum plane.
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.

18–7

Abaqus ID:
Printed on:
FEATURE COMMANDS

Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.6 DatumAxisByParToEdge(...)
This method creates a Feature object and a DatumAxis object parallel to the specified edge and passing
through the specified point.

Path
mdb.models[name].rootAssembly.DatumAxisByParToEdge
mdb.models[name].parts[name].DatumAxisByParToEdge

Required arguments
edge
A straight Edge, an ElementEdge, or a Datum object representing a datum axis.
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.7 DatumAxisByPrincipalAxis(...)
This method creates a Feature object and a DatumAxis object along one of the three principal axes.

Path
mdb.models[name].rootAssembly.DatumAxisByPrincipalAxis

18–8

Abaqus ID:
Printed on:
 FEATURE COMMANDS

mdb.models[name].parts[name].DatumAxisByPrincipalAxis

Required argument
principalAxis
A SymbolicConstant specifying the principal axis. Possible values are XAXIS, YAXIS, and
ZAXIS.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.8 DatumAxisByRotation(...)
This method creates a Feature object and a DatumAxis object in a three-dimensional model by rotating
a line about the specified axis through the specified angle.

Path
mdb.models[name].rootAssembly.DatumAxisByRotation
mdb.models[name].parts[name].DatumAxisByRotation

Required arguments
line
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object specifying
the line to rotate.
axis
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object specifying
the axis about which to rotate the line.
angle
A Float specifying the angle in degrees to rotate the line.
Optional arguments
None.

Return value
A Feature object.

18–9

Abaqus ID:
Printed on:
FEATURE COMMANDS

Exceptions
AbaqusException.

18.1.9 DatumAxisByRotation(...)
This method creates a Feature object and a DatumAxis object in a two-dimensional model by rotating a
line about the specified point through the specified angle.

Path
mdb.models[name].rootAssembly.DatumAxisByRotation
mdb.models[name].parts[name].DatumAxisByRotation

Required arguments
line
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object specifying
the line to rotate.
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying the point about which to rotate the line.
angle
A Float specifying the angle in degrees to rotate the line.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.10 DatumAxisByThreePoint(...)
This method creates a Feature object and a DatumAxis object normal to the circle described by three
points and through its center.

Path
mdb.models[name].rootAssembly.DatumAxisByThreePoint

18–10

Abaqus ID:
Printed on:
 FEATURE COMMANDS

mdb.models[name].parts[name].DatumAxisByThreePoint

Required arguments
point1
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying the first point on the circle.
point2
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying the second point on the circle.
point3
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying the third point on the circle.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.11 DatumAxisByThruEdge(...)
This method creates a Feature object and a DatumAxis object along the specified edge.

Path
mdb.models[name].rootAssembly.DatumAxisByThruEdge
mdb.models[name].parts[name].DatumAxisByThruEdge

Required argument
edge
A straight Edge or an ElementEdge object.
Optional arguments
None.

Return value
A Feature object.

18–11

Abaqus ID:
Printed on:
FEATURE COMMANDS

Exceptions
AbaqusException.

18.1.12 DatumAxisByTwoPlane(...)
This method creates a Feature object and a DatumAxis object at the intersection of two planes.

Path
mdb.models[name].rootAssembly.DatumAxisByTwoPlane
mdb.models[name].parts[name].DatumAxisByTwoPlane

Required arguments
plane1
A planar Face, an ElementFace, or a Datum object representing a datum plane.
plane2
A planar Face, an ElementFace, or a Datum object representing a datum plane.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.13 DatumAxisByTwoPoint(...)
This method creates a Feature object and a DatumAxis object along the line joining two points.

Path
mdb.models[name].rootAssembly.DatumAxisByTwoPoint
mdb.models[name].parts[name].DatumAxisByTwoPoint

Required arguments
point1
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.

18–12

Abaqus ID:
Printed on:
 FEATURE COMMANDS

point2
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.14 DatumCsysByDefault(...)
This method creates a Feature object and a DatumCsys object from the specified default coordinate
system at the origin.

Path
mdb.models[name].rootAssembly.DatumCsysByDefault
mdb.models[name].parts[name].DatumCsysByDefault

Required argument
coordSysType
A SymbolicConstant specifying the default coordinate system to be used. Possible values are
CARTESIAN, CYLINDRICAL, and SPHERICAL.
Optional argument
name
A String specifying the name of the DatumCsys .

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.15 DatumCsysByOffset(...)
This method creates a Feature object and a DatumCsys object by offsetting the origin of an existing
datum coordinate system to a specified point.

18–13

Abaqus ID:
Printed on:
FEATURE COMMANDS

Path
mdb.models[name].rootAssembly.DatumCsysByOffset
mdb.models[name].parts[name].DatumCsysByOffset

Required arguments
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
datumCoordSys
A Datum object representing a datum coordinate system from which to offset.
vector
A sequence of three Floats specifying the X-, Y-, and Z-offsets from datumCoordSys. The
arguments vector and point are mutually exclusive, and one of them must be specified.
point
A Vertex , InterestingPoint , DatumPoint object or a sequence of three Floats specifying the X-, Y-,
and Z coordinates of a point in space. The point represents the origin of the new datum coordinate
system. The arguments vector and point are mutually exclusive, and one of them must be specified.
Optional argument
name
A String specifying the name of the DatumCsys .

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.16 DatumCsysByThreePoints(...)
This method creates a Feature object and a DatumCsys object from three points.

Path
mdb.models[name].parts[name].DatumCsysByThreePoints
mdb.models[name].rootAssembly.DatumCsysByThreePoints

18–14

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Required arguments
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
origin
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying the origin of the coordinate system.
point1
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying a point on the X-axis or the -axis. The point1 and line1 arguments are mutually
exclusive. One of them must be specified.
point2
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point
specifying a point in the X–Y plane or the – plane. The point2 and line2 arguments are mutually
exclusive. One of them must be specified.
line1
An Edge, an Element Edge, or a Datum object representing a datum axis specifying the X-axis or
the -axis. The point1 and line1 arguments are mutually exclusive. One of them must be specified.
line2
An Edge, an Element Edge, or a Datum object representing a datum axis specifying a vector in the
X–Y plane or the – plane. The point2 and line2 arguments are mutually exclusive. One of them
must be specified.
Optional argument
name
A String specifying the name of the DatumCsys .

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.17 DatumCsysByTwoLines(...)
This method creates a Feature object and a DatumCsys object from two orthogonal lines. The origin of
the new datum coordinate system is placed at the intersection of the two lines.

18–15

Abaqus ID:
Printed on:
FEATURE COMMANDS

Path
mdb.models[name].rootAssembly.DatumCsysByTwoLines
mdb.models[name].parts[name].DatumCsysByTwoLines

Required arguments
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
line1
A straight Edge, an ElementEdge, or a Datum object representing a datum axis specifying the
X-axis or the -axis.
line2
A straight Edge, an ElementEdge, or a Datum object representing a datum axis specifying a line
in the X–Y plane or in the – plane.
Optional argument
name
A String specifying the name of the DatumCsys .

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.18 DatumPlaneByPrincipalPlane(...)
This method creates a Feature object and a DatumPlane object through the origin along one of the three
principal planes.

Path
mdb.models[name].rootAssembly.DatumPlaneByPrincipalPlane
mdb.models[name].parts[name].DatumPlaneByPrincipalPlane

Required arguments
principalPlane
A SymbolicConstant specifying the principal plane. Possible values are XYPLANE, YZPLANE,
and XZPLANE.

18–16

Abaqus ID:
Printed on:
 FEATURE COMMANDS

offset
A Float specifying the offset from the plane.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.19 DatumPlaneByOffset(...)
This method creates a Feature object and a DatumPlane object offset by a specified distance from an
existing plane.

Path
mdb.models[name].rootAssembly.DatumPlaneByOffset
mdb.models[name].parts[name].DatumPlaneByOffset

Required arguments
plane
A planar Face, an ElementFace, or a Datum object representing a datum plane.
flip
A SymbolicConstant specifying whether the normal should be flipped. Possible values are SIDE1
and SIDE2.
offset
A Float specifying the offset from the plane.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18–17

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.20 DatumPlaneByOffset(...)
This method creates a Feature object and a DatumPlane object offset from an existing plane and passing
through the specified point.

Path
mdb.models[name].rootAssembly.DatumPlaneByOffset
mdb.models[name].parts[name].DatumPlaneByOffset

Required arguments
plane
A planar Face, an ElementFace, or a Datum object representing a datum plane.
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.21 DatumPlaneByRotation(...)
This method creates a Feature object and a DatumPlane object by rotating a plane about the specified
axis through the specified angle.

Path
mdb.models[name].rootAssembly.DatumPlaneByRotation
mdb.models[name].parts[name].DatumPlaneByRotation

Required arguments
plane
A planar Face, an ElementFace, or a Datum object representing a datum plane.
axis
A straight Edge, an ElementEdge, or a Datum object representing a datum axis.

18–18

Abaqus ID:
Printed on:
 FEATURE COMMANDS

angle
A Float specifying the angle in degrees to rotate the plane.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.22 DatumPlaneByThreePoints(...)
This method creates a Feature object and a DatumPlane object defined by passing through three points.

Path
mdb.models[name].rootAssembly.DatumPlaneByThreePoints
mdb.models[name].parts[name].DatumPlaneByThreePoints

Required arguments
point1
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
point2
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
point3
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18–19

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.23 DatumPlaneByLinePoint(...)
This method creates a Feature object and a DatumPlane object that pass through the specified line and
through the specified point that does not lie on the line.

Path
mdb.models[name].rootAssembly.DatumPlaneByLinePoint
mdb.models[name].parts[name].DatumPlaneByLinePoint

Required arguments
line
A straight Edge, an ElementEdge, or a Datum object representing a datum axis.
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.24 DatumPlaneByPointNormal(...)
This method creates a Feature object and a DatumPlane object normal to the specified line and running
through the specified point.

Path
mdb.models[name].rootAssembly.DatumPlaneByPointNormal
mdb.models[name].parts[name].DatumPlaneByPointNormal

Required arguments
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
normal
A straight Edge, an ElementEdge, or a Datum object representing a datum axis.

18–20

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.25 DatumPlaneByTwoPoint(...)
This method creates a Feature object and a DatumPlane object midway between two points and normal
to the line connecting the points.

Path
mdb.models[name].rootAssembly.DatumPlaneByTwoPoint
mdb.models[name].parts[name].DatumPlaneByTwoPoint

Required arguments
point1
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
point2
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.26 DatumPointByCoordinate(...)
This method creates a Feature object and a DatumPoint object at the point defined by the specified
coordinates.

18–21

Abaqus ID:
Printed on:
FEATURE COMMANDS

Path
mdb.models[name].rootAssembly.DatumPointByCoordinate
mdb.models[name].parts[name].DatumPointByCoordinate

Required argument
coords
A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18.1.27 DatumPointByOffset(...)
This method creates a Feature object and a DatumPoint object offset from an existing point by a vector.

Path
mdb.models[name].rootAssembly.DatumPointByOffset
mdb.models[name].parts[name].DatumPointByOffset

Required arguments
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
vector
A sequence of three Floats specifying the X-, Y-, and Z-offsets from point.
Optional arguments
None.

Return value
A Feature object.

18–22

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Exceptions
None.

18.1.28 DatumPointByMidPoint(...)
This method creates a Feature object and a DatumPoint object midway between two points.

Path
mdb.models[name].rootAssembly.DatumPointByMidPoint
mdb.models[name].parts[name].DatumPointByMidPoint

Required arguments
point1
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
point2
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18.1.29 DatumPointByOnFace(...)
This method creates a Feature object and a DatumPoint object on the specified face, offset from two
edges.

Path
mdb.models[name].rootAssembly.DatumPointByOnFace
mdb.models[name].parts[name].DatumPointByOnFace

Required arguments
face
A planar Face or a Datum object representing a datum plane.

18–23

Abaqus ID:
Printed on:
FEATURE COMMANDS

edge1
A straight Edge or a Datum object representing a datum axis.
offset1
A Float specifying the offset from edge1.
edge2
A straight Edge or a Datum object representing a datum axis.
offset2
A Float specifying the offset from edge2.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.30 DatumPointByEdgeParam(...)
This method creates a Feature object and a DatumPoint object along an edge at a selected distance from
one end of the edge.

Path
mdb.models[name].rootAssembly.DatumPointByEdgeParam
mdb.models[name].parts[name].DatumPointByEdgeParam

Required arguments
edge
An Edge object.
parameter
A Float specifying the distance along edge to the DatumPoint object. Possible values are 0
parameter 1.
Optional arguments
None.

Return value
A Feature object.

18–24

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Exceptions
AbaqusException and RangeError.

18.1.31 DatumPointByProjOnEdge(...)
This method creates a Feature object and a DatumPoint object along an edge by projecting an existing
point along the normal to the edge.

Path
mdb.models[name].rootAssembly.DatumPointByProjOnEdge
mdb.models[name].parts[name].DatumPointByProjOnEdge

Required arguments
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
edge
An Edge, an ElementEdge or a Datum object representing a datum axis.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.32 DatumPointByProjOnFace(...)
This method creates a Feature object and a DatumPoint object on a specified face by projecting an existing
point onto the face.

Path
mdb.models[name].rootAssembly.DatumPointByProjOnFace
mdb.models[name].parts[name].DatumPointByProjOnFace

18–25

Abaqus ID:
Printed on:
FEATURE COMMANDS

Required arguments
point
A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
face
A Face object or a Datum object representing a datum plane.
Note: Any other types of planes are not supported.

Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.33 MakeSketchTransform(...)
This method creates a Transform object. A Transform object is a 4x3 matrix of Floats that represents the
transformation from sketch coordinates to part coordinates.

Path
mdb.models[name].parts[name].MakeSketchTransform
mdb.models[name].rootAssembly.MakeSketchTransform

Required argument
sketchPlane
A Datum plane object or a planar Face object specifying the sketch plane.
Optional arguments
origin
A sequence of Floats specifying the X-, Y-, and Z-coordinates that will be used as the origin of the
sketch. The default value is computed as the centroid of the face.
sketchOrientation
A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values
are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT.

18–26

Abaqus ID:
Printed on:
 FEATURE COMMANDS

sketchPlaneSide
A SymbolicConstant specifying on which side of the sketchPlane the sketch is positioned. Possible
values are SIDE1 and SIDE2. The default value is SIDE1.
sketchUpEdge
An Edge or DatumAxis object specifying the orientation of the sketch. If unspecified, the sketch
is assumed to be oriented with the Y-direction pointing up.

Return value
A Transform object. A Transform is an object with one method that returns the transform matrix.

Exceptions
If the sketchUpEdge is parallel to the sketchPlane:
Up direction is parallel to plane normal

18.1.34 PartitionCellByDatumPlane(...)
This method partitions one or more cells using the given datum plane.

Path
mdb.models[name].parts[name].PartitionCellByDatumPlane
mdb.models[name].rootAssembly.PartitionCellByDatumPlane

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.
datumPlane
A DatumPlane object.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18–27

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.35 PartitionCellByExtendFace(...)
This method partitions one or more cells by extending the underlying geometry of a given face to partition
the target cells.

Path
mdb.models[name].parts[name].PartitionCellByExtendFace
mdb.models[name].rootAssembly.PartitionCellByExtendFace

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.
extendFace
A planar, cylindrical, conical, or spherical Face object.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.36 PartitionCellByExtrudeEdge(...)
This method partitions one or more cells by extruding selected edges in the given direction.

Path
mdb.models[name].parts[name].PartitionCellByExtrudeEdge
mdb.models[name].rootAssembly.PartitionCellByExtrudeEdge

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.
edges
The Edge objects to be extruded. The edges must be in the same plane. The edges must form a
continuous chain, without branches. The edges must belong to the same PartInstance object.

18–28

Abaqus ID:
Printed on:
 FEATURE COMMANDS

line
A straight Edge or DatumAxis object specifying the extrude direction. line must be perpendicular
to the plane formed by edges.
sense
A SymbolicConstant specifying the direction of the extrusion. Possible values are FORWARD
and REVERSE. If sense=FORWARD, the extrusion is in the direction of line.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.37 PartitionCellByPatchNCorners(...)
This method partitions a cell using an N-sided cutting patch defined by the given corner points.

Path
mdb.models[name].parts[name].PartitionCellByPatchNCorners
mdb.models[name].rootAssembly.PartitionCellByPatchNCorners

Required arguments
cell
A Cell object specifying the cell to partition.
cornerPoints
A sequence of Vertex, InterestingPoint, or DatumPoint objects. 3 len(cornerPoints) 5. The
corner points must not coincide.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18–29

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.38 PartitionCellByPatchNEdges(...)
This method partitions a cell using an N-sided cutting patch defined by the given edges.

Path
mdb.models[name].parts[name].PartitionCellByPatchNEdges
mdb.models[name].rootAssembly.PartitionCellByPatchNEdges

Required arguments
cell
A Cell specifying the cell to partition.
edges
A sequence of Edge objects bounding the patch. The edges must form a closed loop. The Edge
objects must belong to the same PartInstance object as cell.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.39 PartitionCellByPlaneNormalToEdge(...)
This method partitions one or more cells using a plane normal to an edge at the given edge point.

Path
mdb.models[name].parts[name].PartitionCellByPlaneNormalToEdge
mdb.models[name].rootAssembly.PartitionCellByPlaneNormalToEdge

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.
edge
An Edge object specifying the normal to the plane.
point
A Vertex , InterestingPoint , or DatumPoint object specifying a point on edge.

18–30

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.40 PartitionCellByPlanePointNormal(...)
This method partitions one or more cells using a plane defined by a point and a normal direction.

Path
mdb.models[name].parts[name].PartitionCellByPlanePointNormal
mdb.models[name].rootAssembly.PartitionCellByPlanePointNormal

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.
point
A Vertex , InterestingPoint , or DatumPoint object specifying a point on the plane.
normal
A straight Edge or DatumAxis object specifying the normal to the plane.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.41 PartitionCellByPlaneThreePoints(...)
This method partitions one or more cells using a plane defined by three points.

18–31

Abaqus ID:
Printed on:
FEATURE COMMANDS

Path
mdb.models[name].parts[name].PartitionCellByPlaneThreePoints
mdb.models[name].rootAssembly.PartitionCellByPlaneThreePoints

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.
point1
A Vertex , InterestingPoint , or DatumPoint object specifying a point on the plane.
point2
A Vertex , InterestingPoint , or DatumPoint object specifying a point on the plane.
point3
A Vertex , InterestingPoint , or DatumPoint object specifying a point on the plane.
Note: point1, point2, and point3 must not be colinear and must not coincide.

Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.42 PartitionCellBySweepEdge(...)
This method partitions one or more cells by sweeping selected edges along the given sweep path.

Path
mdb.models[name].parts[name].PartitionCellBySweepEdge
mdb.models[name].rootAssembly.PartitionCellBySweepEdge

Required arguments
cells
A sequence of Cell objects specifying the cells to partition.

18–32

Abaqus ID:
Printed on:
 FEATURE COMMANDS

edges
A sequence of Edge objects to be swept. The edges must be in the same plane. The edges must form
a continuous chain without branches. The Edge objects must all belong to the same PartInstance
object.
sweepPath
An Edge object specifying the sweep path. The start of sweepPath must be in the plane and
perpendicular to the plane formed by edges. The sweep path must be planar.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.43 PartitionEdgeByDatumPlane(...)
This method partitions an edge where it intersects with a datum plane.

Path
mdb.models[name].parts[name].PartitionEdgeByDatumPlane
mdb.models[name].rootAssembly.PartitionEdgeByDatumPlane

Required arguments
edges
A sequence of Edge objects specifying the edges to partition.
datumPlane
A DatumPlane object specifying the location of the partition.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18–33

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.44 PartitionEdgeByParam(...)
This method partitions one or more edges at the given normalized edge parameter.

Path
mdb.models[name].parts[name].PartitionEdgeByParam
mdb.models[name].rootAssembly.PartitionEdgeByParam

Required arguments
edges
A sequence of Edge objects specifying the edges to partition.
parameter
A Float specifying the normalized distance along edge at which to partition. Possible values are
0.0 parameter 1.0.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.45 PartitionEdgeByPoint(...)
This method partitions an edge at the given point.

Path
mdb.models[name].parts[name].PartitionEdgeByPoint
mdb.models[name].rootAssembly.PartitionEdgeByPoint

Required arguments
edge
An Edge object specifying the edge to partition.
point
An InterestingPoint or DatumPoint object specifying a point on edge.
Optional arguments
None.

18–34

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.46 PartitionFaceByAuto(...)
This method automatically partitions a target face into simple regions that can be meshed using a
structured meshing technique.

Path
mdb.models[name].parts[name].PartitionFaceByAuto
mdb.models[name].rootAssembly.PartitionFaceByAuto

Required argument
face
A Face object specifying the face to partition.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18.1.47 PartitionFaceByCurvedPathEdgeParams(...)
This method partitions a face normal to two edges, using a curved path between the two given edge
points defined by the normalized edge parameters.

Path
mdb.models[name].parts[name].PartitionFaceByCurvedPathEdgeParams
mdb.models[name].rootAssembly.PartitionFaceByCurvedPathEdgeParams

18–35

Abaqus ID:
Printed on:
FEATURE COMMANDS

Required arguments
face
A Face object specifying the face to partition.
edge1
An Edge object specifying the start of the partition. The edge must belong to face.
parameter1
A Float specifying the distance along edge1 at which to partition. Possible values are 0.0
distance1 1.0.
edge2
An Edge object specifying the end of the partition. The edge must belong to face.
parameter2
A Float specifying the distance along edge2 at which to partition. Possible values are 0.0
distance2 1.0.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.48 PartitionFaceByCurvedPathEdgePoints(...)
This method partitions a face normal to two edges, using a curved path between the two given edge
points.

Path
mdb.models[name].parts[name].PartitionFaceByCurvedPathEdgePoints
mdb.models[name].rootAssembly.PartitionFaceByCurvedPathEdgePoints

Required arguments
face
A Face object specifying the face to partition.
edge1
An Edge object specifying the start of the partition. The edge must belong to face.

18–36

Abaqus ID:
Printed on:
 FEATURE COMMANDS

point1
A Vertex , InterestingPoint , or DatumPoint object specifying a point on edge1.
edge2
An Edge object specifying the end of the partition. The edge must belong to face.
point2
A Vertex , InterestingPoint , or DatumPoint object specifying a point on edge2.
Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.49 PartitionFaceByDatumPlane(...)
This method partitions one or more faces using the given datum plane.

Path
mdb.models[name].parts[name].PartitionFaceByDatumPlane
mdb.models[name].rootAssembly.PartitionFaceByDatumPlane

Required arguments
faces
A sequence of Face objects specifying the faces to partition.
datumPlane
A DatumPlane object specifying the location of the partition.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18–37

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.50 PartitionFaceByExtendFace(...)
This method partitions one or more faces by extending the underlying geometry of another given face to
partition the target faces.

Path
mdb.models[name].parts[name].PartitionFaceByExtendFace
mdb.models[name].rootAssembly.PartitionFaceByExtendFace

Required arguments
faces
A sequence of Face objects specifying the faces to partition.
extendFace
A Face object that is to be extended to create the partition. The face to extend can be a planar,
cylindrical, conical, or spherical face.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18.1.51 PartitionFaceByIntersectFace(...)
This method partitions one or more faces using the given cutting faces to partition the target faces.

Path
mdb.models[name].parts[name].PartitionFaceByIntersectFace
mdb.models[name].rootAssembly.PartitionFaceByIntersectFace

Required arguments
faces
A sequence of Face objects specifying the faces to partition.
cuttingFaces
A sequence of Face objects that specify the cutting faces.

18–38

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18.1.52 PartitionFaceByShortestPath(...)
This method partitions one or more faces using a minimum distance path between the two given points.

Path
mdb.models[name].parts[name].PartitionFaceByShortestPath
mdb.models[name].rootAssembly.PartitionFaceByShortestPath

Required arguments
faces
A sequence of Face objects specifying the face to partition.
point1
A Vertex , InterestingPoint , or DatumPoint object.
point2
A Vertex , InterestingPoint , or DatumPoint object.

Note: point1 and point2 must not coincide, and they must both lie on the underlying surface
geometry of at least one of the target faces.

Optional arguments
None.

Return value
A Feature object.

Exceptions
AbaqusException.

18–39

Abaqus ID:
Printed on:
FEATURE COMMANDS

18.1.53 PartitionFaceBySketch(...)
This method partitions one or more planar faces by sketching on them.

Path
mdb.models[name].parts[name].PartitionFaceBySketch
mdb.models[name].rootAssembly.PartitionFaceBySketch

Required arguments
faces
A sequence of Face objects specifying the faces to partition.
sketch
A ConstrainedSketch object specifying the partition.
Optional arguments
sketchUpEdge
An Edge or DatumAxis object specifying the orientation of sketch. This edge or datum axis must
not be orthogonal to the plane defined by faces. If unspecified, sketch is assumed to be oriented in
with the Y direction pointing up.
sketchOrientation
A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values
are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.54 PartitionFaceBySketchDistance(...)
This method partitions one or more faces by sketching on a sketch plane and then projecting the sketch
toward the target faces through the given distance.

Path
mdb.models[name].parts[name].PartitionFaceBySketchDistance
mdb.models[name].rootAssembly.PartitionFaceBySketchDistance

18–40

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Required arguments
faces
A sequence of Face objects specifying the faces to partition.
sketchPlane
A planar Face or DatumPlane object.
sketchPlaneSide
A SymbolicConstant specifying the side of the plane to be used for sketching. Possible values are
SIDE1 and SIDE2.
sketchUpEdge
An Edge object specifying the orientation of sketch. This edge must not be orthogonal to
sketchPlane.
sketch
A ConstrainedSketch object specifying the partition.
distance
A Float specifying the projection distance. Possible values are distance 0.0.
Optional argument
sketchOrientation
A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values
are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.55 PartitionFaceBySketchRefPoint(...)
This method partitions one or more faces by sketching on a sketch plane and then projecting the sketch
toward the target faces through a distance governed by the reference point.

Path
mdb.models[name].parts[name].PartitionFaceBySketchRefPoint
mdb.models[name].rootAssembly.PartitionFaceBySketchRefPoint

18–41

Abaqus ID:
Printed on:
FEATURE COMMANDS

Required arguments
faces
A sequence of Face objects specifying the faces to partition.
sketchPlane
A planar Face or DatumPlane object.
sketchUpEdge
An Edge object or a DatumAxis object specifying the orientation of sketch. This edge or datum
axis must not be orthogonal to sketchPlane.
sketch
A ConstrainedSketch object specifying the partition.
point
A Vertex , InterestingPoint , or DatumPoint object specifying the distance to project sketch. The
point must not lie on sketchPlane.
Optional argument
sketchOrientation
A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values
are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.56 PartitionFaceBySketchThruAll(...)
This method partitions one or more faces by sketching on a sketch plane and then projecting toward the
target faces through an infinite distance.

Path
mdb.models[name].parts[name].PartitionFaceBySketchThruAll
mdb.models[name].rootAssembly.PartitionFaceBySketchThruAll

Required arguments
faces
A sequence of Face objects specifying the faces to partition.

18–42

Abaqus ID:
Printed on:
 FEATURE COMMANDS

sketchPlane
A planar Face or DatumPlane object.
sketchPlaneSide
A SymbolicConstant specifying the extrude direction of the sketch. Possible values are SIDE1
and SIDE2.
sketchUpEdge
An Edge or a DatumAxis object specifying the orientation of sketch. This edge or datum axis must
not be orthogonal to sketchPlane.
sketch
A ConstrainedSketch object specifying the partition.
Optional argument
sketchOrientation
A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values
are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT.

Return value
A Feature object.

Exceptions
AbaqusException.

18.1.57 ReferencePoint(...)
This method creates a Feature object and a ReferencePoint object at the specified location.

Path
mdb.models[name].rootAssembly.ReferencePoint
mdb.models[name].parts[name].ReferencePoint

Required argument
point
A Vertex , InterestingPoint , a MeshNode , or a Datum object specifying a reference point. point
can also be a sequence of three Floats representing the X-, Y-, and Z-coordinates of the point.
Optional arguments
instanceName
Used internally by the input file writer.

18–43

Abaqus ID:
Printed on:
FEATURE COMMANDS

Return value
A Feature Object.

Exceptions
None.

18.1.58 RemoveWireEdges(...)
This method removes wire edges.

Path
mdb.models[name].parts[name].RemoveWireEdges
mdb.models[name].rootAssembly.RemoveWireEdges

Required argument
wireEdgeList
A sequence of Edge objects specifying the edges to remove. Any specified edge that is not a wire
edge will not be removed.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

18.1.59 WirePolyLine(...)
This method creates an additional Feature object by creating a series of wires joining points in pairs.
When such a feature is created at the Part level, then each point can be either a datum point, a vertex,
a reference point, an interesting point, an orphan mesh node, or the coordinates of a point. When such
a feature is created at the Assembly level, then each point can only be a vertex, a reference point, or an
orphan mesh node.

Path
mdb.models[name].parts[name].WirePolyLine

18–44

Abaqus ID:
Printed on:
 FEATURE COMMANDS

mdb.models[name].rootAssembly.WirePolyLine

Required argument
points
A tuple of point pairs, each pair being itself represented by a tuple. For part level features each
point can be a Vertex, Datum point, Reference point, orphan mesh Node, or InterestingPoint object
specifying the points through which the polyline wire will pass. Each point can also be a tuple of
Floats representing the coordinates of a point. For assembly level features each point can only be
a Vertex, Reference point, or orphan mesh Node specifying the points through which the polyline
wire will pass (coordinates cannot be specified). In any of the pairs, the first or second point can
be NONE. In that case, the point pair will create a zero-length wire, which is required for certain
types of connectors. You must specify at least one pair.
Optional arguments
mergeWire
A Boolean specifying whether to merge the wire with existing geometry. If mergeWire=ON,
Abaqus will merge the wire with existing faces if the wire lies on the faces, and Abaqus will
merge the wire into solid regions of the part if the wire passes through them. If mergeWire=OFF,
Abaqus will not merge the polyline wire with existing geometry. The default value is ON.
meshable
A Boolean specifying whether the wire should be available for selection for meshing operations.
If meshable=OFF, the wire can be used for connector section assignment. The default value is ON.

Return value
A Feature object.

Exceptions
None.

18.1.60 isSuppressed()
This method queries the suppressed state of the feature.

Arguments
None.

Return value
A Boolean value of True if the feature is suppressed and False if it is not suppressed.

18–45

Abaqus ID:
Printed on:
FEATURE COMMANDS

Exceptions
None.

18.1.61 restore()
This method restores the parameters of a feature to the value they had when the backup method was
invoked on the part or assembly. Use the restore method after the backup method.

Arguments
None.

Return value
None

Exceptions
None.

18.1.62 resume()
This method resumes suppressed features. Resuming a feature fully restores it to the part or assembly.
You can resume the last feature you suppressed, all suppressed features, or just selected features. When
you resume a child feature, Abaqus/CAE also resumes the parent features automatically.

Arguments
None.

Return value
None

Exceptions
None.

18.1.63 setValues(...)
This method modifies the Feature object.

18–46

Abaqus ID:
Printed on:
 FEATURE COMMANDS

Arguments
Required arguments
None.
Optional arguments
parameter
A Float specifying the normalized distance along edge at which to partition. Possible values are
0.0 parameter 1.0. You use this argument to modify a partition created with the created with
the PartitionEdgeByParam method.
parameter1
A Float specifying the distance along edge1 at which to partition. Possible values are 0.0
parameter1 1.0. You use this argument to modify a partition object created with the
PartitionFaceByCurvedPathEdgeParam method.
parameter2
A Float specifying the distance along edge2 at which to partition. Possible values are 0.0
parameter2 1.0. You use this argument to modify a partition object created with the
PartitionFaceByCurvedPathEdgeParam method.
sketch
A ConstrainedSketch object specifying the partition. You use this argument to modify a partition
object created with a sketch; for example, using the PartitionFaceBySketch method.
distance
A Float specifying the projection distance. Possible values are distance 0.0. You use this
argument to modify a partition object created with the PartitionFaceBySketchDistance
method.

Return value
None

Exceptions
AbaqusException.

18.1.64 suppress()
This method suppresses features. Suppressing a feature is equivalent to temporarily removing the
feature from the part or assembly. Suppressed features remain suppressed when you regenerate a part or
assembly. You cannot suppress the base feature. In addition, if you suppress a parent feature, all of its
child features are also suppressed automatically. Suppressed features can be restored with the resume
command.

18–47

Abaqus ID:
Printed on:
FEATURE COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

18.1.65 Members
The Feature object has the following members:
name
A String specifying the repository key.
id
An Int specifying the ID of the feature.

18.2 FeatureOptions object

The FeatureOptions object stores the options that control the behavior of feature regeneration for all
features in a model.

Access
import part
mdb.models[name].featureOptions

18.2.1 setValues(...)
This method modifies the FeatureOptions object for the specified model.

Arguments
Required arguments
None.
Optional arguments
checkSelfIntersection
A Boolean specifying whether Abaqus/CAE should perform self-intersection checks while
regenerating features. The default value is ON.

18–48

Abaqus ID:
Printed on:
 FEATURE COMMANDS

autoCaching
A Boolean specifying whether geometric states should be automatically cached. The default value
is ON.
maxCachedStates
An Int specifying the maximum number of caches to be stored with each part or with the assembly.
The default value is 5.

Return value
None

Exceptions
None.

18.2.2 Members
The FeatureOptions object has members with the same names and descriptions as the arguments to the
setValues method.

18–49

Abaqus ID:
Printed on:
 FIELD COMMANDS

19. Field commands

A Field object stores the non-propagating data of a field as well as a number of instances of the
corresponding FieldState object. The FieldState object stores the propagating data of the field in a
single step. A specific type of Field object and a specific type of FieldState object are designed for
each type of predefined field. Instances of the FieldState object are created and deleted internally by its
corresponding Field object.

19.1 Field object

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

Access
import fields

19.1.1 Members
The Field object can have the following members:
name
A String specifying the repository key.
description
A String specifying the description of the field. The default value is an empty string.

19.2 AnalyticalField object

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

Access
import fields
mdb.models[name].analyticalFields[name]

19–1

Abaqus ID:
Printed on:
FIELD COMMANDS

19.2.1 Members
The AnalyticalField object can have the following members:

name
A String specifying the repository key.
localCsys
None or a DatumCsys object specifying the local coordinate system of the field. If
localCsys=None, the field is defined in the global coordinate system. The default value is None.
description
A String specifying the description of the field. The default value is an empty string.

19.3 DataTable object

A DataTable is an object used to define the domain and data for a DiscreteField .

Access

import field
mdb.models[name].discreteFields[name].data[i]

19.3.1 Members
The DataTable object has the following members:

dataWidth
An Int specifying the width of the data. Valid widths are 1, 6, 21, corresponding to scalar data,
orientations and 4D tensors.
name
A String specifying the index.
instanceName
A String specifying the instance name.
domain
A tuple of Ints specifying the domain node, element or integration point identifiers.
table
A tuple of Floats specifying the data within the domain.

19–2

Abaqus ID:
Printed on:
 FIELD COMMANDS

19.4 DiscreteField object

The DiscreteField object defines a varying field whose values correspond to distinct points within a
domain.
The DiscreteField object is derived from the Field object.

Access
import fields
mdb.models[name].discreteFields[name]

19.4.1 DiscreteField(...)
This method creates a DiscreteField object.

Path
mdb.models[name].DiscreteField

Required arguments
name
A String specifying the repository key.
defaultValues
A sequence of Floats specifying a sequence of floats specifying the default values.
fieldType
A SymbolicConstant or an Int specifying the type of data represented by this discrete field. Possible
values are SCALAR, ORIENTATION, and PRESCRIBEDCONDITION_DOF.
Optional arguments
location
A SymbolicConstant or an Int specifying the location of the domain data. Possible values are
NODES and ELEMENTS. The default value is NODES.
dataWidth
An Int specifying the width of the supplied data. The default value is 1.
data
A DataTableArray object.
description
A String specifying the description of the field. The default value is an empty string.

19–3

Abaqus ID:
Printed on:
FIELD COMMANDS

orientationType
A SymbolicConstant specifying the type of the system being described by a discrete field used
for an orientation. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL. The
default value is CARTESIAN.
partLevelOrientation
A Boolean specifying whether or not the orientations are described in terms of part level
coordinates. The default value is OFF.

Return value
A DiscreteField object.

Exceptions
AbaqusException.

19.4.2 DiscreteFieldByVolumeFraction(...)
This method creates a DiscreteField object that represents the volume fraction of each element of an
Eulerian Instance that is occupied by a reference instance.

Path
mdb.models[name].rootAssembly.DiscreteFieldByVolumeFraction

Required arguments
name
A String specifying the repository key.
eulerianInstance
A PartInstance object specifying the elements for which volume fraction values will be computed.
referenceInstance
A PartInstance object specifying the region that either contains material or is empty of material.
Optional arguments
accuracy
A Symbolic Constant specifying the level of accuracy that will be used in computing volume
fractions. Possible values are LOW, MEDIUM or, HIGH. The default value is MEDIUM.
materialLocation
A Symbolic Constant indicating whether the material is inside or outside the referenceInstance.
Possible values are INSIDE or OUTSIDE. The default value is INSIDE.
description
A String specifying the description of the field. The default value is an empty string.

19–4

Abaqus ID:
Printed on:
 FIELD COMMANDS

scaleFactor
A float specifying the fraction of the volume that is occupied by the referenceInstance.Valid values
are between 0 and 1.

Return value
A DiscreteField object.

Exceptions
AbaqusException.

19.4.3 setValues(...)
This method modifies the DiscreteField object.

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

Return value
None

Exceptions

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

19.5 ExpressionField object

The ExpressionField object defines a spatially varying field whose value is calculated from a
user-supplied mathematical expression.
The ExpressionField object is derived from the AnalyticalField object.

19–5

Abaqus ID:
Printed on:
FIELD COMMANDS

Access
import fields
mdb.models[name].analyticalFields[name]

19.5.1 ExpressionField(...)
This method creates an ExpressionField object.

Path
mdb.models[name].ExpressionField

Required arguments
name
A String specifying the repository key.
expression
A String specifying the Python expression to evaluate in space. Variables are X, Y, and Z; R, Th,
and Z; or R, Th, and P based on the selected coordinate system.
Optional arguments
localCsys
None or a DatumCsys object specifying the local coordinate system of the field. If
localCsys=None, the field is defined in the global coordinate system. The default value is None.
description
A String specifying the description of the field. The default value is an empty string.

Return value
An ExpressionField object.

Exceptions
TextException.

19.5.2 setValues(...)
This method modifies the ExpressionField object.

Arguments
Required arguments
None.

19–6

Abaqus ID:
Printed on:
 FIELD COMMANDS

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

Return value
None

Exceptions

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

19–7

Abaqus ID:
Printed on:
 FILTER COMMANDS

20. Filter commands

Filter commands are used to create real-time filters of output request data.

20.1 Filter object

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

Access
import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

20.1.1 Members
The Filter object has the following members:
name
A String specifying the repository key. This name ANTIALIASING is reserved for filters
generated internally by the program.
cutoffFrequency
A Float specifying the attenuation point of the filter. Possible values are non-negative numbers.
Order is not available for OperatorFilter.
order
An Int specifying the highest power of the filter transfer function. Possible values are non-negative
numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation
A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and
ABS. The default value is NONE.
halt
A Boolean specifying whether to stop the analysis if the specified limit is reached. The default
value is OFF.
limit
None or a Float specifying the threshold limit, an upper or lower bound for output values
depending on the operation, or a bound for stopping the analysis when Halt is used. The default
value is None.

20–1

Abaqus ID:
Printed on:
FILTER COMMANDS

invariant
A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are
NONE, FIRST, and SECOND. The default value is NONE.

20.2 ButterworthFilter object

The ButterworthFilter object defines a Butterworth type filter.

The ButterworthFilter object is derived from the Filter object.

Access
import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

20.2.1 ButterworthFilter(...)
This method creates a ButterworthFilter object.

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

Required arguments
name
A String specifying the repository key. This name ANTIALIASING is reserved for filters
generated internally by the program.
cutoffFrequency
A Float specifying the attenuation point of the filter. Possible values are non-negative numbers.
Order is not available for OperatorFilter.
Optional arguments
order
An Int specifying the highest power of the filter transfer function. Possible values are non-negative
numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation
A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and
ABS. The default value is NONE.

20–2

Abaqus ID:
Printed on:
 FILTER COMMANDS

halt
A Boolean specifying whether to stop the analysis if the specified limit is reached. The default
value is OFF.
limit
None or a Float specifying the threshold limit, an upper or lower bound for output values
depending on the operation, or a bound for stopping the analysis when Halt is used. The default
value is None.
invariant
A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are
NONE, FIRST, and SECOND. The default value is NONE.

Return value
A ButterworthFilter object.

Exceptions
InvalidNameError and RangeError.

20.2.2 setValues(...)
This method modifies the ButterworthFilter object.

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

Return value
None

Exceptions
RangeError.

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

20–3

Abaqus ID:
Printed on:
FILTER COMMANDS

20.2.4 Corresponding analysis keywords

*FILTER

20.3 Chebyshev1Filter object

The Chebyshev1Filter object defines a Chebyshev type 1 filter.

The Chebyshev1Filter object is derived from the Filter object.

Access
import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

20.3.1 Chebyshev1Filter(...)
This method creates a Chebyshev1Filter object.

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

Required arguments
name
A String specifying the repository key. This name ANTIALIASING is reserved for filters
generated internally by the program.
cutoffFrequency
A Float specifying the attenuation point of the filter. Possible values are non-negative numbers.
Order is not available for OperatorFilter.
Optional arguments
rippleFactor
A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative
numbers. The default value is 0.225.

20–4

Abaqus ID:
Printed on:
 FILTER COMMANDS

order
An Int specifying the highest power of the filter transfer function. Possible values are non-negative
numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation
A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and
ABS. The default value is NONE.
halt
A Boolean specifying whether to stop the analysis if the specified limit is reached. The default
value is OFF.
limit
None or a Float specifying the threshold limit, an upper or lower bound for output values
depending on the operation, or a bound for stopping the analysis when Halt is used. The default
value is None.
invariant
A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are
NONE, FIRST, and SECOND. The default value is NONE.

Return value
A Chebyshev1Filter object.

Exceptions
InvalidNameError and RangeError.

20.3.2 setValues(...)
This method modifies the Chebyshev1Filter object.

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

Return value
None

20–5

Abaqus ID:
Printed on:
FILTER COMMANDS

Exceptions
RangeError.

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

20.3.4 Corresponding analysis keywords

*FILTER

20.4 Chebyshev2Filter object

The Chebyshev2Filter object defines a Chebyshev type 2 filter.

The Chebyshev2Filter object is derived from the Filter object.

Access
import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

20.4.1 Chebyshev2Filter(...)
This method creates a Chebyshev2Filter object.

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

Required arguments
name
A String specifying the repository key. This name ANTIALIASING is reserved for filters
generated internally by the program.

20–6

Abaqus ID:
Printed on:
 FILTER COMMANDS

cutoffFrequency
A Float specifying the attenuation point of the filter. Possible values are non-negative numbers.
Order is not available for OperatorFilter.
Optional arguments
rippleFactor
A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative
numbers less than 1. The default value is 0.025.
order
An Int specifying the highest power of the filter transfer function. Possible values are non-negative
numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation
A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and
ABS. The default value is NONE.
halt
A Boolean specifying whether to stop the analysis if the specified limit is reached. The default
value is OFF.
limit
None or a Float specifying the threshold limit, an upper or lower bound for output values
depending on the operation, or a bound for stopping the analysis when Halt is used. The default
value is None.
invariant
A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are
NONE, FIRST, and SECOND. The default value is NONE.

Return value
A Chebyshev2Filter object.

Exceptions
InvalidNameError and RangeError.

20.4.2 setValues(...)
This method modifies the Chebyshev2Filter object.

Arguments
Required arguments
None.

20–7

Abaqus ID:
Printed on:
FILTER COMMANDS

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

Return value
None

Exceptions
RangeError.

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

20.4.4 Corresponding analysis keywords

*FILTER

20.5 OperatorFilter object

The OperatorFilter object defines an operator filter.

The OperatorFilter object is derived from the Filter object.

Access
import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

20.5.1 OperatorFilter(...)
This method creates an OperatorFilter object.

Path
mdb.models[name].OperatorFilter

20–8

Abaqus ID:
Printed on:
 FILTER COMMANDS

session.odbs[name].OperatorFilter

Required arguments
name
A String specifying the repository key. This name ANTIALIASING is reserved for filters
generated internally by the program.
cutoffFrequency
A Float specifying the attenuation point of the filter. Possible values are non-negative numbers.
Order is not available for OperatorFilter.
Optional arguments
order
An Int specifying the highest power of the filter transfer function. Possible values are non-negative
numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation
A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and
ABS. The default value is NONE.
halt
A Boolean specifying whether to stop the analysis if the specified limit is reached. The default
value is OFF.
limit
None or a Float specifying the threshold limit, an upper or lower bound for output values
depending on the operation, or a bound for stopping the analysis when Halt is used. The default
value is None.
invariant
A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are
NONE, FIRST, and SECOND. The default value is NONE.

Return value
An OperatorFilter object.

Exceptions
InvalidNameError and RangeError.

20.5.2 setValues(...)
This method modifies the OperatorFilter object.

20–9

Abaqus ID:
Printed on:
FILTER COMMANDS

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

Return value
None

Exceptions
RangeError.

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

20.5.4 Corresponding analysis keywords

*FILTER

20–10

Abaqus ID:
Printed on:
 HISTORY AND FIELD REPORT COMMANDS

21. History and Field Report commands

21.1 FieldReportOptions object

The FieldReportOptions object stores settings used by the writeFieldReport method when you
write a FieldOutput object to an ASCII file. The FieldReportOptions object has no constructor. Abaqus
creates the fieldReportOptions member when you import the Visualization module.

Access
import visualization
session.defaultFieldReportOptions
session.fieldReportOptions

21.1.1 setValues(...)
This method modifies the FieldReportOptions object.

Arguments
Required arguments
None.
Optional arguments
numColumns
An Int specifying the number of columns to display for the tabular report. The default value is 80.
numberFormat
A NumberFormat object specifying the format type, number of digits and precision used to print
the numeric output.
printXYData
A Boolean specifying whether to include X–Y data values in the tabular report. The default value
is ON.
printTotal
A Boolean specifying whether to include column totals in the tabular report. The default value is
ON.
printMinMax
A Boolean specifying whether to include column summary minimum and maximum values in the
tabular report. The default value is ON.

21–1

Abaqus ID:
Printed on:
HISTORY AND FIELD REPORT COMMANDS

pageWidth
A SymbolicConstant specifying how the width of the tabular report is to be determined. Possible
values are NO_LIMIT and SPECIFY. The default value is NO_LIMIT.
columnLayout
A SymbolicConstant specifying how values are to be presented in the tabular report. Possible
values are SINGLE_TABLE and SEPARATE_TABLES. The default value is SINGLE_TABLE.
sort
A SymbolicConstant specifying the order in which values are to be sorted within a tabular report.
Possible values are ASCENDING and DESCENDING. The default value is ASCENDING.

Return value
A FieldReportOptions object.

Exceptions
None.

21.1.2 Members
The FieldReportOptions object has members with the same names and descriptions as the arguments to
the setValues method.

21.2 FreeBodyReportOptions object

The FreeBodyReportOptions object stores settings used by the writeFreeBodyReport method

when you write free body computational results to an ASCII file. The FreeBodyReportOptions
object has no constructor. Abaqus creates the freeBodyReportOptions member when you import the
Visualization module.

Access
import visualization
session.defaultFreeBodyReportOptions
session.freeBodyReportOptions

21.2.1 setValues(...)
This method modifies the FreeBodyReportOptions object.

21–2

Abaqus ID:
Printed on:
 HISTORY AND FIELD REPORT COMMANDS

Arguments
Required arguments
None.
Optional arguments
numDigits
An Int specifying the number of decimal places. The default value is 3.
forceThreshold
A Float specifying the threshold value for force. The default value is 10–6 .
momentThreshold
A Float specifying the threshold value for moment. The default value is 10–6 .
numberFormat
A SymbolicConstant specifying the number format. Possible values are SCIENTIFIC, FIXED,
and ENGINEERING. The default value is SCIENTIFIC.
reportFormat
A SymbolicConstant specifying the report format. Possible values are NORMAL_ANNOTATED
and COMMA_SEPARATED_VALUES. The default value is NORMAL_ANNOTATED.
csysType
A SymbolicConstant specifying the coordinate system type. Possible values are GLOBAL and
LOCAL. The default value is GLOBAL.

Return value
A FreeBodyReportOptions object.

Exceptions
None.

21.2.2 Members
The FreeBodyReportOptions object has members with the same names and descriptions as the arguments
to the setValues method.

21.3 OdbFieldVarList object

The read-only OdbFieldVarList object is a sequence listing all variables available for the current step
and frame. Each item in the sequence is itself a sequence fully describing the given variable.

21–3

Abaqus ID:
Printed on:
HISTORY AND FIELD REPORT COMMANDS

Access
import visualization
session.viewports[name].layers[name].odbDisplay.fieldVariables
session.viewports[name].odbDisplay.fieldVariables

21.3.1 Members
The OdbFieldVarList object has no members.

21.4 OdbModelFieldVarList object

The read-only OdbModelFieldVarList object lists all variables available for the model in the current
OdbDisplay object.

Access
import visualization
session.viewports[name].layers[name].odbDisplay.modelVariableList
session.viewports[name].odbDisplay.modelVariableList

21.4.1 Members
The OdbModelFieldVarList object has no members.

21.5 writeFieldReport

This command writes a field output report to a file.

21.5.1 writeFieldReport(...)
This method writes a FieldOutput object to a user-defined ASCII file.

Path
session.writeFieldReport

Arguments
Required arguments
filename
A String specifying the name of the file to which field output will be written.

21–4

Abaqus ID:
Printed on:
 HISTORY AND FIELD REPORT COMMANDS

append
A Boolean specifying whether to append the field output to an existing file. The default value is
ON.
sortItem
A String specifying the item by which to sort the tabular values.
odb
An Odb object from which to obtain field output values.
step
An Int (or OdbStep object) specifying the step from which to obtain field output values. Possible
values are 0 step (numSteps − 1).
frame
An Int (or OdbFrame object) specifying the frame from which to obtain field output values.
Possible values are 0 frame (numFramesInStep − 1).
outputPosition
A SymbolicConstant specifying the position from which to obtain data.
Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE,
ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION,
WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE.
displayGroup
A DisplayGroup object specifying the subset of the model for which to obtain data.
variable
A sequence of variable description sequences specifying one or more field output variables for
which to obtain data. Each variable description sequence contains the following elements:
• element0: A String specifying the name of the variable.
• element1: A SymbolicConstant specifying the output position at which to report data.
Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL,
GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT,
WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
• element2: A Sequence of tuples each consisting of a SymbolicConstant specifying the
refinement (COMPONENT or INVARIANT), followed by a String specifying the name of a
component or invariant for which to obtain values.
If this element is omitted, data are written for all components and invariants (if
applicable). This element is required if element3 (the following element in the tuple) is
included.
• element3 (if applicable): A Dictionary with a String key and a String value specifying a
single section point at which to report data. The key specifies a region in the model; the
corresponding value specifies a section point within that region. For example:
{'shell < MAT > < 7 section points >':'SPOS,
(fraction = 1.0)'}

21–5

Abaqus ID:
Printed on:
HISTORY AND FIELD REPORT COMMANDS

If this element is omitted, data are written for all section points (if applicable).
Optional arguments
numericForm
A SymbolicConstant specifying the numeric form in which to display results that contain
complex numbers. Possible values are COMPLEX_MAGNITUDE, COMPLEX_PHASE,
REAL, IMAGINARY, and COMPLEX_MAG_AT_ANGLE. The initial value is
COMPLEX_MAGNITUDE.
complexAngle
A Float specifying the angle (in degrees) at which to display results that contain complex numbers
when numericForm=COMPLEX_MAG_AT_ANGLE. The initial value is 0.

Return value
None

Exceptions
None.

21–6

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22. Interaction commands

A specific type of interaction object and a specific type of interaction state object are designed for each
type of interaction. An interaction object stores the non-propagating data of an interaction as well as a
number of instances of the corresponding interaction state object, each of which stores the propagating
data of the interaction in a single step. Instances of the interaction state object are created and deleted
internally by its corresponding interaction object.

22.1 Interaction object

The Interaction object is the abstract base type for other Interaction objects. The Interaction object has
no explicit constructor. Each of the Interaction objects has the following methods:
• deactivate
• move
• reset
• resume
• suppress
• delete
The methods are described below.

Access
import interaction
mdb.models[name].interactions[name]

22.1.1 deactivate(...)
This method deactivates the interaction in the specified step and all its subsequent steps.

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

22–1

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Return value
None

Exceptions
None.

22.1.2 move(...)
This method moves an interaction from one step to another.

Arguments
Required arguments
fromStepName
A String specifying the name of the step from which to move the interaction.
toStepName
A String specifying the name of the step to which to move the interaction.
Optional arguments
None.

Return value
None

Exceptions
None.

22.1.3 reset(...)
This method reactivates an interaction that was deactivated previously. The reset method is available
during the step in which the interaction was deactivated originally.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is reactivated.
Optional arguments
None.

22–2

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
None

Exceptions
None.

22.1.4 resume()
This method resumes an interaction that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

22.1.5 suppress()
This method suppresses an interaction.

Arguments
None.

Return value
None

Exceptions
None.

22.1.6 delete(...)
This method allows you to delete existing interactions.

22–3

Abaqus ID:
Printed on:
INTERACTION COMMANDS

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

Return value
None

Exceptions
None.

22.1.7 Members
The Interaction object has the following member:
name
A String specifying the repository key.

22.2 AcousticImpedance object

The AcousticImpedance object defines surface impedance information or nonreflecting boundaries for
acoustic and coupled acoustic-structural analyses.
The AcousticImpedance object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.2.1 AcousticImpedance(...)
This method creates an AcousticImpedance object.

Path
mdb.models[name].AcousticImpedance

22–4

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the AcousticImpedance object is created.
surface
A Region object specifying the acoustic boundary surface.
Optional arguments
definition
A SymbolicConstant specifying the type of acoustic impedance to be defined. Possible values are
TABULAR and NONREFLECTING. The default value is TABULAR.
interactionProperty
A String specifying the AcousticImpedanceProp object associated with this interaction.
nonreflectingType
A SymbolicConstant specifying the type of nonreflecting geometry to be defined. Possible values
are PLANE, IMPROVED, CIRCULAR, SPHERICAL, ELLIPTICAL, and PROLATE. The
default value is PLANE.
This argument is valid only when definition=NONREFLECTING.
radius
A Float specifying the radius of the circle or sphere defining the boundary surface. The default
value is 1.0.
This argument is valid only when definition=NONREFLECTING, and
nonreflectingType=CIRCULAR or SPHERICAL.
semimajorAxis
A Float specifying the semimajor axis length of the ellipse or prolate spheroid defining the
boundary surface. The default value is 1.0.
This argument is valid only when definition=NONREFLECTING, and
nonreflectingType=ELLIPTICAL or PROLATE.
eccentricity
A Float specifying the eccentricity of the ellipse or prolate spheroid defining the boundary surface.
The default value is 0.0.
This argument is valid only when definition=NONREFLECTING, and
nonreflectingType=ELLIPTICAL or PROLATE.
centerCoordinates
A sequence of three Floats specifying the X, Y, and Z coordinates of the center of the ellipse or
prolate spheroid defining the boundary surface. The default value is (0, 0, 0).
This argument is valid only when definition=NONREFLECTING, and
nonreflectingType=ELLIPTICAL or PROLATE.

22–5

Abaqus ID:
Printed on:
INTERACTION COMMANDS

directionCosine
A sequence of three Floats specifying the X, Y, and Z components of the direction cosine of the
major axis of the ellipse or prolate spheroid defining the boundary surface. The default value is
(0, 0, 1).
This argument is valid only when definition=NONREFLECTING, and
nonreflectingType=ELLIPTICAL or PROLATE.

Return value
An AcousticImpedance object.

Exceptions
None.

22.2.2 setValues(...)
This method modifies the data for an existing AcousticImpedance 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 AcousticImpedance
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

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

22–6

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Optional argument
interactionProperty
A String specifying the AcousticImpedanceProp object associated with this interaction.

Return value
None

Exceptions
None.

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

22.2.5 Corresponding analysis keywords

*SIMPEDANCE

22.3 AcousticImpedanceProp object

The AcousticImpedanceProp object is an interaction property that defines the properties referred to by
an AcousticImpedance object.
The AcousticImpedanceProp object is derived from the InteractionProperty object.

Access
import interaction
mdb.models[name].interactionProperties[name]

22.3.1 AcousticImpedanceProp(...)
This method creates an AcousticImpedanceProp object.

Path
mdb.models[name].AcousticImpedanceProp

22–7

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Required arguments
name
A String specifying the interaction property repository key.
tableType
A SymbolicConstant specifying the type of tabular data to be defined. Possible values are
IMPEDANCE and ADMITTANCE.
table
A sequence of sequences of Floats specifying acoustic impedance properties.
If tableType=IMPEDANCE, each sequence of the table data specifies:
• The real part of the complex impedance.
• The imaginary part of the complex impedance.
• Frequency, if the data depend on frequency.
If tableType=ADMITTANCE, each sequence of the table data specifies:
• The real part of the complex admittance.
• The imaginary part of the complex admittance.
• Frequency, if the data depend on frequency.

Optional argument
frequencyDependency
A Boolean specifying whether the table data depend on frequency. The default value is OFF.

Return value
An AcousticImpedanceProp object.

Exceptions
None.

22.3.2 setValues(...)
This method modifies the AcousticImpedanceProp object.

Arguments
Required arguments
None.

22–8

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

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

Return value
None

Exceptions
None.

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

22.3.4 Corresponding analysis keywords

*IMPEDANCE PROPERTY

22.4 AcousticImpedanceState object

The AcousticImpedanceState object stores the propagating data of an AcousticImpedance object in a

step. One instance of this object is created internally by the AcousticImpedance object for each step.
The instance is also deleted internally by the AcousticImpedance object.
The AcousticImpedanceState object has no constructor or methods.
The AcousticImpedanceState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.4.1 Members
The AcousticImpedanceState object has the following members:
interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.

22–9

Abaqus ID:
Printed on:
INTERACTION COMMANDS

interactionProperty
A String specifying the name of the AcousticImpedanceProp object associated with this
interaction.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.4.2 Corresponding analysis keywords

*SIMPEDANCE

22.5 ActuatorSensor object

The ActuatorSensor object defines a single point actuator where the actuation is determined by a user
subroutine (UEL). The subroutine senses the data at the same point as the actuator.
The ActuatorSensor object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.5.1 ActuatorSensor(...)
This method creates an ActuatorSensor object.

22–10

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Path
mdb.models[name].ActuatorSensor

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the actuator/sensor interaction is created.
createStepName must be set to ’Initial’.
point
A Region object specifying the point at which the constraint is applied.
interactionProperty
A String specifying the ActuatorSensorProp object associated with this interaction.
noCoordComponents
An Int specifying the number of coordinate components supplied to the user subroutine (UEL).
unsymm
A Boolean specifying whether the element matrices are symmetric (ON) or unsymmetric (OFF).
The default value is OFF.
noSolutionDepVar
An Int specifying the number of solution-dependent variables. The default value is 0.
userSubUel
A String specifying the name of the user subroutine (UEL) that defines the user element.
dof
A String specifying the degrees of freedom, separated by commas.
solutionDepVars
A sequence of Floats specifying the initial values of the solution-dependent variables.
Optional arguments
None.

Return value
An ActuatorSensor object.

Exceptions
None.

22–11

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.5.2 setValues(...)
This method modifies the ActuatorSensor object.

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

Return value
None

Exceptions
None.

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

22.5.4 Corresponding analysis keywords

*ELEMENT
*USER ELEMENT
*INITIAL CONDITIONS, TYPE=SOLUTION

22.6 ActuatorSensorProp object

The ActuatorSensorProp object is an interaction property that defines the properties referred to by an
ActuatorSensor object.
The ActuatorSensorProp object is derived from the InteractionProperty object.

Access
import interaction

22–12

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

mdb.models[name].interactionProperties[name]

22.6.1 ActuatorSensorProp(...)
This method creates an ActuatorSensorProp object.

Path
mdb.models[name].ActuatorSensorProp

Required argument
name
A String specifying the interaction property repository key.
Optional arguments
realProperties
A sequence of Floats specifying the PROPS array used by user subroutine UEL. The default value
is an empty sequence.
integerProperties
A sequence of Ints specifying the JPROPS array used by user subroutine UEL. The default value
is an empty sequence.

Return value
An ActuatorSensorProp object.

Exceptions
None.

22.6.2 setValues(...)
This method modifies the ActuatorSensorProp object.

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

22–13

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Return value
None

Exceptions
None.

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

22.6.4 Corresponding analysis keywords

*UEL PROPERTY

22.7 ActuatorSensorState object

The ActuatorSensorState object stores the propagating data of an actuator sensor in a step. One instance
of this object is created internally by the ActuatorSensor object for each step. The instance is also deleted
internally by the ActuatorSensor object.
The ActuatorSensorState object has no constructor, methods, or members.
The ActuatorSensorState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.7.1 Members
The ActuatorSensorState object has the following member:
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED

22–14

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.8 CavityRadiation object

The CavityRadiation object defines cavities for thermal radiation heat transfer and controls the
calculation of viewfactors.
The CavityRadiation object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.8.1 CavityRadiation(...)
This method creates a CavityRadiation object.

Path
mdb.models[name].CavityRadiation

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the cavity radiation interaction should be created.
surfaces
A RegionArray object specifying the surfaces for which radiation viewfactor control is being
specified.

22–15

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
surfaceEmissivities
A sequence of Strings specifying the names of the Cavity Radiation properties containing the
surface emissivity data. One name per specified surface. The emissivity data is ignored when
surfaceReflection=OFF.
ambientTemp
None or a Float specifying the reference ambient temperature value, . Specifying a value
indicates an open cavity. The default value is None.
blocking
A SymbolicConstant specifying the blocking checks to be performed in the viewfactor
calculations. Possible values are BLOCKING_ALL, NO_BLOCKING, and
PARTIAL_BLOCKING. The default value is BLOCKING_ALL.
blockingSurfaces
A RegionArray object specifying the surfaces that provide blocking inside the cavity. This
argument applies only when blocking=PARTIAL_BLOCKING.
rangeOfView
None or a Float specifying the maximum distance between surface facets at which viewfactors
are calculated. More distant facets are deemed too far apart to exchange significant amounts of
heat through radiation effects, and the viewfactors between these facets are assumed to be zero. If
rangeOfView=None, there is no upper limit. The default value is None.
surfaceReflection
A Boolean specifying whether heat reflections are to be included in the cavity radiation
calculations. The default value is ON.
viewfactorAccurTol
A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is
0.05.
minInfinitesimalRatio
A Float specifying the facet area ratio above which the infinitesimal-to-finite area approximation
is used for viewfactor calculations. The default value is 64.0.
numPointsPerEdge
An Int specifying the number of Gauss integration points to be used along each edge when
the numerical integration of contour integrals is used for viewfactor calculations. One to five
integration points are allowed. The default value is 3.
minLumpedAreaDS
A Float specifying the nondimensional distance-square value above which the lumped area
approximation is used for viewfactor calculations. The default value is 5.0.
cyclicSymmetry
A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be specified
for axisymmetric models. The default value is OFF.

22–16

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

cyclicImages
An Int specifying the number of cyclically similar images that compose the cavity formed as a
result of this symmetry. This argument applies only when cyclicSymmetry=ON. The default value
is 2.
cyclicRotPt
A ModelDot object specifying the rotation axis point. This argument applies only when
cyclicSymmetry=ON.
cyclicRotEndPt
A ModelDot object specifying the rotation axis end point. This argument applies only for three-
dimensional models, and only when cyclicSymmetry=ON.
cyclicSymPt
A ModelDot object specifying the symmetry axis end point. This argument applies only when
cyclicSymmetry=ON.
periodicSymmetries
An Int specifying the number of periodic symmetries that will be applied. The default value is 0.
periodicImages_1
An Int specifying the number of repetitions used in the numerical calculation of the cavity
viewfactors resulting from the first periodic symmetry. The result of this symmetry is a cavity
composed of the cavity surface defined in the model plus twice the value of periodicImages_1.
This argument applies only when periodicSymmetries is greater than zero. The default value is 2.
periodicImages_2
An Int specifying the number of repetitions used in the numerical calculation of the cavity
viewfactors resulting from the second periodic symmetry. The result of this symmetry is a cavity
composed of the cavity surface defined in the model plus twice the value of periodicImages_2.
This argument applies only when periodicSymmetries is greater than one. The default value is 2.
periodicImages_3
An Int specifying the number of repetitions used in the numerical calculation of the cavity
viewfactors resulting from the third periodic symmetry. The result of this symmetry is a cavity
composed of the cavity surface defined in the model plus twice the value of periodicImages_3.
This argument applies only when periodicSymmetries = 3. The default value is 2.
periodicSymAxis_1
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating
the first line of symmetry in two-dimensional models. This argument applies only for 2D models,
and when periodicSymmetries is greater than zero.
periodicSymAxis_2
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating
the second line of symmetry in two-dimensional models. This argument applies only for two-
dimensional models, and when periodicSymmetries = 2.

22–17

Abaqus ID:
Printed on:
INTERACTION COMMANDS

periodicSymPlane_1
A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the first
plane of symmetry in three-dimensional models. This argument applies only for three-dimensional
models, and when periodicSymmetries is greater than zero.
periodicSymPlane_2
A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the
second plane of symmetry in three-dimensional models. This argument applies only for three-
dimensional models, and when periodicSymmetries is greater than one.
periodicSymPlane_3
A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the third
plane of symmetry in three-dimensional models. This argument applies only for three-dimensional
models, and when periodicSymmetries = 3.
periodicDistance_1
A sequence of sequences of Floats specifying the two points of the vector that describes the periodic
distance for the first periodic symmetry. Each point is defined by a tuple of three coordinates
indicating its position. This argument applies only when periodicSymmetries is greater than zero.
The default value is an empty sequence.
periodicDistance_2
A sequence of sequences of Floats specifying the two points of the vector that describes the periodic
distance for the second periodic symmetry. Each point is defined by a tuple of three coordinates
indicating its position. This argument applies only when periodicSymmetries is greater than one.
The default value is an empty sequence.
periodicDistance_3
A sequence of sequences of Floats specifying the two points of the vector that describes the periodic
distance for the third periodic symmetry. Each point is defined by a tuple of three coordinates
indicating its position. This argument applies only when periodicSymmetries = 3. The default
value is an empty sequence.
periodicSymZ
None or a Float specifying the Z value indicating the symmetry reference line in axisymmetric
models. This argument applies only for axisymmetric models, and when periodicSymmetries = 1.
The default value is None.
periodicDistZ
None or a Float specifying the Z value indicating the periodic distance in axisymmetric models.
This argument applies only for axisymmetric models, and when periodicSymmetries = 1. The
default value is None.
reflectionSymmetries
An Int specifying the number of reflection symmetries will be applied. The default value is 0.

22–18

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

reflectionSymAxis_1
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating the
first line of symmetry in two-dimensional models. This argument applies only for two-dimensional
models, and when reflectionSymmetries is greater than zero.
reflectionSymAxis_2
A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating
the second line of symmetry in two-dimensional models. This argument applies only for two-
dimensional models, and when reflectionSymmetries = 2.
reflectionSymPlane_1
A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the first
plane of symmetry in three-dimensional models. This argument applies only for three-dimensional
models, and when reflectionSymmetries is greater than zero.
reflectionSymPlane_2
A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the
second plane of symmetry in three-dimensional models. This argument applies only for three-
dimensional models, and when reflectionSymmetries is greater than one.
reflectionSymPlane_3
A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the third
plane of symmetry in three-dimensional models. This argument applies only for three-dimensional
models, and when reflectionSymmetries = 3.
reflectionSymZ
None or a Float specifying the Z value indicating the symmetry reference line in axisymmetric
models. This argument applies only for axisymmetric models, and when reflectionSymmetries =
1. The default value is None.

Return value
A CavityRadiation object.

Exceptions
None.

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

Arguments
Required arguments
None.

22–19

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the CavityRadiation
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

22.8.3 setValuesInStep(...)
This method modifies the propagating data of an existing CavityRadiation object in the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
blocking
A SymbolicConstant specifying the blocking checks to be performed in the viewfactor
calculations. Possible values are BLOCKING_ALL, NO_BLOCKING, and
PARTIAL_BLOCKING. The default value is BLOCKING_ALL.
blockingSurfaces
A RegionArray object specifying the surfaces that provide blocking inside the cavity. This
argument applies only when blocking=PARTIAL_BLOCKING.
rangeOfView
None or a Float specifying the maximum distance between surface facets at which viewfactors
are calculated. More distant facets are deemed too far apart to exchange significant amounts of
heat through radiation effects, and the viewfactors between these facets are assumed to be zero. If
rangeOfView=None, there is no upper limit. The default value is None.
surfaceReflection
A Boolean specifying whether heat reflections are to be included in the cavity radiation
calculations. The default value is ON.
viewfactorAccurTol
A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is
0.05.

22–20

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
None

Exceptions
None.

22.8.4 Members
The CavityRadiation object can have the following members:
name
A String specifying the repository key.
ambientTemp
None or a Float specifying the reference ambient temperature value, . Specifying a value
indicates an open cavity. The default value is None.
blocking
A SymbolicConstant specifying the blocking checks to be performed in the viewfactor
calculations. Possible values are BLOCKING_ALL, NO_BLOCKING, and
PARTIAL_BLOCKING. The default value is BLOCKING_ALL.
rangeOfView
None or a Float specifying the maximum distance between surface facets at which viewfactors
are calculated. More distant facets are deemed too far apart to exchange significant amounts of
heat through radiation effects, and the viewfactors between these facets are assumed to be zero. If
rangeOfView=None, there is no upper limit. The default value is None.
surfaceReflection
A Boolean specifying whether heat reflections are to be included in the cavity radiation
calculations. The default value is ON.
viewfactorAccurTol
A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is
0.05.
minInfinitesimalRatio
A Float specifying the facet area ratio above which the infinitesimal-to-finite area approximation
is used for viewfactor calculations. The default value is 64.0.
numPointsPerEdge
An Int specifying the number of Gauss integration points to be used along each edge when
the numerical integration of contour integrals is used for viewfactor calculations. One to five
integration points are allowed. The default value is 3.

22–21

Abaqus ID:
Printed on:
INTERACTION COMMANDS

minLumpedAreaDS
A Float specifying the nondimensional distance-square value above which the lumped area
approximation is used for viewfactor calculations. The default value is 5.0.
cyclicSymmetry
A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be specified
for axisymmetric models. The default value is OFF.
cyclicImages
An Int specifying the number of cyclically similar images that compose the cavity formed as a
result of this symmetry. This argument applies only when cyclicSymmetry=ON. The default value
is 2.
periodicSymmetries
An Int specifying the number of periodic symmetries that will be applied. The default value is 0.
periodicImages_1
An Int specifying the number of repetitions used in the numerical calculation of the cavity
viewfactors resulting from the first periodic symmetry. The result of this symmetry is a cavity
composed of the cavity surface defined in the model plus twice the value of periodicImages_1.
This argument applies only when periodicSymmetries is greater than zero. The default value is 2.
periodicImages_2
An Int specifying the number of repetitions used in the numerical calculation of the cavity
viewfactors resulting from the second periodic symmetry. The result of this symmetry is a cavity
composed of the cavity surface defined in the model plus twice the value of periodicImages_2.
This argument applies only when periodicSymmetries is greater than one. The default value is 2.
periodicImages_3
An Int specifying the number of repetitions used in the numerical calculation of the cavity
viewfactors resulting from the third periodic symmetry. The result of this symmetry is a cavity
composed of the cavity surface defined in the model plus twice the value of periodicImages_3.
This argument applies only when periodicSymmetries = 3. The default value is 2.
periodicSymZ
None or a Float specifying the Z value indicating the symmetry reference line in axisymmetric
models. This argument applies only for axisymmetric models, and when periodicSymmetries = 1.
The default value is None.
periodicDistZ
None or a Float specifying the Z value indicating the periodic distance in axisymmetric models.
This argument applies only for axisymmetric models, and when periodicSymmetries = 1. The
default value is None.
reflectionSymmetries
An Int specifying the number of reflection symmetries will be applied. The default value is 0.

22–22

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

reflectionSymZ
None or a Float specifying the Z value indicating the symmetry reference line in axisymmetric
models. This argument applies only for axisymmetric models, and when reflectionSymmetries =
1. The default value is None.
createStepName
A String specifying the name of the step in which the cavity radiation interaction should be created.
surfaces
A RegionArray object specifying the surfaces for which radiation viewfactor control is being
specified.
surfaceEmissivities
A tuple of Strings specifying the names of the Cavity Radiation properties containing the
surface emissivity data. One name per specified surface. The emissivity data is ignored when
surfaceReflection=OFF.
blockingSurfaces
A RegionArray object specifying the surfaces that provide blocking inside the cavity. This
argument applies only when blocking=PARTIAL_BLOCKING.
cyclicRotPt
A ModelDot object specifying the rotation axis point. This argument applies only when
cyclicSymmetry=ON.
cyclicRotEndPt
A ModelDot object specifying the rotation axis end point. This argument applies only for three-
dimensional models, and only when cyclicSymmetry=ON.
cyclicSymPt
A ModelDot object specifying the symmetry axis end point. This argument applies only when
cyclicSymmetry=ON.
periodicDistance_1
A tuple of tuples of Floats specifying the two points of the vector that describes the periodic
distance for the first periodic symmetry. Each point is defined by a tuple of three coordinates
indicating its position. This argument applies only when periodicSymmetries is greater than zero.
The default value is an empty sequence.
periodicDistance_2
A tuple of tuples of Floats specifying the two points of the vector that describes the periodic
distance for the second periodic symmetry. Each point is defined by a tuple of three coordinates
indicating its position. This argument applies only when periodicSymmetries is greater than one.
The default value is an empty sequence.
periodicDistance_3
A tuple of tuples of Floats specifying the two points of the vector that describes the periodic
distance for the third periodic symmetry. Each point is defined by a tuple of three coordinates
indicating its position. This argument applies only when periodicSymmetries = 3. The default
value is an empty sequence.

22–23

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.8.5 Corresponding analysis keywords

*CAVITY DEFINITION, SET PROPERTY

*CYCLIC
*EMISSIVITY
*PERIODIC
*RADIATION SYMMETRY
*RADIATION VIEWFACTOR
*REFLECTION

22.9 CavityRadiationProp object

The CavityRadiationProp object is an interaction property that defines emissivity as a function of

temperature and field variables.
The CavityRadiationProp object is derived from the InteractionProperty object.

Access
import interaction
mdb.models[name].interactionProperties[name]

22.9.1 CavityRadiationProp(...)
This method creates a CavityRadiationProp object.

Path
mdb.models[name].CavityRadiationProp

Required argument
name
A String specifying the interaction property repository key.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

22–24

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

property
A sequence of sequences of Floats specifying the following:
• The emissivity, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CavityRadiationProp object.

Exceptions
None.

22.9.2 setValues(...)
This method modifies the CavityRadiationProp object.

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

Return value
None

Exceptions
None.

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

22–25

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.9.4 Corresponding analysis keywords

*EMISSIVITY

22.10 CavityRadiationState object

The CavityRadiationState object stores the propagating data for a CavityRadiation object. One instance
of this object is created internally by the CavityRadiation object for each step. The instance is also deleted
internally by the CavityRadiation object.
The CavityRadiationState object has no constructor or methods.
The CavityRadiationState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.10.1 Members
The CavityRadiationState object has the following members:
blocking
A SymbolicConstant specifying the blocking checks to be performed in the viewfactor
calculations. Possible values are BLOCKING_ALL, NO_BLOCKING, and
PARTIAL_BLOCKING.
blockingState
A SymbolicConstant specifying the propagation state of the blocking member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
blockingSurfacesState
A SymbolicConstant specifying the propagation state of the blockingSurfaces member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
rangeOfView
A Float specifying the distance beyond which factors need not be calculated because surfaces are
judged to be too far apart to “see” each other (due to blocking by other surfaces).
rangeOfViewState
A SymbolicConstant specifying the propagation state of the rangeOfView member. Possible values
are UNSET, SET, UNCHANGED, and FREED.

22–26

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

surfaceReflection
A Boolean specifying whether reflection must be included in the cavity radiation calculations. The
default value is ON.
surfaceReflectionState
A SymbolicConstant specifying the propagation state of the surfaceReflection member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
viewfactorAccuracyTol
A Float specifying the acceptable tolerance for the viewfactor calculations.
viewfactorAccuracyTolState
A SymbolicConstant specifying the propagation state of the viewfactorAccuracyTol member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
blockingSurfaces
A tuple of Strings specifying the surfaces that provide blocking inside the cavity.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.10.2 Corresponding analysis keywords

*RADIATION VIEWFACTOR

22.11 CohesiveBehavior object

The CohesiveBehavior object specifies cohesive behavior for a contact interaction property.

22–27

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Access
import interaction
mdb.models[name].interactionProperties[name].cohesiveBehavior

22.11.1 CohesiveBehavior(...)
This method creates a CohesiveBehavior object.

Path
mdb.models[name].interactionProperties[name].CohesiveBehavior

Required arguments
None.
Optional arguments
repeatedContacts
A Boolean specifying whether to enforce cohesive behavior for recurrent contacts at nodes on the
slave surface subsequent to ultimate failure. The default value is OFF.
eligibility
A SymbolicConstant specifying the eligible slave nodes. Possible values are ALL_NODES,
INITIAL_NODES, and SPECIFIED. The default value is ALL_NODES.
defaultPenalties
A Boolean specifying whether to use the default contact penalties. The default value is ON.
coupling
A SymbolicConstant specifying whether the traction-separation coefficients are coupled
or uncoupled. This argument is valid only for defaultPenalties=OFF. Possible values are
UNCOUPLED and COUPLED. The default value is UNCOUPLED.
temperatureDependency
A Boolean specifying whether the coefficient data depend on temperature. This argument is valid
only for defaultPenalties=OFF. The default value is OFF.
dependencies
An Int specifying the number of field variables. This argument is valid only for
defaultPenalties=OFF. The default value is 0.
table
A sequence of sequences of Floats specifying the traction-separation coefficients. The items in the
table data are described below. This argument is valid only for defaultPenalties=OFF.
Table data
If coupling=UNCOUPLED, the table data specify the following:
• Stiffness coefficient in the normal direction, .

22–28

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• Stiffness coefficient in the first shear direction, .

• Stiffness coefficient in the second shear direction, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If coupling=COUPLED, the table data specify the following:
• Stiffness coefficient in the normal direction, .
• Stiffness coefficient in the first shear direction, .
• Stiffness coefficient in the second shear direction, .
• Coupled stiffness coefficient, .
• Coupled stiffness coefficient, .
• Coupled stiffness coefficient, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CohesiveBehavior object.

Exceptions
None.

22.11.2 setValues(...)
This method modifies the CohesiveBehavior object.

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

22–29

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Return value
None

Exceptions
None.

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

22.11.4 Corresponding analysis keywords

*COHESIVE BEHAVIOR

22.12 ConcentratedFilmCondition object

The ConcentratedFilmCondition object defines concentrated film coefficients and associated sink
temperatures.
The ConcentratedFilmCondition object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.12.1 ConcentratedFilmCondition(...)
This method creates a ConcentratedFilmCondition object.

Path
mdb.models[name].ConcentratedFilmCondition

Required arguments
name
A String specifying the repository key.

22–30

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

createStepName
A String specifying the name of the step in which the ConcentratedFilmCondition object is created.
region
A Region object specifying the region to which the concentrated film condition interaction is
applied. The interaction is applied to each node in the region.
definition
A SymbolicConstant specifying how the concentrated film condition is defined. Possible values
are EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.
Optional arguments
nodalArea
A Float specifying the area associated with the node where the concentrated film condition is
applied. The default value is 1.0.
explicitRegionType
A SymbolicConstant specifying how the concentrated film condition is applied to the boundary of
an adaptive mesh domain. Possible values are LAGRANGIAN, SLIDING, and EULERIAN. The
default value is LAGRANGIAN.
This argument applies only during an Abaqus/Explicit analysis.
interactionProperty
A String specifying the name of the FilmConditionProp object associated with this interaction.
The interactionProperty argument applies only when definition=PROPERTY_REF. The default
value is an empty string.
field
A String specifying the name of the AnalyticalField object associated with this interaction. The
field argument applies only when definition=FIELD. The default value is an empty string.
sinkTemperature
A Float specifying the reference sink temperature, . The default value is 0.0.
sinkAmplitude
A String specifying the name of the Amplitude object that gives the variation of the sink
temperature, , with time. The default value is an empty string.

Note: Use None in an Abaqus/Standard analysis to specify that the reference sink temperature
is applied immediately at the beginning of the step or linearly over the step. Use None in an
Abaqus/Explicit analysis to specify that the reference sink temperature is applied throughout the
step.

filmCoeff
A Float specifying the reference film coefficient value, . The filmCoeff argument applies when
definition=EMBEDDED_COEFF, definition=USER_SUB, or definition=FIELD. The default
value is 0.0.

22–31

Abaqus ID:
Printed on:
INTERACTION COMMANDS

filmCoeffAmplitude
A String specifying the name of the Amplitude object that gives the variation of the film coefficient,
, with time. The default value is an empty string.

Note: Use None in an Abaqus/Standard analysis to specify that the reference film coefficient
is applied immediately at the beginning of the step or linearly over the step. Use None in an
Abaqus/Explicit analysis to specify that the reference film coefficient is applied throughout the
step.

Return value
A ConcentratedFilmCondition object.

Exceptions
None.

22.12.2 setValues(...)
This method modifies the data for an existing ConcentratedFilmCondition 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
ConcentratedFilmCondition method, except for the name and createStepName
arguments.

Return value
None

Exceptions
None.

22–32

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.12.3 setValuesInStep(...)
This method modifies the propagating data of an existing ConcentratedFilmCondition object in the
specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
None.
The optional arguments to setValuesInStep are the same as the optional arguments to the
ConcentratedFilmCondition method, except for the explicitRegionType argument.

Return value
None

Exceptions
None.

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

22.13 ConcentratedFilmConditionState object

The ConcentratedFilmConditionState object stores the propagating data for a

ConcentratedFilmCondition object. One instance of this object is created internally by the
ConcentratedFilmCondition object for each step. The instance is also deleted internally by the
ConcentratedFilmCondition object.
The ConcentratedFilmConditionState object has no constructor or methods.
The ConcentratedFilmConditionState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22–33

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.13.1 Members
The ConcentratedFilmConditionState object has the following members:
interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
sinkTemperature
A Float specifying the sink temperature.
sinkTemperatureState
A SymbolicConstant specifying the propagation state of the sinkTemperature member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
sinkAmplitudeState
A SymbolicConstant specifying the propagation state of the sinkAmplitude member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
filmCoeff
A Float specifying the film coefficient.
filmCoeffState
A SymbolicConstant specifying the propagation state of the filmCoeff member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
filmCoeffAmplitudeState
A SymbolicConstant specifying the propagation state of the filmCoeffAmplitude member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
nodalArea
A Float specifying the area associated with the node where the concentrated film condition is
applied.
nodalAreaState
A SymbolicConstant specifying the propagation state of the nodalArea member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
interactionProperty
A String specifying the FilmConditionProp object associated with this interaction.
sinkAmplitude
A String specifying the name of the Amplitude object that gives the variation of the sink
temperature.
filmCoeffAmplitude
A String specifying the name of the Amplitude object that gives the variation of the film coefficient.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE

22–34

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.13.2 Corresponding analysis keywords

*CFILM

22.14 ConcentratedRadiationToAmbient object

The ConcentratedRadiationToAmbient object defines radiant heat transfer between a point and its
nonreflecting environment.
The ConcentratedRadiationToAmbient object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.14.1 ConcentratedRadiationToAmbient(...)
This method creates a ConcentratedRadiationToAmbient object.

Path
mdb.models[name].ConcentratedRadiationToAmbient

Required arguments
name
A String specifying the repository key.

22–35

Abaqus ID:
Printed on:
INTERACTION COMMANDS

createStepName
A String specifying the name of the step in which the ConcentratedRadiationToAmbient object is
created.
region
A Region object specifying the region to which the concentrated radiation interaction is applied.
The interaction is applied to each node in the region.
ambientTemperature
A Float specifying the reference ambient temperature, .
ambientTemperatureAmp
A String specifying the name of the Amplitude object that gives the variation of the ambient
temperature with time.
Note: Use None in an Abaqus/Standard analysis to specify that the reference ambient temperature
is applied immediately at the beginning of the step or linearly over the step. Use None in an
Abaqus/Explicit analysis to specify that the reference ambient temperature is applied throughout
the step.

emissivity
A Float specifying the emissivity, .
Optional arguments
nodalArea
A Float specifying the area associated with the node where the concentrated radiation interaction
is applied. The default value is 1.0.
explicitRegionType
A SymbolicConstant specifying how the concentrated radiation is applied to the boundary of an
adaptive mesh domain. Possible values are LAGRANGIAN, SLIDING, and EULERIAN. The
default value is LAGRANGIAN.

Note: explicitRegionType applies only during an Abaqus/Explicit analysis.

field
A String specifying the name of the AnalyticalField object associated with this interaction. The
field argument applies only when distributionType=ANALYTICAL_FIELD. The default value is
an empty string.
distributionType
A SymbolicConstant specifying how the radiation is defined. Possible values are UNIFORM and
ANALYTICAL_FIELD. The default value is UNIFORM.

Return value
A ConcentratedRadiationToAmbient object.

22–36

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Exceptions
None.

22.14.2 setValues(...)
This method modifies the data for an existing ConcentratedRadiationToAmbient 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
ConcentratedRadiationToAmbient method, except for the name and createStepName
arguments.

Return value
None

Exceptions
None.

22.14.3 setValuesInStep(...)
This method modifies the propagating data of an existing ConcentratedRadiationToAmbient object in
the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
None.
The optional arguments to setValuesInStep are the same as the arguments to the
ConcentratedRadiationToAmbient method, except for the name, createStepName, region,
and explicitRegionType arguments.

22–37

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Return value
None

Exceptions
None.

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

22.15 ConcentratedRadiationToAmbientState object

The ConcentratedRadiationToAmbientState object stores the propagating data for a

ConcentratedRadiationToAmbient object. One instance of this object is created internally by the
ConcentratedRadiationToAmbient object for each step. The instance is also deleted internally by the
ConcentratedRadiationToAmbient object.
The ConcentratedRadiationToAmbientState object has no constructor or methods.
The ConcentratedRadiationToAmbientState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.15.1 Members
The ConcentratedRadiationToAmbientState object has the following members:
ambientTemperature
A Float specifying the ambient temperature.
ambientTemperatureState
A SymbolicConstant specifying the propagation state of the ambientTemperature member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
ambientTemperatureAmpState
A SymbolicConstant specifying the propagation state of the ambientTemperatureAmp member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
emissivity
A Float specifying the emissivity.

22–38

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

emissivityState
A SymbolicConstant specifying the propagation state of the emissivity member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
nodalArea
A Float specifying the area associated with the node where the concentrated radiation is applied.
nodalAreaState
A SymbolicConstant specifying the propagation state of the nodalArea member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
ambientTemperatureAmp
A String specifying the name of the Amplitude object that gives the variation of the ambient
temperature with time.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.15.2 Corresponding analysis keywords

*CRADIATE

22.16 ContactControl object

The ContactControl object is the abstract base type for other ContactControl objects. The ContactControl
object has no explicit constructor, members, or methods.

Access
import interaction

22–39

Abaqus ID:
Printed on:
INTERACTION COMMANDS

mdb.models[name].contactControls[name]

22.16.1 Members
The ContactControl object has no members.

22.17 ContactDamage object

The ContactDamage object specifies damage options for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].damage

22.17.1 Damage(...)
This method creates a ContactDamage object.

Path
mdb.models[name].interactionProperties[name].Damage

Required argument
initTable
A sequence of sequences of Floats specifying the values defining the damage initiation. The items
in the table data are described below.
Optional arguments
criterion
A SymbolicConstant specifying the type of data used to define the initiation of damage.
Possible values are MAX_STRESS, MAX_SEPARATION, QUAD_TRACTION, and
QUAD_SEPARATION. The default value is MAX_STRESS.
initTempDep
A Boolean specifying whether the initiation data depend on temperature. The default value is OFF.
initDependencies
An Int specifying the number of initiation data field variables. The default value is 0.
useEvolution
A Boolean specifying whether evolution data will be defined. The default value is OFF.

22–40

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

evolutionType
A SymbolicConstant specifying the type of data used to define the evolution of damage. This
argument is valid only when useEvolution=ON. Possible values are DISPLACEMENT and
ENERGY. The default value is DISPLACEMENT.
softening
A SymbolicConstant specifying the type of data used to define the evolution softening response.
This argument is valid only when useEvolution=ON. The TABULAR value can be used only
when evolutionType=DISPLACEMENT. Possible values are LINEAR, EXPONENTIAL, and
TABULAR. The default value is LINEAR.
useMixedMode
A Boolean specifying whether evolution data be defined using dependent behavior modes. This
argument is valid only when useEvolution=ON. The default value is OFF.
mixedModeType
A SymbolicConstant specifying the mode mix fracture criterion. This argument is valid only when
useEvolution=ON and when useMixedMode=ON. The POWER_LAW and BK values can be used
only when evolutionType=ENERGY. Possible values are TABULAR, POWER_LAW, and BK.
The default value is TABULAR.
modeMixRatio
A SymbolicConstant specifying the mode mix ratio type. This argument is valid only when
useEvolution=ON and when useMixedMode=ON. The TRACTION value can be used only when
mixedModeType=TABULAR. Possible values are ENERGY and TRACTION. The default value
is ENERGY.
exponent
None or a Float specifying the exponent in the power-law or BK criterion that defines the variation
of fracture energy with mode mix. This argument is valid only when useEvolution=ON and when
mixedModeType=POWER_LAW or BK. The default value is None.
evolTempDep
A Boolean specifying whether the evolution data depend on temperature. This argument is valid
only when useEvolution=ON. The default value is OFF.
evolDependencies
An Int specifying the number of evolution data field variables. This argument is valid only when
useEvolution=ON. The default value is 0.
evolTable
A sequence of sequences of Floats specifying the values defining the damage evolution. The items
in the table data are described below. This argument is valid only when useEvolution=ON.
useStabilization
A Boolean specifying whether stabilization data will be defined. This argument is valid only when
useEvolution=ON. The default value is OFF.

22–41

Abaqus ID:
Printed on:
INTERACTION COMMANDS

viscosityCoef
None or a Float specifying the viscosity coefficient. This argument is valid only when
useStabilization=ON. The default value is None.
Table data
Table data for initTable:
If criterion=MAX_STRESS or QUAD_TRACTION, the table data specify the following:
• Maximum nominal stress in the normal-only mode.
• Maximum nominal stress in the first shear direction (for a mode that involves separation only in this
direction).
• Maximum nominal stress in the second shear direction (for a mode that involves separation only in
this direction).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If criterion=MAX_SEPARATION or QUAD_SEPARATION, the table data specify the following:
• Separation at damage initiation in a normal-only mode.
• Separation at damage initiation in a shear-only mode that involves separation only along the first
shear direction.
• Separation at damage initiation in a shear-only mode that involves separation only along the second
shear direction.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
Table data for evolTable:
If evolutionType=DISPLACEMENT, softening=LINEAR, and useMixedMode=OFF, the table data
specify the following:
• Effective total or plastic displacement at failure, measured from the time of damage initiation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=ENERGY, softening=LINEAR or EXPONENTIAL, and useMixedMode=OFF,
the table data specify the following:
• Fracture energy.

22–42

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=DISPLACEMENT, softening=LINEAR, useMixedMode=ON,
mixedModeType=TABULAR, and modeMixRatio=ENERGY or TRACTION, the table data specify
the following:
• Total displacement at failure, measured from the time of damage initiation.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=ENERGY, softening=LINEAR or EXPONENTIAL, useMixedMode=ON,
mixedModeType=TABULAR, and modeMixRatio=ENERGY or TRACTION, the table data specify the
following:
• Fracture energy.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=DISPLACEMENT, softening=EXPONENTIAL, and useMixedMode=OFF, the
table data specify the following:
• Effective total or plastic displacement at failure, measured from the time of damage initiation.
• Exponential law parameter.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

22–43

Abaqus ID:
Printed on:
INTERACTION COMMANDS

If evolutionType=DISPLACEMENT, softening=EXPONENTIAL, useMixedMode=ON,

mixedModeType=TABULAR, and modeMixRatio=ENERGY or TRACTION, the table data specify the
following:
• Total displacement at failure, measured from the time of damage initiation.
• Exponential law parameter.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=DISPLACEMENT, softening=TABULAR, and useMixedMode=OFF, the table
data specify the following:
• Damage variable.
• Effective total or plastic displacement at failure, measured from the time of damage initiation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=DISPLACEMENT, softening=TABULAR, useMixedMode=ON,
mixedModeType=TABULAR, and modeMixRatio=ENERGY or TRACTION, the table data specify
the following:
• Damage variable.
• Effective total displacement, measured from the time of damage initiation.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If evolutionType=ENERGY, softening=LINEAR or EXPONENTIAL, useMixedMode=ON,
mixedModeType=POWER_LAW or BK, and modeMixRatio=ENERGY, the table data specify the
following:
• Normal mode fracture energy.

22–44

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• Shear mode fracture energy for failure in the first shear direction.
• Shear mode fracture energy for failure in the second shear direction.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ContactDamage object.

Exceptions
None.

22.17.2 setValues(...)
This method modifies the ContactDamage object.

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

Return value
None

Exceptions
None.

22.17.3 Members
The ContactDamage object has the following members:
criterion
A SymbolicConstant specifying the type of data used to define the initiation of damage.
Possible values are MAX_STRESS, MAX_SEPARATION, QUAD_TRACTION, and
QUAD_SEPARATION. The default value is MAX_STRESS.
initTempDep
A Boolean specifying whether the initiation data depend on temperature. The default value is OFF.

22–45

Abaqus ID:
Printed on:
INTERACTION COMMANDS

initDependencies
An Int specifying the number of initiation data field variables. The default value is 0.
useEvolution
A Boolean specifying whether evolution data will be defined. The default value is OFF.
evolutionType
A SymbolicConstant specifying the type of data used to define the evolution of damage. This
argument is valid only when useEvolution=ON. Possible values are DISPLACEMENT and
ENERGY. The default value is DISPLACEMENT.
softening
A SymbolicConstant specifying the type of data used to define the evolution softening response.
This argument is valid only when useEvolution=ON. The TABULAR value can be used only
when evolutionType=DISPLACEMENT. Possible values are LINEAR, EXPONENTIAL, and
TABULAR. The default value is LINEAR.
useMixedMode
A Boolean specifying whether evolution data be defined using dependent behavior modes. This
argument is valid only when useEvolution=ON. The default value is OFF.
mixedModeType
A SymbolicConstant specifying the mode mix fracture criterion. This argument is valid only when
useEvolution=ON and when useMixedMode=ON. The POWER_LAW and BK values can be used
only when evolutionType=ENERGY. Possible values are TABULAR, POWER_LAW, and BK.
The default value is TABULAR.
modeMixRatio
A SymbolicConstant specifying the mode mix ratio type. This argument is valid only when
useEvolution=ON and when useMixedMode=ON. The TRACTION value can be used only when
mixedModeType=TABULAR. Possible values are ENERGY and TRACTION. The default value
is ENERGY.
exponent
None or a Float specifying the exponent in the power-law or BK criterion that defines the variation
of fracture energy with mode mix. This argument is valid only when useEvolution=ON and when
mixedModeType=POWER_LAW or BK. The default value is None.
evolTempDep
A Boolean specifying whether the evolution data depend on temperature. This argument is valid
only when useEvolution=ON. The default value is OFF.
evolDependencies
An Int specifying the number of evolution data field variables. This argument is valid only when
useEvolution=ON. The default value is 0.
useStabilization
A Boolean specifying whether stabilization data will be defined. This argument is valid only when
useEvolution=ON. The default value is OFF.

22–46

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

viscosityCoef
None or a Float specifying the viscosity coefficient. This argument is valid only when
useStabilization=ON. The default value is None.
initTable
A tuple of tuples of Floats specifying the values defining the damage initiation. The items in the
table data are described below.
evolTable
A tuple of tuples of Floats specifying the values defining the damage evolution. The items in the
table data are described below. This argument is valid only when useEvolution=ON.

22.17.4 Corresponding analysis keywords

*DAMAGE INITIATION
*DAMAGE EVOLUTION
*DAMAGE STABILIZATION

22.18 ContactDamping object

The ContactDamping object specifies damping for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].damping

22.18.1 Damping(...)
This method creates a ContactDamping object.

Path
mdb.models[name].interactionProperties[name].Damping

Required arguments
None.

22–47

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
definition
A SymbolicConstant specifying the method used to define the damping. Possible values are
DAMPING_COEFFICIENT and CRITICAL_DAMPING_FRACTION. The default value is
DAMPING_COEFFICIENT.
tangentFraction
The SymbolicConstant DEFAULT or a Float specifying the tangential damping coefficient divided
by the normal damping coefficient. The default value is DEFAULT.
clearanceDependence
A SymbolicConstant specifying the variation of the damping coefficient or fraction with respect
to clearance. Possible values are STEP, LINEAR, and BILINEAR. The default value is STEP.
If definition=CRITICAL_DAMPING_FRACTION, the only possible value is STEP.
table
A sequence of pairs of Floats specifying the damping properties. The items in the table data are
described below.
Table data
If definition=DAMPING_COEFFICIENT and clearanceDependence=STEP, the table data specify the
following:
• Damping coefficient.
If definition=DAMPING_COEFFICIENT and clearanceDependence=LINEAR or BILINEAR, the table
data specify the following:
• Damping coefficient.
• Clearance.
Two pairs must be given for clearanceDependence=LINEAR and three pairs for
clearanceDependence=BILINEAR. The first pair must have clearance=0.0, and the last pair must
have coefficient=0.0.
If definition=CRITICAL_DAMPING_FRACTION, the table data specify the following:
• Critical damping fraction.

Return value
A ContactDamping object.

Exceptions
None.

22.18.2 setValues(...)
This method modifies the ContactDamping object.

22–48

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

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

Return value
None

Exceptions
None.

22.18.3 Members
The ContactDamping object has the following members:
definition
A SymbolicConstant specifying the method used to define the damping. Possible values are
DAMPING_COEFFICIENT and CRITICAL_DAMPING_FRACTION. The default value is
DAMPING_COEFFICIENT.
tangentFraction
The SymbolicConstant DEFAULT or a Float specifying the tangential damping coefficient divided
by the normal damping coefficient. The default value is DEFAULT.
clearanceDependence
A SymbolicConstant specifying the variation of the damping coefficient or fraction with respect
to clearance. Possible values are STEP, LINEAR, and BILINEAR. The default value is STEP.
If definition=CRITICAL_DAMPING_FRACTION, the only possible value is STEP.
table
A tuple of pairs of Floats specifying the damping properties. The items in the table data are
described below.

22.18.4 Corresponding analysis keywords

*CONTACT DAMPING

22–49

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.19 ContactExp object

The ContactExp object defines the contact domain and associated properties during contact in an
Abaqus/Explicit analysis.
The ContactExp object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.19.1 ContactExp(...)
This method creates a ContactExp object.

Path
mdb.models[name].ContactExp

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which this contact interaction is created.
Optional arguments
useAllstar
A Boolean specifying whether the contacting surface pair consists of all exterior faces, shell edges,
beam segments, analytical rigid surfaces, and when applicable, Eulerian material surfaces.
includedPairs
A RegionPairs object specifying the domain pairs included in contact.
excludedPairs
A RegionPairs object specifying the domain pairs excluded from contact.
contactPropertyAssignments
A ContactPropertyAssignment object specifying the contact property assignments in the contact
domain.
surfaceThicknessAssignments
A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact
domain.

22–50

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

surfaceOffsetAssignments
A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact
domain.
surfaceFeatureAssignments
A SurfaceFeatureAssignment object specifying the surface feature angle assignments in the contact
domain.
masterSlaveAssignments
A MasterSlaveAssignment object specifying the master-slave assignments in the contact domain.

Return value
A ContactExp object.

Exceptions
None.

22.19.2 ContactExp(...)
This method creates a ContactExp object.

Path
mdb.models[name].ContactExp

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which this contact interaction is created.
Optional arguments
useAllstar
A Boolean specifying whether the contacting surface pair consists of all exterior faces, shell edges,
beam segments, analytical rigid surfaces, and when applicable, Eulerian material surfaces.
includedPairs
A sequence of pairs of Region objects or SymbolicConstants that specifies the surface pairs in
contact. Possible values of the SymbolicConstants are ALLSTAR and SELF. This argument is
valid only when useAllstar=OFF.
excludedPairs
A sequence of pairs of Region objects or SymbolicConstants that specifies the surface pairs
excluded from contact. Possible values of the SymbolicConstants are ALLSTAR and SELF.

22–51

Abaqus ID:
Printed on:
INTERACTION COMMANDS

contactPropertyAssignments
A sequence of tuples specifying the properties assigned to each surface pair. Each tuple contains
three entries:
• A Region object or the SymbolicConstant GLOBAL.
• A Region object or the SymbolicConstant SELF.
• A String specifying an InteractionProperty object associated with this pair of regions.
surfaceThicknessAssignments
A sequence of tuples specifying the surface thickness assignments in the contact domain. Each
tuple contains three entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the surface thickness is assigned.
• A Float or a SymbolicConstant specifying the overriding thickness value to be used in the
contact definition. Possible values of the SymbolicConstant are ORIGINAL or THINNING.
• A Float specifying a scale factor that multiplies the thickness value specified in the second
entry.
surfaceOffsetAssignments
A sequence of tuples specifying the surface offset fraction assignments in the contact domain.
Each tuple contains two entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the surface offset fraction is assigned.
• A Float or a SymbolicConstant specifying the offset fraction value to be used in the contact
definition. Possible values of the SymbolicConstant are ORIGINAL, SPOS, or SNEG.
surfaceFeatureAssignments
A sequence of tuples specifying the surface feature angle assignments in the contact domain. Each
tuple contains two entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the surface feature angle is assigned.
• A Float or a SymbolicConstant specifying the overriding feature angle value to be used in the
contact definition. Possible values of the SymbolicConstant are PERIMETER or NONE.
masterSlaveAssignments
A sequence of tuples specifying pure master-slave assignments in the contact domain. Each tuple
contains three entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the first surface that
defines the master-slave assignment.
• A region object specifying the second surface in the master-slave assignment definition.
• A SymbolicConstant specifying the status of the first surface. Possible values are MASTER
and SLAVE.

22–52

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
A ContactExp object.

Exceptions
None.

22.19.3 Members
The ContactExp object can have the following members:
name
A String specifying the repository key.
includedPairs
A RegionPairs object specifying the domain pairs included in contact.
excludedPairs
A RegionPairs object specifying the domain pairs excluded from contact.
contactPropertyAssignments
A ContactPropertyAssignment object specifying the contact property assignments in the contact
domain.
surfaceThicknessAssignments
A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact
domain.
surfaceOffsetAssignments
A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact
domain.
surfaceFeatureAssignments
A SurfaceFeatureAssignment object specifying the surface feature angle assignments in the contact
domain.
masterSlaveAssignments
A MasterSlaveAssignment object specifying the master-slave assignments in the contact domain.

22.19.4 Corresponding analysis keywords

*CONTACT

22–53

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.20 ContactInitialization object

The ContactInitialization object is the abstract base type for other ContactInitialization objects. The
ContactInitialization object has no explicit constructor, members, or methods.

Access
import interaction
mdb.models[name].contactInitialization[name]

22.20.1 Members
The ContactInitialization object has no members.

22.21 ContactProperty object

The ContactProperty object defines a contact interaction property.

The ContactProperty object is derived from the InteractionProperty object.

Access
import interaction
mdb.models[name].interactionProperties[name]

22.21.1 ContactProperty(...)
This method creates a ContactProperty object.

Path
mdb.models[name].ContactProperty

Required argument
name
A String specifying the interaction property repository key.
Optional arguments
None.

22–54

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
A ContactProperty object.

Exceptions
None.

22.21.2 Members
The ContactProperty object can have the following members:
tangentialBehavior
A ContactTangentialBehavior object.
normalBehavior
A NormalBehavior object.
damping
A ContactDamping object.
damage
A ContactDamage object.
fractureCriterion
A FractureCriterion object.
cohesiveBehavior
A CohesiveBehavior object.
thermalConductance
A ThermalConductance object.
heatGeneration
A GapHeatGeneration object.
radiation
A Radiation object.
geometricProperties
A GeometricProperties object.

22.21.3 Corresponding analysis keywords

*SURFACE INTERACTION

22–55

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.22 ContactPropertyAssignment object

The ContactPropertyAssignment object stores the contact property assignment definition for domain
pairs in ContactExp and ContactStd objects. The ContactPropertyAssignment object has no constructor
or members.

Access
import interaction
mdb.models[name].interactions[name].contactPropertyAssignments

22.22.1 changeValuesInStep(...)
This method allows modification of contact property assignments to domain pairs already defined in a
given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the contact property assignments are to be
modified.
index
An Int specifying the position of the contact property assignment whose value is to be modified.
value
A String specifying the value of the contact property to be assigned to the domain pair whose index
is referenced.
Optional arguments
None.

Return value
None

Exceptions
None.

22.22.2 appendInStep(...)
This method allows addition of contact property assignments to new domain pairs in a given step.

22–56

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Arguments
Required arguments
stepName
A String specifying the name of the step in which new contact property assignments are to be
defined.
assignments
A sequence of tuples specifying the properties assigned to each surface pair. Each tuple contains
three entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN.
• A region object or the SymbolicConstant SELF. When used with ContactExp objects, this
parameter can also be a string that references an Eulerian material surface.
• A String specifying a ContactProperty object associated with this pair of regions.

Optional arguments
None.

Return value
None

Exceptions
None.

22.22.3 delete(...)
The delete method allows you to delete existing contact property assignments.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each contact property assignment to delete.
Optional arguments
None.

Return value
None

22–57

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Exceptions
None.

22.22.4 Members
The ContactPropertyAssignment object has no members.

22.22.5 Corresponding analysis keywords

*CONTACT PROPERTY ASSIGNMENT

22.23 ContactStd object

The ContactStd object defines the contact domain and associated properties during contact in an
Abaqus/Standard analysis.
The ContactStd object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.23.1 ContactStd(...)
This method creates a ContactStd object.

Path
mdb.models[name].ContactStd

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which this contact interaction is created.

22–58

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Optional arguments
useAllstar
A Boolean specifying whether the contacting surface pairs consist of all exterior faces in the model.
includedPairs
A RegionPairs object specifying the domain pairs included in contact.
excludedPairs
A RegionPairs object specifying the domain pairs excluded from contact.
contactPropertyAssignments
A ContactPropertyAssignment object specifying the contact property assignments in the contact
domain.
surfaceThicknessAssignments
A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact
domain.
surfaceOffsetAssignments
A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact
domain.
masterSlaveAssignments
A MasterSlaveAssignment object specifying the master-slave assignments in the contact domain.
initializationAssignments
An InitializationAssignment object specifying the contact initialization assignments in the contact
domain.
smoothingAssignments
A SmoothingAssignment object specifying the surface smoothing assignments in the contact
domain.

Return value
A ContactStd object.

Exceptions
None.

22.23.2 ContactStd(...)
This method creates a ContactStd object.

Path
mdb.models[name].ContactStd

22–59

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which this contact interaction is created.
Optional arguments
useAllstar
A Boolean specifying whether the contacting surface pairs consist of all exterior faces in the model.
includedPairs
A sequence of pairs of Region objects or SymbolicConstants that specifies the surface pairs in
contact. Possible values of the SymbolicConstants are ALLSTAR and SELF. This argument is
valid only when useAllstar=OFF.
excludedPairs
A sequence of pairs of Region objects or SymbolicConstants that specifies the surface pairs
excluded from contact. Possible values of the SymbolicConstants are ALLSTAR and SELF.
contactPropertyAssignments
A sequence of tuples specifying the properties assigned to each surface pair. Each tuple contains
three entries:
• A Region object or the SymbolicConstant GLOBAL.
• A Region object or the SymbolicConstant SELF.
• A String specifying an InteractionProperty object associated with this pair of regions.
surfaceThicknessAssignments
A sequence of tuples specifying the surface thickness assignments in the contact domain. Each
tuple contains three entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the surface thickness is assigned.
• A Float or a SymbolicConstant specifying the overriding thickness value to be used in the
contact definition. The SymbolicConstant ORIGINAL may be specified instead of a floating
point value.
• A Float specifying a scale factor that multiplies the thickness value specified in the second
entry.
surfaceOffsetAssignments
A sequence of tuples specifying the surface offset fraction assignments in the contact domain.
Each tuple contains two entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the surface offset fraction is assigned.

22–60

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• A Float or a SymbolicConstant specifying the offset fraction value to be used in the contact
definition. Possible values of the SymbolicConstant are ORIGINAL, SPOS, or SNEG.
masterSlaveAssignments
A sequence of tuples specifying master-slave assignments in the contact domain. Each tuple
contains three entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the first surface that
defines the master-slave assignment.
• A region object specifying the second surface in the master-slave assignment definition.
• A SymbolicConstant specifying the status of the first surface. Possible values are MASTER,
SLAVE, and BALANCED.
initializationAssignments
A sequence of tuples specifying the contact initialization data assigned to each surface pair. Each
tuple contains three entries:
• A Region object or the SymbolicConstant GLOBAL.
• A Region object or the SymbolicConstant SELF.
• A String specifying a StdInitialization object associated with this pair of regions.
smoothingAssignments
A sequence of tuples specifying the surface smoothing assignments in the contact domain. Each
tuple contains two entries:
• A region object specifying the surface to which the smoothing option is assigned.
• A SymbolicConstant specifying the smoothing option to be used in the contact definition.
Possible values of the SymbolicConstant are NONE, REVOLUTION, or SPHERICAL.

Return value
A ContactStd object.

Exceptions
None.

22.23.3 Members
The ContactStd object can have the following members:
name
A String specifying the repository key.
includedPairs
A RegionPairs object specifying the domain pairs included in contact.

22–61

Abaqus ID:
Printed on:
INTERACTION COMMANDS

excludedPairs
A RegionPairs object specifying the domain pairs excluded from contact.
contactPropertyAssignments
A ContactPropertyAssignment object specifying the contact property assignments in the contact
domain.
surfaceThicknessAssignments
A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact
domain.
surfaceOffsetAssignments
A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact
domain.
masterSlaveAssignments
A MasterSlaveAssignment object specifying the master-slave assignments in the contact domain.
initializationAssignments
An InitializationAssignment object specifying the contact initialization assignments in the contact
domain.
smoothingAssignments
A SmoothingAssignment object specifying the surface smoothing assignments in the contact
domain.

22.23.4 Corresponding analysis keywords

*CONTACT

22.24 ContactTangentialBehavior object

The ContactTangentialBehavior object specifies tangential behavior for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].tangentialBehavior

22.24.1 TangentialBehavior(...)
This method creates a ContactTangentialBehavior object.

22–62

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Path
mdb.models[name].interactionProperties[name].TangentialBehavior

Required arguments
None.
Optional arguments
formulation
A SymbolicConstant specifying the friction formulation. Possible values are FRICTIONLESS,
PENALTY, EXPONENTIAL_DECAY, ROUGH, LAGRANGE, and USER_DEFINED. The
default value is FRICTIONLESS.
directionality
A SymbolicConstant specifying the directionality of the friction. Possible values are ISOTROPIC
and ANISOTROPIC. The default value is ISOTROPIC.
slipRateDependency
A Boolean specifying whether the data depend on slip rate. The default value is OFF.
pressureDependency
A Boolean specifying whether the data depend on contact pressure. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variables. The default value is 0.
exponentialDecayDefinition
A SymbolicConstant specifying the exponential decay definition. Possible values are
COEFFICIENTS and TEST_DATA. The default value is COEFFICIENTS.
table
A sequence of sequences of Floats specifying tangential behavior. The items in the table data are
described below.
shearStressLimit
None or a Float specifying the shear stress limit. If shearStressLimit=None, there is no upper
limit. The default value is None.
maximumElasticSlip
A SymbolicConstant specifying what the maximum elastic slip will be. Possible values are
FRACTION and ABSOLUTE_DISTANCE. The default value is FRACTION.
fraction
A Float specifying the fraction of a characteristic surface dimension. The default value is 0.0.
absoluteDistance
A Float specifying the absolute distance. The default value is 0.0.

22–63

Abaqus ID:
Printed on:
INTERACTION COMMANDS

elasticSlipStiffness
None or a Float specifying the elastic slip stiffness. If elasticSlipStiffness=None, there is no upper
limit. The default value is None.
nStateDependentVars
An Int specifying the number of state-dependent variables. The default value is 0.
useProperties
A Boolean specifying whether property values will be used. The default value is OFF.
Table data
If formulation=PENALTY or LAGRANGE, the table data specify the following:
• Friction coefficient in the first slip direction, .
• Friction coefficient in the second slip direction, (if directionality=ANISOTROPIC).
• Slip rate, if the data depend on slip rate.
• Contact pressure, if the data depend on contact pressure.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If formulation=EXPONENTIAL_DECAY and exponentialDecayDefinition=COEFFICIENTS, the table
data specify the following:
• Static friction coefficient.
• Kinetic friction coefficient.
• Decay coefficient.
If formulation=EXPONENTIAL_DECAY and exponentialDecayDefinition=TEST_DATA, the table
data specify the following:
• Friction coefficient.
• Slip rate.
If formulation=USER_DEFINED, the table data specify the following:
• Friction property.

Return value
A ContactTangentialBehavior object.

Exceptions
None.

22–64

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.24.2 setValues(...)
This method modifies the ContactTangentialBehavior object.

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

Return value
None

Exceptions
None.

22.24.3 Members
The ContactTangentialBehavior object has the following members:
formulation
A SymbolicConstant specifying the friction formulation. Possible values are FRICTIONLESS,
PENALTY, EXPONENTIAL_DECAY, ROUGH, LAGRANGE, and USER_DEFINED. The
default value is FRICTIONLESS.
directionality
A SymbolicConstant specifying the directionality of the friction. Possible values are ISOTROPIC
and ANISOTROPIC. The default value is ISOTROPIC.
slipRateDependency
A Boolean specifying whether the data depend on slip rate. The default value is OFF.
pressureDependency
A Boolean specifying whether the data depend on contact pressure. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variables. The default value is 0.
exponentialDecayDefinition
A SymbolicConstant specifying the exponential decay definition. Possible values are
COEFFICIENTS and TEST_DATA. The default value is COEFFICIENTS.

22–65

Abaqus ID:
Printed on:
INTERACTION COMMANDS

shearStressLimit
None or a Float specifying the shear stress limit. If shearStressLimit=None, there is no upper
limit. The default value is None.
maximumElasticSlip
A SymbolicConstant specifying what the maximum elastic slip will be. Possible values are
FRACTION and ABSOLUTE_DISTANCE. The default value is FRACTION.
fraction
A Float specifying the fraction of a characteristic surface dimension. The default value is 0.0.
absoluteDistance
A Float specifying the absolute distance. The default value is 0.0.
elasticSlipStiffness
None or a Float specifying the elastic slip stiffness. If elasticSlipStiffness=None, there is no upper
limit. The default value is None.
nStateDependentVars
An Int specifying the number of state-dependent variables. The default value is 0.
useProperties
A Boolean specifying whether property values will be used. The default value is OFF.
table
A tuple of tuples of Floats specifying tangential behavior. The items in the table data are described
below.

22.24.4 Corresponding analysis keywords

*FRICTION
*CHANGE FRICTION

22.25 CyclicSymmetry object

The CyclicSymmetry object defines a cyclic symmetry analysis.

The CyclicSymmetry object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22–66

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.25.1 CyclicSymmetry(...)
This method creates a CyclicSymmetry object.

Path
mdb.models[name].CyclicSymmetry

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the cyclic symmetry interaction should be
created.
master
A Region object specifying the master surface.
slave
A Region object specifying the slave surface.
repetitiveSectors
An Int specifying the total number of sectors in the cyclic symmetric model.
axisPoint1
A Region object specifying the first point of the axis of symmetry. The region should
contain exactly one mesh node, vertex, interesting point, reference point or datum point. In a
two-dimensional model axisPoint1 is the only point used to define the axis of symmetry.
axisPoint2
A Region object specifying the second point of the axis of symmetry. The region should
contain exactly one mesh node, vertex, interesting point, reference point or datum point. In a
two-dimensional model this point is ignored.
Optional arguments
extractedNodalDiameter
A SymbolicConstant specifying whether Abaqus should extract all possible nodal diameters
or the nodal diameters between the user-specified values for lowestNodalDiameter
and highestNodalDiameter. Possible values are ALL_NODAL_DIAMETER and
SPECIFIED_NODAL_DIAMETER. The default value is ALL_NODAL_DIAMETER.
lowestNodalDiameter
An Int specifying the lowest nodal diameter to be used in the eigenfrequency analysis. The default
value is 0.

22–67

Abaqus ID:
Printed on:
INTERACTION COMMANDS

highestNodalDiameter
An Int specifying the highest nodal diameter to be used in the eigenfrequency analysis. This
argument value should be less than or equal to the half of the total number of sectors (as specified
in the repetitiveSectors parameter). The default value is 0.
excitationNodalDiameter
An Int specifying the nodal diameter for which the modal-based steady-state dynamic analysis
will be performed. This value should be greater than or equal to the lowest nodal diameter
(specified in the lowestNodalDiameter parameter), and less than or equal to the highest nodal
diameter (specified in the highestNodalDiameter parameter). The default value is 0.
adjustTie
A Boolean specifying whether or not to adjust the slave surface of the cyclic symmetry to tie it to
the master surface. The default value is ON.
positionTolerance
A Float specifying the position tolerance. ThepositionTolerance argument applies only when
positionToleranceMethod=SPECIFY_TOLERANCE. The default value is 0.0.
positionToleranceMethod
A SymbolicConstant specifying the method used to determine the position tolerance. Possible
values are COMPUTED_TOLERANCE and SPECIFY_TOLERANCE. The default value is
COMPUTED_TOLERANCE.

Return value
A CyclicSymmetry object.

Exceptions
None.

22.25.2 swapSurfaces()
This method switches the master and slave surfaces of a cyclic symmetry interaction. This command is
valid only during the step in which the interaction is created.

Arguments
None.

Return value
None

Exceptions
None.

22–68

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.25.3 setValues(...)
This method modifies the data for an existing CyclicSymmetry 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 CyclicSymmetry
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

22.25.4 setValuesInStep(...)
This method modifies the propagating data of an existing CyclicSymmetry object in the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
extractedNodalDiameter
A SymbolicConstant specifying whether Abaqus should extract all possible nodal diameters
or the nodal diameters between the user-specified values for lowestNodalDiameter
and highestNodalDiameter. Possible values are ALL_NODAL_DIAMETER and
SPECIFIED_NODAL_DIAMETER. The default value is ALL_NODAL_DIAMETER.
lowestNodalDiameter
An Int specifying the lowest nodal diameter to be used in the eigenfrequency analysis. The default
value is 0.
highestNodalDiameter
An Int specifying the highest nodal diameter to be used in the eigenfrequency analysis. This
argument value should be less than or equal to the half of the total number of sectors (as specified
in the repetitiveSectors parameter). The default value is 0.

22–69

Abaqus ID:
Printed on:
INTERACTION COMMANDS

excitationNodalDiameter
An Int specifying the nodal diameter for which the modal-based steady-state dynamic analysis
will be performed. This value should be greater than or equal to the lowest nodal diameter
(specified in the lowestNodalDiameter parameter), and less than or equal to the highest nodal
diameter (specified in the highestNodalDiameter parameter). The default value is 0.

Return value
None

Exceptions
None.

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

22.25.6 Corresponding analysis keywords

*CLOAD, CYCLIC MODE

*CYCLIC SYMMETRY MODEL
*DLOAD, CYCLIC MODE
*DSLOAD, CYCLIC MODE
*SELECT CYCLIC SYMMETRY MODES
*TIE, CYCLIC SYMMETRY

22.26 CyclicSymmetryState object

The CyclicSymmetryState object stores the propagating data for a CyclicSymmetry object. One instance
of this object is created internally by the CyclicSymmetry object for each step. The instance is also
deleted internally by the CyclicSymmetry object.
The CyclicSymmetryState object has no constructor or methods.
The CyclicSymmetryState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22–70

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.26.1 Members
The CyclicSymmetryState object has the following members:
extractedNodalDiameter
A SymbolicConstant specifying whether Abaqus should extract all possible nodal diameters
or the nodal diameters between the user-specified values for lowestNodalDiameter
and highestNodalDiameter. Possible values are ALL_NODAL_DIAMETER and
SPECIFIED_NODAL_DIAMETER. The default value is ALL_NODAL_DIAMETER.
extractedNodalDiameterState
A SymbolicConstant specifying the propagation state of the extractedNodalDiameter member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
lowestNodalDiameter
An Int specifying the lowest nodal diameter to be used in the eigenfrequency analysis. The default
value is 0.
lowestNodalDiameterState
A SymbolicConstant specifying the propagation state of the lowestNodalDiameter member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
highestNodalDiameter
An Int specifying the highest nodal diameter to be used in the eigenfrequency analysis. This
argument value should be less than or equal to the half of the total number of sectors. The default
value is 0.
highestNodalDiameterState
A SymbolicConstant specifying the propagation state of the highestNodalDiameter member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
excitiationNodalDiameter
An Int specifying the nodal diameter for which the modal-based steady-state dynamic analysis
will be performed. This value should be greater than or equal to the lowest nodal diameter
(specified in the lowestNodalDiameter parameter), and less than or equal to the highest nodal
diameter (specified in the highestNodalDiameter parameter). The default value is 0.
excitiationNodalDiameterState
A SymbolicConstant specifying the propagation state of the excitiationNodalDiameter member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED

22–71

Abaqus ID:
Printed on:
INTERACTION COMMANDS

• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.26.2 Corresponding analysis keywords

*CLOAD, CYCLIC MODE

*DLOAD, CYCLIC MODE
*DSLOAD, CYCLIC MODE
*SELECT CYCLIC SYMMETRY MODES

22.27 ElasticFoundation object

The ElasticFoundation object defines a mechanical foundation.

The ElasticFoundation object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.27.1 ElasticFoundation(...)
This method creates an ElasticFoundation object.

Path
mdb.models[name].ElasticFoundation

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the ElasticFoundation object is created.
createStepName must be set to ’Initial’.

22–72

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

surface
A Region object specifying the surface to which the foundation applies.
stiffness
A Float specifying the foundation stiffness per area (or per length for beams).
Optional arguments
None.

Return value
An ElasticFoundation object.

Exceptions
None.

22.27.2 setValues(...)
This method modifies the data for an existing ElasticFoundation 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 ElasticFoundation
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

22.27.3 setValuesInStep(...)
This method modifies the propagating data of an existing ElasticFoundation object in the specified step.

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

22–73

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional argument
stiffness
A Float specifying the foundation stiffness per area (or per length for beams).

Return value
None

Exceptions
None.

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

22.27.5 Corresponding analysis keywords

*FOUNDATION

22.28 ElasticFoundationState object

The ElasticFoundationState object stores the propagating data for an ElasticFoundation object. One
instance of this object is created internally by the ElasticFoundation object for each step. The instance
is also deleted internally by the ElasticFoundation object.
The ElasticFoundationState object has no constructor or methods.
The ElasticFoundationState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.28.1 Members
The ElasticFoundationState object has the following members:
stiffness
A Float specifying the foundation stiffness per area.

22–74

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

stiffnessState
A SymbolicConstant specifying the propagation state of the stiffness member. Possible values are
UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.29 ExpContactControl object

The ExpContactControl object is used in Abaqus/Explicit analyses to specify optional solution controls
for problems involving contact between bodies.
The ExpContactControl object is derived from the ContactControl object.

Access
import interaction
mdb.models[name].contactControls[name]

22.29.1 ExpContactControl(...)
This method creates an ExpContactControl object.

Path
mdb.models[name].ExpContactControl

Required argument
name
A String specifying the contact controls repository key.

22–75

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
globTrkChoice
A SymbolicConstant specifying whether or not the default value will be used for the maximum
number of increments between global contact searches. Possible values are DEFAULT and
SPECIFY. The default value is DEFAULT.
globTrkInc
An Int specifying the maximum number of increments between global contact searches. The
globTrkInc argument applies only when globTrkChoice=SPECIFY. The default value is 100 for
surface-to-surface contact and 4 for self-contact.
fastLocalTrk
A Boolean specifying whether to use the more computationally efficient local tracking method.
The default value is ON.
scalePenalty
A Float specifying the factor by which Abaqus/Explicit will scale the default penalty stiffness to
obtain the stiffnesses used for the penalty contact pairs. The default value is 1.0.
warpCheckPeriod
An Int specifying the number of increments between checks for highly warped facets on master
surfaces. The default value is 20.
warpCutoff
A Float specifying the out-of-plane warping angle (in degrees), at which a facet will be considered
to be highly warped. The default value is 20.0.

Return value
An ExpContactControl object.

Exceptions
RangeError.

22.29.2 setValues(...)
This method modifies the ExpContactControl object.

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

22–76

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
None

Exceptions
RangeError.

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

22.29.4 Corresponding analysis keywords

*CONTACT CONTROLS

22.30 FilmCondition object

The FilmCondition object defines film coefficients and associated sink temperatures for coupled
temperature-displacement analyses.
The FilmCondition object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.30.1 FilmCondition(...)
This method creates a FilmCondition object.

Path
mdb.models[name].FilmCondition

Required arguments
name
A String specifying the repository key.

22–77

Abaqus ID:
Printed on:
INTERACTION COMMANDS

createStepName
A String specifying the name of the step in which the FilmCondition object is created.
surface
A Region object specifying the name of the surface to which the film condition interaction is
applied.
definition
A SymbolicConstant specifying how the film condition is defined. Possible values are
EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.
Optional arguments
interactionProperty
A String specifying the name of the FilmConditionProp object associated with this interaction.
The interactionProperty argument applies only when definition=PROPERTY_REF. The default
value is an empty string.
sinkTemperature
A Float specifying the reference sink temperature, . The default value is 0.0.
sinkAmplitude
A String specifying the name of the Amplitude object that gives the variation of the sink
temperature, , with time. The default value is an empty string.

Note: Use empty string in an Abaqus/Standard analysis to specify that the reference sink
temperature is applied immediately at the beginning of the step or linearly over the step. Use
empty string in an Abaqus/Explicit analysis to specify that the reference sink temperature is
applied throughout the step.

filmCoeff
A Float specifying the reference film coefficient value, . The filmCoeff argument applies when
definition=EMBEDDED_COEFF, definition=USER_SUB, or definition=FIELD. The default
value is 0.0.
filmCoeffAmplitude
A String specifying the name of the Amplitude object that gives the variation of the film coefficient,
, with time. The default value is an empty string.

Note: Use empty string in an Abaqus/Standard analysis to specify that the reference film
coefficient is applied immediately at the beginning of the step or linearly over the step. Use
empty string in an Abaqus/Explicit analysis to specify that the reference film coefficient is applied
throughout the step.

field
A String specifying the name of the AnalyticalField object associated with this interaction. The
field argument applies only when definition=FIELD. The default value is an empty string.

22–78

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
A FilmCondition object.

Exceptions
None.

22.30.2 setValues(...)
This method modifies the data for an existing FilmCondition 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 FilmCondition method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

22.30.3 setValuesInStep(...)
This method modifies the propagating data of an existing FilmCondition object in the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
None.
The optional arguments to setValuesInStep are the same as the optional arguments to the
FilmCondition method.

22–79

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Return value
None

Exceptions
None.

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

22.31 FilmConditionProp object

The FilmConditionProp object is an interaction property that defines a film coefficient as a function of
temperature and field variables.
The FilmConditionProp object is derived from the InteractionProperty object.

Access
import interaction
mdb.models[name].interactionProperties[name]

22.31.1 FilmConditionProp(...)
This method creates a FilmConditionProp object.

Path
mdb.models[name].FilmConditionProp

Required argument
name
A String specifying the interaction property repository key.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

22–80

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

property
A sequence of sequences of Floats specifying the following:
• The film coefficient, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A FilmConditionProp object.

Exceptions
None.

22.31.2 setValues(...)
This method modifies the FilmConditionProp object.

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

Return value
None

Exceptions
None.

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

22–81

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.31.4 Corresponding analysis keywords

*FILM PROPERTY

22.32 FilmConditionState object

The FilmConditionState object stores the propagating data for a FilmCondition object. One instance of
this object is created internally by the FilmCondition object for each step. The instance is also deleted
internally by the FilmCondition object.
The FilmConditionState object has no constructor or methods.
The FilmConditionState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.32.1 Members
The FilmConditionState object has the following members:
interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
sinkTemperature
A Float specifying the sink temperature.
sinkTemperatureState
A SymbolicConstant specifying the propagation state of the sinkTemperature member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
sinkAmplitudeState
A SymbolicConstant specifying the propagation state of the sinkAmplitude member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
filmCoeff
A Float specifying the film coefficient.
filmCoeffState
A SymbolicConstant specifying the propagation state of the filmCoeff member. Possible values
are UNSET, SET, UNCHANGED, and FREED.

22–82

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

filmCoeffAmplitudeState
A SymbolicConstant specifying the propagation state of the filmCoeffAmplitude member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
interactionProperty
A String specifying the FilmConditionProp object associated with this interaction.
sinkAmplitude
A String specifying the name of the Amplitude object that gives the variation of the sink
temperature.
filmCoeffAmplitude
A String specifying the name of the Amplitude object that gives the variation of the film coefficient.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.32.2 Corresponding analysis keywords

*SFILM
*FILM

22.33 FractureCriterion object

The FractureCriterion object specifies fractureCriterion options for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].fractureCriterion

22–83

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.33.1 FractureCriterion(...)
This method creates a FractureCriterion object.

Path
mdb.models[name].interactionProperties[name].FractureCriterion

Required argument
initTable
A sequence of sequences of Floats specifying the value defining the fracture criterion. The items
in the table data are described below.
Optional arguments
type
A SymbolicConstant specifying the type of data used to define the fracture criterion. The default
value is VCCT.
mixedModeBehavior
A SymbolicConstant specifying the mixed mode behavior type used to define fracture criterion.
Possible values are BK, POWER, and REEDER. The default value is BK.
temperatureDependency
A Boolean specifying whether the fracture criterion data depend on temperature. The default value
is OFF.
dependencies
An Int specifying the number of fracture criterion data field variables. The default value is 0.
tolerance
A SymbolicConstant specifying the tolerance for VCCT type. The default value is 0.2.
Table data
Table data for initTable:
If type=VCCT for mixedModeBehavior=BK or REEDER, the table data specify the following:
• Mode I critical energy release rate, .
• Mode II critical energy release rate, .
• Mode III critical energy release rate, .
• Exponent, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=VCCT for mixedModeBehavior=POWER, the table data specify the following:

22–84

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• Mode I critical energy release rate, .

• Mode II critical energy release rate, .
• Mode III critical energy release rate, .
• Exponent, .
• Exponent, .
• Exponent, .
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A FractureCriterion object.

Exceptions
None.

22.33.2 setValues(...)
This method modifies the FractureCriterion object.

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

Return value
None

Exceptions
None.

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

22–85

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.33.4 Corresponding analysis keywords

*FRACTURE CRITERION

22.34 GapHeatGeneration object

The GapHeatGeneration object specifies heat generation for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].heatGeneration

22.34.1 HeatGeneration(...)
This method creates a GapHeatGeneration object.

Path
mdb.models[name].interactionProperties[name].HeatGeneration

Required arguments
None.
Optional arguments
conversionFraction
A Float specifying the fraction of dissipated energy caused by friction or electric currents that is
converted to heat. The default value is 1.0.
slaveFraction
A Float specifying the fraction of converted heat distributed to the slave surface. The default value
is 0.5.

Return value
A GapHeatGeneration object.

Exceptions
None.

22–86

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.34.2 setValues(...)
This method modifies the GapHeatGeneration object.

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

Return value
None

Exceptions
None.

22.34.3 Members
The GapHeatGeneration object has the following members:
conversionFraction
A Float specifying the fraction of dissipated energy caused by friction or electric currents that is
converted to heat. The default value is 1.0.
slaveFraction
A Float specifying the fraction of converted heat distributed to the slave surface. The default value
is 0.5.

22.34.4 Corresponding analysis keywords

*GAP HEAT GENERATION

22.35 GeometricProperties object

The GeometricProperties object specifies surface interaction properties.

22–87

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Access
import interaction
mdb.models[name].interactionProperties[name].geometricProperties

22.35.1 GeometricProperties(...)
This method creates a GeometricProperties object.

Path
mdb.models[name].interactionProperties[name].GeometricProperties

Required arguments
None.
Optional arguments
contactArea
A Float specifying the out-of-plane thickness of the surface for a two-dimensional model or cross-
sectional area for every node in the node-based surface. The default value is 1.0.
padThickness
None or a Float specifying the thickness of an interfacial layer between the contacting surfaces.
If padThickness=None, there is no interfacial layer. The default value is None.

Return value
A GeometricProperties object.

Exceptions
None.

22.35.2 setValues(...)
This method modifies the GeometricProperties object.

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

22–88

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
None

Exceptions
None.

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

22.35.4 Corresponding analysis keywords

*SURFACE INTERACTION

22.36 IncidentWave object

The IncidentWave object defines incident wave interactions for acoustic and coupled acoustic-structural
analyses.
The IncidentWave object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.36.1 IncidentWave(...)
This method creates an IncidentWave object.

Path
mdb.models[name].IncidentWave

Required arguments
name
A String specifying the repository key.

22–89

Abaqus ID:
Printed on:
INTERACTION COMMANDS

createStepName
A String specifying the name of the step in which the IncidentWave object is created.
sourcePoint
A Region object specifying the incident wave source point.
standoffPoint
A Region object specifying the incident wave standoff point.
This argument is not valid when definition=CONWEP.
surface
A Region object specifying the surface defining the incident wave interaction. In problems
involving fluid/surface boundaries, both the fluid surface and the solid surface comprising the
boundary must have an incident wave interaction specified.
interactionProperty
A String specifying the IncidentWaveProperty object associated with this interaction.
Optional arguments
definition
A SymbolicConstant specifying the type of incident wave to be defined. The value must be
PRESSURE for linear perturbation steps. An Explicit step is required when the value is set to
CONWEP. Possible values are PRESSURE, ACCELERATION, UNDEX, and CONWEP. The
default value is PRESSURE.
amplitude
A String specifying the name of the Amplitude object that defines the fluid pressure time history
at the standoff point, if definition=PRESSURE. If definition=ACCELERATION, then this string
specifies the name of the Amplitude object that defines the fluid particle acceleration time
history at the standoff point. This member can be specified only if definition=PRESSURE or
ACCELERATION. The default value is an empty string.
imaginaryAmplitude
A String specifying the name of the Amplitude object that defines the imaginary component of
the fluid pressure time history at the standoff point. This member is applicable only for linear
perturbation steps and if definition=PRESSURE. The default value is an empty string.
surfaceNormal
A sequence of three Floats specifying the X, Y, and Z components of the direction cosine of the
fluid surface normal.
This argument is valid only when definition=UNDEX.
initialDepth
None or a Float specifying the initial depth of the UNDEX bubble. The default value is None.
This argument is valid only when definition=UNDEX.
referenceMagnitude
A Float specifying the reference magnitude.
This argument is not valid when definition=CONWEP.

22–90

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

detonationTime
A Float specifying the time of detonation, given in total time.
This argument is valid only when definition=CONWEP.
magnitudeFactor
A Float specifying the magnitude scale factor. The default value is 1.0.
This argument is valid only when definition=CONWEP.

Return value
An IncidentWave object.

Exceptions
None.

22.36.2 setValues(...)
This method modifies the IncidentWave object.

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

Return value
None

Exceptions
None.

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

22.36.4 Corresponding analysis keywords

*INCIDENT WAVE INTERACTION

22–91

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.37 IncidentWaveProperty object

The IncidentWaveProperty object is an interaction property that defines the properties referred to by an
IncidentWave object.
The IncidentWaveProperty object is derived from the InteractionProperty object.

Access
import interaction
mdb.models[name].interactionProperties[name]

22.37.1 IncidentWaveProperty(...)
This method creates an IncidentWaveProperty object.

Path
mdb.models[name].IncidentWaveProperty

Required argument
name
A String specifying the interaction property repository key.
Optional arguments
definition
A SymbolicConstant specifying the type of wave to be defined. Possible values are PLANAR,
SPHERICAL, DIFFUSE, AIR_BLAST, and SURFACE_BLAST. The default value is PLANAR.
propagationModel
A SymbolicConstant specifying the spherical propagation model. Possible values are ACOUSTIC,
UNDEX_CHARGE, and GENERALIZED_DECAY. The default value is ACOUSTIC.
This argument is valid only when definition=SPHERICAL.
soundSpeed
A Float specifying the speed of sound in the fluid.
This argument is not valid when definition=AIR_BLAST or when
definition=SURFACE_BLAST.
fluidDensity
A Float specifying the fluid mass density.
This argument is not valid when definition=AIR_BLAST or when
definition=SURFACE_BLAST.

22–92

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

specificHeatRatio
None or a Float specifying the ratio of specific heats for gas. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
gravity
None or a Float specifying the acceleration due to gravity. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
atmosphericPressure
None or a Float specifying the atmospheric pressure. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
dragCoefficient
None or a Float specifying the fluid drag coefficient. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
dragExponent
A Float specifying the fluid drag exponent. The default value is 2.0.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
waveEffects
A Boolean specifying whether or not to include wave effects in the fluid and gas. The default value
is ON.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
chargeDensity
None or a Float specifying the density of the charge material. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
chargeMass
None or a Float specifying the mass of the charge material. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
constantK1
None or a Float specifying the charge material constant K. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
constantK2
None or a Float specifying the charge material constant k. The default value is None.

22–93

Abaqus ID:
Printed on:
INTERACTION COMMANDS

This argument is valid only when definition=SPHERICAL and

propagationModel=UNDEX_CHARGE.
constantA
None or a Float specifying the charge material constant A. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
constantB
None or a Float specifying the charge material constant B. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
constantKc
None or a Float specifying the charge material constant Kc. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
duration
None or a Float specifying the time duration for the bubble simulation. The default value is None.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
maximumSteps
An Int specifying the maximum number of time steps for the bubble simulation. The default value
is 1500.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
relativeStepControl
A Float specifying the relative step size control parameter. The default value is 1×10–11 .
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
absoluteStepControl
A Float specifying the absolute step size control parameter. The default value is 1×10–11 .
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
stepControlExponent
A Float specifying the step size control exponent. The default value is 0.2.
This argument is valid only when definition=SPHERICAL and
propagationModel=UNDEX_CHARGE.
genDecayA
A Float specifying the constant A associated with the generalized decay propagation model. The
default value is 0.0.
This argument is valid only when definition=SPHERICAL and
propagationModel=GENERALIZED_DECAY.

22–94

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

genDecayB
A Float specifying the constant B associated with the generalized decay propagation model. The
default value is 0.0.
This argument is valid only when definition=SPHERICAL and
propagationModel=GENERALIZED_DECAY.
genDecayC
A Float specifying the constant C associated with the generalized decay propagation model. The
default value is 0.0.
This argument is valid only when definition=SPHERICAL and
propagationModel=GENERALIZED_DECAY.
seedNumber
An Int specifying the seed number (N) for the diffuse source calculation. N2 sources will be used
in the simulation.
This argument is valid only when definition=DIFFUSE.
massTNT
A Float specifying the equivalent mass of TNT, in any preferred mass unit.
This argument is valid only when definition=AIR_BLAST or definition=SURFACE_BLAST.
massFactor
A Float specifying the multiplication factor to convert from the preferred mass unit to kilograms.
The default value is 1.0.
This argument is valid only when definition=AIR_BLAST or definition=SURFACE_BLAST.
lengthFactor
A Float specifying the multiplication factor to convert from the analysis length unit to meters. The
default value is 1.0.
This argument is valid only when definition=AIR_BLAST or definition=SURFACE_BLAST.
timeFactor
A Float specifying the multiplication factor to convert from the analysis time unit to seconds. The
default value is 1.0.
This argument is valid only when definition=AIR_BLAST or definition=SURFACE_BLAST.
pressureFactor
A Float specifying the multiplication factor to convert from the analysis pressure unit to pascals.
The default value is 1.0.
This argument is valid only when definition=AIR_BLAST or definition=SURFACE_BLAST.

Return value
An IncidentWaveProperty object.

Exceptions
None.

22–95

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.37.2 setValues(...)
This method modifies the IncidentWaveProperty object.

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

Return value
None

Exceptions
None.

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

22.37.4 Corresponding analysis keywords

*INCIDENT WAVE INTERACTION PROPERTY

*UNDEX CHARGE PROPERTY
*CONWEP CHARGE PROPERTY

22.38 IncidentWaveState object

The IncidentWaveState object stores the propagating data of an IncidentWave object in a step. One
instance of this object is created internally by the IncidentWave object for each step. The instance is also
deleted internally by the IncidentWave object.
The IncidentWaveState object has no constructor or methods.
The IncidentWaveState object is derived from the InteractionState object.

22–96

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.38.1 Members
The IncidentWaveState object has the following member:
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.38.2 Corresponding analysis keywords

*INCIDENT WAVE INTERACTION

22.39 InitializationAssignment object

The InitializationAssignment object stores the contact initialization assignment definition for domain
pairs in a ContactStd object. The InitializationAssignment object has no constructor or members.

Access
import interaction
mdb.models[name].interactions[name].initializationAssignments

22–97

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.39.1 changeValuesInStep(...)
This method allows modification of contact initialization assignments to domain pairs already defined in
a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the contact initialization assignments are to be
modified.
index
An Int specifying the position of the contact initialization assignment whose value is to be modified.
value
A String specifying the value of the contact initialization to be assigned to the domain pair whose
index is referenced.
Optional arguments
None.

Return value
None

Exceptions
None.

22.39.2 appendInStep(...)
This method allows addition of contact initialization assignments to new domain pairs in a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which new contact initialization assignments are to be
defined.
assignments
A sequence of tuples specifying the initializations assigned to each surface pair. Each tuple
contains three entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN.
• A region object or the SymbolicConstant SELF.

22–98

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• A String specifying a StdInitialization object associated with this pair of regions.

Optional arguments
None.

Return value
None

Exceptions
None.

22.39.3 delete(...)
The delete method allows you to delete existing contact initialization assignments from a ContactStd
object.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each contact initialization assignment to delete.
Optional arguments
None.

Return value
None

Exceptions
None.

22.39.4 Members
The InitializationAssignment object has no members.

22.39.5 Corresponding analysis keywords

*CONTACT INITIALIZATION ASSIGNMENT

22–99

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.40 InteractionProperty object

The InteractionProperty object is the abstract base type for other InteractionProperty objects. The
InteractionProperty object has no explicit constructor, members, or methods.

Access
import interaction
mdb.models[name].interactionProperties[name]

22.40.1 Members
The InteractionProperty object has no members.

22.41 InteractionState object

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

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.41.1 Members
The InteractionState object has the following member:
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE

22–100

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.42 MasterSlaveAssignment object

The MasterSlaveAssignment object stores the master-slave assignment definition for surfaces in
ContactExp and ContactStd objects. The MasterSlaveAssignment object has no constructor or
members.

Access
import interaction
mdb.models[name].interactions[name].masterSlaveAssignments

22.42.1 changeValuesInStep(...)
This method allows modification of master-slave assignments already defined on surface pairs in a given
step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the master-slave assignments are to be modified.
index
An Int specifying the position of the master-slave assignment whose value is to be modified.
value
A SymbolicConstant specifying the value of the master-slave role to be assigned to the surface
whose index is referenced. Possible values are MASTER, SLAVE, and BALANCED. The
SymbolicConstant BALANCED can be specified only in an Abaqus/Standard analysis.
Optional arguments
None.

Return value
None

Exceptions
None.

22–101

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.42.2 appendInStep(...)
This method allows addition of master-slave assignments to new surface pairs in a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the master-slave assignments are to be defined.
assignments
A sequence of tuples specifying the master-slave assignments. Each tuple contains two entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the master-slave attribute is assigned.
• A SymbolicConstant specifying the overriding master-slave value to be used for the first
surface. Possible values of the SymbolicConstant are MASTER, SLAVE, and BALANCED.
The SymbolicConstant BALANCED can be specified only in an Abaqus/Standard analysis.

Optional arguments
None.

Return value
None

Exceptions
None.

22.42.3 delete(...)
The delete method allows you to delete existing master-slave assignments.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each master-slave assignment to delete.
Optional arguments
None.

22–102

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
None

Exceptions
None.

22.42.4 Members
The MasterSlaveAssignment object has no members.

22.42.5 Corresponding analysis keywords

*CONTACT FORMULATION, TYPE=PURE MASTER-SLAVE

*CONTACT FORMULATION, TYPE=MASTER SLAVE ROLES

22.43 Model object

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

Access
import interaction

22.43.1 contactDetection(...)
This method uses contact detection to create SurfaceToSurfaceContactStd ,
SurfaceToSurfaceContactExp , and Tie objects.

Arguments
Required arguments
None.
Optional arguments
name
A String specifying the prefix used to generate repository keys. The default value is "CP-"

22–103

Abaqus ID:
Printed on:
INTERACTION COMMANDS

createStepName
A String specifying the name of the step in which the SurfaceToSurfaceContactStd ,
SurfaceToSurfaceContactExp , and Tie objects are created. The default value is "Initial."
searchDomain
A SymbolicConstant MODEL or a sequence of Strings specifying the names of instances to search.
MODEL indicates the whole model is searched. The default value is MODEL.
defaultType
A SymbolicConstant specifying the default type of object to create. Possible values are
CONTACT, CONTACT_STANDARD, CONTACT_EXPLICIT, and TIE. If CONTACT is used,
the behavior is determined by the type of Step in the model. If an ExplicitDynamicsStep or
TempDisplacementDynamicsStep exists, then SurfaceToSurfaceContactExp is created by default.
Otherwise SurfaceToSurfaceContactStd is created by default. The default value is CONTACT.
interactionProperty
A String specifying the name of the ContactProperty object associated with any interactions
created.
separationTolerance
A Float specifying the maximum separation for considering two surfaces to be candidates for
contact, where separation is the maximum distance between the points of closest approach on the
two surfaces. The default value is a function of the model.
extendByAngle
None or a Float specifying the angle for extending surface definitions to include adjacent faces.
The default value is 20.
mergeWithinAngle
None or a Float specifying the angle for merging adjacent contact pairs which lie within the angle.
The default value is 20.
searchSingleInstances
A Boolean specifying whether to include surface pairs within a single instance. The default value
is OFF.
nameEachSurfaceFound
A Boolean specifying whether to assign a name to each surface found. The default value is ON.
createUnionOfMasterSurfaces
A Boolean specifying whether to create a surface that is the union of all master surfaces found.
The default value is OFF.
createUnionOfSlaveSurfaces
A Boolean specifying whether to create a surface that is the union of all slave surfaces found. The
default value is OFF.
createUnionOfMasterSlaveSurfaces
A Boolean specifying whether to create a surface that is the union of all master and slave surfaces
found. The default value is OFF.

22–104

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

includePlanar
A Boolean specifying whether to include planar geometry. The default value is ON.
includeCylindricalSphericalToric
A Boolean specifying whether to include cylindrical, spherical and toric geometry. The default
value is ON.
includeSplineBased
A Boolean specifying whether to include spline-based geometry. The default value is ON.
includeMeshSolid
A Boolean specifying whether to include solid mesh entities. The default value is ON.
includeMeshShell
A Boolean specifying whether to include shell mesh entities. The default value is ON.
includeMeshMembrane
A Boolean specifying whether to include mesh membrane entities. The default value is OFF.
includeOverclosed
A Boolean specifying whether to include overclosed pairs. The default value is ON.
includeNonOverlapping
A Boolean specifying whether to include opposing geometry surfaces that do not overlap. The
default value is OFF.
meshedGeometrySearchTechnique
A SymbolicConstant USE_GEOMETRY or USE_MESH specifying whether to locate pairs
in meshed geometry using the geometric entities or mesh entities. The default value is
USE_GEOMETRY.
useShellThickness
A Boolean specifying whether to account for shell thickness and offset during contact detection.
The default value is ON.
surfaceSmoothing
A SymbolicConstant specifying whether to use surface smoothing for geometric surfaces in
SurfaceToSurfaceContactStd interactions. Possible values are NONE, and AUTOMATIC. The
default value is AUTOMATIC.

Return value
None

Exceptions
None.

22–105

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.44 ModelChange object

The ModelChange object defines model change interactions for element removal and reactivation.
The ModelChange object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.44.1 ModelChange(...)
This method creates a ModelChange object.

Path
mdb.models[name].ModelChange

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the ModelChange object is created.
Optional arguments
isRestart
A Boolean specifying whether this interaction is being used solely to indicate that model change
may be required in a subsequent restart analysis (either for elements or contact pairs). The default
value is OFF.
regionType
A SymbolicConstant specifying the region selection type. This argument is valid only when
isRestart=False. Possible values are GEOMETRY, SKINS, STRINGERS, and ELEMENTS. The
default value is GEOMETRY.
region
A Region object specifying the elements to be removed or reactivated. This argument is valid only
when isRestart=False.
activeInStep
A Boolean specifying whether elements are being removed or reactivated. This argument is valid
only when isRestart=False. The default value is OFF.

22–106

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

includeStrain
A Boolean specifying whether stress/displacement elements are reactivated with strain. This
argument is valid only when isRestart=False and when activeInStep=True. The default value is
OFF.

Return value
A ModelChange object.

Exceptions
None.

22.44.2 setValues(...)
This method modifies the data for an existing ModelChange 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 ModelChange method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

22.44.3 setValuesInStep(...)
This method modifies the propagating data of an existing ModelChange object in the specified step.

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

22–107

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
activeInStep
A Boolean specifying whether elements are being removed or reactivated. This argument is valid
only when isRestart=False. The default value is OFF.
includeStrain
A Boolean specifying whether stress/displacement elements are reactivated with strain. This
argument is valid only when isRestart=False and when activeInStep=True. The default value is
OFF.

Return value
None

Exceptions
None.

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

22.44.5 Corresponding analysis keywords

*MODEL CHANGE, TYPE=ELEMENT

*MODEL CHANGE, ACTIVATE

22.45 NormalBehavior object

The NormalBehavior object specifies normal behavior for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].normalBehavior

22.45.1 NormalBehavior(...)
This method creates a NormalBehavior object.

22–108

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Path
mdb.models[name].interactionProperties[name].NormalBehavior

Required arguments
None.
Optional arguments
contactStiffness
The SymbolicConstant DEFAULT or a Float specifying the contact
stiffness. This argument is valid for pressureOverclosure=LINEAR.
This argument is also valid for pressureOverclosure=HARD when
constraintEnforcementMethod=AUGMENTED_LAGRANGE or PENALTY. A value of
DEFAULT is valid only when the later conditions are met. A value of zero is equivalent to
specifying DEFAULT. The default value is DEFAULT.
pressureOverclosure
A SymbolicConstant specifying the pressure-overclosure relationship to be used. Possible values
are HARD, EXPONENTIAL, LINEAR, TABULAR, and SCALE_FACTOR. The default value is
HARD.
allowSeparation
A Boolean specifying whether to allow separation after contact. The default value is ON.
maxStiffness
None or a Float specifying the maximum stiffness. If maxStiffness=None, there is no upper limit.
The default value is None.
table
A sequence of sequences of Floats specifying the normal behavior properties. This argument is
valid only for pressureOverclosure=EXPONENTIAL or TABULAR. The items in the table data
are described below.
constraintEnforcementMethod
A SymbolicConstant specifying the method for enforcement of the contact constraint. Possible
values are DEFAULT, AUGMENTED_LAGRANGE, PENALTY, and DIRECT. The default value
is DEFAULT.
overclosureFactor
A Float specifying the overclosure measure (used to delineate the segments of the
pressure-overclosure curve) as a percentage of the minimum element size in the contact
region. The default value is 0.0.
overclosureMeasure
A Float specifying the overclosure measure (used to delineate the segments of the
pressure-overclosure curve) directly. The default value is 0.0.

22–109

Abaqus ID:
Printed on:
INTERACTION COMMANDS

contactStiffnessScaleFactor
A Float specifying scale factor for the penalty stiffness or the geometric scaling of the "base"
stiffness. The default value is 1.0.
initialStiffnessScaleFactor
A Float specifying an additional scale factor for the "base" default contact stiffness. The default
value is 1.0.
clearanceAtZeroContactPressure
A Float specifying the clearance at which the contact pressure is zero. The default value is 0.0.
stiffnessBehavior
A SymbolicConstant specifying the type of penalty stiffness to be defined. This argument is
valid only when constraintEnforcementMethod=PENALTY. Possible values are LINEAR and
NONLINEAR. The default value is LINEAR.
stiffnessRatio
A Float specifying the ratio of the initial stiffness divided by the final stiffness. This argument
is valid only when stiffnessBehavior=NONLINEAR. Possible values are 0 stiffnessRatio 1.
The default value is 0.01.
upperQuadraticFactor
A Float specifying the ratio of the overclosure at the maximum stiffness divided by the
characteristic facet length. This argument is valid only when stiffnessBehavior=NONLINEAR.
The default value is 0.03.
lowerQuadraticRatio
A Float specifying the ratio of the overclosure at the initial stiffness divided by the overclosure
at the maximum stiffness, both relative to the clearance at which the contact pressure is zero.
This argument is valid only when stiffnessBehavior=NONLINEAR. Possible values are 0
stiffnessRatio 1. The default value is 0.33333.
Table data
If pressureOverclosure=EXPONENTIAL, the table data specify the following:
• Pressure at zero clearance, .
• Clearance at which the contact pressure is zero, .
If pressureOverclosure=TABULAR, the table data specify the following:
• Pressure.
• Overclosure.

Return value
A NormalBehavior object.

Exceptions
None.

22–110

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.45.2 setValues(...)
This method modifies the NormalBehavior object.

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

Return value
None

Exceptions
None.

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

22.45.4 Corresponding analysis keywords

*SURFACE BEHAVIOR

22.46 PressurePenetration object

The PressurePenetration object defines pressure penetration loading simulated with surface-to-surface
contact.
The PressurePenetration object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22–111

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.46.1 PressurePenetration(...)
This method creates a PressurePenetration object.

Path
mdb.models[name].PressurePenetration

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the PressurePenetration object is created.
contactInteraction
A String specifying the name of the Surface-to-surface contact (Standard) interaction.
masterPoints
A RegionArray object specifying the points on the master surface that are exposed to the fluid.
slavePoints
A RegionArray object specifying the points on the slave surface that are exposed to the fluid.
penetrationPressure
A tuple of Floats specifying the fluid pressure magnitude. For steady state dynamic analyses, a
tuple of Complexes specifying the fluid pressure magnitude.
criticalPressure
A tuple of Floats specifying the critical contact pressure below which fluid penetration starts to
occur.
Optional arguments
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
penetrationTime
A Float specifying the fraction of the current step time over which the fluid pressure on newly
penetrated contact surface segments is ramped up to the current magnitude. The default value is
0.001.

Return value
A PressurePenetration object.

22–112

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Exceptions
None.

22.46.2 setValues(...)
This method modifies the data for an existing PressurePenetration 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
PressurePenetration method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
penetrationPressure
A tuple of Floats specifying the fluid pressure magnitude. For steady state dynamic analyses, a
tuple of Complexes specifying the fluid pressure magnitude.
criticalPressure
A tuple of Floats specifying the critical contact pressure below which fluid penetration starts to
occur.

22–113

Abaqus ID:
Printed on:
INTERACTION COMMANDS

amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load is
changed to have no amplitude reference. You should provide the amplitude argument only if it is
valid for the specified step.
penetrationTime
A Float specifying the fraction of the current step time over which the fluid pressure on newly
penetrated contact surface segments is ramped up to the current magnitude. The default value is
0.001.

Return value
None

Exceptions
None.

22.46.4 Members
The PressurePenetration object has the following members:
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the PressurePenetration object is created.
contactInteraction
A String specifying the name of the Surface-to-surface contact (Standard) interaction.
masterPoints
A RegionArray object specifying the points on the master surface that are exposed to the fluid.
slavePoints
A RegionArray object specifying the points on the slave surface that are exposed to the fluid.

22.46.5 Corresponding analysis keywords

*PRESSURE PENETRATION

22–114

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.47 PressurePenetrationState object

The PressurePenetrationState object stores the propagating data of a PressurePenetration object in a step.
One instance of this object is created internally by the PressurePenetration object for each step. The
instance is also deleted internally by the PressurePenetration object.
The PressurePenetrationState object has no constructor or methods.
The PressurePenetrationState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.47.1 Members
The PressurePenetrationState object has the following members:
penetrationTime
A Float specifying the fraction of the current step time over which the fluid pressure on newly
penetrated contact surface segments is ramped up to the current magnitude. The default value is
10–3 .
penetrationTimeState
A SymbolicConstant specifying the propagation state of the penetrationTime member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
criticalPressureState
A SymbolicConstant specifying the propagation state of the criticalPressure member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
penetrationPressureState
A SymbolicConstant specifying the propagation state of the penetrationPressure member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
penetrationPressure
A tuple of Floats specifying the fluid pressure magnitude. For steady state dynamic analyses, a
tuple of Complexes specifying the fluid pressure magnitude.
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

22–115

Abaqus ID:
Printed on:
INTERACTION COMMANDS

criticalPressure
A tuple of Floats specifying the critical contact pressure below which fluid penetration starts to
occur.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.47.2 Corresponding analysis keywords

*PRESSURE PENETRATION

22.48 Radiation object

The Radiation object specifies radiation for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].radiation

22.48.1 Radiation(...)
This method creates a Radiation object.

Path
mdb.models[name].interactionProperties[name].Radiation

22–116

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Required arguments
masterEmissivity
A Float specifying the emissivity of the master surface.
slaveEmissivity
A Float specifying the emissivity of the slave surface.
table
A sequence of sequences of Floats specifying the following:
• Effective viewfactor, .
• Gap clearance, .

Optional arguments
None.

Return value
A Radiation object.

Exceptions
None.

22.48.2 setValues(...)
This method modifies the Radiation object.

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

Return value
None

Exceptions
None.

22–117

Abaqus ID:
Printed on:
INTERACTION COMMANDS

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

22.48.4 Corresponding analysis keywords

*GAP RADIATION

22.49 RadiationToAmbient object

The RadiationToAmbient object defines radiant heat transfer between a surface and its environment.
The RadiationToAmbient object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.49.1 RadiationToAmbient(...)
This method creates a RadiationToAmbient object.

Path
mdb.models[name].RadiationToAmbient

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the RadiationToAmbient object is created.
surface
A Region object specifying the surface to which the radiation interaction is applied.
emissivity
A Float specifying the emissivity, .

22–118

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this interaction. The
field argument applies only when distributionType=ANALYTICAL_FIELD. The default value is
an empty string.
distributionType
A SymbolicConstant specifying how the radiation is distributed. This argument applies only
when radiationType=AMBIENT. Possible values are UNIFORM and ANALYTICAL_FIELD.
The default value is UNIFORM.
radiationType
A SymbolicConstant specifying whether to use the default surface radiation behavior, or the
cavity radiation approximation. Possible values are AMBIENT and CAVITY. The default value
is AMBIENT.
ambientTemperature
A Float specifying the reference ambient temperature, . This argument applies only when
radiationType=AMBIENT. The default value is 0.0.
ambientTemperatureAmp
A String specifying the name of the Amplitude object that gives the variation of the ambient
temperature with time.
Note: Use None in an Abaqus/Standard analysis to specify that the reference ambient temperature
is applied immediately at the beginning of the step or linearly over the step. Use None in an
Abaqus/Explicit analysis to specify that the reference ambient temperature is applied throughout
the step. This argument applies only when radiationType=AMBIENT.

Return value
A RadiationToAmbient object.

Exceptions
None.

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

Arguments
Required arguments
None.

22–119

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the RadiationToAmbient
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

22.49.3 setValuesInStep(...)
This method modifies the propagating data of an existing RadiationToAmbient object in the specified
step.

Arguments

Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
None.
The optional arguments to setValuesInStep are the same as the arguments to the
RadiationToAmbient method, except for the name, createStepName, and surface arguments.

Return value
None

Exceptions
None.

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

22–120

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.50 RadiationToAmbientState object

The RadiationToAmbientState object stores the propagating data for a RadiationToAmbient object. One
instance of this object is created internally by the RadiationToAmbient object for each step. The instance
is also deleted internally by the RadiationToAmbient object.
The RadiationToAmbientState object has no constructor or methods.
The RadiationToAmbientState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.50.1 Members
The RadiationToAmbientState object has the following members:
ambientTemperature
A Float specifying the ambient temperature.
ambientTemperatureState
A SymbolicConstant specifying the propagation state of the ambientTemperature member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
ambientTemperatureAmpState
A SymbolicConstant specifying the propagation state of the ambientTemperatureAmp member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
emissivity
A Float specifying the emissivity.
emissivityState
A SymbolicConstant specifying the propagation state of the emissivity member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
ambientTemperatureAmp
A String specifying the name of the Amplitude object that gives the variation of the ambient
temperature with time.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED

22–121

Abaqus ID:
Printed on:
INTERACTION COMMANDS

• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.50.2 Corresponding analysis keywords

*SRADIATE

22.51 RegionPairs object

The RegionPairs object stores the domain pair definition for ContactExp and ContactStd objects. The
RegionPairs object has no constructor or members.

Access
import interaction
mdb.models[name].interactions[name].excludedPairs
mdb.models[name].interactions[name].includedPairs

22.51.1 setValuesInStep(...)
This method allows addition and removal of domain pairs in a given step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the region pair assignments are to be modified.
Optional arguments
useAllstar
A Boolean specifying whether the contacting surface pair consists of all exterior faces and -- in an
Abaqus/Explicit analysis -- analytical rigid surfaces, shell edges, and beam segments in the model.

22–122

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

addPairs
A sequence of pairs of region objects or SymbolicConstants that specify the surface pairs to add
to the included pairs of the ContactExp or ContactStd object in the given step. Possible values of
the SymbolicConstants are WHOLE_DOMAIN and SELF. When used with ContactExp objects,
the second parameter of each pair can also be a string that references an Eulerian material surface.
removePairs
A sequence of pairs of region objects or SymbolicConstants that specify the surface pairs to remove
from the included pairs of the ContactExp or ContactStd object in the given step. Possible values of
the SymbolicConstants are WHOLE_DOMAIN and SELF. When used with ContactExp objects,
the second parameter of each pair can also be a string that references an Eulerian material surface.

Return value
None

Exceptions
None.

22.51.2 Members
The RegionPairs object has no members.

22.51.3 Corresponding analysis keywords

*CONTACT INCLUSIONS
*CONTACT EXCLUSIONS

22.52 SelfContactExp object

The SelfContactExp object defines self-contact during an Abaqus/Explicit analysis.

The SelfContactExp object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22–123

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.52.1 SelfContactExp(...)
This method creates a SelfContactExp object.

Path
mdb.models[name].SelfContactExp

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the SelfContactExp object is created.
surface
A Region object specifying the surface where self-contact is defined.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
Optional arguments
mechanicalConstraint
A SymbolicConstant specifying the mechanical constraint formulation. Possible values are
KINEMATIC and PENALTY. The default value is KINEMATIC.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. An
empty string indicates that the default contact controls will be used. The default value is an empty
string.

Return value
A SelfContactExp object.

Exceptions
None.

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

Arguments
Required arguments
None.

22–124

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the SelfContactExp
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. An
empty string indicates that the default contact controls will be used. The default value is an empty
string.

Return value
None

Exceptions
None.

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

22–125

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.53 SelfContactExpState object

The SelfContactExpState object stores the propagating data for a SelfContactExp object. One instance
of this object is created internally by the SelfContactExp object for each step. The instance is also deleted
internally by the SelfContactExp object.
The SelfContactExpState object has no constructor or methods.
The SelfContactExpState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.53.1 Members
The SelfContactExpState object has the following members:
interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
contactControlsState
A SymbolicConstant specifying the propagation state of the contactControls member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
contactControls
A String specifying the name of the ContactControl object associated with this interaction.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22–126

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.53.2 Corresponding analysis keywords

*CONTACT CONTROLS
*CONTACT PAIR
*MODEL CHANGE, TYPE=CONTACT PAIR

22.54 SelfContactStd object

The SelfContactStd object defines self-contact during an Abaqus/Standard analysis.

The SelfContactStd object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.54.1 SelfContactStd(...)
This method creates a SelfContactStd object.

Path
mdb.models[name].SelfContactStd

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the SelfContactStd object is created.
surface
A Region object specifying the surface where self-contact is defined.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.

22–127

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
enforcement
A SymbolicConstant specifying the discretization method. Possible values are
NODE_TO_SURFACE and SURFACE_TO_SURFACE. The default value is
SURFACE_TO_SURFACE.
thickness
A Boolean specifying whether shell/membrane element thickness is considered. The default value
is ON.
This argument in valid only when enforcement=SURFACE_TO_SURFACE.
smooth
A Float specifying the degree of smoothing used for deformable or rigid master surfaces involved
when enforcement=NODE_TO_SURFACE. The value given must lie between 0.0 and 0.5. The
default value is 0.2.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. An
empty string indicates that the default contact controls will be used. The default value is an empty
string.

Return value
A SelfContactStd object.

Exceptions
None.

22.54.2 setValues(...)
This method modifies the data for an existing SelfContactStd 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 SelfContactStd
method, except for the name and createStepName arguments.

Return value
None

22–128

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Exceptions
None.

22.54.3 setValuesInStep(...)
This method modifies the propagating data of an existing SelfContactStd object in the specified step.

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. An
empty string indicates that the default contact controls will be used. The default value is an empty
string.

Return value
None

Exceptions
None.

22.54.4 Members
The SelfContactStd object has members with the same names and descriptions as the arguments to the
SelfContactStd method.
In addition, the SelfContactStd object has the following members:
contactTracking
A SymbolicConstant specifying the choice of contact tracking algorithm. The STATE tracking
algorithm uses only normal projections and is specified by using ONE_CONFIG. The PATH
tracking algorithm uses crossing and normal projections and is specified by using TWO_CONFIG.
Possible values are ONE_CONFIG and TWO_CONFIG. The default value is TWO_CONFIG.
This argument is valid only when enforcement=SURFACE_TO_SURFACE.

22–129

Abaqus ID:
Printed on:
INTERACTION COMMANDS

supplementaryContact
A SymbolicConstant specifying the manner in which mid-face constraints are employed. Possible
values are SELECTIVE, NEVER, and ALWAYS. The default value is SELECTIVE.
This argument is valid only when enforcement=NODE_TO_SURFACE.

22.55 SelfContactStdState object

The SelfContactStdState object stores the propagating data for a SelfContactStd object. One instance of
this object is created internally by the SelfContactStd object for each step. The instance is also deleted
internally by the SelfContactStd object.
The SelfContactStdState object has no constructor or methods.
The SelfContactStdState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.55.1 Members
The SelfContactStdState object has the following members:
interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
contactControlsState
A SymbolicConstant specifying the propagation state of the contactControls member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
interactionProperty
A String specifying the ContactProperty object associated with this interaction.
contactControls
A String specifying the name of the ContactControl object associated with this interaction.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED

22–130

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.55.2 Corresponding analysis keywords

*CONTACT CONTROLS
*CONTACT PAIR
*MODEL CHANGE, TYPE=CONTACT PAIR

22.56 SmoothingAssignment object

The SmoothingAssignment object stores the surface smoothing assignment definition for surfaces in a
ContactStd object. The SmoothingAssignment object has no constructor or members.

Access
import interaction
mdb.models[name].interactions[name].smoothingAssignments

22.56.1 changeValuesInStep(...)
This method allows modification of surface smoothing assignments already defined on surfaces in a given
step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the surface smoothing assignments are to be
modified.
index
An Int specifying the position of the surface smoothing assignment whose value is to be modified.
value
A tuple specifying the value of the surface smoothing assignments for the surface whose index is
referenced. Each tuple contains one entry:

22–131

Abaqus ID:
Printed on:
INTERACTION COMMANDS

• A SymbolicConstant specifying the surface smoothing value to be used for the surface.
Possible values of the SymbolicConstant are NONE, REVOLUTION, and SPHERICAL.

Optional arguments
None.

Return value
None

Exceptions
None.

22.56.2 appendInStep(...)
This method allows addition of surface smoothing assignments to new surfaces in a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which new surface smoothing assignments are to be
defined.
assignments
A sequence of tuples specifying the surface smoothing assignments. Each tuple contains two
entries:
• A region object specifying the surface to which the smoothing is assigned.
• A SymbolicConstant specifying the surface smoothing value to be used for the surface.
Possible values of the SymbolicConstant are NONE, REVOLUTION, and SPHERICAL.

Optional arguments
None.

Return value
None

Exceptions
None.

22–132

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.56.3 delete(...)
The delete method allows you to delete existing surface smoothing assignments from a ContactStd
object.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each surface smoothing assignment to delete.
Optional arguments
None.

Return value
None

Exceptions
None.

22.56.4 Members
The SmoothingAssignment object has no members.

22.56.5 Corresponding analysis keywords

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=GEOMETRIC CORRECTION

22.57 StdContactControl object

The StdContactControl object is used in Abaqus/Standard analyses to specify optional solution controls
for problems involving contact between bodies.
The StdContactControl object is derived from the ContactControl object.

Access
import interaction
mdb.models[name].contactControls[name]

22–133

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.57.1 StdContactControl(...)
This method creates an StdContactControl object.

Path
mdb.models[name].StdContactControl

Required argument
name
A String specifying the contact controls repository key.
Optional arguments
stiffnessScaleFactor
A Float specifying the factor by which Abaqus/Standard will scale the default penalty stiffness to
obtain the stiffnesses used for the contact pairs. Only contact interactions defined with augmented
Lagrangian surface behavior will be affected by this argument. The default value is 1.0.
penetrationTolChoice
A SymbolicConstant specifying whether the allowable penetration is an absolute value or a value
relative to the characteristic contact surface face dimension. Only contact interactions defined
with augmented Lagrangian surface behavior will be affected by this argument. Possible values
are RELATIVE and ABSOLUTE. The default value is RELATIVE.
relativePenetrationTolerance
A Float specifying the ratio of the allowable penetration to the characteristic contact surface face
dimension. The float values represent percentages (e.g.: 0.001=0.1%). Only contact interactions
defined with augmented Lagrangian surface behavior will be affected by this argument. The default
value is 10–3 .
The relativePenetrationTolerance argument applies only when
penetrationTolChoice=RELATIVE. The relativePenetrationTolerance and
absolutePenetrationTolerance arguments are mutually exclusive.
absolutePenetrationTolerance
None or a Float specifying the allowable penetration. Only contact interactions defined
with augmented Lagrangian surface behavior will be affected by this argument. The
absolutePenetrationTolerance argument applies only when penetrationTolChoice=ABSOLUTE.
The relativePenetrationTolerance and absolutePenetrationTolerance arguments are mutually
exclusive. The default value is None.
frictionOnset
A SymbolicConstant specifying when the application of friction occurs. Possible values are:
• IMMEDIATE, specifying the friction is included in the increment when contact occurs.

22–134

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

• DELAYED, specifying the application of friction is delayed until the increment after contact
occurs.
The default value is IMMEDIATE.
automaticTolerances
A Boolean specifying whether Abaqus/Standard should automatically compute an overclosure
tolerance and a separation tolerance to prevent chattering in contact. The default value is OFF.
The automaticTolerances argument cannot be used with the maxchp, perrmx, and uerrmx
arguments.
maxchp
An Int specifying the maximum number of points that are permitted to violate contact conditions
in any increment. The default value is 0.
Either the perrmx or the uerrmx argument must be specified in conjunction with the maxchp
argument.
perrmx
A Float specifying the maximum value of tensile stress (tensile force in GAP- or ITT-type contact
elements) allowed to be transmitted at a contact point. The default value is 0.0.
The perrmx argument must be specified in conjunction with the maxchp argument.
uerrmx
A Float specifying the maximum overclosure distance allowed at a slave node that is considered
to be open. The default value is 0.0.
The uerrmx argument must be specified in conjunction with the maxchp argument.
stabilizeChoice
A SymbolicConstant specifying whether or not viscous damping will be specified, and if so, how
it will be specified. Possible values are NONE, AUTOMATIC, and COEFFICIENT. The default
value is NONE.
dampFactor
A Float specifying the value of the damping factor. This value is multiplied by the calculated
damping coefficient. The default value is 1.0.
This argument is only valid when stabilizeChoice=AUTOMATIC.
dampCoef
A Float specifying the damping coefficient. The default value is 0.0.
This argument is only valid when stabilizeChoice=COEFFICIENT.
tangFraction
A Float specifying the tangential stabilization as a fraction of the normal stabilization (damping).
The default value is 1.0.
This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT.
eosFraction
A Float specifying the fraction of the damping that remains at the end of the step. The default
value is 0.0.

22–135

Abaqus ID:
Printed on:
INTERACTION COMMANDS

This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT.

zeroDampingChoice
A SymbolicConstant specifying how the zero-damping clearance will be specified. Possible values
are COMPUTE and SPECIFY. The default value is COMPUTE.
This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT.
zeroDamping
None or a Float specifying the clearance at which damping becomes zero. This argument is
valid only when zeroDampingChoice=SPECIFY. This argument is valid only if stabilizeChoice
= AUTOMATIC or COEFFICIENT. The default value is None.
enforceWithLagrangeMultipliers
A SymbolicConstant specifying whether to enforce the contact constraints with Lagrange
multipliers. Possible values are DEFAULT, ENFORCEMENT_OFF, and ENFORCEMENT_ON.
The default value is DEFAULT.

Return value
A StdContactControl object.

Exceptions
RangeError.

22.57.2 setValues(...)
This method modifies the StdContactControl object.

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

Return value
None

Exceptions
RangeError.

22–136

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

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

22.57.4 Corresponding analysis keywords

*CONTACT CONTROLS

22.58 StdInitialization object

The StdInitialization object is used in conjunction with ContactStd in Abaqus/Standard analyses to

specify contact initialization data.
The StdInitialization object is derived from the ContactInitialization object.

Access
import interaction
mdb.models[name].contactInitialization[name]

22.58.1 StdInitialization(...)
This method creates a StdInitialization object.

Path
mdb.models[name].StdInitialization

Required argument
name
A String specifying the contact initialization repository key.
Optional arguments
useInterferenceFit
A Boolean specifying whether initial overclosures should treated as interference fits. The default
value is OFF.

22–137

Abaqus ID:
Printed on:
INTERACTION COMMANDS

openingTolerance
None or a Float specifying the distance tolerance within which initial openings will undergo strain-
free adjustments. This argument is valid only when useInterferenceFit=OFF. The default value is
None.
overclosureTolerance
None or a Float specifying the distance tolerance within which initial overclosures will undergo
strain-free adjustments. This argument is valid only when useInterferenceFit=OFF. The default
value is None.

Return value
A StdInitialization object.

Exceptions
RangeError.

22.58.2 setValues(...)
This method modifies the StdInitialization object.

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

Return value
None

Exceptions
RangeError.

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

22.58.4 Corresponding analysis keywords

22–138

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

*CONTACT INITIALIZATION DATA

22.59 StdXplCosimulation object

The StdXplCosimulation object defines co-simulation behavior between Abaqus/Standard and

Abaqus/Explicit.
The StdXplCosimulation object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.59.1 StdXplCosimulation(...)
This method creates a StdXplCosimulation object.

Path
mdb.models[name].StdXplCosimulation

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the StdXplCosimulation object is created.
region
A Region object specifying the import and export region upon which the co-simulation exchanges
data with the coupled analysis program.
Optional arguments
incrementation
A SymbolicConstant specifying whether the analysis programs use the same time increments or
one is allowed to use more time increments than the other before exchanging data. Possible values
are ALLOW_SUBCYCLING and LOCKSTEP. The default value is ALLOW_SUBCYCLING.
stepSize
A Float specifying the size of the increments to be used by Abaqus/Standard and Abaqus/Explicit.
The default value is 0.0.

22–139

Abaqus ID:
Printed on:
INTERACTION COMMANDS

stepSizeDefinition
A SymbolicConstant specifying whether the increment size is the analysis default or a supplied
variable. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

Return value
A StdXplCosimulation object.

Exceptions
None.

22.59.2 setValues(...)
This method modifies the StdXplCosimulation object.

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

Return value
None

Exceptions
None.

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

22.60 StdXplCosimulationState object

The StdXplCosimulationState object stores the propagating data for a StdXplCosimulation object. One
instance of this object is created internally by the StdXplCosimulation object for each step. The instance
is also deleted internally by the StdXplCosimulation object.
The StdXplCosimulationState object has no constructor or methods.

22–140

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

The StdXplCosimulationState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.60.1 Members
The StdXplCosimulationState object has the following member:
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.60.2 Corresponding analysis keywords

*CO-SIMULATION,
*CO-SIMULATION REGION,
*CO-SIMULATION CONTROLS

22.61 SurfaceFeatureAssignment object

The SurfaceFeatureAssignment object stores the surface feature angle assignment definition for surfaces
in a ContactExp object. The SurfaceFeatureAssignment object has no constructor or members.

Access
import interaction

22–141

Abaqus ID:
Printed on:
INTERACTION COMMANDS

mdb.models[name].interactions[name].surfaceFeatureAssignments

22.61.1 changeValuesInStep(...)
This method allows modification of surface feature angle assignments already defined on surfaces in a
given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the surface feature assignments are to be
modified.
index
An Int specifying the position of the surface feature angle assignment whose value is to be
modified.
value
A tuple specifying the value of the surface feature assignments for the surface whose index is
referenced. Each tuple contains one entry:
• A Float or a SymbolicConstant specifying the overriding surface feature angle value to be
used for the surface. Possible values of the SymbolicConstant are PERIMETER and NONE.

Optional arguments
None.

Return value
None

Exceptions
None.

22.61.2 appendInStep(...)
This method allows addition of surface feature angle assignments to new surfaces in a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which new surface feature angle assignments are to be
defined.

22–142

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

assignments
A sequence of tuples specifying the surface feature angle assignments. Each tuple contains two
entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the feature angle is assigned.
• A Float or a SymbolicConstant specifying the overriding surface feature angle value to be
used for the surface. Possible values of the SymbolicConstant are PERIMETER and NONE.

Optional arguments
None.

Return value
None

Exceptions
None.

22.61.3 delete(...)
The delete method allows you to delete existing surface feature angle assignments from a ContactExp
object.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each surface feature angle assignment to delete.
Optional arguments
None.

Return value
None

Exceptions
None.

22.61.4 Members
The SurfaceFeatureAssignment object has no members.

22–143

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.61.5 Corresponding analysis keywords

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=FEATURE EDGE CRITERIA

22.62 SurfaceOffsetAssignment object

The SurfaceOffsetAssignment object stores the surface offset fraction assignment definition for surfaces
in ContactExp and ContactStd objects. The SurfaceOffsetAssignment object has no constructor or
members.

Access
import interaction
mdb.models[name].interactions[name].surfaceOffsetAssignments

22.62.1 changeValuesInStep(...)
This method allows modification of surface offset fraction assignments already defined on surfaces in a
given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which the surface offset assignments are to be modified.
index
An Int specifying the position of the surface offset fraction assignment whose value is to be
modified.
value
A tuple specifying the value of the surface offset assignments for the surface whose index is
referenced. Each tuple contains one entry:
• A Float or a SymbolicConstant specifying the surface offset fraction value to be used for the
surface. Possible values of the SymbolicConstant are ORIGINAL, SPOS, and SNEG.

Optional arguments
None.

22–144

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Return value
None

Exceptions
None.

22.62.2 appendInStep(...)
This method allows addition of surface offset fraction assignments to new surfaces in a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which new surface offset fraction assignments are to
be defined.
assignments
A sequence of tuples specifying the surface offset fraction assignments. Each tuple contains two
entries:
• A region object or the SymbolicConstant WHOLE_DOMAIN specifying the surface to which
the offset fraction is assigned.
• A Float or a SymbolicConstant specifying the surface offset fraction value to be used for the
surface. Possible values of the SymbolicConstant are ORIGINAL, SPOS, and SNEG.

Optional arguments
None.

Return value
None

Exceptions
None.

22.62.3 delete(...)
The delete method allows you to delete existing surface offset fraction assignments.

22–145

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Arguments
Required argument
indices
A sequence of Ints specifying the index of each surface offset fraction assignment to delete.
Optional arguments
None.

Return value
None

Exceptions
None.

22.62.4 Members
The SurfaceOffsetAssignment object has no members.

22.62.5 Corresponding analysis keywords

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=OFFSET FRACTION

22.63 SurfaceThicknessAssignment object

The SurfaceThicknessAssignment object stores the surface thickness assignment definition for surfaces
in ContactExp and ContactStd objects. The SurfaceThicknessAssignment object has no constructor or
members.

Access
import interaction
mdb.models[name].interactions[name].surfaceThicknessAssignments

22.63.1 changeValuesInStep(...)
This method allows modification of surface thickness assignments already defined on surfaces in a given
step.

22–146

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Arguments
Required arguments
stepName
A String specifying the name of the step in which the surface thickness assignments are to be
modified.
index
An Int specifying the position of the surface thickness assignment whose value is to be modified.
value
A tuple specifying the value of the surface thickness assignments for the surface whose index is
referenced. Each tuple contains two entries:
• A Float or a SymbolicConstant specifying the overriding thickness value to be used in the
contact definition. Possible values of the SymbolicConstant are ORIGINAL and THINNING.
The SymbolicConstant THINNING can be specified only in an Abaqus/Explicit analysis.
• A Float specifying a scale factor that multiplies the thickness value specified in the second
entry.

Optional arguments
None.

Return value
None

Exceptions
None.

22.63.2 appendInStep(...)
This method allows addition of surface thickness assignments to new surfaces in a given step.

Arguments
Required arguments
stepName
A String specifying the name of the step in which new surface thickness assignments are to be
defined.
assignments
A sequence of tuples specifying the surface thickness assignments. Each tuple contains three
entries:

22–147

Abaqus ID:
Printed on:
INTERACTION COMMANDS

• A region object or the SymbolicConstant GLOBAL specifying the surface to which the
thickness is assigned.
• A Float or a SymbolicConstant specifying the overriding thickness value to be used in the
contact definition. Possible values of the SymbolicConstant are ORIGINAL and THINNING.
The SymbolicConstant THINNING can be specified only in an Abaqus/Explicit analysis.
• A Float specifying a scale factor that multiplies the thickness value specified in the second
entry.

Optional arguments
None.

Return value
None

Exceptions
None.

22.63.3 delete(...)
The delete method allows you to delete existing surface thickness assignments.

Arguments
Required argument
indices
A sequence of Ints specifying the index of each surface thickness assignment to delete.
Optional arguments
None.

Return value
None

Exceptions
None.

22.63.4 Members
The SurfaceThicknessAssignment object has no members.

22–148

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.63.5 Corresponding analysis keywords

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=THICKNESS

22.64 SurfaceToSurfaceContactExp object

The SurfaceToSurfaceContactExp object defines surface-to-surface contact during an Abaqus/Explicit

analysis.
The SurfaceToSurfaceContactExp object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22.64.1 SurfaceToSurfaceContactExp(...)
This method creates a SurfaceToSurfaceContactExp object.

Path
mdb.models[name].SurfaceToSurfaceContactExp

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the SurfaceToSurfaceContactExp object is
created.
master
A Region object specifying the master surface.
slave
A Region object specifying the slave surface.
sliding
A SymbolicConstant specifying the contact formulation. Possible values are FINITE and SMALL.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.

22–149

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
mechanicalConstraint
A SymbolicConstant specifying the mechanical constraint formulation. Possible values are
KINEMATIC and PENALTY. The default value is KINEMATIC.
weightingFactorType
A SymbolicConstant specifying the weighting for node-to-face contact. Possible values are
DEFAULT and SPECIFIED. The default value is DEFAULT.
weightingFactor
A Float specifying the weighting factor for the contact surfaces when
weightingFactorType=SPECIFIED. The default value is 0.0.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. An
empty string indicates that the default contact controls will be used. The default value is an empty
string.
initialClearance
A SymbolicConstant or a Float specifying the initial clearance at regions of contact. Possible
values are OMIT and COMPUTED. The default value is OMIT.
halfThreadAngle
None or a sequence of Floats specifying the half thread angle used for bolt clearance. The default
value is None.
pitch
None or a sequence of Floats specifying the pitch used for bolt clearance. The default value is
None.
majorBoltDiameter
The SymbolicConstant COMPUTED or a Float specifying the major diameter of the bolt used for
bolt clearance. The default value is COMPUTED.
meanBoltDiameter
The SymbolicConstant COMPUTED or a Float specifying the mean diameter of the bolt used for
bolt clearance. The default value is COMPUTED.
datumAxis
A DatumAxis object specifying the orientation of the bolt hole when specifying bolt clearance.
useReverseDatumAxis
A Boolean specifying whether to reverse the bolt clearance direction given by the datum axis. The
default value is OFF.
clearanceRegion
A Region object specifying the contact region for which clearance is specified.

Return value
A SurfaceToSurfaceContactExp object.

22–150

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Exceptions
None.

22.64.2 swapSurfaces()
This method switches the master and slave surfaces of a surface-to-surface contact pair. This command
is valid only during the step in which the interaction is created.

Arguments
None.

Return value
None

Exceptions
None.

22.64.3 setValues(...)
This method modifies the data for an existing SurfaceToSurfaceContactExp 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
SurfaceToSurfaceContactExp method, except for the name and createStepName
arguments.

Return value
None

Exceptions
None.

22–151

Abaqus ID:
Printed on:
INTERACTION COMMANDS

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. An
empty string indicates that the default contact controls will be used. The default value is an empty
string.

Return value
None

Exceptions
None.

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

22.65 SurfaceToSurfaceContactStd object

The SurfaceToSurfaceContactStd object defines surface-to-surface contact during an Abaqus/Standard

analysis.
The SurfaceToSurfaceContactStd object is derived from the Interaction object.

Access
import interaction
mdb.models[name].interactions[name]

22–152

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.65.1 SurfaceToSurfaceContactStd(...)
This method creates a SurfaceToSurfaceContactStd object.

Path
mdb.models[name].SurfaceToSurfaceContactStd

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the SurfaceToSurfaceContactStd object is
created.
master
A Region object specifying the master surface.
slave
A Region object specifying the slave surface.
sliding
A SymbolicConstant specifying the contact formulation. Possible values are FINITE and SMALL.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
Optional arguments
interferenceType
A SymbolicConstant specifying the type of time-dependent allowable interference for contact pairs
and contact elements. Possible values are:
• NONE, specifying no allowable contact interference.
• SHRINK_FIT.
• UNIFORM.
The default value is NONE.
overclosure
A Float specifying the maximum overclosure distance allowed. This argument applies only when
interferenceType=UNIFORM. The default value is 0.0.
interferenceDirectionType
A SymbolicConstant specifying the method used to determine the interference direction. Possible
values are COMPUTED and DIRECTION_COSINE. The default value is COMPUTED.
direction
A sequence of three Floats specifying the following:

22–153

Abaqus ID:
Printed on:
INTERACTION COMMANDS

• -direction cosine of the interference direction vector.

• -direction cosine of the interference direction vector.
• -direction cosine of the interference direction vector.
This argument is required only when interferenceDirectionType=DIRECTION_COSINE.
amplitude
A String specifying the name of the amplitude curve that defines the magnitude of the prescribed
interference during the step. Use None to specify that the prescribed interference is applied
immediately at the beginning of the step and ramped down to zero linearly over the step.
smooth
A Float specifying the degree of smoothing used for deformable or rigid master surfaces involved
when enforcement=NODE_TO_SURFACE. The value given must lie between 0.0 and 0.5. The
default value is 0.2.
hcrit
A Float specifying the distance by which a slave node must penetrate the master surface before
Abaqus/Standard abandons the current increment and tries again with a smaller increment. The
default value is 0.0.
extensionZone
A Float specifying a fraction of the end segment or facet edge length by which the master surface
is to be extended to avoid numerical round-off errors associated with contact modeling. The value
given must lie between 0.0 and 0.2. The default value is 0.1.
adjustMethod
A SymbolicConstant specifying the adjust method. Possible values are NONE, OVERCLOSED,
TOLERANCE, and SET. The default value is NONE.
adjustTolerance
A Float specifying the adjust tolerance. The default value is 0.0.
adjustSet
A Region object specifying the Set object to which the adjustment is to be applied.
enforcement
A SymbolicConstant specifying the discretization method. Possible values are
NODE_TO_SURFACE and SURFACE_TO_SURFACE. The default value is
SURFACE_TO_SURFACE.
thickness
A Boolean specifying whether shell/membrane element thickness is considered. The default value
is ON.
This argument is not valid when sliding=FINITE and enforcement=NODE_TO_SURFACE.
contactControls
A String specifying the name of the ContactControl object associated with this interaction. The
empty string indicates that the default contact controls will be used. The default value is an empty
string.

22–154

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

tied
A Boolean specifying whether the surfaces are to be "tied" together for the duration of the
simulation. The default value is OFF.
initialClearance
A SymbolicConstant or a Float specifying the initial clearance at regions of contact. Possible
values are OMIT and COMPUTED. The default value is OMIT.
halfThreadAngle
None or a sequence of Floats specifying the half thread angle used for bolt clearance. The default
value is None.
pitch
None or a sequence of Floats specifying the pitch used for bolt clearance. The default value is
None.
majorBoltDiameter
The SymbolicConstant COMPUTED or a Float specifying the major diameter of the bolt used for
bolt clearance. The default value is COMPUTED.
meanBoltDiameter
The SymbolicConstant COMPUTED or a Float specifying the mean diameter of the bolt used for
bolt clearance. The default value is COMPUTED.
datumAxis
A DatumAxis object specifying the orientation of the bolt hole when specifying bolt clearance.
useReverseDatumAxis
A Boolean specifying whether to reverse the bolt clearance direction given by the datum axis. The
default value is OFF.
clearanceRegion
A Region object specifying the contact region for which clearance is specified.
surfaceSmoothing
A SymbolicConstant specifying the discretization method. Possible values are
NODE_TO_SURFACE and SURFACE_TO_SURFACE. The default value is NONE.
A SymbolicConstant specifying whether to use surface smoothing for geometric surfaces
in SurfaceToSurfaceContactStd interactions. Possible values are NONE, and AUTOMATIC. is
created by default.
bondingSet
A Region object specifying the slave node sub-set for bonding, used only when the contact property
CohesiveBehavior option specifies use.

Return value
A SurfaceToSurfaceContactStd object.

22–155

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Exceptions
None.

22.65.2 swapSurfaces()
This method switches the master and slave surfaces of a surface-to-surface contact pair. This command
is valid only for the step in which the interaction is created.

Arguments
None.

Return value
None

Exceptions
None.

22.65.3 setValues(...)
This method modifies the data for an existing SurfaceToSurfaceContactStd 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
SurfaceToSurfaceContactStd method, except for the name and createStepName
arguments.

Return value
None

Exceptions
None.

22–156

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional arguments
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
interferenceType
A SymbolicConstant specifying the type of time-dependent allowable interference for contact pairs
and contact elements. Possible values are:
• NONE, specifying no allowable contact interference.
• SHRINK_FIT.
• UNIFORM.
The default value is NONE.
overclosure
A Float specifying the maximum overclosure distance allowed. This argument applies only when
interferenceType=UNIFORM. The default value is 0.0.
interferenceDirectionType
A SymbolicConstant specifying the method used to determine the interference direction. Possible
values are COMPUTED and DIRECTION_COSINE. The default value is COMPUTED.
direction
A sequence of three Floats specifying the following:
• -direction cosine of the interference direction vector.
• -direction cosine of the interference direction vector.
• -direction cosine of the interference direction vector.
This argument is required only when interferenceDirectionType=DIRECTION_COSINE.
amplitude
A String specifying the name of the amplitude curve that defines the magnitude of the prescribed
interference during the step. Use None to specify that the prescribed interference is applied
immediately at the beginning of the step and ramped down to zero linearly over the step.

22–157

Abaqus ID:
Printed on:
INTERACTION COMMANDS

contactControls
A String specifying the name of the ContactControl object associated with this interaction. The
empty string indicates that the default contact controls will be used. The default value is an empty
string.

Return value
None

Exceptions
None.

22.65.5 Members
The SurfaceToSurfaceContactStd object has members with the same names and descriptions as the
arguments to the SurfaceToSurfaceContactStd method.
In addition, the SurfaceToSurfaceContactStd object has the following members:
contactTracking
A SymbolicConstant specifying the choice of contact tracking algorithm. The STATE tracking
algorithm uses only normal projections and is specified by using ONE_CONFIG. The PATH
tracking algorithm uses crossing and normal projections and is specified by using TWO_CONFIG.
Possible values are ONE_CONFIG and TWO_CONFIG. The default value is TWO_CONFIG.
This argument is valid only when sliding=FINITE and
enforcement=SURFACE_TO_SURFACE.
supplementaryContact
A SymbolicConstant specifying the manner in which mid-face constraints are employed. Possible
values are SELECTIVE, NEVER, and ALWAYS. The default value is SELECTIVE.
This argument is not valid when sliding=FINITE and
enforcement=SURFACE_TO_SURFACE.

22.66 SurfaceToSurfaceExpState object

The SurfaceToSurfaceExpState object stores the propagating data for a SurfaceToSurfaceContactExp

object. One instance of this object is created internally by the SurfaceToSurfaceContactExp object for
each step. The instance is also deleted internally by the SurfaceToSurfaceContactExp object.
The SurfaceToSurfaceExpState object has no constructor or methods.
The SurfaceToSurfaceExpState object is derived from the InteractionState object.

Access
import interaction

22–158

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

mdb.models[name].steps[name].interactionStates[name]

22.66.1 Members
The SurfaceToSurfaceExpState object has the following members:

interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
contactControlsState
A SymbolicConstant specifying the propagation state of the contactControls member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
contactControls
A String specifying the name of the ContactControl object associated with this interaction.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:

• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.66.2 Corresponding analysis keywords

*CONTACT CONTROLS
*CONTACT PAIR

22–159

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.67 SurfaceToSurfaceStdState object

The SurfaceToSurfaceStdState object stores the propagating data for a SurfaceToSurfaceContactStd

object. One instance of this object is created internally by the SurfaceToSurfaceContactStd object for
each step. The instance is also deleted internally by the SurfaceToSurfaceContactStd object.
The SurfaceToSurfaceStdState object has no constructor or methods.
The SurfaceToSurfaceStdState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.67.1 Members
The SurfaceToSurfaceStdState object has the following members:
interactionPropertyState
A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
interferenceType
A SymbolicConstant specifying the interference type. Possible values are NONE, SHRINK_FIT,
and UNIFORM.
interferenceTypeState
A SymbolicConstant specifying the propagation state of the interferenceType member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
overclosure
A Float specifying the allowable overclosure.
overclosureState
A SymbolicConstant specifying the propagation state of the overclosure member. Possible values
are COMPUTED and DIRECTION_COSINE.
interferenceDirectionType
A SymbolicConstant specifying the interference direction type. Possible values are COMPUTED
and DIRECTION_COSINE.
interferenceDirectionTypeState
A SymbolicConstant specifying the propagation state of the interferenceDirectionType member.
Possible values are UNSET, SET, UNCHANGED, and FREED.
directionState
A SymbolicConstant specifying the propagation state of the direction member. Possible values
are UNSET, SET, UNCHANGED, and FREED.

22–160

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
contactControlsState
A SymbolicConstant specifying the propagation state of the contactControls member. Possible
values are UNSET, SET, UNCHANGED, and FREED.
interactionProperty
A String specifying the name of the ContactProperty object associated with this interaction.
amplitude
A String specifying the name of the Amplitude object that defines the magnitude of the prescribed
interference during the step.
contactControls
A String specifying the name of the ContactControl object associated with this interaction.
direction
A tuple of three Floats specifying the following:
• -direction cosine of the interference direction vector.
• -direction cosine of the interference direction vector.
• -direction cosine of the interference direction vector.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22.67.2 Corresponding analysis keywords

*CONTACT CONTROLS
*CONTACT PAIR
*CONTACT INTERFERENCE

22–161

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.68 ThermalConductance object

The ThermalConductance object specifies thermal conductance for a contact interaction property.

Access
import interaction
mdb.models[name].interactionProperties[name].thermalConductance

22.68.1 ThermalConductance(...)
This method creates a ThermalConductance object.

Path
mdb.models[name].interactionProperties[name].ThermalConductance

Required arguments
None.
Optional arguments
definition
A SymbolicConstant specifying how the thermal conductance is defined. Possible values are
TABULAR and USER_DEFINED. The default value is TABULAR.
clearanceDependency
A Boolean specifying whether to use clearance-dependent data. The default value is ON.
pressureDependency
A Boolean specifying whether to use pressure-dependent data. The default value is OFF.
temperatureDependencyC
A Boolean specifying whether to use temperature-dependent data with clearance dependency. The
default value is OFF.
massFlowRateDependencyC
A Boolean specifying whether to use mass-flow-rate-dependent data with clearance dependency.
The default value is OFF.
dependenciesC
An Int specifying the number of field variables to use with clearance dependency. The default
value is 0.

22–162

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

clearanceDepTable
A sequence of sequences of Floats specifying clearance dependency data. The items in the table
data are described below.
temperatureDependencyP
A Boolean specifying whether to use temperature-dependent data with pressure dependency. The
default value is OFF.
massFlowRateDependencyP
A Boolean specifying whether to use mass-flow-rate-dependent data with pressure dependency.
The default value is OFF.
dependenciesP
An Int specifying the number of field variables to use with pressure dependency. The default value
is 0.
pressureDepTable
A sequence of sequences of Floats specifying pressure dependency data. The items in the table
data are described below.
Table data
The clearanceDepTable data specify the following:
• Conductivity.
• Clearance.
• Temperature, if the data depend on temperature.
• Mass flow rate, if the data depend on mass flow rate.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
The pressureDepTable data specify the following:
• Conductivity.
• Pressure.
• Temperature, if the data depend on temperature.
• Mass flow rate, if the data depend on mass flow rate.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ThermalConductance object.

22–163

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Exceptions
None.

22.68.2 setValues(...)
This method modifies the ThermalConductance object.

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

Return value
None

Exceptions
None.

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

22.68.4 Corresponding analysis keywords

*GAP CONDUCTANCE

22.69 XFEMCrackGrowth object

The XFEMCrackGrowth object defines the enrichment activation state for an XFEMCrack .
The XFEMCrackGrowth object is derived from the Interaction object.

22–164

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

Access
import interaction
mdb.models[name].interactions[name]

22.69.1 XFEMCrackGrowth(...)
This method creates an XFEMCrackGrowth object.

Path
mdb.models[name].XFEMCrackGrowth

Required arguments
name
A String specifying the repository key.
createStepName
A String specifying the name of the step in which the XFEMCrackGrowth object is created.
crackName
A String specifying the XFEMCrack object associated with this interaction.
Optional argument
allowGrowth
A Boolean specifying whether the crack is allowed to grow (propagate) during this analysis step.
The default value is ON.

Return value
A XFEMCrackGrowth object.

Exceptions
None.

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

Arguments
Required arguments
None.

22–165

Abaqus ID:
Printed on:
INTERACTION COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the XFEMCrackGrowth
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the interaction is modified.
Optional argument
allowGrowth
A Boolean specifying whether the crack is allowed to grow (propagate) during this analysis step.
The default value is ON.

Return value
None

Exceptions
None.

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

22.69.5 Corresponding analysis keywords

*ENRICHMENT ACTIVATION

22–166

Abaqus ID:
Printed on:
 INTERACTION COMMANDS

22.70 XFEMCrackGrowthState object

The XFEMCrackGrowthState object stores the propagating data of an XFEMCrackGrowth object in a

step. One instance of this object is created internally by the XFEMCrackGrowth object for each step.
The instance is also deleted internally by the XFEMCrackGrowth object.
The XFEMCrackGrowthState object has no constructor or methods.
The XFEMCrackGrowthState object is derived from the InteractionState object.

Access
import interaction
mdb.models[name].steps[name].interactionStates[name]

22.70.1 Members
The XFEMCrackGrowthState object has the following members:
allowGrowth
A Boolean specifying whether the crack is allowed to grow (propagate) during this analysis step.
The default value is ON.
allowGrowthState
A SymbolicConstant specifying the propagation state of the allowGrowth member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the InteractionState object. Possible
values are:

• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

22–167

Abaqus ID:
Printed on:
INTERACTION COMMANDS

22.70.2 Corresponding analysis keywords

*ENRICHMENT ACTIVATION

22–168

Abaqus ID:
Printed on:
 JOB COMMANDS

23. Job commands

The Job commands provide methods to create, modify, submit, and control jobs.

23.1 Job object

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

Access
import job
mdb.coexecutions[name].jobs[name]
mdb.jobs[name]

23.1.1 kill()
This method kills the analysis of a job.

Arguments
None.

Return value
None

Exceptions
None.

23.1.2 submit(...)
This method submits a job for analysis.

Arguments
Required arguments
None.

23–1

Abaqus ID:
Printed on:
JOB COMMANDS

Optional arguments
consistencyChecking
A Boolean specifying whether to perform consistency checking for the job. The default value is
ON. It is not recommended to turn the consistency checking off unless you are absolutely sure the
model is consistent.
datacheckJob
A Boolean specifying whether to run the job 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 job as a continuation analysis. The default value is False.
The datacheckJob and continueJob arguments cannot both be True.

Return value
None

Exceptions
None.

23.1.3 waitForCompletion()
This method interrupts the execution of the script until the end of the analysis. If you call the
waitForCompletion method and the status member is neither SUBMITTED nor RUNNING,
Abaqus assumes the analysis has either completed or aborted and returns immediately.

Arguments
None.

Return value
None

Exceptions
None.

23.1.4 Members
The Job object can have the following members:
name
A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.

23–2

Abaqus ID:
Printed on:
 JOB COMMANDS

type
A SymbolicConstant specifying the type of job. Possible values are ANALYSIS,
SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.
waitHours
An Int specifying the number of hours to wait before submitting the job. This argument is ignored
if queue is set. The default value is 0.
This argument works in conjunction with waitMinutes. waitHours and atTime are mutually
exclusive.
waitMinutes
An Int specifying the number of minutes to wait before submitting the job. This argument is
ignored if queue is set. The default value is 0.
This argument works in conjunction with waitHours. waitMinutes and atTime are mutually
exclusive.
numCpus
An Int specifying the number of CPUs to use for this analysis if parallel processing is available.
Possible values are numCpus 0. The default value is 1.
memory
An Int specifying the amount of memory available to Abaqus analysis. The value should be
expressed in the units supplied in memoryUnits. The default value is 90.
memoryUnits
A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis.
Possible values are PERCENTAGE, MEGA_BYTES, and GIGA_BYTES. The default value is
PERCENTAGE.
getMemoryFromAnalysis
A Boolean specifying whether to retrieve the recommended memory settings from the last
datacheck or analysis run and use those values in subsequent submissions. The default value is
ON.
explicitPrecision
A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit.
Possible values are SINGLE, FORCE_SINGLE, DOUBLE, DOUBLE_CONSTRAINT_ONLY,
and DOUBLE_PLUS_PACK. The default value is SINGLE.
nodalOutputPrecision
A SymbolicConstant specifying the precision of the nodal output written to the output database.
Possible values are SINGLE and FULL. The default value is SINGLE.
parallelizationMethodExplicit
A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. Possible values
are LOOP and DOMAIN. The default value is LOOP.

23–3

Abaqus ID:
Printed on:
JOB COMMANDS

numDomains
An Int specifying the number of domains for parallel execution in Abaqus/Explicit. When
parallelizationMethodExplicit=DOMAIN, numDomains must be a multiple of numCpus. The
default value is 1.
activateLoadBalancing
A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple
processors with multiple domains in Abaqus/Explicit. The default value is OFF.
multiprocessingMode
A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple
processes that communicate through a message passing interface (MPI). Possible values are
DEFAULT, THREADS, and MPI. The default value is DEFAULT.
analysis
A SymbolicConstant specifying whether the job will be analyzed by Abaqus/Standard,
Abaqus/Explicit, or Abaqus/CFD. Possible values are STANDARD, EXPLICIT, CFD, and
UNKNOWN.
If the object has type JobFromInputFile , analysis=UNKNOWN.
status
A SymbolicConstant specifying the status of the analysis. Possible values are SUBMITTED,
RUNNING, ABORTED, TERMINATED, COMPLETED, CHECK_RUNNING, and
CHECK_COMPLETED.
If the message member is empty, status is set to NONE.
queue
A String specifying the name of the queue to which to submit the job. The default value is an
empty string.

Note: You can use the queue argument when creating a Job object on a Windows workstation;
however, remote queues are available only on UNIX platforms.

atTime
A String specifying the time at which to submit the job. If queue is empty, the string syntax must
be valid for the UNIX at command. If queue is set, the syntax must be valid according to the
system administrator. The default value is an empty string.

Note: You can use the atTime argument when creating a Job object on a Windows workstation;
however, the at command is available only on UNIX platforms.

scratch
A String specifying the location of the scratch directory. The default value is an empty string.

23–4

Abaqus ID:
Printed on:
 JOB COMMANDS

userSubroutine
A String specifying the file containing the user’s subroutine definitions. The default value is an
empty string.
messages
A MessageArray object specifying the messages received during an analysis.
environment
A tuple of Strings specifying the environment variables and their values.

23.1.5 Corresponding analysis keywords

*HEADING
*PREPRINT

23.2 JobFromInputFile object

The JobFromInputFile object defines a Job object which analyzes a model contained in an input file.
The JobFromInputFile object is derived from the Job object.

Access
import job
mdb.jobs[name]

23.2.1 JobFromInputFile(...)
This method creates an analysis job using an input file for the model definition.

Path
mdb.JobFromInputFile

Required arguments
name
A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.
inputFileName
A String specifying the input file to read. Possible values are any valid file name. If the .inp
extension is not included in the value of the argument, the system will append it for the user.

23–5

Abaqus ID:
Printed on:
JOB COMMANDS

Optional arguments
type
A SymbolicConstant specifying the type of job. Possible values are ANALYSIS,
SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.
queue
A String specifying the name of the queue to which to submit the job. The default value is an
empty string.

Note: You can use the queue argument when creating a Job object on a Windows workstation;
however, remote queues are available only on UNIX platforms.

waitHours
An Int specifying the number of hours to wait before submitting the job. This argument is ignored
if queue is set. The default value is 0.
This argument works in conjunction with waitMinutes. waitHours and atTime are mutually
exclusive.
waitMinutes
An Int specifying the number of minutes to wait before submitting the job. This argument is
ignored if queue is set. The default value is 0.
This argument works in conjunction with waitHours. waitMinutes and atTime are mutually
exclusive.
atTime
A String specifying the time at which to submit the job. If queue is empty, the string syntax must
be valid for the UNIX at command. If queue is set, the syntax must be valid according to the
system administrator. The default value is an empty string.

Note: You can use the atTime argument when creating a Job object on a Windows workstation;
however, the at command is available only on UNIX platforms.

scratch
A String specifying the location of the scratch directory. The default value is an empty string.
userSubroutine
A String specifying the file containing the user’s subroutine definitions. The default value is an
empty string.
numCpus
An Int specifying the number of CPUs to use for this analysis if parallel processing is available.
Possible values are numCpus 0. The default value is 1.
memory
An Int specifying the amount of memory available to Abaqus analysis. The value should be
expressed in the units supplied in memoryUnits. The default value is 90.

23–6

Abaqus ID:
Printed on:
 JOB COMMANDS

memoryUnits
A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis.
Possible values are PERCENTAGE, MEGA_BYTES, and GIGA_BYTES. The default value is
PERCENTAGE.
explicitPrecision
A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit.
Possible values are SINGLE, FORCE_SINGLE, DOUBLE, DOUBLE_CONSTRAINT_ONLY,
and DOUBLE_PLUS_PACK. The default value is SINGLE.
nodalOutputPrecision
A SymbolicConstant specifying the precision of the nodal output written to the output database.
Possible values are SINGLE and FULL. The default value is SINGLE.
parallelizationMethodExplicit
A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. Possible values
are LOOP and DOMAIN. The default value is LOOP.
numDomains
An Int specifying the number of domains for parallel execution in Abaqus/Explicit. When
parallelizationMethodExplicit=DOMAIN, numDomains must be a multiple of numCpus. The
default value is 1.
activateLoadBalancing
A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple
processors with multiple domains in Abaqus/Explicit. The default value is OFF.
multiprocessingMode
A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple
processes that communicate through a message passing interface (MPI). Possible values are
DEFAULT, THREADS, and MPI. The default value is DEFAULT.

Return value
A JobFromInputFile object.

Exceptions
AbaqusException.

23.2.2 setValues(...)
This method modifies the JobFromInputFile object.

Arguments
Required arguments
None.

23–7

Abaqus ID:
Printed on:
JOB COMMANDS

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

Return value
None

Exceptions

23.2.3 Members
The JobFromInputFile object has members with the same names and descriptions as the arguments to
the JobFromInputFile method.
In addition, the JobFromInputFile object can have the following members:
getMemoryFromAnalysis
A Boolean specifying whether to retrieve the recommended memory settings from the last
datacheck or analysis run and use those values in subsequent submissions. The default value is
ON.
analysis
A SymbolicConstant specifying whether the job will be analyzed by Abaqus/Standard,
Abaqus/Explicit, or Abaqus/CFD. Possible values are STANDARD, EXPLICIT, CFD, and
UNKNOWN.
If the object has type JobFromInputFile, analysis=UNKNOWN.
status
A SymbolicConstant specifying the status of the analysis. Possible values are SUBMITTED,
RUNNING, ABORTED, TERMINATED, COMPLETED, CHECK_RUNNING, and
CHECK_COMPLETED.
If the message member is empty, status is set to NONE.
messages
A MessageArray object specifying the messages received during an analysis.
environment
A tuple of Strings specifying the environment variables and their values.

23.3 Message object

The Message object contains information about a given phase of the simulation. Job messages are not
returned if a script is run without the Abaqus/CAE GUI (using the noGUI option).

23–8

Abaqus ID:
Printed on:
 JOB COMMANDS

Access
import job
mdb.coexecutions[name].jobs[name].messages[i]
mdb.jobs[name].messages[i]

23.3.1 Members
The Message object has the following members:
type
A SymbolicConstant specifying the type of message. Possible values are:
• ABORTED
• ANY_JOB
• ANY_MESSAGE_TYPE
• COMPLETED
• END_STEP
• ERROR
• HEADING
• HEALER_JOB
• HEALER_TYPE
• INTERRUPTED
• ITERATION
• JOB_ABORTED
• JOB_COMPLETED
• JOB_INTERRUPTED
• JOB_SUBMITTED
• MONITOR_DATA
• ODB_FILE
• ODB_FRAME
• STARTED
• STATE_FRAME
• STATUS
• STEP
• WARNING
data
A Dictionary object specifying the data returned by the analysis product. The value depends on
the message returned. For a list of the possible entries, see the members of DataObject .

23–9

Abaqus ID:
Printed on:
JOB COMMANDS

23.4 ModelJob object

The ModelJob object defines a Job object which analyzes a model on a model database (MDB).
The ModelJob object is derived from the Job object.

Access
import job
mdb.adaptivityProcesses[name].job
mdb.jobs[name]

23.4.1 Job(...)
This method creates an analysis job using a model on a model database (MDB) for the model definition.

Path
mdb.Job

Required arguments
name
A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.
model
A String specifying the name of the model to be analyzed or a Model object specifying the model
to be analyzed.
Optional arguments
description
A String specifying a description of the job.
type
A SymbolicConstant specifying the type of job. Possible values are ANALYSIS,
SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.
queue
A String specifying the name of the queue to which to submit the job. The default value is an
empty string.

Note: You can use the queue argument when creating a Job object on a Windows workstation;
however, remote queues are available only on UNIX platforms.

23–10

Abaqus ID:
Printed on:
 JOB COMMANDS

waitHours
An Int specifying the number of hours to wait before submitting the job. This argument is ignored
if queue is set. The default value is 0.
This argument works in conjunction with waitMinutes. waitHours and atTime are mutually
exclusive.
waitMinutes
An Int specifying the number of minutes to wait before submitting the job. This argument is
ignored if queue is set. The default value is 0.
This argument works in conjunction with waitHours. waitMinutes and atTime are mutually
exclusive.
atTime
A String specifying the time at which to submit the job. If queue is empty, the string syntax must
be valid for the UNIX at command. If queue is set, the syntax must be valid according to the
system administrator. The default value is an empty string.

Note: You can use the atTime argument when creating a Job object on a Windows workstation;
however, the at command is available only on UNIX platforms.

echoPrint
A Boolean specifying whether an echo of the input data is printed. The default value is OFF.
contactPrint
A Boolean specifying whether contact constraint data are printed. The default value is OFF.
modelPrint
A Boolean specifying whether model definition data are printed. The default value is OFF.
historyPrint
A Boolean specifying whether history data are printed. The default value is OFF.
scratch
A String specifying the location of the scratch directory. The default value is an empty string.
userSubroutine
A String specifying the file containing the user’s subroutine definitions. The default value is an
empty string.
numCpus
An Int specifying the number of CPUs to use for this analysis if parallel processing is available.
Possible values are numCpus 0. The default value is 1.
memory
An Int specifying the amount of memory available to Abaqus analysis. The value should be
expressed in the units supplied in memoryUnits. The default value is 90.

23–11

Abaqus ID:
Printed on:
JOB COMMANDS

memoryUnits
A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis.
Possible values are PERCENTAGE, MEGA_BYTES, and GIGA_BYTES. The default value is
PERCENTAGE.
explicitPrecision
A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit.
Possible values are SINGLE, FORCE_SINGLE, DOUBLE, DOUBLE_CONSTRAINT_ONLY,
and DOUBLE_PLUS_PACK. The default value is SINGLE.
nodalOutputPrecision
A SymbolicConstant specifying the precision of the nodal output written to the output database.
Possible values are SINGLE and FULL. The default value is SINGLE.
parallelizationMethodExplicit
A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. Possible values
are LOOP and DOMAIN. The default value is LOOP.
numDomains
An Int specifying the number of domains for parallel execution in Abaqus/Explicit. When
parallelizationMethodExplicit=DOMAIN, numDomains must be a multiple of numCpus. The
default value is 1.
activateLoadBalancing
A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple
processors with multiple domains in Abaqus/Explicit. The default value is OFF.
multiprocessingMode
A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple
processes that communicate through a message passing interface (MPI). Possible values are
DEFAULT, THREADS, and MPI. The default value is DEFAULT.

Return value
A ModelJob object.

Exceptions
AbaqusException.

23.4.2 writeInput(...)
This method writes an input file.

Arguments
Required arguments
None.

23–12

Abaqus ID:
Printed on:
 JOB COMMANDS

Optional argument
consistencyChecking
A Boolean specifying whether to perform consistency checking for the job. The default value is
ON.It is not recommended to turn the consistency checking off unless you are absolutely sure the
model is consistent.

Return value
None

Exceptions
None.

23.4.3 setValues(...)
This method modifies the ModelJob object.

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

Return value
None

Exceptions
None.

23.4.4 Members
The ModelJob object can have the following members:
name
A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.
echoPrint
A Boolean specifying whether an echo of the input data is printed. The default value is OFF.
contactPrint
A Boolean specifying whether contact constraint data are printed. The default value is OFF.

23–13

Abaqus ID:
Printed on:
JOB COMMANDS

modelPrint
A Boolean specifying whether model definition data are printed. The default value is OFF.
historyPrint
A Boolean specifying whether history data are printed. The default value is OFF.
model
A String specifying the name of the model to be analyzed or a Model object specifying the model
to be analyzed.
description
A String specifying a description of the job.
type
A SymbolicConstant specifying the type of job. Possible values are ANALYSIS,
SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.
waitHours
An Int specifying the number of hours to wait before submitting the job. This argument is ignored
if queue is set. The default value is 0.
This argument works in conjunction with waitMinutes. waitHours and atTime are mutually
exclusive.
waitMinutes
An Int specifying the number of minutes to wait before submitting the job. This argument is
ignored if queue is set. The default value is 0.
This argument works in conjunction with waitHours. waitMinutes and atTime are mutually
exclusive.
numCpus
An Int specifying the number of CPUs to use for this analysis if parallel processing is available.
Possible values are numCpus 0. The default value is 1.
memory
An Int specifying the amount of memory available to Abaqus analysis. The value should be
expressed in the units supplied in memoryUnits. The default value is 90.
memoryUnits
A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis.
Possible values are PERCENTAGE, MEGA_BYTES, and GIGA_BYTES. The default value is
PERCENTAGE.
getMemoryFromAnalysis
A Boolean specifying whether to retrieve the recommended memory settings from the last
datacheck or analysis run and use those values in subsequent submissions. The default value is
ON.

23–14

Abaqus ID:
Printed on:
 JOB COMMANDS

explicitPrecision
A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit.
Possible values are SINGLE, FORCE_SINGLE, DOUBLE, DOUBLE_CONSTRAINT_ONLY,
and DOUBLE_PLUS_PACK. The default value is SINGLE.
nodalOutputPrecision
A SymbolicConstant specifying the precision of the nodal output written to the output database.
Possible values are SINGLE and FULL. The default value is SINGLE.
parallelizationMethodExplicit
A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. Possible values
are LOOP and DOMAIN. The default value is LOOP.
numDomains
An Int specifying the number of domains for parallel execution in Abaqus/Explicit. When
parallelizationMethodExplicit=DOMAIN, numDomains must be a multiple of numCpus. The
default value is 1.
activateLoadBalancing
A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple
processors with multiple domains in Abaqus/Explicit. The default value is OFF.
multiprocessingMode
A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple
processes that communicate through a message passing interface (MPI). Possible values are
DEFAULT, THREADS, and MPI. The default value is DEFAULT.
analysis
A SymbolicConstant specifying whether the job will be analyzed by Abaqus/Standard,
Abaqus/Explicit, or Abaqus/CFD. Possible values are STANDARD, EXPLICIT, CFD, and
UNKNOWN.
If the object has type JobFromInputFile , analysis=UNKNOWN.
status
A SymbolicConstant specifying the status of the analysis. Possible values are SUBMITTED,
RUNNING, ABORTED, TERMINATED, COMPLETED, CHECK_RUNNING, and
CHECK_COMPLETED.
If the message member is empty, status is set to NONE.
queue
A String specifying the name of the queue to which to submit the job. The default value is an
empty string.

Note: You can use the queue argument when creating a Job object on a Windows workstation;
however, remote queues are available only on UNIX platforms.

23–15

Abaqus ID:
Printed on:
JOB COMMANDS

atTime
A String specifying the time at which to submit the job. If queue is empty, the string syntax must
be valid for the UNIX at command. If queue is set, the syntax must be valid according to the
system administrator. The default value is an empty string.

Note: You can use the atTime argument when creating a Job object on a Windows workstation;
however, the at command is available only on UNIX platforms.

scratch
A String specifying the location of the scratch directory. The default value is an empty string.
userSubroutine
A String specifying the file containing the user’s subroutine definitions. The default value is an
empty string.
messages
A MessageArray object specifying the messages received during an analysis.
environment
A tuple of Strings specifying the environment variables and their values.

23.5 Queue object

A Queue object tells the job where and how to submit a job remotely. A Queue object can be used as the
queue argument to the Job method.

Access
import job
session.queues[name]

23.5.1 Queue(...)
This method creates a Queue object.

Note: Remote queues are available only on UNIX platforms.

Path
session.Queue

23–16

Abaqus ID:
Printed on:
 JOB COMMANDS

Required arguments
name
A String specifying the name of the new Queue object.
queueName
A String specifying the name of the remote analysis queue.
Optional arguments
hostName
A String specifying the name of the remote host. The default value is an empty string.
fileCopy
A Boolean specifying if the results files are to be copied from the remote machine to the local
machine. The default value is ON.
directory
A String specifying the remote location for the execution of the simulation. The default value is
an empty string.
driver
A String specifying the designation of the remote driver. The default value is "abaqus".
localPlatform
A SymbolicConstant specifying the type of operating system on the local machine. Possible values
are UNIX and WINDOWS. The default value is WINDOWS.
remotePlatform
A SymbolicConstant specifying the type of operating system on the remote machine. The default
value is UNIX.
filesToCopy
A sequence of Strings specifying the files to be copied from the remote location to the local
machine. The default value is (’log’, ’dat’, ’msg’, ’sta’, ’odb’, ’ipm’, ’res’, ’abq’, ’pac’, ’023’,
’sel’).
description
A String specifying a description of the queue. The default value is an empty string.

Return value
A Queue object.

Exceptions
If fileCopy=ON and hostName is empty:
Remote queue host name is not set.
If fileCopy=ON and directory is empty:
Directory in which to run the job on the remote computer is not set.

23–17

Abaqus ID:
Printed on:
JOB COMMANDS

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

23.6 Coexecution object

The Coexecution object contains a set of jobs as associated parameters to define a co-simulation analysis.

Access
import job
mdb.coexecutions[name]

23.6.1 kill()
This method kills the analysis of a co-execution.

Arguments
None.

Return value
None

Exceptions
None.

23.6.2 submit(...)
This method submits a co-execution for analysis.

Arguments
Required arguments
None.
Optional arguments
consistencyChecking
A Boolean specifying whether to perform consistency checking for the individual jobs. The default
value is ON. It is not recommended to turn the consistency checking off unless you are absolutely
sure the models are all consistent.

23–18

Abaqus ID:
Printed on:
 JOB COMMANDS

datacheckJob
A Boolean specifying whether to run the co-execution 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 co-execution as a continuation analysis. The default
value is False. The datacheckJob and continueJob arguments cannot both be True.

Return value
None

Exceptions
None.

23.6.3 writeInput(...)
This method writes an input file for each analysis in the co-execution.

Arguments
Required arguments
None.
Optional argument
consistencyChecking
A Boolean specifying whether to perform consistency checking for the individual jobs. The default
value is ON. It is not recommended to turn the consistency checking off unless you are absolutely
sure the models are all consistent.

Return value
None

Exceptions
None.

23.6.4 waitForCompletion()
This method interrupts the execution of the script until the end of all the analyses. If you call the
waitForCompletion method and the status member is neither SUBMITTED nor RUNNING,
Abaqus assumes the analysis has either completed or aborted and returns immediately.

23–19

Abaqus ID:
Printed on:
JOB COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

23.6.5 Members
The Coexecution object can have the following members:
name
A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.
type
A SymbolicConstant specifying the type of analysis to execute for the co-execution. Possible
values are ANALYSIS, SYNTAXCHECK, RECOVER, and RESTART. The default value is
ANALYSIS.
masterAnalysisProduct
A SymbolicConstant specifying the analysis product type of the master model for the co-execution.
The default value is ABAQUS.
waitHours
An Int specifying the number of hours to wait before submitting the co-execution. This argument
is ignored if queue is set. The default value is 0.
This argument works in conjunction with waitMinutes. waitHours and atTime are mutually
exclusive.
waitMinutes
An Int specifying the number of minutes to wait before submitting the job. This argument is
ignored if queue is set. The default value is 0.
This argument works in conjunction with waitHours. waitMinutes and atTime are mutually
exclusive.
status
A SymbolicConstant specifying the status of the co-execution. Possible values are SUBMITTED,
RUNNING, ABORTED, TERMINATED, COMPLETED, CHECK_SUBMITTED,
CHECK_RUNNING, and CHECK_COMPLETED.
If the message member of all the jobs are empty, status is set to NONE.
queue
A String specifying the name of the queue to which to submit the co-execution. The default value
is an empty string.

23–20

Abaqus ID:
Printed on:
 JOB COMMANDS

Note: You can use the queue argument when creating a Coexecution object on a Windows
workstation; however, remote queues are available only on UNIX platforms.

atTime
A String specifying the time at which to submit the co-execution. If queue is empty, the string
syntax must be valid for the UNIX at command. If queue is set, the syntax must be valid according
to the system administrator. The default value is an empty string.

Note: You can use the atTime argument when creating a Coexecution object on a Windows
workstation; however, the at command is available only on UNIX platforms.

jobs
A repository of Job objects specifying the jobs that comprise this co-execution.
slaveModels
A tuple of Strings specifying the names of the slave models for the co-execution.
slaveAnalysisProducts
A tuple of SymbolicConstants specifying the analysis product types of the slave models for the
co-execution. The default value is an empty sequence.
masterModel
A String specifying the name of the master model for the co-execution.

23.6.6 Corresponding analysis keywords

*HEADING
*PREPRINT

23–21

Abaqus ID:
Printed on:
 LOAD COMMANDS

24. Load commands

A specific type of load object and a specific type of load state object are designed for each type of load. A
load object stores the non-propagating data of a load as well as a number of instances of the corresponding
load state object, each of which stores the propagating data of the load in a single step. Instances of the
load state object are created and deleted internally by its corresponding load object.

24.1 Load object

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

Access
import load
mdb.models[name].loads[name]

24.1.1 deactivate(...)
This method deactivates the load in the specified step and all its subsequent steps.

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

Return value
None

Exceptions
TextError.

24.1.2 move(...)
This method moves the load state object from one step to a different step.

24–1

Abaqus ID:
Printed on:
LOAD COMMANDS

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

Return value
None

Exceptions
TextError.

24.1.3 reset(...)
This method resets the load state of the specified step to the state of the previous general analysis step.

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

Return value
None

Exceptions
TextError.

24.1.4 resume()
This method resumes the load that was previously suppressed.

24–2

Abaqus ID:
Printed on:
 LOAD COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

24.1.5 suppress()
This method suppresses the load.

Arguments
None.

Return value
None

Exceptions
None.

24.1.6 delete(...)
This method allows you to delete existing loads.

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

Return value
None

24–3

Abaqus ID:
Printed on:
LOAD COMMANDS

Exceptions
None.

24.1.7 Members
The Load object can have the following members:
name
A String specifying the load repository key.
region
A Region object specifying the region to which the load is applied.

24.2 BodyCharge object

The BodyCharge object stores the data for a body charge.

The BodyCharge object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.2.1 BodyCharge(...)
This method creates a BodyCharge object.

Path
mdb.models[name].BodyCharge

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.

24–4

Abaqus ID:
Printed on:
 LOAD COMMANDS

Optional arguments
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

Return value
A BodyCharge object.

Exceptions
None.

24.2.2 setValues(...)
This method modifies the data for an existing BodyCharge 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 BodyCharge method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–5

Abaqus ID:
Printed on:
LOAD COMMANDS

Arguments

Required argument
stepName
A String specifying the name of the step in which the load is modified.

Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.2.4 Members
The BodyCharge object can have the following members:

name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–6

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.3 BodyChargeState object

The BodyChargeState object stores the propagating data of a body charge in a step. One instance of this
object is created internally by the BodyCharge object for each step. The instance is also deleted internally
by the BodyCharge object.
The BodyChargeState object has no constructor or methods.
The BodyChargeState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.3.1 Members
The BodyChargeState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–7

Abaqus ID:
Printed on:
LOAD COMMANDS

24.3.2 Corresponding analysis keywords

*DECHARGE (load type label: EBF)

24.4 BodyConcentrationFlux object

The BodyConcentrationFlux object defines body concentration flux from a region or into a region.
The BodyConcentrationFlux object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.4.1 BodyConcentrationFlux(...)
This method creates a BodyConcentrationFlux object.

Path
mdb.models[name].BodyConcentrationFlux

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the body concentration flux magnitude. magnitude is optional if
distributionType=USER_DEFINED.
Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

24–8

Abaqus ID:
Printed on:
 LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A BodyConcentrationFlux object.

Exceptions
None.

24.4.2 setValues(...)
This method modifies the data for an existing BodyConcentrationFlux 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
BodyConcentrationFlux method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–9

Abaqus ID:
Printed on:
LOAD COMMANDS

Arguments

Required argument
stepName
A String specifying the name of the step in which the Body heat flux is modified.

Optional arguments
magnitude
A Float specifying the Body concentration flux magnitude.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.4.4 Members
The BodyConcentrationFlux object can have the following members:

name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible
values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–10

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.5 BodyConcentrationFluxState object

The BodyConcentrationFluxState object stores the propagating data for a BodyConcentrationFlux object
in a step. One instance of this object is created internally by the BodyConcentrationFlux object for each
step. The instance is also deleted internally by the BodyConcentrationFlux object.
The BodyConcentrationFluxState object has no constructor or methods.
The BodyConcentrationFluxState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.5.1 Members
The BodyConcentrationFluxState object has the following members:
magnitude
A Float specifying the body concentration flux magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the body concentration flux magnitude.
Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–11

Abaqus ID:
Printed on:
LOAD COMMANDS

24.5.2 Corresponding analysis keywords

*CFLUX

24.6 BodyCurrent object

The BodyCurrent object stores the data for a body current.

The BodyCurrent object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.6.1 BodyCurrent(...)
This method creates a BodyCurrent object.

Path
mdb.models[name].BodyCurrent

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

24–12

Abaqus ID:
Printed on:
 LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

Return value
A BodyCurrent object.

Exceptions
None.

24.6.2 setValues(...)
This method modifies the data for an existing BodyCurrent 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 BodyCurrent method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

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

24–13

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.6.4 Members
The BodyCurrent object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.7 BodyCurrentState object

The BodyCurrentState object stores the propagating data of a body current in a step. One instance of
this object is created internally by the BodyCurrent object for each step. The instance is also deleted
internally by the BodyCurrent object.
The BodyCurrentState object has no constructor or methods.
The BodyCurrentState object is derived from the LoadState object.

24–14

Abaqus ID:
Printed on:
 LOAD COMMANDS

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.7.1 Members
The BodyCurrentState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.7.2 Corresponding analysis keywords

*DECURRENT (load type label: CBF)

24–15

Abaqus ID:
Printed on:
LOAD COMMANDS

24.8 BodyForce object

The BodyForce object defines a distributed load.

The BodyForce object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.8.1 BodyForce(...)
This method creates a BodyForce object.

Path
mdb.models[name].BodyForce

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
comp1
A Float or a Complex specifying the body force component in the 1-direction.
Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be
nonzero unless distributionType=USER_DEFINED.

comp2
A Float or a Complex specifying the body force component in the 2-direction.

24–16

Abaqus ID:
Printed on:
 LOAD COMMANDS

comp3
A Float or a Complex specifying the body force component in the 3-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A BodyForce object.

Exceptions
None.

24.8.2 setValues(...)
This method modifies the data for an existing BodyForce 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 BodyForce method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

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

24–17

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
comp1
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force
component in the 1-direction. UNCHANGED should be used if the body force component is
propagated from the previous analysis step.
comp2
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force
component in the 2-direction. UNCHANGED should be used if the body force component is
propagated from the previous analysis step.
comp3
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force
component in the 3-direction. UNCHANGED should be used if the body force component is
propagated from the previous analysis step.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load is
changed to have no amplitude reference. You should provide the amplitude argument only if it is
valid for the specified step.

Return value
None

Exceptions
None.

24.8.4 Members
The BodyForce object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–18

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.8.5 Corresponding analysis keywords

*DLOAD (load type label: BX, BY, BZ, BR, BXNU, BYNU, BZNU, or BRNU)

24.9 BodyForceState object

The BodyForceState object stores the propagating data of a body force in a step. One instance of this
object is created internally by the BodyForce object for each step. The instance is also deleted internally
by the BodyForce object.
The BodyForceState object has no constructor or methods.
The BodyForceState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.9.1 Members
The BodyForceState object has the following members:
comp1
A Float or a Complex specifying the body force component in the 1-direction.
comp2
A Float or a Complex specifying the body force component in the 2-direction.
comp3
A Float or a Complex specifying the body force component in the 3-direction.
comp1State
A SymbolicConstant specifying the propagation state of the body force component in the
1-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
comp2State
A SymbolicConstant specifying the propagation state of the body force component in the
2-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
comp3State
A SymbolicConstant specifying the propagation state of the body force component in the
3-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

24–19

Abaqus ID:
Printed on:
LOAD COMMANDS

amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.9.2 Corresponding analysis keywords

*DLOAD (load type label: BX, BY, BZ, BR, BXNU, BYNU, BZNU, or BRNU)

24.10 BodyHeatFlux object

The BodyHeatFlux object defines body heat flux from a region or into a region.
The BodyHeatFlux object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.10.1 BodyHeatFlux(...)
This method creates a BodyHeatFlux object.

24–20

Abaqus ID:
Printed on:
 LOAD COMMANDS

Path
mdb.models[name].BodyHeatFlux

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the body heat flux magnitude. magnitude is optional if
distributionType=USER_DEFINED.
Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
distributionType
A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A BodyHeatFlux object.

Exceptions
None.

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

Arguments
Required arguments
None.

24–21

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the BodyHeatFlux method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the body heat flux is modified.
Optional arguments
magnitude
A Float specifying the body heat flux magnitude.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.10.4 Members
The BodyHeatFlux object can have the following members:
name
A String specifying the load repository key.

24–22

Abaqus ID:
Printed on:
 LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.11 BodyHeatFluxState object

The BodyHeatFluxState object stores the propagating data for a Body BodyHeatFlux object in a step.
One instance of this object is created internally by the BodyHeatFlux object for each step. The instance
is also deleted internally by the BodyHeatFlux object.
The BodyHeatFluxState object has no constructor or methods.
The BodyHeatFluxState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.11.1 Members
The BodyHeatFluxState object has the following members:
magnitude
A Float specifying the Body heat flux magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the Body heat flux magnitude. Possible
values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED

24–23

Abaqus ID:
Printed on:
LOAD COMMANDS

• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.11.2 Corresponding analysis keywords

*DFLUX

24.12 BoltLoad object

The BoltLoad object defines a bolt load.

The BoltLoad object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.12.1 BoltLoad(...)
This method creates a BoltLoad object.

Path
mdb.models[name].BoltLoad

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.

24–24

Abaqus ID:
Printed on:
 LOAD COMMANDS

region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the bolt load magnitude.
datumAxis
A DatumAxis object specifying the orientation of the pre-tension section normal.
Note: datumAxis is required only for Solid and Shell regions; it has no meaning for Wire regions.

Optional arguments
boltMethod
A SymbolicConstant specifying the method of applying the bolt load. Possible values are
APPLY_FORCE and ADJUST_LENGTH. The default value is APPLY_FORCE.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A BoltLoad object.

Exceptions
TextError.

24.12.2 setValues(...)
This method modifies the data for an existing BoltLoad 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 BoltLoad method, except
for the name and createStepName arguments.

Return value
None

24–25

Abaqus ID:
Printed on:
LOAD COMMANDS

Exceptions

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
boltMethod
A SymbolicConstant specifying the type of bolt load. Possible values are APPLY_FORCE,
ADJUST_LENGTH, and FIX_LENGTH. The default is APPLY_FORCE.
magnitude
A Float specifying the bolt load magnitude.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load is
changed to have no amplitude reference. You should provide the amplitude argument only if it is
valid for the specified step.

Return value
None

Exceptions
None.

24.12.4 Members
The BoltLoad object can have the following members:
name
A String specifying the load repository key.
datumAxis
A DatumAxis object specifying the orientation of the pre-tension section normal.
Note: datumAxis is required only for Solid and Shell regions; it has no meaning for Wire regions.

24–26

Abaqus ID:
Printed on:
 LOAD COMMANDS

region
A Region object specifying the region to which the load is applied.

24.12.5 Corresponding analysis keywords

*PRE-TENSION SECTION
*NODE (for the reference node)
*NSET (for the reference node)

24.13 BoltLoadState object

The BoltLoadState object stores the propagating data of a bolt load in a step. One instance of this object
is created internally by the BoltLoad object for each step. The instance is also deleted internally by the
BoltLoad object.
The BoltLoadState object has no constructor or methods.
The BoltLoadState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.13.1 Members
The BoltLoadState object has the following members:
boltMethod
A SymbolicConstant specifying the type of bolt load. Possible values are APPLY_FORCE,
ADJUST_LENGTH, and FIX_LENGTH.
boltMethodState
A SymbolicConstant specifying the propagation state of the bolt load type. Possible values are
UNSET, SET, UNCHANGED, and MODIFIED.
magnitude
A Float specifying the bolt load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the bolt load magnitude. Possible values
are UNSET, SET, UNCHANGED, and MODIFIED.

24–27

Abaqus ID:
Printed on:
LOAD COMMANDS

amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.13.2 Corresponding analysis keywords

*CLOAD (when boltMethod=APPLY_FORCE)

*BOUNDARY (when boltMethod=ADJUST_LENGTH or FIX_LENGTH)

24.14 ConcCharge object

The ConcCharge object stores the data for a concentrated charge.

The ConcCharge object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.14.1 ConcCharge(...)
This method creates a ConcCharge object.

24–28

Abaqus ID:
Printed on:
 LOAD COMMANDS

Path
mdb.models[name].ConcCharge

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A ConcCharge object.

Exceptions
None.

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

Arguments
Required arguments
None.

24–29

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the ConcCharge method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.14.4 Members
The ConcCharge object can have the following members:
name
A String specifying the load repository key.

24–30

Abaqus ID:
Printed on:
 LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.15 ConcConcFlux object

The ConcConcFlux object stores the data for a concentrated concentration flux.
The ConcConcFlux object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.15.1 ConcConcFlux(...)
This method creates a ConcConcFlux object.

Path
mdb.models[name].ConcConcFlux

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.

24–31

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A ConcConcFlux object.

Exceptions
None.

24.15.2 setValues(...)
This method modifies the data for an existing ConcConcFlux 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 ConcConcFlux method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–32

Abaqus ID:
Printed on:
 LOAD COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.15.4 Members
The ConcConcFlux object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.16 ConcCurrent object

The ConcCurrent object stores the data for a concentrated current.

24–33

Abaqus ID:
Printed on:
LOAD COMMANDS

The ConcCurrent object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.16.1 ConcCurrent(...)
This method creates a ConcCurrent object.

Path
mdb.models[name].ConcCurrent

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A ConcCurrent object.

24–34

Abaqus ID:
Printed on:
 LOAD COMMANDS

Exceptions
None.

24.16.2 setValues(...)
This method modifies the data for an existing ConcCurrent 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 ConcCurrent method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

24–35

Abaqus ID:
Printed on:
LOAD COMMANDS

Return value
None

Exceptions
None.

24.16.4 Members
The ConcCurrent object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.17 ConcCurrentState object

The ConcCurrentState object stores the propagating data of a concentrated current in a step. One instance
of this object is created internally by the ConcCurrent object for each step. The instance is also deleted
internally by the ConcCurrent object.
The ConcCurrentState object has no constructor or methods.
The ConcCurrentState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.17.1 Members
The ConcCurrentState object has the following members:
magnitude
A Float specifying the load magnitude.

24–36

Abaqus ID:
Printed on:
 LOAD COMMANDS

magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.17.2 Corresponding analysis keywords

*CECURRENT

24.18 ConcentratedChargeState object

The ConcentratedChargeState object stores the propagating data of a concentrated charge in a step. One
instance of this object is created internally by the ConcCharge object for each step. The instance is also
deleted internally by the ConcCharge object.
The ConcentratedChargeState object has no constructor or methods.
The ConcentratedChargeState object is derived from the LoadState object.

Access
import load

24–37

Abaqus ID:
Printed on:
LOAD COMMANDS

mdb.models[name].steps[name].loadStates[name]

24.18.1 Members
The ConcentratedChargeState object has the following members:

magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.18.2 Corresponding analysis keywords

*CECHARGE

24–38

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.19 ConcentratedConcentrationFluxState object

The ConcentratedConcentrationFluxState object stores the propagating data of a concentrated

concentration flux in a step. One instance of this object is created internally by the ConcConcFlux
object for each step. The instance is also deleted internally by the ConcConcFlux object.
The ConcentratedConcentrationFluxState object has no constructor or methods.
The ConcentratedConcentrationFluxState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.19.1 Members
The ConcentratedConcentrationFluxState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

24–39

Abaqus ID:
Printed on:
LOAD COMMANDS

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.19.2 Corresponding analysis keywords

*CFLUX (degree of freedom: 11, which is assumed)

24.20 ConcentratedForce object

The ConcentratedForce object defines a concentrated force.

The ConcentratedForce object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.20.1 ConcentratedForce(...)
This method creates a ConcentratedForce object.

Path
mdb.models[name].ConcentratedForce

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.

24–40

Abaqus ID:
Printed on:
 LOAD COMMANDS

field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
cf1
A Float or a Complex specifying the concentrated force component in the 1-direction. Although
cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.
cf2
A Float or a Complex specifying the concentrated force component in the 2-direction.
cf3
A Float or a Complex specifying the concentrated force component in the 3-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
follower
A Boolean specifying whether the direction of the force rotates with the rotation at each node of
the region. You should provide the follower argument only if it is valid for the specified step. The
default value is OFF.
localCsys
None or a DatumCsys object specifying the local coordinate system of the load’s degrees of
freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system.
When this member is queried, it returns an Int. The default value is None.

Return value
A ConcentratedForce object.

Exceptions
None.

24.20.2 setValues(...)
This method modifies the data for an existing ConcentratedForce 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 ConcentratedForce
method, except for the name and createStepName arguments.

24–41

Abaqus ID:
Printed on:
LOAD COMMANDS

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
cf1
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the concentrated force
component in the 1-direction. UNCHANGED should be used if the concentrated force component
is propagated from the previous analysis step.
cf2
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the concentrated force
component in the 2-direction. UNCHANGED should be used if the concentrated force component
is propagated from the previous analysis step.
cf3
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the concentrated force
component in the 3-direction. UNCHANGED should be used if the concentrated force component
is propagated from the previous analysis step.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load is
changed to have no amplitude reference. You should provide the amplitude argument only if it is
valid for the specified step.

Return value
None

24–42

Abaqus ID:
Printed on:
 LOAD COMMANDS

Exceptions
None.

24.20.4 Members
The ConcentratedForce object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
follower
A Boolean specifying whether the direction of the force rotates with the rotation at each node of
the region. You should provide the follower argument only if it is valid for the specified step. The
default value is OFF.
localCsys
None or a DatumCsys object specifying the local coordinate system of the load’s degrees of
freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system.
When this member is queried, it returns an Int. The default value is None.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.21 ConcentratedForceState object

The ConcentratedForceState object stores the propagating data for a concentrated force in a step. One
instance of this object is created internally by the ConcentratedForce object for each step. The instance
is also deleted internally by the ConcentratedForce object.
The ConcentratedForceState object has no constructor or methods.
The ConcentratedForceState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24–43

Abaqus ID:
Printed on:
LOAD COMMANDS

24.21.1 Members
The ConcentratedForceState object has the following members:
cf1
A Float or a Complex specifying the concentrated force component in the 1-direction. Although
cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.
cf2
A Float or a Complex specifying the concentrated force component in the 2-direction.
cf3
A Float or a Complex specifying the concentrated force component in the 3-direction.
cf1State
A SymbolicConstant specifying the propagation state of the concentrated force component in the
1-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
cf2State
A SymbolicConstant specifying the propagation state of the concentrated force component in the
2-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
cf3State
A SymbolicConstant specifying the propagation state of the concentrated force component in the
3-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–44

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.21.2 Corresponding analysis keywords

*CLOAD (degree of freedom: 1, 2, or 3)

24.22 ConcentratedHeatFlux object

The ConcentratedHeatFlux object stores the data for a concentrated heat flux load.
The ConcentratedHeatFlux object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.22.1 ConcentratedHeatFlux(...)
This method creates a ConcentratedHeatFlux object.

Path
mdb.models[name].ConcentratedHeatFlux

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.

24–45

Abaqus ID:
Printed on:
LOAD COMMANDS

field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
dof
An Int specifying the degree of freedom of the node, to which the concentrated heat flux should
be applied. The default value is 11.

Return value
A ConcentratedHeatFlux object.

Exceptions
None.

24.22.2 setValues(...)
This method modifies the data for an existing ConcentratedHeatFlux 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
ConcentratedHeatFlux method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–46

Abaqus ID:
Printed on:
 LOAD COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.22.4 Members
The ConcentratedHeatFlux object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
dof
An Int specifying the degree of freedom of the node, to which the concentrated heat flux should
be applied. The default value is 11.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–47

Abaqus ID:
Printed on:
LOAD COMMANDS

24.23 ConcentratedHeatFluxState object

The ConcentratedHeatFluxState object stores the propagating data of a concentrated heat flux load in a
step. One instance of this object is created internally by the ConcentratedHeatFlux object for each step.
The instance is also deleted internally by the ConcentratedHeatFlux object.
The ConcentratedHeatFluxState object has no constructor or methods.
The ConcentratedHeatFluxState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.23.1 Members
The ConcentratedHeatFluxState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–48

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.23.2 Corresponding analysis keywords

*CFLUX (degree of freedom: one out of integers 11 to 31)

24.24 ConcentratedPoreFluidState object

The ConcentratedPoreFluidState object stores the propagating data of a concentrated pore fluid flow load
in a step. One instance of this object is created internally by the ConcPoreFluid object for each step. The
instance is also deleted internally by the ConcPoreFluid object.
The ConcentratedPoreFluidState object has no constructor or methods.
The ConcentratedPoreFluidState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.24.1 Members
The ConcentratedPoreFluidState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE

24–49

Abaqus ID:
Printed on:
LOAD COMMANDS

• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.24.2 Corresponding analysis keywords

*CLOAD (degree of freedom: 8)

24.25 ConcPoreFluid object

The ConcPoreFluid object stores the data for a concentrated pore fluid flow load.
The ConcPoreFluid object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.25.1 ConcPoreFluid(...)
This method creates a ConcPoreFluid object.

Path
mdb.models[name].ConcPoreFluid

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.

24–50

Abaqus ID:
Printed on:
 LOAD COMMANDS

magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A ConcPoreFluid object.

Exceptions
None.

24.25.2 setValues(...)
This method modifies the data for an existing ConcPoreFluid 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 ConcPoreFluid method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

24–51

Abaqus ID:
Printed on:
LOAD COMMANDS

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.25.4 Members
The ConcPoreFluid object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–52

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.26 ConnectorForce object

The ConnectorForce object defines a connector force.

The ConnectorForce object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.26.1 ConnectorForce(...)
This method creates a ConnectorForce object.

Path
mdb.models[name].ConnectorForce

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
connectors
A sequence of Strings specifying the names of the connectors to which the load is applied.
Optional arguments
f1
A Float or a Complex specifying the connector force component in the connector’s local
1-direction.

Note: Although f1, f2, and f3 are optional arguments, at least one of them must be nonzero.

f2
A Float or a Complex specifying the connector force component in the connector’s local
2-direction.
f3
A Float or a Complex specifying the connector force component in the connector’s local
3-direction.

24–53

Abaqus ID:
Printed on:
LOAD COMMANDS

amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A ConnectorForce object.

Exceptions
None.

24.26.2 setValues(...)
This method modifies the data for an existing ConnectorForce 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 ConnectorForce
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

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

24–54

Abaqus ID:
Printed on:
 LOAD COMMANDS

Optional arguments
f1
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the connector force
component in the connector’s local 1-direction. UNCHANGED should be used if the connector
force component is propagated from the previous analysis step.
f2
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the connector force
component in the connector’s local 2-direction. UNCHANGED should be used if the connector
force component is propagated from the previous analysis step.
f3
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the connector force
component in the connector’s local 3-direction. UNCHANGED should be used if the connector
force component is propagated from the previous analysis step.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load is
changed to have no amplitude reference. You should provide the amplitude argument only if it is
valid for the specified step.

Return value
None

Exceptions
None.

24.26.4 Members
The ConnectorForce object can have the following members:

name
A String specifying the load repository key.
connectors
A tuple of Strings specifying the names of the connectors to which the load is applied.
region
A Region object specifying the region to which the load is applied.

24–55

Abaqus ID:
Printed on:
LOAD COMMANDS

24.27 ConnectorForceState object

The ConnectorForceState object stores the propagating data for a connector force in a step. One instance
of this object is created internally by the ConnectorForce object for each step. The instance is also deleted
internally by the ConnectorForce object.
The ConnectorForceState object has no constructor or methods.
The ConnectorForceState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.27.1 Members
The ConnectorForceState object has the following members:
f1
A Float or a Complex specifying the connector force component in the connector’s local
1-direction.
f2
A Float or a Complex specifying the connector force component in the connector’s local
2-direction.
f3
A Float or a Complex specifying the connector force component in the connector’s local
3-direction.
f1State
A SymbolicConstant specifying the propagation state of the connector force component in the
connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
f2State
A SymbolicConstant specifying the propagation state of the connector force component in the
connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
f3State
A SymbolicConstant specifying the propagation state of the connector force component in the
connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

24–56

Abaqus ID:
Printed on:
 LOAD COMMANDS

• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.27.2 Corresponding analysis keywords

*CONNECTOR LOAD (degree of freedom: 1, 2, or 3)

24.28 ConnectorMoment object

The ConnectorMoment object stores the data for a connector moment.

The ConnectorMoment object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.28.1 ConnectorMoment(...)
This method creates a ConnectorMoment object.

Path
mdb.models[name].ConnectorMoment

24–57

Abaqus ID:
Printed on:
LOAD COMMANDS

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
connectors
A sequence of Strings specifying the names of the connectors which the load is applied.
Optional arguments
m1
A Float or a Complex specifying the moment component in the connector’s local 4-direction.
m2
A Float or a Complex specifying the moment component in the connector’s local 5-direction.
m3
A Float or a Complex specifying the moment component in the connector’s local 6-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A ConnectorMoment object.

Exceptions
None.

24.28.2 setValues(...)
This method modifies the data for an existing ConnectorMoment 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 ConnectorMoment
method, except for the name and createStepName arguments.

24–58

Abaqus ID:
Printed on:
 LOAD COMMANDS

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
m1
A Float, a Complex, or a SymbolicConstant specifying the moment component in the connector’s
local 4-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED.
UNCHANGED should be used if the load component is propagated from the previous static
analysis step. Use FREED to remove a previously defined load component.
m2
A Float, a Complex, or a SymbolicConstant specifying the moment component in the connector’s
local 5-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED.
UNCHANGED should be used if the load component is propagated from the previous static
analysis step. Use FREED to remove a previously defined load component.
m3
A Float, a Complex, or a SymbolicConstant specifying the moment component in the connector’s
local 6-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED.
UNCHANGED should be used if the load component is propagated from the previous static
analysis step. Use FREED to remove a previously defined load component.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

24–59

Abaqus ID:
Printed on:
LOAD COMMANDS

Return value
None

Exceptions
None.

24.28.4 Members
The ConnectorMoment object can have the following members:
name
A String specifying the load repository key.
connectors
A tuple of Strings specifying the names of the connectors which the load is applied.
region
A Region object specifying the region to which the load is applied.

24.29 ConnectorMomentState object

The ConnectorMomentState object stores the propagating data for a connector moment in a step. One
instance of this object is created internally by the ConnectorMoment object for each step. The instance
is also deleted internally by the ConnectorMoment object.
The ConnectorMomentState object has no constructor or methods.
The ConnectorMomentState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.29.1 Members
The ConnectorMomentState object has the following members:
m1
A Float or a Complex specifying the connector moment component in the connector’s local 4-
direction. Although m1, m2, and m3 are optional arguments, at least one of them must be nonzero.
m2
A Float or a Complex specifying the connector moment component in the connector’s local
5direction.

24–60

Abaqus ID:
Printed on:
 LOAD COMMANDS

m3
A Float or a Complex specifying the connector moment component in the connector’s local 6-
direction.
m1State
A SymbolicConstant specifying the propagation state of the load component in the connector’s
local 4-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.
m2State
A SymbolicConstant specifying the propagation state of the load component in the connector’s
local 5-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.
m3State
A SymbolicConstant specifying the propagation state of the load component in the connector’s
local 6-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.29.2 Corresponding analysis keywords

*CONNECTOR LOAD (degree of freedom: 4, 5, or 6)

24–61

Abaqus ID:
Printed on:
LOAD COMMANDS

24.30 CoriolisForce object

The CoriolisForce object stores the data for a coriolis force.

The CoriolisForce object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.30.1 CoriolisForce(...)
This method creates a CoriolisForce object.

Path
mdb.models[name].CoriolisForce

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
point1
A sequence of Floats specifying the first point on the axis of rotation for the load.
point2
A sequence of Floats specifying the second point on the axis of rotation for the load.
Optional arguments
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

24–62

Abaqus ID:
Printed on:
 LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

Return value
A CoriolisForce object.

Exceptions
None.

24.30.2 setValues(...)
This method modifies the data for an existing CoriolisForce 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 CoriolisForce method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

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

24–63

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value

None

Exceptions

None.

24.30.4 Members
The CoriolisForce object can have the following members:

name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
point1
A tuple of Floats specifying the first point on the axis of rotation for the load.
point2
A tuple of Floats specifying the second point on the axis of rotation for the load.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–64

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.31 CoriolisForceState object

The CoriolisForceState object stores the propagating data of a coriolis force in a step. One instance of
this object is created internally by the CoriolisForce object for each step. The instance is also deleted
internally by the CoriolisForce object.
The CoriolisForceState object has no constructor or methods.
The CoriolisForceState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.31.1 Members
The CoriolisForceState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–65

Abaqus ID:
Printed on:
LOAD COMMANDS

24.31.2 Corresponding analysis keywords

*DLOAD (load type label: CORIO)

24.32 Gravity object

The Gravity object stores the data of a gravity load.

The Gravity object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.32.1 Gravity(...)
This method creates a Gravity object.

Path
mdb.models[name].Gravity

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–66

Abaqus ID:
Printed on:
 LOAD COMMANDS

comp1
A Float or a Complex specifying the component of the load in the 1-direction.

Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be
nonzero.

comp2
A Float or a Complex specifying the component of the load in the 2-direction.
comp3
A Float or a Complex specifying the component of the load in the 3-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A Gravity object.

Exceptions
None.

24.32.2 setValues(...)
This method modifies the data for an existing Gravity 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 Gravity method, except
for the name and createStepName arguments.

Return value
None

Exceptions
None.

24–67

Abaqus ID:
Printed on:
LOAD COMMANDS

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
comp1
A Float, a Complex, or a SymbolicConstant specifying the load component in the 1-direction.
Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should
be used if the load component is propagated from the previous static analysis step. Use FREED
to remove a previously defined load component.
comp2
A Float, a Complex, or a SymbolicConstant specifying the load component in the 2-direction. For
details see comp1.
comp3
A Float, a Complex, or a SymbolicConstant specifying the load component in the 3-direction. For
details see comp1.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.32.4 Members
The Gravity object can have the following members:
name
A String specifying the load repository key.

24–68

Abaqus ID:
Printed on:
 LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.33 GravityState object

The GravityState object stores the propagating data for a gravity load in a step. One instance of this
object is created internally by the Gravity object for each step. The instance is also deleted internally by
the Gravity object.
The GravityState object has no constructor or methods.
The GravityState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.33.1 Members
The GravityState object has the following members:
comp1
A Float or a Complex specifying the load component in the 1-direction.
comp2
A Float or a Complex specifying the load component in the 2-direction.
comp3
A Float or a Complex specifying the load component in the 3-direction.
comp1State
A SymbolicConstant specifying the propagation state of the load component in the 1-direction.
Possible values are UNSET, SET, UNCHANGED, and FREED.
comp2State
A SymbolicConstant specifying the propagation state of the load component in the 2-direction.
Possible values are UNSET, SET, UNCHANGED, and FREED.

24–69

Abaqus ID:
Printed on:
LOAD COMMANDS

comp3State
A SymbolicConstant specifying the propagation state of the load component in the 3-direction.
Possible values are UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.33.2 Corresponding analysis keywords

*DLOAD (load type label:GRAV)

24.34 HydrostaticFluidFlowState object

The HydrostaticFluidFlowState object stores the propagating data for a concentrated

HydrostaticFluidFlow object in a step. One instance of this object is created internally by
the HydrostaticFluidFlow object for each step. The instance is also deleted internally by the
HydrostaticFluidFlow object.
The HydrostaticFluidFlowState object has no constructor or methods.
The HydrostaticFluidFlowState object is derived from the LoadState object.

24–70

Abaqus ID:
Printed on:
 LOAD COMMANDS

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.34.1 Members
The HydrostaticFluidFlowState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.34.2 Corresponding analysis keywords

*FLUID FLUX

24–71

Abaqus ID:
Printed on:
LOAD COMMANDS

24.35 InertiaRelief object

The InertiaRelief object defines an inertia relief load.

The InertiaRelief object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.35.1 InertiaRelief(...)
This method creates an InertiaRelief object.

Path
mdb.models[name].InertiaRelief

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
Optional arguments
u1
A Boolean specifying the 1-direction as a free direction.
Note: Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be
specified. Further, any specified set of free directions cannot include only two rotational degrees
of freedom.

u2
A Boolean specifying the 2-direction as a free direction.
u3
A Boolean specifying the 3-direction as a free direction.
ur1
A Boolean specifying the rotation about the 1–direction as a free direction.
ur2
A Boolean specifying the rotation about the 2–direction as a free direction.

24–72

Abaqus ID:
Printed on:
 LOAD COMMANDS

ur3
A Boolean specifying the rotation about the 3–direction as a free direction.
referencePoint
A sequence of Floats specifying the X, Y and Z-coordinates of a fixed rotation point or a point on
the rotation axis or a point on the symmetry line, about which rotations are defined. Such a point
must be specified only for certain combinations of free directions.
localCoordinates
None or a DatumCsys object specifying the local coordinate system of the rigid body degrees of
freedom for the inertia relief load. If localCoordinates=None, the free directions are defined in
the global coordinate system. When this member is queried, it returns an Int. The default value is
None.

Return value
An InertiaRelief object.

Exceptions
None.

24.35.2 setValues(...)
This method modifies the data for an existing InertiaRelief 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 InertiaRelief method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–73

Abaqus ID:
Printed on:
LOAD COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
u1
A Boolean specifying the 1-direction as a free direction.
u2
A Boolean specifying the 2-direction as a free direction.
u3
A Boolean specifying the 3-direction as a free direction.
ur1
A Boolean specifying the rotation about the 1–direction as a free direction.
ur2
A Boolean specifying the rotation about the 2–direction as a free direction.
ur3
A Boolean specifying the rotation about the 3–direction as a free direction.
referencePoint
A sequence of Floats specifying the point about which rotations are defined. The point can be
specified only for certain combinations of free directions. The referencePoint argument can be
one of the following:
• The X, Y and Z-coordinates of a fixed rotation point.
• A point on the rotation axis.
• A point on the symmetry line.
fixed
A Boolean specifying whether the inertia relief loading should remain fixed at the current loading
at the start of the step. The default value is OFF.

Return value
None

Exceptions
None.

24.35.4 Members
The InertiaRelief object can have the following members:

24–74

Abaqus ID:
Printed on:
 LOAD COMMANDS

name
A String specifying the load repository key.
localCoordinates
None or a DatumCsys object specifying the local coordinate system of the rigid body degrees of
freedom for the inertia relief load. If localCoordinates=None, the free directions are defined in
the global coordinate system. When this member is queried, it returns an Int. The default value is
None.
region
A Region object specifying the region to which the load is applied.

24.36 InertiaReliefState object

The InertiaReliefState object stores the propagating data for an inertia relief load in a step. One instance
of this object is created internally by the InertiaRelief object for each step. The instance is also deleted
internally by the InertiaRelief object.
The InertiaReliefState object has no constructor or methods.
The InertiaReliefState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.36.1 Members
The InertiaReliefState object has the following members:
u1
A Boolean specifying the 1-direction as a free direction.
u2
A Boolean specifying the 2-direction as a free direction.
u3
A Boolean specifying the 3-direction as a free direction.
ur1
A Boolean specifying the rotation about the 1–direction as a free direction.
ur2
A Boolean specifying the rotation about the 2–direction as a free direction.
ur3
A Boolean specifying the rotation about the 3–direction as a free direction.

24–75

Abaqus ID:
Printed on:
LOAD COMMANDS

u1State
A SymbolicConstant specifying the propagation state of the Boolean that identifies the local 1-
direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
u2State
A SymbolicConstant specifying the propagation state of the Boolean that identifies the local 2-
direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
u3State
A SymbolicConstant specifying the propagation state of the Boolean that identifies the local the
3-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
ur1State
A SymbolicConstant specifying the propagation state of the Boolean that identifies rotation about
the local 1-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and
MODIFIED.
ur2State
A SymbolicConstant specifying the propagation state of the Boolean that identifies the
rotation about the local the 2-direction as a free direction. Possible values are UNSET, SET,
UNCHANGED, and MODIFIED.
ur3State
A SymbolicConstant specifying the propagation state of the Boolean that identifies the
rotation about the local the 3-direction as a free direction. Possible values are UNSET, SET,
UNCHANGED, and MODIFIED.
fixed
A Boolean specifying whether the inertia relief loading should remain fixed at the current loading
at the start of the step. The default value is OFF.
fixedState
A SymbolicConstant specifying the propagation state of the Boolean that identifies whether the
inertia relief load should remain fixed at current level at the start of the step. Possible values are
UNSET, SET, UNCHANGED, and MODIFIED.
referencePointState
A SymbolicConstant specifying the propagation state of the reference point of the inertia relief
load. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
referencePoint
A tuple of Floats specifying the point about which rotations are defined. The point can be specified
only for certain combinations of free directions. The referencePoint argument can be one of the
following:
• The X, Y and Z-coordinates of a fixed rotation point.
• A point on the rotation axis.
• A point on the symmetry line.

24–76

Abaqus ID:
Printed on:
 LOAD COMMANDS

amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.36.2 Corresponding analysis keywords

*INERTIA RELIEF

24.37 InwardVolAccel object

The InwardVolAccel object stores the data for an inward volume acceleration acoustic load.
The InwardVolAccel object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.37.1 InwardVolAccel(...)
This method creates a InwardVolAccel object.

24–77

Abaqus ID:
Printed on:
LOAD COMMANDS

Path
mdb.models[name].InwardVolAccel

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the name of
the first analysis step.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
An InwardVolAccel object.

Exceptions
None.

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

Arguments
Required arguments
None.

24–78

Abaqus ID:
Printed on:
 LOAD COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the InwardVolAccel
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.37.4 Members
The InwardVolAccel object can have the following members:
name
A String specifying the load repository key.

24–79

Abaqus ID:
Printed on:
LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.38 InwardVolAccelState object

The InwardVolAccelState object stores the propagating data of an inward volume acceleration acoustic
load in a step. One instance of this object is created internally by the InwardVolAccel object for each
step. The instance is also deleted internally by the InwardVolAccel object.
The InwardVolAccelState object has no constructor or methods.
The InwardVolAccelState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.38.1 Members
The InwardVolAccelState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED

24–80

Abaqus ID:
Printed on:
 LOAD COMMANDS

• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.38.2 Corresponding analysis keywords

*CLOAD (degree of freedom: 8)

24.39 LineLoad object

The LineLoad object stores the data of an applied line load.

The LineLoad object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.39.1 LineLoad(...)
This method creates a LineLoad object.

Path
mdb.models[name].LineLoad

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

24–81

Abaqus ID:
Printed on:
LOAD COMMANDS

region
A Region object specifying the region to which the load is applied.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
comp1
A Float or a Complex specifying the component of the load in the global or the beam local 1-
direction.

Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be
nonzero unless distributionType=USER_DEFINED.

comp2
A Float or a Complex specifying the component of the load in the global or the beam local 2-
direction.
comp3
A Float or a Complex specifying the component of the load in the global 3-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
system
A SymbolicConstant specifying whether the load is applied in a global or the beam local frame of
reference. Possible values are GLOBAL and LOCAL. The default value is GLOBAL.

Return value
A LineLoad object.

Exceptions
None.

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

24–82

Abaqus ID:
Printed on:
 LOAD COMMANDS

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

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
comp1
A Float, a Complex, or a SymbolicConstant specifying the load component in the global or
the beam local 1-direction. Possible values for the SymbolicConstant are UNCHANGED and
FREED. UNCHANGED should be used if the load component is propagated from the previous
static analysis step. Use FREED to remove a previously defined load component.
comp2
A Float, a Complex, or a SymbolicConstant specifying the load component in the global or the
beam local 2-direction. For details see comp1.
comp3
A Float, a Complex, or a SymbolicConstant specifying the load component in the global
3-direction. For details see comp1.
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 static analysis step. FREED should be used if the load

24–83

Abaqus ID:
Printed on:
LOAD COMMANDS

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.

24.39.4 Members
The LineLoad object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
system
A SymbolicConstant specifying whether the load is applied in a global or the beam local frame of
reference. Possible values are GLOBAL and LOCAL. The default value is GLOBAL.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.40 LineLoadState object

The LineLoadState object stores the propagating data of a line load in a step. One instance of this object
is created internally by the LineLoad object for each step. The instance is also deleted internally by the
LineLoad object.
The LineLoadState object has no constructor or methods.
The LineLoadState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24–84

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.40.1 Members
The LineLoadState object has the following members:
comp1
A Float or a Complex specifying the load component in the global or the beam local 1-direction.
comp2
A Float or a Complex specifying the load component in the global or the beam local 2-direction.
comp3
A Float or a Complex specifying the load component in the global 3-direction.
comp1State
A SymbolicConstant specifying the propagation state of the load component in the global or the
beam local 1-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.
comp2State
A SymbolicConstant specifying the propagation state of the load component in the global or the
beam local 2-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.
comp3State
A SymbolicConstant specifying the propagation state of the load component in the global
3-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–85

Abaqus ID:
Printed on:
LOAD COMMANDS

24.40.2 Corresponding analysis keywords

*DLOAD (load type label: PX, PY, PZ for a global reference frame, and P1, P2 for a local reference
frame)

24.41 LoadState object

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

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.41.1 Members
The LoadState object has the following members:
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–86

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.42 Moment object

The Moment object stores the data for a moment.

The Moment object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.42.1 Moment(...)
This method creates a Moment object.

Path
mdb.models[name].Moment

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
Optional arguments
cm1
A Float or a Complex specifying the load component in the 4-direction.
Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be
nonzero.

cm2
A Float or a Complex specifying the load component in the 5- direction.
cm3
A Float or a Complex specifying the load component in the 6-direction.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

24–87

Abaqus ID:
Printed on:
LOAD COMMANDS

follower
A Boolean specifying whether the direction of the force rotates with the rotation of the node. You
should provide the follower argument only if it is valid for the specified step. The default value is
OFF.
localCsys
None or a DatumCsys object specifying the ID of the Datum coordinate system used as the local
coordinate system of the load. If localCsys=None, the load is defined in the global coordinate
system. When this member is queried, it returns an Int. The default value is None.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

Return value
A Moment object.

Exceptions
None.

24.42.2 setValues(...)
This method modifies the data for an existing Moment 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 Moment method, except
for the name and createStepName arguments.

Return value
None

Exceptions
None.

24–88

Abaqus ID:
Printed on:
 LOAD COMMANDS

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
comp1
A Float, a Complex, or a SymbolicConstant specifying the load component in the 4-direction.
Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should
be used if the load component is propagated from the previous static analysis step. Use FREED
to remove a previously defined load component.
comp2
A Float, a Complex, or a SymbolicConstant specifying the load component in the 5-direction. For
details see comp1.
comp3
A Float, a Complex, or a SymbolicConstant specifying the load component in the 6-direction. For
details see comp1.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.42.4 Members
The Moment object can have the following members:
name
A String specifying the load repository key.

24–89

Abaqus ID:
Printed on:
LOAD COMMANDS

distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
follower
A Boolean specifying whether the direction of the force rotates with the rotation of the node. You
should provide the follower argument only if it is valid for the specified step. The default value is
OFF.
localCsys
None or a DatumCsys object specifying the ID of the Datum coordinate system used as the local
coordinate system of the load. If localCsys=None, the load is defined in the global coordinate
system. When this member is queried, it returns an Int. The default value is None.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.43 MomentState object

The MomentState object stores the propagating data for a moment in a step. One instance of this object
is created internally by the Moment object for each step. The instance is also deleted internally by the
Moment object.
The MomentState object has no constructor or methods.
The MomentState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.43.1 Members
The MomentState object has the following members:
cm1
A Float or a Complex specifying the load component in the 4-direction.
cm2
A Float or a Complex specifying the load component in the 5-direction.
cm3
A Float or a Complex specifying the load component in the 6-direction.

24–90

Abaqus ID:
Printed on:
 LOAD COMMANDS

cm1State
A SymbolicConstant specifying the propagation state of the load component in the 4-direction.
Possible values are UNSET, SET, UNCHANGED, and FREED.
cm2State
A SymbolicConstant specifying the propagation state of the load component in the 5-direction.
Possible values are UNSET, SET, UNCHANGED, and FREED.
cm3State
A SymbolicConstant specifying the propagation state of the load component in the 6-direction.
Possible values are UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.43.2 Corresponding analysis keywords

*CLOAD (degree of freedom: 4, 5, or 6)

24.44 PEGLoad object

The PEGLoad object stores the data for a PEG load.

The PEGLoad object is derived from the Load object.

24–91

Abaqus ID:
Printed on:
LOAD COMMANDS

Access
import load
mdb.models[name].loads[name]

24.44.1 PEGLoad(...)
This method creates a PEGLoad object.

Path
mdb.models[name].PEGLoad

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
comp1
A Float or a Complex specifying the load component at dof 1 of reference node 1.
Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be
nonzero.

comp2
A Float or a Complex specifying the load component at dof 1 of reference node 2.
comp3
A Float or a Complex specifying the load component at dof 2 of reference node 2.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

24–92

Abaqus ID:
Printed on:
 LOAD COMMANDS

Return value
A PEGLoad object.

Exceptions
None.

24.44.2 setValues(...)
This method modifies the data for an existing PEGLoad 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 PEGLoad method, except
for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
comp1
A Float, a Complex, or a SymbolicConstant specifying the load component at dof 1 of
reference node 1. Possible values for the SymbolicConstant are UNCHANGED and FREED.
UNCHANGED should be used if the load component is propagated from the previous static
analysis step. Use FREED to remove a previously defined load component.

24–93

Abaqus ID:
Printed on:
LOAD COMMANDS

comp2
A Float, a Complex, or a SymbolicConstant specifying the load component at dof 1 of reference
node 2. For details see comp1.
comp3
A Float, a Complex, or a SymbolicConstant specifying the load component at dof 2 of reference
node 2. For details see comp1.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.44.4 Members
The PEGLoad object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.45 PEGLoadState object

The PEGLoadState object stores the propagating data for a concentrated force in a step. One instance
of this object is created internally by the PEGLoad object for each step. The instance is also deleted
internally by the PEGLoad object.

24–94

Abaqus ID:
Printed on:
 LOAD COMMANDS

The PEGLoadState object has no constructor or methods.

The PEGLoadState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.45.1 Members
The PEGLoadState object has the following members:
comp1
A Float or a Complex specifying the load component at dof 1 of reference node 1.
comp2
A Float or a Complex specifying the load component at dof 1 of reference node 2.
comp3
A Float or a Complex specifying the load component at dof 2 of reference node 2.
comp1State
A SymbolicConstant specifying the propagation state of the load component at dof 1 of reference
node 1. Possible values are UNSET, SET, UNCHANGED, and FREED.
comp2State
A SymbolicConstant specifying the propagation state of the load component at dof 1 of reference
node 2. Possible values are UNSET, SET, UNCHANGED, and FREED.
comp3State
A SymbolicConstant specifying the propagation state of the load component at dof 2 of reference
node 2. Possible values are UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE

24–95

Abaqus ID:
Printed on:
LOAD COMMANDS

• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.45.2 Corresponding analysis keywords

*CLOAD (degree of freedom: 1 or 2)

24.46 PipePressure object

The PipePressure object stores the data for a pressure applied to pipe or elbow elements.
The PipePressure object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.46.1 PipePressure(...)
This method creates a Pressure object.

Path
mdb.models[name].PipePressure

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the pressure is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the pressure magnitude.
Note: magnitude is optional if distributionType=USER_DEFINED.

24–96

Abaqus ID:
Printed on:
 LOAD COMMANDS

diameter
A Float specifying the effective inner or outer diameter.
hZero
A Float specifying the height of the zero pressure level when distributionType=HYDROSTATIC.
hReference
A Float specifying the height of the reference pressure level when
distributionType=HYDROSTATIC.
Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
distributionType
A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM,
HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.
side
A SymbolicConstant specifying whether the pressure is applied internally or externally. Possible
values are INTERNAL and EXTERNAL. The default value is INTERNAL.

Return value
A PipePressure object.

Exceptions
None.

24.46.2 setValues(...)
This method modifies the data for an existing PipePressure 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 PipePressure method,
except for the name and createStepName arguments.

24–97

Abaqus ID:
Printed on:
LOAD COMMANDS

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the pressure magnitude.
hZero
A Float specifying the height of the zero pressure level when distributionType=HYDROSTATIC.
hReference
A Float specifying the height of the reference pressure level when
distributionType=HYDROSTATIC.
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 static analysis step. FREED should be used if the load
has no amplitude reference. You should provide the amplitude argument only if it is valid for the
specified step.

Return value
None

Exceptions
None.

24.46.4 Members
The PipePressure object can have the following members:

24–98

Abaqus ID:
Printed on:
 LOAD COMMANDS

name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM,
HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.
side
A SymbolicConstant specifying whether the pressure is applied internally or externally. Possible
values are INTERNAL and EXTERNAL. The default value is INTERNAL.
diameter
A Float specifying the effective inner or outer diameter.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.47 PipePressureState object

The PipePressureState object stores the propagating data for a pipe pressure in a step. One instance of
this object is created internally by the PipePressure object for each step. The instance is also deleted
internally by the PipePressure object.
The PipePressureState object has no constructor or methods.
The PipePressureState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.47.1 Members
The PipePressureState object has the following members:
magnitude
A Float or a Complex specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.

24–99

Abaqus ID:
Printed on:
LOAD COMMANDS

hZero
A Float specifying the height of the zero pressure level when the pipe pressure
distributionType=HYDROSTATIC.
hZeroState
A SymbolicConstant specifying the propagation state of hZero. Possible values are UNSET, SET,
UNCHANGED, and FREED.
hReference
A Float specifying the height of the reference pressure level when the pipe pressure
distributionType=HYDROSTATIC.
hReferenceState
A SymbolicConstant specifying the propagation state of hReference. Possible values are UNSET,
SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.47.2 Corresponding analysis keywords

*DSLOAD
*DLOAD

24–100

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.48 Pressure object

The Pressure object defines a pressure load.

The Pressure object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.48.1 Pressure(...)
This method creates a Pressure object.

Path
mdb.models[name].Pressure

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the pressure is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float or a Complex specifying the pressure magnitude.
Note: magnitude is optional if distributionType=USER_DEFINED.

hZero
A Float specifying the height of the zero pressure level when distributionType=HYDROSTATIC.
hReference
A Float specifying the height of the reference pressure level when
distributionType=HYDROSTATIC.
Optional arguments
field
A String specifying the name of the AnalyticalField or DiscreteField object associated
with this load. The field argument applies only when distributionType=FIELD or
distributionType=DISCRETE_FIELD. The default value is an empty string.

24–101

Abaqus ID:
Printed on:
LOAD COMMANDS

refPoint
A Region specifying the reference point from which the relative velocity is determined when
distributionType=STAGNATION or VISCOUS.
distributionType
A SymbolicConstant specifying how the pressure is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, FIELD, HYDROSTATIC, STAGNATION, VISCOUS, and
DISCRETE_FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A Pressure object.

Exceptions
None.

24.48.2 setValues(...)
This method modifies the data for an existing Pressure 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 Pressure method, except
for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–102

Abaqus ID:
Printed on:
 LOAD COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float or a Complex specifying the pressure magnitude.
hZero
A Float specifying the height of the zero pressure level when distributionType=HYDROSTATIC.
hReference
A Float specifying the height of the reference pressure level when
distributionType=HYDROSTATIC.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.48.4 Members
The Pressure object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the pressure is distributed spatially. Possible values are
UNIFORM, USER_DEFINED, FIELD, HYDROSTATIC, STAGNATION, VISCOUS, and
DISCRETE_FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField or DiscreteField object associated
with this load. The field argument applies only when distributionType=FIELD or
distributionType=DISCRETE_FIELD. The default value is an empty string.

24–103

Abaqus ID:
Printed on:
LOAD COMMANDS

region
A Region object specifying the region to which the load is applied.

24.49 PressureState object

The PressureState object stores the propagating data for a pressure in a step. One instance of this object
is created internally by the Pressure object for each step. The instance is also deleted internally by the
Pressure object.
The PressureState object has no constructor or methods.
The PressureState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.49.1 Members
The PressureState object has the following members:
magnitude
A Float or a Complex specifying the pressure magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the pressure magnitude. Possible values
are UNSET, SET, UNCHANGED, and MODIFIED.
hZero
A Float specifying the height of the zero pressure level when the pressure
distributionType=HYDROSTATIC.
hZeroState
A SymbolicConstant specifying the propagation state of hZero. Possible values are UNSET, SET,
UNCHANGED, and FREED.
hReference
A Float specifying the height of the reference pressure level when the pressure
distributionType=HYDROSTATIC.
hReferenceState
A SymbolicConstant specifying the propagation state of hReference. Possible values are UNSET,
SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.

24–104

Abaqus ID:
Printed on:
 LOAD COMMANDS

status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.49.2 Corresponding analysis keywords

*DSLOAD
*DLOAD

24.50 ReferencePressure object

The ReferencePressure object stores the data for a fluid reference pressure load.
The ReferencePressure object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.50.1 ReferencePressure(...)
This method creates a ReferencePressure object.

Path
mdb.models[name].ReferencePressure

24–105

Abaqus ID:
Printed on:
LOAD COMMANDS

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region specifying the point at which the reference pressure value is applied.
magnitude
A Float specifying the reference pressure value.
Optional arguments
None.

Return value
A ReferencePressure object.

Exceptions
None.

24.50.2 setValues(...)
This method modifies the data for an existing ReferencePressure 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 ReferencePressure
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

24–106

Abaqus ID:
Printed on:
 LOAD COMMANDS

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional argument
magnitude
A Float specifying the reference pressure value.

Return value
None

Exceptions
None.

24.50.4 Members
The ReferencePressure object can have the following members:
name
A String specifying the load repository key.
region
A Region object specifying the region to which the load is applied.

24.51 RotationalBodyForce object

The RotationalBodyForce object stores the data for a rotational body force.
The RotationalBodyForce object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24–107

Abaqus ID:
Printed on:
LOAD COMMANDS

24.51.1 RotationalBodyForce(...)
This method creates a RotationalBodyForce object.

Path
mdb.models[name].RotationalBodyForce

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
point1
A sequence of Floats specifying the first point on the axis of rotation for the load.
point2
A sequence of Floats specifying the second point on the axis of rotation for the load.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
centrifugal
A Boolean specifying whether or not the effect of the load is centrifugal. The default value is OFF.

Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have
the value ON.

rotaryAcceleration
A Boolean specifying whether or not the effect of the load is rotary acceleration. The default value
is OFF.

24–108

Abaqus ID:
Printed on:
 LOAD COMMANDS

Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have
the value ON.

amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A RotationalBodyForce object.

Exceptions
None.

24.51.2 setValues(...)
This method modifies the data for an existing RotationalBodyForce 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
RotationalBodyForce method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–109

Abaqus ID:
Printed on:
LOAD COMMANDS

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.51.4 Members
The RotationalBodyForce object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
centrifugal
A Boolean specifying whether or not the effect of the load is centrifugal. The default value is OFF.

Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have
the value ON.

rotaryAcceleration
A Boolean specifying whether or not the effect of the load is rotary acceleration. The default value
is OFF.

24–110

Abaqus ID:
Printed on:
 LOAD COMMANDS

Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have
the value ON.

point1
A tuple of Floats specifying the first point on the axis of rotation for the load.
point2
A tuple of Floats specifying the second point on the axis of rotation for the load.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.52 RotationalBodyForceState object

The RotationalBodyForceState object stores the propagating data of a rotational body force in a step.
One instance of this object is created internally by the RotationalBodyForce object for each step. The
instance is also deleted internally by the RotationalBodyForce object.
The RotationalBodyForceState object has no constructor or methods.
The RotationalBodyForceState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.52.1 Members
The RotationalBodyForceState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE

24–111

Abaqus ID:
Printed on:
LOAD COMMANDS

• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.52.2 Corresponding analysis keywords

*DLOAD (load type labels: CENTRIF, ROTA)

24.53 ShellEdgeLoad object

The ShellEdgeLoad object defines shell edge loads on a region.

The ShellEdgeLoad object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.53.1 ShellEdgeLoad(...)
This method creates a ShellEdgeLoad object.

Path
mdb.models[name].ShellEdgeLoad

Required arguments
name
A String specifying the load repository key.

24–112

Abaqus ID:
Printed on:
 LOAD COMMANDS

createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float or Complex specifying the load magnitude. magnitude is optional if
distributionType=USER_DEFINED
Optional arguments
distributionType
A SymbolicConstant specifying how the shell edge load is distributed spatially. Possible values
are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.
angle
A Float specifying an additional rotation of directionVector about an axis. The default value is
0.This parameter is available only if traction is GENERAL.
axis
A SymbolicConstant specifying the axis about which to apply an additional rotation of
directionVector. Possible values are AXIS_1, AXIS_2, AXIS_3. The default value is AXIS_1.
This parameter is available only if traction is GENERAL.
localCsys
A DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. The
default value is None, indicating that the degrees of freedom are defined in the global coordinate
system or by the userCsys parameter if defined. This parameter is available only if traction is
GENERAL. When this member is queried, it returns an Int.
userCsys
A String specifying a CSYS defined by a user-subroutine. The default value is None, indicating
that the degrees of freedom are defined in the global coordinate system or by the localCsys
parameter if defined. This parameter is available only if traction is GENERAL.
directionVector
A tuple of two points specifying the direction of the load. Each point is specified as a point region
or a tuple of coordinates. If traction is SHEAR, then directionVector will be projected onto the
region surface. This parameter is available only if traction is GENERAL.

24–113

Abaqus ID:
Printed on:
LOAD COMMANDS

follower
A Boolean specifying whether the direction of the force changes with rotation. The default value
is ON. This parameter may be modified only if traction is GENERAL. You should provide the
follower argument only if it is valid for the specified step.
resultant
A Boolean specifying whether to maintain a constant resultant force by defining traction per unit
undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default value
is OFF. You should provide the resultant argument only if it is valid for the specified step.
traction
A SymbolicConstant specifying how to apply surface traction. Possible values are NORMAL,
TRANSVERSE, SHEAR, MOMENT and GENERAL. The default value is NORMAL.

Return value
A ShellEdgeLoad object.

Exceptions
None.

24.53.2 setValues(...)
This method modifies the data for an existing ShellEdgeLoad 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 ShellEdgeLoad method,
except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–114

Abaqus ID:
Printed on:
 LOAD COMMANDS

Arguments

Required argument
stepName
A String specifying the name of the step in which the surface pore fluid flow is modified.
Optional arguments
magnitude
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the load magnitude.
UNCHANGED should be used if the magnitude is propagated from the previous analysis step.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.53.4 Members
The ShellEdgeLoad object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the shell edge load is distributed spatially. Possible values
are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–115

Abaqus ID:
Printed on:
LOAD COMMANDS

24.54 ShellEdgeLoadState object

The ShellEdgeLoadState object stores the propagating data for a ShellEdgeLoad object in a step. One
instance of this object is created internally by the ShellEdgeLoad object for each step. The instance is
also deleted internally by the ShellEdgeLoad object.
The ShellEdgeLoadState object has no constructor or methods.
The ShellEdgeLoadState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.54.1 Members
The ShellEdgeLoadState object has the following members:
magnitude
A Float or a Complex specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–116

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.54.2 Corresponding analysis keywords

*DSLOAD
*DLOAD

24.55 SubmodelSB object

The SubmodelSB object stores the data for a submodel surface based load.
The SubmodelSB object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.55.1 SubmodelSB(...)
This method creates a SubmodelSB object.

Path
mdb.models[name].SubmodelSB

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
globalStep
A String specifying the step in the global model from which Abaqus reads the values of the
variables that will drive the submodel analysis. The String indicates the position of the step in
the sequence of analysis steps. For example, globalStep=’1’ indicates the first step.

24–117

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
globalDrivingRegion
A String specifying the element set in the global model that will be searched for elements whose
responses will be used to drive the submodel. An empty string indicates that the entire global
model will be searched. The default value is an empty string.
absoluteExteriorTolerance
A Float specifying the absolute value by which a driven node of the submodel can lie outside the
region of the elements of the global model. The default value is 0.0.
exteriorTolerance
A Float specifying the fraction of the average element size in the global model by which a driven
node of the submodel can lie outside the region of the elements of the global model. The default
value is 0.05.
globalIncrement
An Int specifying the increment number in the global model step from which the solution will be
used to specify the values of the driven variables. If globalIncrement=0, the solution from the last
increment will be used. The globalIncrement argument is applicable only for linear perturbation
steps. The default value is 0.

Return value
A SubmodelSB object.

Exceptions
None.

24.55.2 setValues(...)
This method modifies the data for an existing SubmodelSB 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 SubmodelSB method,
except for the name and createStepName arguments.

Return value
None

24–118

Abaqus ID:
Printed on:
 LOAD COMMANDS

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
fixed
A Boolean specifying whether the load should remain fixed at the current values at the start of the
step. The default value is ON.
globalStep
A String specifying the step in the global model from which Abaqus reads the values of the
variables that will drive the submodel analysis. The String indicates the position of the step in the
sequence of analysis steps. For example, globalStep=’1’ indicates the first step. The globalStep
argument is applicable only if fixed=OFF.
globalIncrement
An Int specifying the increment number in the global model step at which the solution will be
used to specify the values of the driven variables. If globalIncrement=0, the solution from the last
increment will be used. The globalIncrement argument is applicable only for linear perturbation
steps and if fixed=OFF. The default value is 0.

Return value
None

Exceptions
None.

24.55.4 Members
The SubmodelSB object can have the following members:
name
A String specifying the load repository key.

24–119

Abaqus ID:
Printed on:
LOAD COMMANDS

absoluteExteriorTolerance
A Float specifying the absolute value by which a driven node of the submodel can lie outside the
region of the elements of the global model. The default value is 0.0.
exteriorTolerance
A Float specifying the fraction of the average element size in the global model by which a driven
node of the submodel can lie outside the region of the elements of the global model. The default
value is 0.05.
globalDrivingRegion
A String specifying the element set in the global model that will be searched for elements whose
responses will be used to drive the submodel. An empty string indicates that the entire global
model will be searched. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.56 SubmodelSBState object

The SubmodelSBState object stores the propagating data for a Submodel load in a step. One instance
of this object is created internally by the SubmodelSB object for each step. The instance is also deleted
internally by the SubmodelSB object.
The SubmodelSBState object has no constructor or methods.
The SubmodelSBState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.56.1 Members
The SubmodelSBState object has the following members:
globalStepState
A SymbolicConstant specifying the propagation state of the globalStep member. Possible values
are SET and UNCHANGED.
globalIncrement
An Int specifying the increment number in the global model step at which the solution will be
used to specify the values of the driven variables. This argument is applicable only for linear
perturbation steps.
globalIncrementState
A SymbolicConstant specifying the propagation state of the globalIncrement member. Possible
values are SET and UNCHANGED.

24–120

Abaqus ID:
Printed on:
 LOAD COMMANDS

globalStep
A String specifying the step in the global model from which Abaqus reads the values of the
variables that will drive the submodel analysis. The String indicates the position of the step in
the sequence of analysis steps. For example, globalStep=’1’ indicates the first step.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.56.2 Corresponding analysis keywords

*SUBMODEL
*DSLOAD, SUBMODEL

24.57 SurfaceCharge object

The SurfaceCharge object stores the data for a surface charge.

The SurfaceCharge object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24–121

Abaqus ID:
Printed on:
LOAD COMMANDS

24.57.1 SurfaceCharge(...)
This method creates a SurfaceCharge object.

Path
mdb.models[name].SurfaceCharge

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A SurfaceCharge object.

Exceptions
None.

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

24–122

Abaqus ID:
Printed on:
 LOAD COMMANDS

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

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24–123

Abaqus ID:
Printed on:
LOAD COMMANDS

24.57.4 Members
The SurfaceCharge object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.58 SurfaceChargeState object

The SurfaceChargeState object stores the propagating data of a surface charge in a step. One instance of
this object is created internally by the SurfaceCharge object for each step. The instance is also deleted
internally by the SurfaceCharge object.
The SurfaceChargeState object has no constructor or methods.
The SurfaceChargeState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.58.1 Members
The SurfaceChargeState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.

24–124

Abaqus ID:
Printed on:
 LOAD COMMANDS

status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.58.2 Corresponding analysis keywords

*DSECHARGE (load type label: ES)

24.59 SurfaceConcentrationFlux object

The SurfaceConcentrationFlux object defines surface concentration flux from a region or into a region.
The SurfaceConcentrationFlux object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.59.1 SurfaceConcentrationFlux(...)
This method creates a SurfaceConcentrationFlux object.

Path
mdb.models[name].SurfaceConcentrationFlux

24–125

Abaqus ID:
Printed on:
LOAD COMMANDS

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the surface concentration flux magnitude. magnitude is optional if
distributionType=USER_DEFINED.
Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
distributionType
A SymbolicConstant specifying how the surface concentration flux is distributed spatially.
Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A SurfaceConcentrationFlux object.

Exceptions
None.

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

Arguments
Required arguments
None.

24–126

Abaqus ID:
Printed on:
 LOAD COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the
SurfaceConcentrationFlux method, except for the name and createStepName
arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the surface concentration flux is modified.
Optional arguments
magnitude
A Float specifying the surface concentration flux magnitude.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.59.4 Members
The SurfaceConcentrationFlux object can have the following members:

24–127

Abaqus ID:
Printed on:
LOAD COMMANDS

name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the surface concentration flux is distributed spatially.
Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.60 SurfaceConcentrationFluxState object

The SurfaceConcentrationFluxState object stores the propagating data for a SurfaceConcentrationFlux

object in a step. One instance of this object is created internally by the SurfaceConcentrationFlux object
for each step. The instance is also deleted internally by the SurfaceConcentrationFlux object.
The SurfaceConcentrationFluxState object has no constructor or methods.
The SurfaceConcentrationFluxState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.60.1 Members
The SurfaceConcentrationFluxState object has the following members:
magnitude
A Float specifying the surface concentration flux magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the surface concentration flux magnitude.
Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED

24–128

Abaqus ID:
Printed on:
 LOAD COMMANDS

• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.60.2 Corresponding analysis keywords

*DSFLUX

24.61 SurfaceCurrent object

The SurfaceCurrent object stores the data for a surface current.

The SurfaceCurrent object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.61.1 SurfaceCurrent(...)
This method creates a SurfaceCurrent object.

Path
mdb.models[name].SurfaceCurrent

Required arguments
name
A String specifying the load repository key.

24–129

Abaqus ID:
Printed on:
LOAD COMMANDS

createStepName
A String specifying the name of the step in which the load is created. This must be the first analysis
step name.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the load magnitude.
Optional arguments
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A SurfaceCurrent object.

Exceptions
None.

24.61.2 setValues(...)
This method modifies the data for an existing SurfaceCurrent 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 SurfaceCurrent
method, except for the name and createStepName arguments.

Return value
None

24–130

Abaqus ID:
Printed on:
 LOAD COMMANDS

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float specifying the load magnitude.
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 static analysis step. FREED should be used if the load
is changed to have no amplitude reference. You should provide the amplitude argument only if it
is valid for the specified step.

Return value
None

Exceptions
None.

24.61.4 Members
The SurfaceCurrent object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the load is distributed spatially. Possible values are
UNIFORM and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

24–131

Abaqus ID:
Printed on:
LOAD COMMANDS

region
A Region object specifying the region to which the load is applied.

24.62 SurfaceCurrentState object

The SurfaceCurrentState object stores the propagating data of a surface current in a step. One instance
of this object is created internally by the SurfaceCurrent object for each step. The instance is also deleted
internally by the SurfaceCurrent object.
The SurfaceCurrentState object has no constructor or methods.
The SurfaceCurrentState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.62.1 Members
The SurfaceCurrentState object has the following members:
magnitude
A Float specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and FREED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

24–132

Abaqus ID:
Printed on:
 LOAD COMMANDS

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.62.2 Corresponding analysis keywords

*DSECURRENT (load type label: CS)

24.63 SurfaceHeatFlux object

The SurfaceHeatFlux object defines surface heat flux from a region or into a region.
The SurfaceHeatFlux object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.63.1 SurfaceHeatFlux(...)
This method creates a SurfaceHeatFlux object.

Path
mdb.models[name].SurfaceHeatFlux

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the surface heat flux magnitude. magnitude is optional if
distributionType=USER_DEFINED.

24–133

Abaqus ID:
Printed on:
LOAD COMMANDS

Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
distributionType
A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values
are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A SurfaceHeatFlux object.

Exceptions
None.

24.63.2 setValues(...)
This method modifies the data for an existing SurfaceHeatFlux 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 SurfaceHeatFlux
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

24–134

Abaqus ID:
Printed on:
 LOAD COMMANDS

Arguments

Required argument
stepName
A String specifying the name of the step in which the surface heat flux is modified.

Optional arguments
magnitude
A Float specifying the surface heat flux magnitude.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.63.4 Members
The SurfaceHeatFlux object can have the following members:

name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values
are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24–135

Abaqus ID:
Printed on:
LOAD COMMANDS

24.64 SurfaceHeatFluxState object

The SurfaceHeatFluxState object stores the propagating data for a surface SurfaceHeatFlux object in a
step. One instance of this object is created internally by the SurfaceHeatFlux object for each step. The
instance is also deleted internally by the SurfaceHeatFlux object.
The SurfaceHeatFluxState object has no constructor or methods.
The SurfaceHeatFluxState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.64.1 Members
The SurfaceHeatFluxState object has the following members:
magnitude
A Float specifying the surface heat flux magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the surface heat flux magnitude. Possible
values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE
amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24–136

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.64.2 Corresponding analysis keywords

*DSFLUX

24.65 SurfacePoreFluid object

The SurfacePoreFluid object defines surface pore fluid flow from a region or into a region.
The SurfacePoreFluid object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.65.1 SurfacePoreFluid(...)
This method creates a SurfacePoreFluid object.

Path
mdb.models[name].SurfacePoreFluid

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float specifying the surface pore fluid flow magnitude. magnitude is optional if
distributionType=USER_DEFINED.
Optional arguments
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.

24–137

Abaqus ID:
Printed on:
LOAD COMMANDS

distributionType
A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM,
USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

Return value
A SurfacePoreFluid object.

Exceptions
None.

24.65.2 setValues(...)
This method modifies the data for an existing SurfacePoreFluid 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 SurfacePoreFluid
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the surface pore fluid flow is modified.

24–138

Abaqus ID:
Printed on:
 LOAD COMMANDS

Optional arguments
magnitude
A Float specifying the surface pore fluid flow magnitude.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

Exceptions
None.

24.65.4 Members
The SurfacePoreFluid object can have the following members:
name
A String specifying the load repository key.
distributionType
A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM,
USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
region
A Region object specifying the region to which the load is applied.

24.66 SurfacePoreFluidState object

The SurfacePoreFluidState object stores the propagating data for a SurfacePoreFluid object in a step.
One instance of this object is created internally by the SurfacePoreFluid object for each step. The instance
is also deleted internally by the SurfacePoreFluid object.
The SurfacePoreFluidState object has no constructor or methods.
The SurfacePoreFluidState object is derived from the LoadState object.

24–139

Abaqus ID:
Printed on:
LOAD COMMANDS

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.66.1 Members
The SurfacePoreFluidState object has the following members:
magnitude
A Float specifying the surface pore fluid flow magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the surface pore fluid flow magnitude.
Possible values are UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE
• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.66.2 Corresponding analysis keywords

*DSFLOW

24–140

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.67 SurfaceTraction object

The SurfaceTraction object defines surface traction on a region.

The SurfaceTraction object is derived from the Load object.

Access
import load
mdb.models[name].loads[name]

24.67.1 SurfaceTraction(...)
This method creates a SurfaceTraction object.

Path
mdb.models[name].SurfaceTraction

Required arguments
name
A String specifying the load repository key.
createStepName
A String specifying the name of the step in which the load is created.
region
A Region object specifying the region to which the load is applied.
magnitude
A Float or Complex specifying the load magnitude. magnitude is optional if
distributionType=USER_DEFINED.
Optional arguments
distributionType
A SymbolicConstant specifying how the surface traction is distributed spatially. Possible values
are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
amplitude
A String or the SymbolicConstant UNSET specifying the name of the amplitude reference.
UNSET should be used if the load has no amplitude reference. The default value is UNSET. You
should provide the amplitude argument only if it is valid for the specified step.

24–141

Abaqus ID:
Printed on:
LOAD COMMANDS

angle
A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.
axis
A SymbolicConstant specifying the axis about which to apply an additional rotation of
directionVector. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is
AXIS_1.
localCsys
None or a DatumCsys object specifying the local coordinate system of the load’s degrees of
freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system
or by the userCsys parameter if defined. When this member is queried, it returns an Int. The
default value is None.
userCsys
A String specifying a CSYS defined by a user-subroutine. If userCsys=None, the degrees of
freedom are defined in the global coordinate system or by the localCsys parameter if defined. The
default value is "None".
directionVector
A VertexArray object of length 2 specifying the direction of the load. Instead of through a
Vertex , each point may be specified through a tuple of coordinates. If traction is SHEAR, then
directionVector will be projected onto the region surface. This parameter is available only if
traction is GENERAL or SHEAR.
follower
A Boolean specifying whether the direction of the force changes with rotation. The default value
is ON.
This parameter may be modified only if traction is GENERAL. You should provide the
follower argument only if it is valid for the specified step.
resultant
A Boolean specifying whether the to maintain a constant resultant force by defining traction per
unit undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default
value is OFF.
You should provide the resultant argument only if it is valid for the specified step.
traction
A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and
GENERAL. The default value is SHEAR.

Return value
A SurfaceTraction object.

Exceptions
None.

24–142

Abaqus ID:
Printed on:
 LOAD COMMANDS

24.67.2 setValues(...)
This method modifies the data for an existing SurfaceTraction 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 SurfaceTraction
method, except for the name and createStepName arguments.

Return value
None

Exceptions
None.

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

Arguments
Required argument
stepName
A String specifying the name of the step in which the load is modified.
Optional arguments
magnitude
A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the load magnitude.
UNCHANGED should be used if the magnitude is propagated from the previous analysis step.
amplitude
A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values
for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the
amplitude is propagated from the previous analysis step. FREED should be used if the load has no
amplitude reference. You should provide the amplitude argument only if it is valid for the specified
step.

Return value
None

24–143

Abaqus ID:
Printed on:
LOAD COMMANDS

Exceptions
None.

24.67.4 Members
The SurfaceTraction object can have the following members:
name
A String specifying the load repository key.
angle
A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.
axis
A SymbolicConstant specifying the axis about which to apply an additional rotation of
directionVector. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is
AXIS_1.
follower
A Boolean specifying whether the direction of the force changes with rotation. The default value
is ON.
This parameter may be modified only if traction is GENERAL. You should provide the
follower argument only if it is valid for the specified step.
resultant
A Boolean specifying whether the to maintain a constant resultant force by defining traction per
unit undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default
value is OFF.
You should provide the resultant argument only if it is valid for the specified step.
traction
A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and
GENERAL. The default value is SHEAR.
distributionType
A SymbolicConstant specifying how the surface traction is distributed spatially. Possible values
are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field
A String specifying the name of the AnalyticalField object associated with this load. The field
argument applies only when distributionType=FIELD. The default value is an empty string.
userCsys
A String specifying a CSYS defined by a user-subroutine. If userCsys=None, the degrees of
freedom are defined in the global coordinate system or by the localCsys parameter if defined. The
default value is "None".

24–144

Abaqus ID:
Printed on:
 LOAD COMMANDS

localCsys
None or a DatumCsys object specifying the local coordinate system of the load’s degrees of
freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system
or by the userCsys parameter if defined. When this member is queried, it returns an Int. The
default value is None.
directionVector
A VertexArray object of length 2 specifying the direction of the load. Instead of through a
Vertex , each point may be specified through a tuple of coordinates. If traction is SHEAR, then
directionVector will be projected onto the region surface. This parameter is available only if
traction is GENERAL or SHEAR.
region
A Region object specifying the region to which the load is applied.

24.68 SurfaceTractionState object

The SurfaceTractionState object stores the propagating data for a SurfaceTraction object in a step. One
instance of this object is created internally by the SurfaceTraction object for each step. The instance is
also deleted internally by the SurfaceTraction object.
The SurfaceTractionState object has no constructor or methods.
The SurfaceTractionState object is derived from the LoadState object.

Access
import load
mdb.models[name].steps[name].loadStates[name]

24.68.1 Members
The SurfaceTractionState object has the following members:
magnitude
A Float or a Complex specifying the load magnitude.
magnitudeState
A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are
UNSET, SET, UNCHANGED, and MODIFIED.
amplitudeState
A SymbolicConstant specifying the propagation state of the amplitude member. Possible values
are UNSET, SET, UNCHANGED, and FREED.
status
A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:
• NOT_YET_ACTIVE

24–145

Abaqus ID:
Printed on:
LOAD COMMANDS

• CREATED
• PROPAGATED
• MODIFIED
• DEACTIVATED
• NO_LONGER_ACTIVE
• TYPE_NOT_APPLICABLE
• INSTANCE_NOT_APPLICABLE
• BUILT_INTO_BASE_STATE

amplitude
A String specifying the name of the amplitude reference. The String is empty if the load has no
amplitude reference.

24.68.2 Corresponding analysis keywords

*DSLOAD
*DLOAD

24–146

Abaqus ID:
Printed on:
 LOAD CASE COMMANDS

25. Load Case commands

Load Case commands are used for configuring load cases in specific types of steps that may use them.

25.1 LoadCase object

The LoadCase object is used to define the loads and constraints comprising a particular loading condition
and the linear response of a structure subjected to that loading condition.

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

25.1.1 LoadCase(...)
This method creates a load case in a step.

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

Required argument
name
A String specifying the name of the object.
Optional arguments
boundaryConditions
A sequence of (String, Float) sequences specifying the name of a BoundaryCondition followed by
a nonzero Float scaling factor. The default value is an empty sequence.
loads
A sequence of (String, Float) sequences specifying the name of a Load followed by a nonzero
Float specifying a scale factor. The default value is an empty sequence.
includeActiveBaseStateBC
A Boolean specifying whether to include all active boundary conditions propagated or modified
from the base state. The default value is ON.

Return value
A LoadCase object.

25–1

Abaqus ID:
Printed on:
LOAD CASE COMMANDS

Exceptions
RangeError.

25.1.2 resume()
This method resumes the load case that was previously suppressed.

Arguments
None.

Return value
None

Exceptions
None.

25.1.3 suppress()
This method suppresses the load case.

Arguments
None.

Return value
None

Exceptions
None.

25.1.4 setValues(...)
This method modifies the LoadCase object.

Arguments
Required arguments
None.

25–2

Abaqus ID:
Printed on:
 LOAD CASE COMMANDS

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

Return value
None

Exceptions
RangeError.

25.1.5 Members
The LoadCase object has members with the same names and descriptions as the arguments to the
LoadCase method.
In addition, the LoadCase object has the following member:
suppressed
A Boolean specifying whether the load case is suppressed or not. The default value is OFF.

25–3

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26. Material commands

The Material commands are used to define the materials in a model.

26.1 Material object

A Material object is the object used to specify a material. The Material object stores the various settings
that determine how a material behaves.
A material is created by combining one or more individual material options and sub options.
A particular material option is associated with the Material object through a member. For example:
the acousticMedium member may contain an AcousticMedium object. The alternative of having a
MaterialOption abstract base class and a container of MaterialOptions was rejected because it would
make it more difficult to enforce the fact that one Material object cannot contain two AcousticMedium
objects, for example.

Access
import material
mdb.models[name].materials[name]
import odbMaterial
session.odbs[name].materials[name]

26.1.1 Material(...)
This method creates a Material object.

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

Required argument
name
A String specifying the name of the new material.
Optional arguments
description
A String specifying user description of the material. The default value is an empty string.
materialIdentifier
A String specifying material identifier for customer use. The default value is an empty string.

26–1

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A Material object.

Exceptions
InvalidNameError.

26.1.2 materialsFromOdb(...)
This methods creates Material objects by reading an output database. The new materials are placed in
the materials repository.

Path
mdb.models[name].materialsFromOdb

Required argument
fileName
A String specifying the name of the output database file (including the .odb extension) to be read.
This String can also be the full path to the output database file if it is located in another directory.
Optional arguments
None.

Return value
A list of Material objects.

Exceptions
None.

26.1.3 Members
The Material object has members with the same names and descriptions as the arguments to the
Material method.
In addition, the Material object can have the following members:
acousticMedium
An AcousticMedium object.
brittleCracking
A BrittleCracking object.
capPlasticity
A CapPlasticity object.

26–2

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

castIronPlasticity
A CastIronPlasticity object.
clayPlasticity
A ClayPlasticity object.
concrete
A Concrete object.
concreteDamagedPlasticity
A ConcreteDamagedPlasticity object.
conductivity
A Conductivity object.
creep
A Creep object.
crushableFoam
A CrushableFoam object.
ductileDamageInitiation
A DamageInitiation object.
fldDamageInitiation
A DamageInitiation object.
flsdDamageInitiation
A DamageInitiation object.
johnsonCookDamageInitiation
A DamageInitiation object.
maxeDamageInitiation
A DamageInitiation object.
maxsDamageInitiation
A DamageInitiation object.
maxpeDamageInitiation
A DamageInitiation object.
maxpsDamageInitiation
A DamageInitiation object.
mkDamageInitiation
A DamageInitiation object.
msfldDamageInitiation
A DamageInitiation object.
quadeDamageInitiation
A DamageInitiation object.
quadsDamageInitiation
A DamageInitiation object.

26–3

Abaqus ID:
Printed on:
MATERIAL COMMANDS

shearDamageInitiation
A DamageInitiation object.
hashinDamageInitiation
A DamageInitiation object.
damping
A Damping object.
deformationPlasticity
A DeformationPlasticity object.
density
A Density object.
depvar
A Depvar object.
dielectric
A Dielectric object.
diffusivity
A Diffusivity object.
druckerPrager
A DruckerPrager object.
elastic
An Elastic object.
electricalConductivity
An ElectricalConductivity object.
eos
An Eos object.
expansion
An Expansion object.
fluidLeakoff
A FluidLeakoff object.
gapFlow
A GapFlow object.
gasketThicknessBehavior
A GasketThicknessBehavior object.
gasketTransverseShearElastic
A GasketTransverseShearElastic object.
gasketMembraneElastic
A GasketMembraneElastic object.
gel
A Gel object.

26–4

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

heatGeneration
A HeatGeneration object.
hyperelastic
A Hyperelastic object.
hyperfoam
A Hyperfoam object.
hypoelastic
A Hypoelastic object.
inelasticHeatFraction
An InelasticHeatFraction object.
jouleHeatFraction
A JouleHeatFraction object.
latentHeat
A LatentHeat object.
lowDensityFoam
A LowDensityFoam object.
mohrCoulombPlasticity
A MohrCoulombPlasticity object.
moistureSwelling
A MoistureSwelling object.
mullinsEffect
A MullinsEffect object.
permeability
A Permeability object.
piezoelectric
A Piezoelectric object.
plastic
A Plastic object.
poreFluidExpansion
A PoreFluidExpansion object.
porousBulkModuli
A PorousBulkModuli object.
porousElastic
A PorousElastic object.
porousMetalPlasticity
A PorousMetalPlasticity object.
regularization
A Regularization object.

26–5

Abaqus ID:
Printed on:
MATERIAL COMMANDS

shear
A Shear object.
solubility
A Solubility object.
sorption
A Sorption object.
specificHeat
A SpecificHeat object.
swelling
A Swelling object.
userDefinedField
A UserDefinedField object.
userMaterial
A UserMaterial object.
userOutputVariables
A UserOutputVariables object.
viscoelastic
A Viscoelastic object.
viscosity
A Viscosity object.
viscous
A Viscous object.

26.1.4 Corresponding analysis keywords

*MATERIAL

26.2 AcousticMedium object

The AcousticMedium object specifies the acoustic properties of a material.

Access
import material
mdb.models[name].materials[name].acousticMedium
import odbMaterial
session.odbs[name].materials[name].acousticMedium

26–6

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.2.1 AcousticMedium(...)
This method creates an AcousticMedium object.

Path
mdb.models[name].materials[name].AcousticMedium
session.odbs[name].materials[name].AcousticMedium

Required arguments
None.
Optional arguments
acousticVolumetricDrag
A Boolean specifying whether the volumetricTable data is specified. The default value is OFF.
temperatureDependencyB
A Boolean specifying whether the data in bulkTable depend on temperature. The default value is
OFF.
temperatureDependencyV
A Boolean specifying whether the data in volumetricTable depend on temperature. The default
value is OFF.
dependenciesB
An Int specifying the number of field variable dependencies for the data in bulkTable. The default
value is 0.
dependenciesV
An Int specifying the number of field variable dependencies for the data in volumetricTable. The
default value is 0.
bulkTable
A sequence of sequences of Floats specifying the following:
• Bulk modulus.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
The default value is an empty sequence.
volumetricTable
A sequence of sequences of Floats specifying the following:
• Volumetric drag.
• Frequency.

26–7

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
The default value is an empty sequence.

Return value
An AcousticMedium object.

Exceptions
RangeError.

26.2.2 setValues(...)
This method modifies the AcousticMedium object.

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

Return value
None

Exceptions
RangeError.

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

26.2.4 Corresponding analysis keywords

*ACOUSTIC MEDIUM

26–8

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.3 AnnealTemperature object

The AnnealTemperature object specifies the material annealing temperature.

Access
import material
mdb.models[name].materials[name].plastic.annealTemperature
import odbMaterial
session.odbs[name].materials[name].plastic.annealTemperature

26.3.1 AnnealTemperature(...)
This method creates an AnnealTemperature object.

Path
mdb.models[name].materials[name].plastic.AnnealTemperature
session.odbs[name].materials[name].plastic.AnnealTemperature

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional argument
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• The annealing temperature, .

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
An AnnealTemperature object.

26–9

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
RangeError.

26.3.2 setValues(...)
This method modifies the AnnealTemperature object.

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

Return value
None

Exceptions
RangeError.

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

26.3.4 Corresponding analysis keywords

*ANNEAL TEMPERATURE

26.4 BiaxialTestData object

The BiaxialTestData object provides equibiaxial test data (compression and/or tension).

Access
import material

26–10

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

mdb.models[name].materials[name].hyperelastic.biaxialTestData
mdb.models[name].materials[name].hyperfoam.biaxialTestData
mdb.models[name].materials[name].mullinsEffect.biaxialTests[i]
import odbMaterial
session.odbs[name].materials[name].hyperelastic.biaxialTestData
session.odbs[name].materials[name].hyperfoam.biaxialTestData
session.odbs[name].materials[name].mullinsEffect.biaxialTests[i]

26.4.1 BiaxialTestData(...)
This method creates a BiaxialTestData object.

Path
mdb.models[name].materials[name].hyperelastic.BiaxialTestData
mdb.models[name].materials[name].hyperfoam.BiaxialTestData
mdb.models[name].materials[name].mullinsEffect.BiaxialTestData
session.odbs[name].materials[name].hyperelastic.BiaxialTestData
session.odbs[name].materials[name].hyperfoam.BiaxialTestData
session.odbs[name].materials[name].mullinsEffect.BiaxialTestData

Required argument
table
A sequence of sequences of Floats specifying the following:

• Nominal stress, .
• Nominal strain, .

Optional arguments
smoothing
None or an Int specifying the value for smoothing. If smoothing=None, no smoothing is
employed. The default value is None.
lateralNominalStrain
A Boolean specifying whether to include lateral nominal strain. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–11

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A BiaxialTestData object.

Exceptions
None.

26.4.2 setValues(...)
This method modifies the BiaxialTestData object.

Arguments

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

Return value
None

Exceptions
None.

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

26.4.4 Corresponding analysis keywords

*BIAXIAL TEST DATA

26–12

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.5 BrittleCracking object

The BrittleCracking object specifies cracking and postcracking properties for the brittle cracking material
model.

Access
import material
mdb.models[name].materials[name].brittleCracking
import odbMaterial
session.odbs[name].materials[name].brittleCracking

26.5.1 BrittleCracking(...)
This method creates an BrittleCracking object.

Path
mdb.models[name].materials[name].BrittleCracking
session.odbs[name].materials[name].BrittleCracking

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
type
A SymbolicConstant specifying the type of postcracking behavior. Possible values are STRAIN,
DISPLACEMENT, and GFI. The default value is STRAIN.
Table data
If type=STRAIN the table data specify the following:
• Remaining direct stress after cracking.
• Direct cracking strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–13

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Value of the second field variable.

• Etc.
If type=DISPLACEMENT the table data specify the following:
• Remaining direct stress after cracking.
• Direct cracking displacement.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=GFI the table data specify the following:
• Failure stress.
• Mode I fracture energy.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A BrittleCracking object.

Exceptions
None.

26.5.2 setValues(...)
This method modifies the BrittleCracking object.

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

Return value
None

26–14

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
None.

26.5.3 Members
The BrittleCracking object has members with the same names and descriptions as the arguments to the
BrittleCracking method.
In addition, the BrittleCracking object can have the following members:
brittleShear
A BrittleShear object.
brittleFailure
A BrittleFailure object.

26.5.4 Corresponding analysis keywords

*BRITTLE CRACKING

26.6 BrittleFailure object

The BrittleFailure object specifies the brittle failure of the material.

Access
import material
mdb.models[name].materials[name].brittleCracking.brittleFailure
import odbMaterial
session.odbs[name].materials[name].brittleCracking.brittleFailure

26.6.1 BrittleFailure(...)
This method creates a BrittleFailure object.

Path
mdb.models[name].materials[name].brittleCracking.BrittleFailure
session.odbs[name].materials[name].brittleCracking.BrittleFailure

26–15

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
failureCriteria
A SymbolicConstant specifying the failure criteria. Possible values are UNIDIRECTIONAL,
BIDIRECTIONAL, and TRIDIRECTIONAL. The default value is UNIDIRECTIONAL.
Table data
If parent BrittleCracking member type=STRAIN the table data specify the following:
• Direct cracking failure strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If parent BrittleCracking member type=DISPLACEMENT or type=GFI the table data specify the
following:
• Direct cracking failure displacement.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A BrittleFailure object.

Exceptions
RangeError.

26.6.2 setValues(...)
This method modifies the BrittleFailure object.

26–16

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.6.4 Corresponding analysis keywords

*BRITTLE FAILURE

26.7 BrittleShear object

The BrittleShear object specifies the postcracking shear behavior of a material used in a brittle cracking
model.

Access
import material
mdb.models[name].materials[name].brittleCracking.brittleShear
import odbMaterial
session.odbs[name].materials[name].brittleCracking.brittleShear

26.7.1 BrittleShear(...)
This method creates a BrittleShear object.

26–17

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].brittleCracking.BrittleShear
session.odbs[name].materials[name].brittleCracking.BrittleShear

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
type
A SymbolicConstant specifying the type of postcracking shear behavior. Possible values are
RETENTION_FACTOR and POWER_LAW. The default value is RETENTION_FACTOR.
Table data
If type=RETENTION_FACTOR the table data specify the following:
• Shear retention factor.
• Crack opening strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=POWER_LAW the table data specify the following:
• e.
• p.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A BrittleShear object.

26–18

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

26.7.2 setValues(...)
This method modifies the BrittleShear object.

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

Return value
None

Exceptions
RangeError.

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

26.7.4 Corresponding analysis keywords

*BRITTLE SHEAR

26.8 CapCreepCohesion object

The CapCreepCohesion object specifies a cap creep model and material properties.

Access
import material
mdb.models[name].materials[name].capPlasticity.capCreepCohesion

26–19

Abaqus ID:
Printed on:
MATERIAL COMMANDS

import odbMaterial
session.odbs[name].materials[name].capPlasticity.capCreepCohesion

26.8.1 CapCreepCohesion(...)
This method creates a CapCreepCohesion object.

Path
mdb.models[name].materials[name].capPlasticity.CapCreepCohesion
session.odbs[name].materials[name].capPlasticity.CapCreepCohesion

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
law
A SymbolicConstant specifying the cap creep law. Possible values are STRAIN, TIME, SINGHM,
and USER. The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If law=STRAIN or law=TIME, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If law=SINGHM, the table data specify the following:
• .
• .
• .
• .
• Temperature, if the data depend on temperature.

26–20

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CapCreepCohesion object.

Exceptions
None.

26.8.2 setValues(...)
This method modifies the CapCreepCohesion object.

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

Return value
None

Exceptions
None.

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

26.8.4 Corresponding analysis keywords

*CAP CREEP

26–21

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.9 CapCreepConsolidation object

The CapCreepConsolidation object specifies a cap creep model and material properties.

Access
import material
mdb.models[name].materials[name].capPlasticity.capCreepConsolidation
import odbMaterial
session.odbs[name].materials[name].capPlasticity.capCreepConsolidation

26.9.1 CapCreepConsolidation(...)
This method creates a CapCreepConsolidation object.

Path
mdb.models[name].materials[name].capPlasticity.CapCreepConsolidation
session.odbs[name].materials[name].capPlasticity.CapCreepConsolidation

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
law
A SymbolicConstant specifying the cap creep law. Possible values are STRAIN, TIME, SINGHM,
and USER. The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If law=STRAIN or law=TIME, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–22

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Value of the second field variable.

• Etc.
If law=SINGHM, the table data specify the following:
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CapCreepConsolidation object.

Exceptions
None.

26.9.2 setValues(...)
This method modifies the CapCreepConsolidation object.

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

Return value
None

Exceptions
None.

26–23

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

26.9.4 Corresponding analysis keywords

*CAP CREEP

26.10 CapHardening object

The CapHardening object specifies Drucker-Prager/Cap plasticity hardening.

Access
import material
mdb.models[name].materials[name].capPlasticity.capHardening
import odbMaterial
session.odbs[name].materials[name].capPlasticity.capHardening

26.10.1 CapHardening(...)
This method creates a CapHardening object.

Path
mdb.models[name].materials[name].capPlasticity.CapHardening
session.odbs[name].materials[name].capPlasticity.CapHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–24

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Table data

• Hydrostatic pressure yield stress.

• Absolute value of the corresponding volumetric inelastic strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CapHardening object.

Exceptions
RangeError.

26.10.2 setValues(...)
This method modifies the CapHardening object.

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

Return value
None

Exceptions
RangeError.

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

26.10.4 Corresponding analysis keywords

26–25

Abaqus ID:
Printed on:
MATERIAL COMMANDS

*CAP HARDENING

26.11 CapPlasticity object

The CapPlasticity object specifies the modified Drucker-Prager/Cap plasticity model.

Access
import material
mdb.models[name].materials[name].capPlasticity
import odbMaterial
session.odbs[name].materials[name].capPlasticity

26.11.1 CapPlasticity(...)
This method creates a CapPlasticity object.

Path
mdb.models[name].materials[name].CapPlasticity
session.odbs[name].materials[name].CapPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Material cohesion, , in the – plane (Abaqus/Standard) or in the – plane (Abaqus/Explicit).

• Material angle of friction, , in the – plane (Abaqus/Standard) or in the – plane
(Abaqus/Explicit). Give the value in degrees.
• Cap eccentricity parameter, . Its value must be greater than zero (typically 0.0 1.0).
• Initial cap yield surface position, .
• Transition surface radius parameter, . The default value is 0.0 (i.e., no transition surface).

26–26

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• (Not used in Abaqus/Explicit) , the ratio of the flow stress in triaxial tension to the flow stress in
triaxial compression. Possible values are 0.778 1.0. If the default value of 0.0 is accepted,
Abaqus/Standard assumes 1.0.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CapPlasticity object.

Exceptions
RangeError.

26.11.2 setValues(...)
This method modifies the CapPlasticity object.

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

Return value
None

Exceptions
RangeError.

26.11.3 Members
The CapPlasticity object has members with the same names and descriptions as the arguments to the
CapPlasticity method.
In addition, the CapPlasticity object can have the following members:
capCreepCohesion
A CapCreepCohesion object.

26–27

Abaqus ID:
Printed on:
MATERIAL COMMANDS

capCreepConsolidation
A CapCreepConsolidation object.
capHardening
A CapHardening object.

26.11.4 Corresponding analysis keywords

*CAP PLASTICITY

26.12 CastIronCompressionHardening object

The CastIronCompressionHardening object specifies hardening for the Cast- Iron plasticity model.

Access
import material
mdb.models[name].materials[name].castIronPlasticity\
.castIronCompressionHardening
import odbMaterial
session.odbs[name].materials[name].castIronPlasticity\
.castIronCompressionHardening

26.12.1 CastIronCompressionHardening(...)
This method creates a CastIronCompressionHardening object.

Path
mdb.models[name].materials[name].castIronPlasticity\
.CastIronCompressionHardening
session.odbs[name].materials[name].castIronPlasticity\
.CastIronCompressionHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–28

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Yield stress in compression, .

• The absolute value of the corresponding plastic strain.(The first tabular value entered must always
be zero.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CastIronCompressionHardening object.

Exceptions
RangeError.

26.12.2 setValues(...)
This method modifies the CastIronCompressionHardening object.

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

Return value
None

Exceptions
RangeError.

26–29

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

26.12.4 Corresponding analysis keywords

*CAST IRON COMPRESSION HARDENING

26.13 CastIronPlasticity object

The CastIronPlasticity object specifies the Cast Iron plasticity model.

Access
import material
mdb.models[name].materials[name].castIronPlasticity
import odbMaterial
session.odbs[name].materials[name].castIronPlasticity

26.13.1 CastIronPlasticity(...)
This method creates a CastIronPlasticity object.

Path
mdb.models[name].materials[name].CastIronPlasticity
session.odbs[name].materials[name].CastIronPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–30

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Table data
The table data specify the following:
• Plastic Poisson’s ratio, (dimensionless).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CastIronPlasticity object.

Exceptions
RangeError.

26.13.2 setValues(...)
This method modifies the CastIronPlasticity object.

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

Return value
None

Exceptions
RangeError.

26.13.3 Members
The CastIronPlasticity object has members with the same names and descriptions as the arguments to
the CastIronPlasticity method.
In addition, the CastIronPlasticity object can have the following members:
castIronTensionHardening
A CastIronTensionHardening object.

26–31

Abaqus ID:
Printed on:
MATERIAL COMMANDS

castIronCompressionHardening
A CastIronCompressionHardening object.

26.13.4 Corresponding analysis keywords

*CAST IRON PLASTICITY

26.14 CastIronTensionHardening object

The CastIronTensionHardening object specifies hardening for the Cast- Iron plasticity model.

Access
import material
mdb.models[name].materials[name].castIronPlasticity\
.castIronTensionHardening
import odbMaterial
session.odbs[name].materials[name].castIronPlasticity\
.castIronTensionHardening

26.14.1 CastIronTensionHardening(...)
This method creates a CastIronTensionHardening object.

Path
mdb.models[name].materials[name].castIronPlasticity\
.CastIronTensionHardening
session.odbs[name].materials[name].castIronPlasticity\
.CastIronTensionHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.

26–32

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Yield stress in uniaxial tension, .

• The absolute value of the corresponding plastic strain.(The first tabular value entered must always
be zero.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CastIronTensionHardening object.

Exceptions
RangeError.

26.14.2 setValues(...)
This method modifies the CastIronTensionHardening object.

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

Return value
None

Exceptions
RangeError.

26–33

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

26.14.4 Corresponding analysis keywords

*CAST IRON TENSION HARDENING

26.15 ClayHardening object

The ClayHardening object specifies hardening for the clay plasticity model.

Access
import material
mdb.models[name].materials[name].clayPlasticity.clayHardening
import odbMaterial
session.odbs[name].materials[name].clayPlasticity.clayHardening

26.15.1 ClayHardening(...)
This method creates a ClayHardening object.

Path
mdb.models[name].materials[name].clayPlasticity.ClayHardening
session.odbs[name].materials[name].clayPlasticity.ClayHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–34

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Table data

• The hydrostatic pressure stress at yield, .

• The absolute value of the corresponding volumetric plastic strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ClayHardening object.

Exceptions
RangeError.

26.15.2 setValues(...)
This method modifies the ClayHardening object.

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

Return value
None

Exceptions
RangeError.

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

26.15.4 Corresponding analysis keywords

26–35

Abaqus ID:
Printed on:
MATERIAL COMMANDS

*CLAY HARDENING

26.16 ClayPlasticity object

The ClayPlasticity object specifies the extended Cam-clay plasticity model.

Access
import material
mdb.models[name].materials[name].clayPlasticity
import odbMaterial
session.odbs[name].materials[name].clayPlasticity

26.16.1 ClayPlasticity(...)
This method creates a ClayPlasticity object.

Path
mdb.models[name].materials[name].ClayPlasticity
session.odbs[name].materials[name].ClayPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
intercept
None or a Float specifying , the intercept of the virgin consolidation line with the void ratio axis
in a plot of void ratio versus the logarithm of pressure stress. The default value is None.
This argument is valid only if hardening=EXPONENTIAL.
hardening
A SymbolicConstant specifying the type of hardening/softening definition. Possible values are
EXPONENTIAL and TABULAR. The default value is EXPONENTIAL.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–36

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Table data
If hardening=EXPONENTIAL, the table data specify the following:
• Logarithmic plastic bulk modulus, (dimensionless).
• Stress ratio at critical state, .
• The initial yield surface size, .
• , the parameter defining the size of the yield surface on the “wet” side of critical state.
• , the ratio of the flow stress in triaxial tension to the flow stress in triaxial compression.
. If the default value of 0.0 is accepted, a value of 1.0 is assumed.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If hardening=TABULAR, the table data specify the following:
• Stress ratio at critical state, .
• The initial volumetric plastic strain, , corresponding to according to the ClayHardening
definition.
• , the parameter defining the size of the yield surface on the “wet” side of critical state.
• , the ratio of the flow stress in triaxial tension to the flow stress in triaxial compression.
.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ClayPlasticity object.

Exceptions
RangeError.

26.16.2 setValues(...)
This method modifies the ClayPlasticity object.

Arguments
Required arguments
None.

26–37

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the ClayPlasticity
method.

Return value
None

Exceptions
RangeError.

26.16.3 Members
The ClayPlasticity object has members with the same names and descriptions as the arguments to the
ClayPlasticity method.
In addition, the ClayPlasticity object can have the following member:
clayHardening
A ClayHardening object.

26.16.4 Corresponding analysis keywords

*CLAY PLASTICITY

26.17 CombinedTestData object

The CombinedTestData object specifies simultaneously the normalized shear and bulk compliances or
relaxation moduli as functions of time.

Access
import material
mdb.models[name].materials[name].viscoelastic.combinedTestData
import odbMaterial
session.odbs[name].materials[name].viscoelastic.combinedTestData

26.17.1 CombinedTestData(...)
This method creates a CombinedTestData object.

26–38

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].viscoelastic.CombinedTestData
session.odbs[name].materials[name].viscoelastic.CombinedTestData

Required argument
table
A sequence of sequences of Floats specifying the items described below. The values of the table
data depend on the value of the time member of the Viscoelastic object.
Optional arguments
volinf
None or a Float specifying a normalized volume. The value of volinf depends on the value of the
time member of the Viscoelastic object. The default value is None.
If time=RELAXATION_TEST_DATA, volinf specifies the value of the long-term normalized
volumetric modulus, .
If time=CREEP_TEST_DATA, volinf specifies the value of the long-term normalized
volumetric compliance, .
shrinf
None or a Float specifying a normalized shear. The value of shrinf depends on the value of the
time member of the Viscoelastic object. The default value is None.
If time=RELAXATION_TEST_DATA, shrinf specifies the value of the long-term normalized
shear modulus, .
If time=CREEP_TEST_DATA, shrinf specifies the value of the long-term normalized shear
compliance, .
Table data
If time=RELAXATION_TEST_DATA, the table data specify the following:
• Normalized shear modulus, .
• Normalized volumetric (bulk) modulus, .
• Time .
If time=CREEP_TEST_DATA, the table data specify the following:
• Normalized shear compliance, .
• Normalized volumetric (bulk) compliance, .
• Time .

Return value
A CombinedTestData object.

26–39

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
None.

26.17.2 setValues(...)
This method modifies the CombinedTestData object.

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

Return value
None

Exceptions
None.

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

26.17.4 Corresponding analysis keywords

*COMBINED TEST DATA

26.18 Concrete object

The Concrete object defines concrete properties beyond the elastic range.

Access
import material

26–40

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

mdb.models[name].materials[name].concrete
import odbMaterial
session.odbs[name].materials[name].concrete

26.18.1 Concrete(...)
This method creates a Concrete object.

Path
mdb.models[name].materials[name].Concrete
session.odbs[name].materials[name].Concrete

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Absolute value of compressive stress.

• Absolute value of plastic strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Concrete object.

Exceptions
RangeError.

26.18.2 setValues(...)
This method modifies the Concrete object.

26–41

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

26.18.3 Members
The Concrete object has members with the same names and descriptions as the arguments to the
Concrete method.
In addition, the Concrete object can have the following members:
failureRatios
A FailureRatios object.
shearRetention
A ShearRetention object.
tensionStiffening
A TensionStiffening object.

26.18.4 Corresponding analysis keywords

*CONCRETE

26.19 ConcreteCompressionDamage object

The ConcreteCompressionDamage object specifies hardening for the concrete damaged plasticity model.

Access
import material
mdb.models[name].materials[name].concreteDamagedPlasticity\

26–42

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

.concreteCompressionDamage
import odbMaterial
session.odbs[name].materials[name].concreteDamagedPlasticity\
.concreteCompressionDamage

26.19.1 ConcreteCompressionDamage(...)
This method creates a ConcreteCompressionDamage object.

Path
mdb.models[name].materials[name].concreteDamagedPlasticity\
.ConcreteCompressionDamage
session.odbs[name].materials[name].concreteDamagedPlasticity\
.ConcreteCompressionDamage

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
tensionRecovery
A Float specifying the value of the stiffness recovery factor, , that determines the amount of
tension stiffness that is recovered as loading changes from compression to tension. The default
value is 0.0.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Compressive damage variable, .

• Inelastic (crushing) strain, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConcreteCompressionDamage object.

26–43

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
RangeError.

26.19.2 setValues(...)
This method modifies the ConcreteCompressionDamage object.

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

Return value
None

Exceptions
RangeError.

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

26.19.4 Corresponding analysis keywords

*CONCRETE COMPRESSION DAMAGE

26.20 ConcreteCompressionHardening object

The ConcreteCompressionHardening object specifies hardening for the concrete damaged plasticity
model.

26–44

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].concreteDamagedPlasticity\
.concreteCompressionHardening
import odbMaterial
session.odbs[name].materials[name].concreteDamagedPlasticity\
.concreteCompressionHardening

26.20.1 ConcreteCompressionHardening(...)
This method creates a ConcreteCompressionHardening object.

Path
mdb.models[name].materials[name].concreteDamagedPlasticity\
.ConcreteCompressionHardening
session.odbs[name].materials[name].concreteDamagedPlasticity\
.ConcreteCompressionHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
rate
A Boolean specifying whether the data depend on rate. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Yield stress in compression, .

• Inelastic (crushing) strain, .
• Inelastic (crushing) strain rate, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

26–45

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A ConcreteCompressionHardening object.

Exceptions
RangeError.

26.20.2 setValues(...)
This method modifies the ConcreteCompressionHardening object.

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

Return value
None

Exceptions
RangeError.

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

26.20.4 Corresponding analysis keywords

*CONCRETE COMPRESSION HARDENING

26.21 ConcreteDamagedPlasticity object

The ConcreteDamagedPlasticity object specifies the concrete damaged plasticity model.

26–46

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].concreteDamagedPlasticity
import odbMaterial
session.odbs[name].materials[name].concreteDamagedPlasticity

26.21.1 ConcreteDamagedPlasticity(...)
This method creates a ConcreteDamagedPlasticity object.

Path
mdb.models[name].materials[name].ConcreteDamagedPlasticity
session.odbs[name].materials[name].ConcreteDamagedPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
The table data specify the following:
• Dilation angle, (in degrees) in the – plane.
• Flow potential eccentricity, . The default value is 0.1.
• , the ratio of initial equibiaxial compressive yield stress to initial uniaxial compressive yield
stress. The default value is 1.16.
• , the ratio of the second stress invariant on the tensile meridian, to that on the compressive
meridian, at initial yield for any given value of the pressure invariant such that the maximum
principal stress is negative. The default value is 2/3.
• Viscosity parameter, , used for the viscoplastic regularization of the concrete constitutive equations
in an Abaqus/Standard analysis. This parameter is ignored in an Abaqus/Explicit analysis. The
default value is 0.0.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.

26–47

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Etc.

Return value
A ConcreteDamagedPlasticity object.

Exceptions
RangeError.

26.21.2 setValues(...)
This method modifies the ConcreteDamagedPlasticity object.

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

Return value
None

Exceptions
RangeError.

26.21.3 Members
The ConcreteDamagedPlasticity object has members with the same names and descriptions as the
arguments to the ConcreteDamagedPlasticity method.
In addition, the ConcreteDamagedPlasticity object can have the following members:
concreteCompressionHardening
A ConcreteCompressionHardening object.
concreteTensionStiffening
A ConcreteTensionStiffening object.
concreteCompressionDamage
A ConcreteCompressionDamage object.
concreteTensionDamage
A ConcreteTensionDamage object.

26–48

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.21.4 Corresponding analysis keywords

*CONCRETE DAMAGED PLASTICITY

26.22 ConcreteTensionDamage object

The ConcreteTensionDamage object specifies hardening for the concrete damaged plasticity model.

Access
import material
mdb.models[name].materials[name].concreteDamagedPlasticity\
.concreteTensionDamage
import odbMaterial
session.odbs[name].materials[name].concreteDamagedPlasticity\
.concreteTensionDamage

26.22.1 ConcreteTensionDamage(...)
This method creates a ConcreteTensionDamage object.

Path
mdb.models[name].materials[name].concreteDamagedPlasticity\
.ConcreteTensionDamage
session.odbs[name].materials[name].concreteDamagedPlasticity\
.ConcreteTensionDamage

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
compressionRecovery
A Float specifying the value of the stiffness recovery factor, , that determines the amount of
compression stiffness that is recovered as loading changes from tension to compression. The
default value is 1.0.

26–49

Abaqus ID:
Printed on:
MATERIAL COMMANDS

type
A SymbolicConstant specifying the type of tensile damage data. Set type=STRAIN to specify the
tensile damage variable as a function of cracking strain. Set type=DISPLACEMENT to specify
the tensile damage variable as a function of cracking displacement. Possible values are STRAIN
and DISPLACEMENT. The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=STRAIN, the table data specify the following:
• Tensile damage variable, .
• Direct cracking strain, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, the table data specify the following:
• Tensile damage variable, .
• Direct cracking displacement, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConcreteTensionDamage object.

Exceptions
RangeError.

26.22.2 setValues(...)
This method modifies the ConcreteTensionDamage object.

26–50

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.22.4 Corresponding analysis keywords

*CONCRETE TENSION DAMAGE

26.23 ConcreteTensionStiffening object

The ConcreteTensionStiffening object specifies hardening for the concrete damaged plasticity model.

Access
import material
mdb.models[name].materials[name].concreteDamagedPlasticity\
.concreteTensionStiffening
import odbMaterial
session.odbs[name].materials[name].concreteDamagedPlasticity\
.concreteTensionStiffening

26–51

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.23.1 ConcreteTensionStiffening(...)
This method creates a ConcreteTensionStiffening object.

Path
mdb.models[name].materials[name].concreteDamagedPlasticity\
.ConcreteTensionStiffening
session.odbs[name].materials[name].concreteDamagedPlasticity\
.ConcreteTensionStiffening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
rate
A Boolean specifying whether the data depend on rate. The default value is OFF.
type
A SymbolicConstant specifying the type of postcracking behavior data. Possible values are:
• STRAIN, specifying postfailure stress as a function of cracking strain.
• DISPLACEMENT, specifying postfailure stress as a function of cracking displacement.
• GFI, specifying failure stress as a function of the fracture energy.
The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=STRAIN, the table data specify the following:
• Remaining direct stress after cracking, .
• Direct cracking strain, .
• Direct cracking strain rate, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, the table data specify the following:

26–52

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Remaining direct stress after cracking, .

• Direct cracking displacement, .
• Direct cracking displacement rate, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=GFI, the table data specify the following:

• Failure stress, .
• Fracture energy, .
• Direct cracking displacement rate, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A ConcreteTensionStiffening object.

Exceptions
RangeError.

26.23.2 setValues(...)
This method modifies the ConcreteTensionStiffening object.

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

Return value
None

26–53

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
RangeError.

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

26.23.4 Corresponding analysis keywords

*CONCRETE TENSION STIFFENING

26.24 Conductivity object

The Conductivity object specifies thermal conductivity.

Access
import material
mdb.models[name].materials[name].conductivity
import odbMaterial
session.odbs[name].materials[name].conductivity

26.24.1 Conductivity(...)
This method creates a Conductivity object.

Path
mdb.models[name].materials[name].Conductivity
session.odbs[name].materials[name].Conductivity

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–54

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
type
A SymbolicConstant specifying the type of conductivity. Possible values are ISOTROPIC,
ORTHOTROPIC, and ANISOTROPIC. The default value is ISOTROPIC.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=ISOTROPIC, the table data specify the following:
• Conductivity, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ANISOTROPIC, the table data specify the following:
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

26–55

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A Conductivity object.

Exceptions
RangeError.

26.24.2 setValues(...)
This method modifies the Conductivity object.

Arguments

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

Return value
None

Exceptions
RangeError.

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

26.24.4 Corresponding analysis keywords

*CONDUCTIVITY

26–56

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.25 ContactArea object

A ContactArea object specifies a suboption of gasket thickness behavior when variableUnits=FORCE on

the GasketThicknessBehavior object. The ContactArea object defines the contact area or contact width
versus closure curves to output an average pressure through variable CS11.

Access
import material
mdb.models[name].materials[name].gasketThicknessBehavior.contactArea
import odbMaterial
session.odbs[name].materials[name].gasketThicknessBehavior.contactArea

26.25.1 ContactArea(...)
This method creates a ContactArea object.

Path
mdb.models[name].materials[name].gasketThicknessBehavior.ContactArea
session.odbs[name].materials[name].gasketThicknessBehavior.ContactArea

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether contact area data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies included in the definition of the contact
area data, in addition to temperature. The default value is 0.
Table data

• Contact area or width; this value must be positive.

• Closure; this value must be positive.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.

26–57

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Etc.

Return value
A ContactArea object.

Exceptions
None.

26.25.2 setValues(...)
This method modifies the ContactArea object.

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

Return value
None

Exceptions
None.

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

26.25.4 Corresponding analysis keywords

*GASKET CONTACT AREA

26.26 Creep object

The Creep object defines a creep law.

26–58

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].creep
import odbMaterial
session.odbs[name].materials[name].creep

26.26.1 Creep(...)
This method creates a Creep object.

Path
mdb.models[name].materials[name].Creep
session.odbs[name].materials[name].Creep

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
law
A SymbolicConstant specifying the strain-hardening law. Possible values are STRAIN, TIME,
HYPERBOLIC_SINE, and USER. The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If law=STRAIN or law=TIME, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If law=HYPERBOLIC_SINE, the table data specify the following:
• .

26–59

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• .
• , if the data depend on temperature.
• .
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Creep object.

Exceptions
RangeError.

26.26.2 setValues(...)
This method modifies the Creep object.

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

Return value
None

Exceptions
RangeError.

26.26.3 Members
The Creep object has members with the same names and descriptions as the arguments to the Creep
method.
In addition, the Creep object can have the following members:
ornl
An Ornl object.

26–60

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

potential
A Potential object.

26.26.4 Corresponding analysis keywords

*CREEP

26.27 CrushableFoam object

The CrushableFoam object specifies the crushable foam plasticity model.

Access
import material
mdb.models[name].materials[name].crushableFoam
import odbMaterial
session.odbs[name].materials[name].crushableFoam

26.27.1 CrushableFoam(...)
This method creates a CrushableFoam object.

Path
mdb.models[name].materials[name].CrushableFoam
session.odbs[name].materials[name].CrushableFoam

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
hardening
A SymbolicConstant specifying the type of hardening/softening definition. Possible values are
VOLUMETRIC and ISOTROPIC. The default value is VOLUMETRIC.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–61

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Table data
If hardening=VOLUMETRIC, the table data specify the following:
• Ratio, , of initial yield stress in uniaxial compression, , to initial yield stress in hydrostatic
compression, ; 0.0 3.0.
• Ratio, , of yield stress in hydrostatic tension, , to initial yield stress in hydrostatic compression,
. The default value is 1.0.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If hardening=ISOTROPIC, the table data specify the following:
• Ratio, , of initial yield stress in uniaxial compression, , to initial yield stress in hydrostatic
compression, ; 0.0 3.0.
• Plastic Poisson’s ratio. ; -1 0.5.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CrushableFoam object.

Exceptions
RangeError.

26.27.2 setValues(...)
This method modifies the CrushableFoam object.

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

Return value
None

26–62

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

26.27.3 Members
The CrushableFoam object has members with the same names and descriptions as the arguments to the
CrushableFoam method.
In addition, the CrushableFoam object can have the following members:
crushableFoamHardening
A CrushableFoamHardening object.
rateDependent
A RateDependent object.

26.27.4 Corresponding analysis keywords

*CRUSHABLE FOAM

26.28 CrushableFoamHardening object

The CrushableFoamHardening object specifies hardening for the crushable foam plasticity model.

Access
import material
mdb.models[name].materials[name].crushableFoam.crushableFoamHardening
import odbMaterial
session.odbs[name].materials[name].crushableFoam\
.crushableFoamHardening

26.28.1 CrushableFoamHardening(...)
This method creates a CrushableFoamHardening object.

Path
mdb.models[name].materials[name].crushableFoam.CrushableFoamHardening
session.odbs[name].materials[name].crushableFoam\
.CrushableFoamHardening

26–63

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• The yield stress in uniaxial compression, .

• The absolute value of the corresponding plastic strain.(The first tabular value entered must always
be zero.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CrushableFoamHardening object.

Exceptions
RangeError.

26.28.2 setValues(...)
This method modifies the CrushableFoamHardening object.

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

26–64

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
None

Exceptions
RangeError.

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

26.28.4 Corresponding analysis keywords

*CRUSHABLE FOAM HARDENING

26.29 CycledPlastic object

The CycledPlastic object specifies cycled yield stress data for the ORNL constitutive model.

Access
import material
mdb.models[name].materials[name].plastic.cycledPlastic
import odbMaterial
session.odbs[name].materials[name].plastic.cycledPlastic

26.29.1 CycledPlastic(...)
This method creates a CycledPlastic object.

Path
mdb.models[name].materials[name].plastic.CycledPlastic
session.odbs[name].materials[name].plastic.CycledPlastic

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–65

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional argument
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
Table data

• Yield stress.
• Plastic strain.
• Temperature, if the data depend on temperature.

Return value
A CycledPlastic object.

Exceptions
None.

26.29.2 setValues(...)
This method modifies the CycledPlastic object.

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

Return value
None

Exceptions
None.

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

26.29.4 Corresponding analysis keywords

26–66

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

*CYCLED PLASTIC

26.30 CyclicHardening object

The CyclicHardening object defines the evolution of the elastic domain for the nonlinear
isotropic/kinematic hardening model.

Access
import material
mdb.models[name].materials[name].plastic.cyclicHardening
import odbMaterial
session.odbs[name].materials[name].plastic.cyclicHardening

26.30.1 CyclicHardening(...)
This method creates a CyclicHardening object.

Path
mdb.models[name].materials[name].plastic.CyclicHardening
session.odbs[name].materials[name].plastic.CyclicHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
parameters
A Boolean specifying whether material parameters are to be input directly. The default value is
OFF.
Table data

• Equivalent stress.
• (only if parameters=ON).

26–67

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Hardening parameter (only if parameters=ON).

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A CyclicHardening object.

Exceptions
None.

26.30.2 setValues(...)
This method modifies the CyclicHardening object.

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

Return value
None

Exceptions
None.

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

26.30.4 Corresponding analysis keywords

*CYCLIC HARDENING

26–68

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.31 DamageEvolution object

The DamageEvolution object specifies material properties to define the evolution of damage.

Access
import material
mdb.models[name].materials[name].ductileDamageInitiation\
.damageEvolution
mdb.models[name].materials[name].fldDamageInitiation.damageEvolution
mdb.models[name].materials[name].flsdDamageInitiation.damageEvolution
mdb.models[name].materials[name].hashinDamageInitiation\
.damageEvolution
mdb.models[name].materials[name].johnsonCookDamageInitiation\
.damageEvolution
mdb.models[name].materials[name].maxeDamageInitiation.damageEvolution
mdb.models[name].materials[name].maxpeDamageInitiation.damageEvolution
mdb.models[name].materials[name].maxpsDamageInitiation.damageEvolution
mdb.models[name].materials[name].maxsDamageInitiation.damageEvolution
mdb.models[name].materials[name].mkDamageInitiation.damageEvolution
mdb.models[name].materials[name].msfldDamageInitiation.damageEvolution
mdb.models[name].materials[name].quadeDamageInitiation.damageEvolution
mdb.models[name].materials[name].quadsDamageInitiation.damageEvolution
mdb.models[name].materials[name].shearDamageInitiation.damageEvolution
import odbMaterial
session.odbs[name].materials[name].ductileDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].fldDamageInitiation.damageEvolution
session.odbs[name].materials[name].flsdDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].hashinDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].johnsonCookDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].maxeDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].maxpeDamageInitiation\
.damageEvolution

26–69

Abaqus ID:
Printed on:
MATERIAL COMMANDS

session.odbs[name].materials[name].maxpsDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].maxsDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].mkDamageInitiation.damageEvolution
session.odbs[name].materials[name].msfldDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].quadeDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].quadsDamageInitiation\
.damageEvolution
session.odbs[name].materials[name].shearDamageInitiation\
.damageEvolution

26.31.1 DamageEvolution(...)
This method creates an DamageEvolution object.

Path
mdb.models[name].materials[name].ductileDamageInitiation\
.DamageEvolution
mdb.models[name].materials[name].fldDamageInitiation.DamageEvolution
mdb.models[name].materials[name].flsdDamageInitiation.DamageEvolution
mdb.models[name].materials[name].hashinDamageInitiation\
.DamageEvolution
mdb.models[name].materials[name].johnsonCookDamageInitiation\
.DamageEvolution
mdb.models[name].materials[name].maxeDamageInitiation.DamageEvolution
mdb.models[name].materials[name].maxpeDamageInitiation.DamageEvolution
mdb.models[name].materials[name].maxpsDamageInitiation.DamageEvolution
mdb.models[name].materials[name].maxsDamageInitiation.DamageEvolution
mdb.models[name].materials[name].mkDamageInitiation.DamageEvolution
mdb.models[name].materials[name].msfldDamageInitiation.DamageEvolution
mdb.models[name].materials[name].quadeDamageInitiation.DamageEvolution
mdb.models[name].materials[name].quadsDamageInitiation.DamageEvolution
mdb.models[name].materials[name].shearDamageInitiation.DamageEvolution
session.odbs[name].materials[name].ductileDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].fldDamageInitiation.DamageEvolution
session.odbs[name].materials[name].flsdDamageInitiation\
.DamageEvolution

26–70

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

session.odbs[name].materials[name].hashinDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].johnsonCookDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].maxeDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].maxpeDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].maxpsDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].maxsDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].mkDamageInitiation.DamageEvolution
session.odbs[name].materials[name].msfldDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].quadeDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].quadsDamageInitiation\
.DamageEvolution
session.odbs[name].materials[name].shearDamageInitiation\
.DamageEvolution

Required arguments
type
A SymbolicConstant specifying the type of damage evolution. Possible values are
DISPLACEMENT and ENERGY.
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
degradation
A SymbolicConstant specifying the degradation. Possible values are MAXIMUM and
MULTIPLICATIVE. The default value is MAXIMUM.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
mixedModeBehavior
A SymbolicConstant specifying the mixed mode behavior. Possible values are
MODE_INDEPENDENT, TABULAR, POWER_LAW, and BK. The default value is
MODE_INDEPENDENT.

26–71

Abaqus ID:
Printed on:
MATERIAL COMMANDS

modeMixRatio
A SymbolicConstant specifying the mode mix ratio. Possible values are ENERGY and
TRACTION. The default value is ENERGY.
power
None or a Float specifying the exponent in the power law or the Benzeggagh-Kenane criterion
that defines the variation of fracture energy with mode mix for cohesive elements. The default
value is None.
softening
A SymbolicConstant specifying the softening. Possible values are LINEAR, EXPONENTIAL,
and TABULAR. The default value is LINEAR.
Table data
If type=DISPLACEMENT, and softening=LINEAR, and
mixedModeBehavior=MODE_INDEPENDENT, the table data specify the following:
• Equivalent total or plastic displacement at failure, measured from the time of damage initiation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ENERGY, and softening=LINEAR, and mixedModeBehavior=MODE_INDEPENDENT, the
table data specify the following:
• Fracture energy.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, and softening=LINEAR, and mixedModeBehavior=TABULAR, the table
data specify the following:
• Total displacement at failure, measured from the time of damage initiation.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three-dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ENERGY, and softening=LINEAR, and mixedModeBehavior=TABULAR, the table data specify
the following:

26–72

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Fracture energy.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three-dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, and softening=EXPONENTIAL, and
mixedModeBehavior=MODE_INDEPENDENT, the table data specify the following:
• Equivalent total or plastic displacement at failure, measured from the time of damage initiation.
• Exponential law parameter.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ENERGY, and softening=EXPONENTIAL, and
mixedModeBehavior=MODE_INDEPENDENT, the table data specify the following:
• Fracture energy.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, and softening=EXPONENTIAL, and mixedModeBehavior=TABULAR, the
table data specify the following:
• Total displacement at failure, measured from the time of damage initiation.
• Exponential law parameter.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three-dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

26–73

Abaqus ID:
Printed on:
MATERIAL COMMANDS

If type=ENERGY, and softening=EXPONENTIAL, and mixedModeBehavior=TABULAR, the table data

specify the following:
• Fracture energy.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three-dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, and softening=TABULAR, and
mixedModeBehavior=MODE_INDEPENDENT, the table data specify the following:
• Damage variable.
• Equivalent total or plastic displacement, measured from the time of damage initiation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, and softening=TABULAR, and mixedModeBehavior=TABULAR, the table
data specify the following:
• Damage variable.
• Equivalent total or plastic displacement, measured from the time of damage initiation.
• Appropriate mode mix ratio.
• Appropriate mode mix ratio (if relevant, for three-dimensional problems with anisotropic shear
behavior).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ENERGY, and softening=LINEAR or EXPONENTIAL, and
mixedModeBehavior=POWER_LAW or BK, the table data specify the following:
• Normal mode fracture energy.
• Shear mode fracture energy for failure in the first shear direction.
• Shear mode fracture energy for failure in the second shear direction.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–74

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Value of the second field variable.

• Etc.
If type=ENERGY, softening=LINEAR and constructor for DamageInitiation
=HashinDamageInitiation the table data specify the following:
• Fiber tensile fracture energy.
• Fiber compressive fracture energy.
• Matrix tensile fracture energy.
• Matrix compressive fracture energy.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A DamageEvolution object.

Exceptions
RangeError.

26.31.2 setValues(...)
This method modifies the DamageEvolution object.

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

Return value
None

Exceptions
RangeError.

26–75

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

26.31.4 Corresponding analysis keywords

*DAMAGE EVOLUTION

26.32 DamageInitiation object

The DamageInitiation object specifies material properties to define the initiation of damage.

Access
import material
mdb.models[name].materials[name].ductileDamageInitiation
mdb.models[name].materials[name].fldDamageInitiation
mdb.models[name].materials[name].flsdDamageInitiation
mdb.models[name].materials[name].hashinDamageInitiation
mdb.models[name].materials[name].johnsonCookDamageInitiation
mdb.models[name].materials[name].maxeDamageInitiation
mdb.models[name].materials[name].maxpeDamageInitiation
mdb.models[name].materials[name].maxpsDamageInitiation
mdb.models[name].materials[name].maxsDamageInitiation
mdb.models[name].materials[name].mkDamageInitiation
mdb.models[name].materials[name].msfldDamageInitiation
mdb.models[name].materials[name].quadeDamageInitiation
mdb.models[name].materials[name].quadsDamageInitiation
mdb.models[name].materials[name].shearDamageInitiation
import odbMaterial
session.odbs[name].materials[name].ductileDamageInitiation
session.odbs[name].materials[name].fldDamageInitiation
session.odbs[name].materials[name].flsdDamageInitiation
session.odbs[name].materials[name].hashinDamageInitiation
session.odbs[name].materials[name].johnsonCookDamageInitiation
session.odbs[name].materials[name].maxeDamageInitiation
session.odbs[name].materials[name].maxpeDamageInitiation

26–76

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

session.odbs[name].materials[name].maxpsDamageInitiation
session.odbs[name].materials[name].maxsDamageInitiation
session.odbs[name].materials[name].mkDamageInitiation
session.odbs[name].materials[name].msfldDamageInitiation
session.odbs[name].materials[name].quadeDamageInitiation
session.odbs[name].materials[name].quadsDamageInitiation
session.odbs[name].materials[name].shearDamageInitiation

26.32.1 DuctileDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].DuctileDamageInitiation
session.odbs[name].materials[name].DuctileDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.

26–77

Abaqus ID:
Printed on:
MATERIAL COMMANDS

numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.
Table data
If constructor is DuctileDamageInitiation, the table data specify the following:
• Equivalent fracture strain at damage initiation.
• Stress triaxiality.
• Strain rate.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is FldDamageInitiation, the table data specify the following:
• Major principal strain at damage initiation.
• Minor principal strain.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor FlsdDamageInitiation, the table data specify the following:

26–78

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Major principal stress at damage initiation.

• Minor principal stress.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is JohnsonCookDamageInitiation, the table data specify the following:
• Johnson-Cook failure parameter D1.
• Johnson-Cook failure parameter D2.
• Johnson-Cook failure parameter D3.
• Johnson-Cook failure parameter D4.
• Johnson-Cook failure parameter D5.
• Melting temperature.
• Transition temperature.
• Reference strain rate.
If constructor MkDamageInitiation, the table data specify the following:
• Flaw size relative to nominal thickness of the section.
• Angle (in degrees) with respect to the 1-direction of the local material orientation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is MsfldDamageInitiation and definition=MSFLD, the table data specify the
following:
• Nominal strain at damage initiation in a normal-only mode.
• Equivalent plastic strain at initiation of localized necking.
• Ratio of minor to major principal strains.
• Equivalent plastic strain rate.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is MsfldDamageInitiation and definition=FLD, the table data specify the following:
• Major principal strain at initiation of localized necking.
• Equivalent plastic strain at initiation of localized necking.

26–79

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Ratio of minor to major principal strains.

• Equivalent plastic strain rate.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is QuadeDamageInitiation or MaxeDamageInitiation, the table data specify
the following:
• Nominal strain at damage initiation in a normal-only mode.
• Nominal strain at damage initiation in a shear-only mode that involves separation only along the
first shear direction.
• Nominal strain at damage initiation in a shear-only mode that involves separation only along the
second shear direction.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is QuadsDamageInitiation or MaxsDamageInitiation, the table data specify
the following:
• Nominal strain at damage initiation in a normal-only mode.
• Nominal strain at damage initiation in a shear-only mode that involves separation only along the
first shear direction.
• Nominal strain at damage initiation in a shear-only mode that involves separation only along the
second shear direction.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is MaxpeDamageInitiation, the table data specify the following:
• Maximum principal strain at damage initiation.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is MaxpsDamageInitiation, the table data specify the following:

26–80

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Maximum principal stress at damage initiation.

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is ShearDamageInitiation, the table data specify the following:
• Equivalent fracture strain at damage initiation.
• Shear stress ratio.
• Strain rate.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If constructor is HashinDamageInitiation, the table data specify the following:
• Fiber tensile strength.
• Fiber compressive strength.
• Matrix tensile strength.
• Matrix compressive strength.
• Longitudinal shear strength.
• Transverse shear strength.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.2 FldDamageInitiation(...)
This method creates a DamageInitiation object.

26–81

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].FldDamageInitiation
session.odbs[name].materials[name].FldDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–82

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.3 FlsdDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].FlsdDamageInitiation
session.odbs[name].materials[name].FlsdDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.

26–83

Abaqus ID:
Printed on:
MATERIAL COMMANDS

fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.4 JohnsonCookDamageInitiation(...)
This method creates a DamageInitiation object.

26–84

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].JohnsonCookDamageInitiation
session.odbs[name].materials[name].JohnsonCookDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–85

Abaqus ID:
Printed on:
MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.5 MaxeDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].MaxeDamageInitiation
session.odbs[name].materials[name].MaxeDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.

26–86

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.6 MaxsDamageInitiation(...)
This method creates a DamageInitiation object.

26–87

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].MaxsDamageInitiation
session.odbs[name].materials[name].MaxsDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–88

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.7 MkDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].MkDamageInitiation
session.odbs[name].materials[name].MkDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.

26–89

Abaqus ID:
Printed on:
MATERIAL COMMANDS

fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.8 MsfldDamageInitiation(...)
This method creates a DamageInitiation object.

26–90

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].MsfldDamageInitiation
session.odbs[name].materials[name].MsfldDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–91

Abaqus ID:
Printed on:
MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.9 QuadeDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].QuadeDamageInitiation
session.odbs[name].materials[name].QuadeDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.

26–92

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.10 QuadsDamageInitiation(...)
This method creates a DamageInitiation object.

26–93

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].QuadsDamageInitiation
session.odbs[name].materials[name].QuadsDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–94

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.11 MaxpeDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].MaxpeDamageInitiation
session.odbs[name].materials[name].MaxpeDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.

26–95

Abaqus ID:
Printed on:
MATERIAL COMMANDS

fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.12 MaxpsDamageInitiation(...)
This method creates a DamageInitiation object.

26–96

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].MaxpsDamageInitiation
session.odbs[name].materials[name].MaxpsDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–97

Abaqus ID:
Printed on:
MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.13 ShearDamageInitiation(...)
This method creates a DamageInitiation object.

Path
mdb.models[name].materials[name].ShearDamageInitiation
session.odbs[name].materials[name].ShearDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.

26–98

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.14 HashinDamageInitiation(...)
This method creates a DamageInitiation object.

26–99

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].HashinDamageInitiation
session.odbs[name].materials[name].HashinDamageInitiation

Required argument
table
A sequence of sequences of Floats specifying the items described in the "Table data" section.
Optional arguments
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.
feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.

26–100

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.

Return value
A DamageInitiation object.

Exceptions
RangeError.

26.32.15 setValues(...)
This method modifies the DamageInitiation object.

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

Return value
None

Exceptions
None.

26.32.16 Members
The DamageInitiation object can have the following members:
definition
A SymbolicConstant specifying the damage initiation definition. Possible values are FLD and
MSFLD. The default value is MSFLD.

26–101

Abaqus ID:
Printed on:
MATERIAL COMMANDS

feq
A Float specifying the critical value of the deformation severity index for equivalent plastic strains.
The default value is 10.0.
fnn
A Float specifying the critical value of the deformation severity index for strains normal to the
groove direction. The default value is 10.0.
fnt
A Float specifying the critical value of the deformation severity index for shear strains. The default
value is 10.0.
frequency
An Int specifying the frequency, in increments, at which the Marciniak-Kuczynski analysis is going
to be performed. The default value is 1.
ks
A Float specifying the value of Ks. The default value is 0.0.
numberImperfections
An Int specifying the number of imperfections to be considered for the evaluation of the Marciniak-
Kuczynski analysis. These imperfections are assumed to be equally spaced in the angular direction.
The default value is 4.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
alpha
A Float specifying the value of the coefficient that will multiply the shear contribution to the
Hashin’s fiber initiation criterion. The default value is 0.0.
omega
A Float specifying the factor used for filtering the ratio of principal strain rates used for the
evaluation of the MSFLD damage initiation criterion. The default value is 1.0.
tolerance
A Float specifying the tolerance within which the damage initiation criterion must be satisfied.
The default value is 0.05.
direction
A SymbolicConstant specifying the damage initiation direction. Possible values are NMORI and
TMORI. The default value is NMORI.
table
A tuple of tuples of Floats specifying the items described in the "Table data" section.
damageEvolution
A DamageEvolution object.

26–102

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

damageStabilization
A DamageStabilization object.
damageStabilizationCohesive
A DamageStabilizationCohesive object.

26.32.17 Corresponding analysis keywords

*DAMAGE INITIATION

26.33 DamageStabilization object

The DamageStabilization object specifies the viscosity coefficients for the damage model for
fiber-reinforced materials.

Access
import material
mdb.models[name].materials[name].ductileDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].fldDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].flsdDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].hashinDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].johnsonCookDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].maxeDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].maxpeDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].maxpsDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].maxsDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].mkDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].msfldDamageInitiation\

26–103

Abaqus ID:
Printed on:
MATERIAL COMMANDS

.damageStabilization
mdb.models[name].materials[name].quadeDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].quadsDamageInitiation\
.damageStabilization
mdb.models[name].materials[name].shearDamageInitiation\
.damageStabilization
import odbMaterial
session.odbs[name].materials[name].ductileDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].fldDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].flsdDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].hashinDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].johnsonCookDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].maxeDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].maxpeDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].maxpsDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].maxsDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].mkDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].msfldDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].quadeDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].quadsDamageInitiation\
.damageStabilization
session.odbs[name].materials[name].shearDamageInitiation\
.damageStabilization

26.33.1 DamageStabilization(...)
This method creates a DamageStabilization object.

26–104

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].ductileDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].fldDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].flsdDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].hashinDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].johnsonCookDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].maxeDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].maxpeDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].maxpsDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].maxsDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].mkDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].msfldDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].quadeDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].quadsDamageInitiation\
.DamageStabilization
mdb.models[name].materials[name].shearDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].ductileDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].fldDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].flsdDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].hashinDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].johnsonCookDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].maxeDamageInitiation\

26–105

Abaqus ID:
Printed on:
MATERIAL COMMANDS

.DamageStabilization
session.odbs[name].materials[name].maxpeDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].maxpsDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].maxsDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].mkDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].msfldDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].quadeDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].quadsDamageInitiation\
.DamageStabilization
session.odbs[name].materials[name].shearDamageInitiation\
.DamageStabilization

Required arguments
fiberTensileCoeff
A Float specifying the viscosity coefficient for the fiber tensile failure mode.
fiberCompressiveCoeff
A Float specifying the viscosity coefficient for the fiber compressive failure mode.
matrixTensileCoeff
A Float specifying the viscosity coefficient for the matrix tensile failure mode.
matrixCompressiveCoeff
A Float specifying the viscosity coefficient for the matrix compressive failure mode.
Optional arguments
None.

Return value
A DamageStabilization object.

Exceptions
RangeError.

26.33.2 setValues(...)
This method modifies the DamageStabilization object.

26–106

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.33.4 Corresponding analysis keywords

*DAMAGE STABILIZATION

26.34 DamageStabilizationCohesive object

The DamageStabilizationCohesive object specifies the viscosity coefficients for the damage model for
surface-based cohesive behavior or enriched cohesive behavior.

Access
import material
mdb.models[name].materials[name].ductileDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].fldDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].flsdDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].hashinDamageInitiation\

26–107

Abaqus ID:
Printed on:
MATERIAL COMMANDS

.damageStabilizationCohesive
mdb.models[name].materials[name].johnsonCookDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].maxeDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].maxpeDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].maxpsDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].maxsDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].mkDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].msfldDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].quadeDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].quadsDamageInitiation\
.damageStabilizationCohesive
mdb.models[name].materials[name].shearDamageInitiation\
.damageStabilizationCohesive
import odbMaterial
session.odbs[name].materials[name].ductileDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].fldDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].flsdDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].hashinDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].johnsonCookDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].maxeDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].maxpeDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].maxpsDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].maxsDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].mkDamageInitiation\

26–108

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

.damageStabilizationCohesive
session.odbs[name].materials[name].msfldDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].quadeDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].quadsDamageInitiation\
.damageStabilizationCohesive
session.odbs[name].materials[name].shearDamageInitiation\
.damageStabilizationCohesive

26.34.1 DamageStabilizationCohesive(...)
This method creates a DamageStabilizationCohesive object.

Path
mdb.models[name].materials[name].ductileDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].fldDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].flsdDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].hashinDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].johnsonCookDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].maxeDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].maxpeDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].maxpsDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].maxsDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].mkDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].msfldDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].quadeDamageInitiation\
.DamageStabilizationCohesive
mdb.models[name].materials[name].quadsDamageInitiation\
.DamageStabilizationCohesive

26–109

Abaqus ID:
Printed on:
MATERIAL COMMANDS

mdb.models[name].materials[name].shearDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].ductileDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].fldDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].flsdDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].hashinDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].johnsonCookDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].maxeDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].maxpeDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].maxpsDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].maxsDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].mkDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].msfldDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].quadeDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].quadsDamageInitiation\
.DamageStabilizationCohesive
session.odbs[name].materials[name].shearDamageInitiation\
.DamageStabilizationCohesive

Required arguments
None.
Optional argument
cohesiveCoeff
None or a Float specifying the viscosity coefficient. The default value is None.

Return value
A DamageStabilizationCohesive object.

26–110

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

26.34.2 setValues(...)
This method modifies the DamageStabilizationCohesive object.

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

Return value
None

Exceptions
RangeError.

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

26.34.4 Corresponding analysis keywords

*DAMAGE STABILIZATION

26.35 Damping object

The Damping object specifies material damping.

Access
import material

26–111

Abaqus ID:
Printed on:
MATERIAL COMMANDS

mdb.models[name].materials[name].damping
import odbMaterial
session.odbs[name].materials[name].damping

26.35.1 Damping(...)
This method creates a Damping object.

Path
mdb.models[name].materials[name].Damping
session.odbs[name].materials[name].Damping

Required arguments
None.
Optional arguments
alpha
A Float specifying the factor to create mass proportional damping in direct-integration and
explicit dynamics. The default value is 0.0.
beta
A Float specifying the factor to create stiffness proportional damping in direct-integration and
explicit dynamics. The default value is 0.0.
composite
A Float specifying the fraction of critical damping to be used with this material in calculating
composite damping factors for the modes (for use in modal dynamics). The default value is 0.0.
This argument applies only to Abaqus/Standard analyses.
structural
A Float specifying the structural factor to create material damping in direct-integration and explicit
dynamics. The default value is 0.0.

Return value
A Damping object.

Exceptions
RangeError.

26.35.2 setValues(...)
This method modifies the Damping object.

26–112

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.35.4 Corresponding analysis keywords

*DAMPING

26.36 DeformationPlasticity object

The DeformationPlasticity object specifies the deformation plasticity model.

Access
import material
mdb.models[name].materials[name].deformationPlasticity
import odbMaterial
session.odbs[name].materials[name].deformationPlasticity

26.36.1 DeformationPlasticity(...)
This method creates a DeformationPlasticity object.

26–113

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].DeformationPlasticity
session.odbs[name].materials[name].DeformationPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional argument
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
Table data

• Young’s modulus, .
• Poisson’s ratio, .
• Yield stress, .
• Exponent, .
• Yield offset, .
• Temperature, if the data depend on temperature.

Return value
A DeformationPlasticity object.

Exceptions
RangeError.

26.36.2 setValues(...)
This method modifies the DeformationPlasticity object.

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

26–114

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
None

Exceptions
RangeError.

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

26.36.4 Corresponding analysis keywords

*DEFORMATION PLASTICITY

26.37 Density object

The Density object specifies the material density.

Access
import material
mdb.models[name].materials[name].density
import odbMaterial
session.odbs[name].materials[name].density

26.37.1 Density(...)
This method creates a Density object.

Path
mdb.models[name].materials[name].Density
session.odbs[name].materials[name].Density

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–115

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• The mass density.

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Density object.

Exceptions
RangeError.

26.37.2 setValues(...)
This method modifies the Density object.

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

Return value
None

Exceptions
RangeError.

26–116

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

26.37.4 Corresponding analysis keywords

*DENSITY

26.38 Depvar object

The Depvar object specifies solution-dependent state variables.

Access
import material
mdb.models[name].materials[name].depvar
import odbMaterial
session.odbs[name].materials[name].depvar

26.38.1 Depvar(...)
This method creates a Depvar object.

Path
mdb.models[name].materials[name].Depvar
session.odbs[name].materials[name].Depvar

Required arguments
None.
Optional arguments
deleteVar
An Int specifying the state variable number controlling the element deletion flag. The default value
is 0.
This argument applies only to Abaqus/Explicit analyses.

26–117

Abaqus ID:
Printed on:
MATERIAL COMMANDS

n
An Int specifying the number of solution-dependent state variables required at each integration
point. The default value is 0.

Return value
A Depvar object.

Exceptions
RangeError.

26.38.2 setValues(...)
This method modifies the Depvar object.

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

Return value
None

Exceptions
RangeError.

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

26.38.4 Corresponding analysis keywords

*DEPVAR

26–118

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.39 DetonationPoint object

A DetonationPoint object specifies a suboption of the Eos object. The DetonationPoint object defines
either isotropic linear elastic shear or linear viscous shear behavior for a hydrodynamic material.

Access
import material
mdb.models[name].materials[name].eos.detonationPoint
import odbMaterial
session.odbs[name].materials[name].eos.detonationPoint

26.39.1 DetonationPoint(...)
This method creates a DetonationPoint object.

Path
mdb.models[name].materials[name].eos.DetonationPoint
session.odbs[name].materials[name].eos.DetonationPoint

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• X value for coordinate of detonation point.

• Y value for coordinate of detonation point.
• Z value for coordinate of detonation point.
• Detonation delay time.

Return value
A DetonationPoint object.

Exceptions
None.

26–119

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.39.2 setValues(...)
This method modifies the DetonationPoint object.

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

Return value
None

Exceptions
None.

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

26.39.4 Corresponding analysis keywords

*DETONATION POINT

26.40 Dielectric object

The Dielectric object specifies dielectric material properties.

Access
import material
mdb.models[name].materials[name].dielectric
import odbMaterial
session.odbs[name].materials[name].dielectric

26–120

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.40.1 Dielectric(...)
This method creates a Dielectric object.

Path
mdb.models[name].materials[name].Dielectric
session.odbs[name].materials[name].Dielectric

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the dielectric behavior. Possible values are ISOTROPIC,
ORTHOTROPIC, and ANISOTROPIC. The default value is ISOTROPIC.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=ISOTROPIC, the table data specify the following:
• Dielectric constant.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ANISOTROPIC, the table data specify the following:
• .

26–121

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Dielectric object.

Exceptions
None.

26.40.2 setValues(...)
This method modifies the Dielectric object.

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

Return value
None

Exceptions
None.

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

26–122

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.40.4 Corresponding analysis keywords

*DIELECTRIC

26.41 Diffusivity object

The Diffusivity object specifies mass diffusivity.

Access
import material
mdb.models[name].materials[name].diffusivity
import odbMaterial
session.odbs[name].materials[name].diffusivity

26.41.1 Diffusivity(...)
This method creates a Diffusivity object.

Path
mdb.models[name].materials[name].Diffusivity
session.odbs[name].materials[name].Diffusivity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the type of diffusivity. Possible values are ISOTROPIC,
ORTHOTROPIC, and ANISOTROPIC. The default value is ISOTROPIC.
law
A SymbolicConstant specifying the diffusion behavior. Possible values are GENERAL and FICK.
The default value is GENERAL.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.

26–123

Abaqus ID:
Printed on:
MATERIAL COMMANDS

dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=ISOTROPIC, the table data specify the following:
• Diffusivity, .
• Concentration, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• Concentration, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ANISOTROPIC, the table data specify the following:
• .
• .
• .
• .
• .
• .
• Concentration, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Diffusivity object.

26–124

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

26.41.2 setValues(...)
This method modifies the Diffusivity object.

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

Return value
None

Exceptions
RangeError.

26.41.3 Members
The Diffusivity object has members with the same names and descriptions as the arguments to the
Diffusivity method.
In addition, the Diffusivity object can have the following members:
pressureEffect
A PressureEffect object.
soretEffect
A SoretEffect object.

26.41.4 Corresponding analysis keywords

*DIFFUSIVITY

26–125

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.42 DruckerPrager object

The DruckerPrager object specifies the extended Drucker-Prager plasticity model.

Access
import material
mdb.models[name].materials[name].druckerPrager
import odbMaterial
session.odbs[name].materials[name].druckerPrager

26.42.1 DruckerPrager(...)
This method creates a DruckerPrager object.

Path
mdb.models[name].materials[name].DruckerPrager
session.odbs[name].materials[name].DruckerPrager

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
shearCriterion
A SymbolicConstant specifying the yield criterion. Possible values are LINEAR, HYPERBOLIC,
and EXPONENTIAL. The default value is LINEAR.
This argument applies only to Abaqus/Standard analyses. Only the linear Drucker-Prager
model is available in Abaqus/Explicit analyses.
eccentricity
A Float specifying the flow potential eccentricity, , a small positive number that defines the rate
at which the hyperbolic flow potential approaches its asymptote. The default value is 0.1.
This argument applies only to Abaqus/Standard analyses.
testData
A Boolean specifying whether the material constants for the exponent model are to be computed
by Abaqus/Standard from triaxial test data at different levels of confining pressure. The default
value is OFF.
This argument is valid only if shearCriterion=EXPONENTIAL.

26–126

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If shearCriterion=LINEAR (the only option allowed in an Abaqus/Explicit analysis), the table data
specify the following:
• Material angle of friction, , in the – plane. Give the value in degrees.
• , the ratio of the flow stress in triaxial tension to the flow stress in triaxial compression.
. If the default value of 0.0 is accepted, a value of 1.0 is assumed.
• Dilation angle, , in the – plane. Give the value in degrees.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If shearCriterion=HYPERBOLIC, the table data specify the following:
• Material angle of friction, , at high confining pressure in the – plane. Give the value in degrees.
• Initial hydrostatic tension strength, .
• Dilation angle, , at high confining pressure in the – plane. Give the value in degrees.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If shearCriterion=EXPONENTIAL, the table data specify the following:
• Dilation angle, , at high confining pressure in the – plane. Give the value in degrees.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A DruckerPrager object.

Exceptions
RangeError.

26–127

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.42.2 setValues(...)
This method modifies the DruckerPrager object.

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

Return value
None

Exceptions
RangeError.

26.42.3 Members
The DruckerPrager object has members with the same names and descriptions as the arguments to the
DruckerPrager method.
In addition, the DruckerPrager object can have the following members:
druckerPragerCreep
A DruckerPragerCreep object.
druckerPragerHardening
A DruckerPragerHardening object.
rateDependent
A RateDependent object.
triaxialTestData
A TriaxialTestData object.

26.42.4 Corresponding analysis keywords

*DRUCKER PRAGER

26–128

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.43 DruckerPragerCreep object

The DruckerPragerCreep object specifies creep for Drucker-Prager plasticity models.

Access
import material
mdb.models[name].materials[name].druckerPrager.druckerPragerCreep
import odbMaterial
session.odbs[name].materials[name].druckerPrager.druckerPragerCreep

26.43.1 DruckerPragerCreep(...)
This method creates a DruckerPragerCreep object.

Path
mdb.models[name].materials[name].druckerPrager.DruckerPragerCreep
session.odbs[name].materials[name].druckerPrager.DruckerPragerCreep

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
law
A SymbolicConstant specifying the type of data defining the creep law. Possible values are:
• STRAIN, specifying a strain-hardening power law.
• TIME, specifying a time-hardening power law.
• SINGHM, specifying a Singh-Mitchell type law.
• USER, specifying the creep law is input from user subroutine CREEP.
The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If law=TIME or law=STRAIN, the table data specify the following:
• . (Units of F L T .)

26–129

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If law=SINGHM, the table data specify the following:
• . (Units of T−1 .)
• . (Units of F−1 L2 .)
• .
• . (Units of T.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A DruckerPragerCreep object.

Exceptions
RangeError.

26.43.2 setValues(...)
This method modifies the DruckerPragerCreep object.

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

Return value
None

26–130

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

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

26.43.4 Corresponding analysis keywords

*DRUCKER PRAGER CREEP

26.44 DruckerPragerHardening object

The DruckerPragerHardening object specifies hardening for Drucker-Prager plasticity models.

Access
import material
mdb.models[name].materials[name].druckerPrager.druckerPragerHardening
import odbMaterial
session.odbs[name].materials[name].druckerPrager\
.druckerPragerHardening

26.44.1 DruckerPragerHardening(...)
This method creates a DruckerPragerHardening object.

Path
mdb.models[name].materials[name].druckerPrager.DruckerPragerHardening
session.odbs[name].materials[name].druckerPrager\
.DruckerPragerHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–131

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
type
A SymbolicConstant specifying the type of data defining the hardening behavior. Possible values
are COMPRESSION, TENSION, and SHEAR. The default value is COMPRESSION.
rate
A Boolean specifying whether the data depend on rate. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Yield stress.
• Absolute value of the corresponding plastic strain. (The first tabular value entered must always be
zero.)
• Equivalent plastic strain rate, , for which this hardening curve applies.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A DruckerPragerHardening object.

Exceptions
RangeError.

26.44.2 setValues(...)
This method modifies the DruckerPragerHardening object.

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

26–132

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
None

Exceptions
RangeError.

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

26.44.4 Corresponding analysis keywords

*DRUCKER PRAGER HARDENING

26.45 Elastic object

The Elastic object specifies elastic material properties.

Access
import material
mdb.models[name].materials[name].elastic
import odbMaterial
session.odbs[name].materials[name].elastic

26.45.1 Elastic(...)
This method creates an Elastic object.

Path
mdb.models[name].materials[name].Elastic
session.odbs[name].materials[name].Elastic

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–133

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
type
A SymbolicConstant specifying the type of elasticity data provided. Possible values are:
• ISOTROPIC
• ORTHOTROPIC
• ANISOTROPIC
• ENGINEERING_CONSTANTS
• LAMINA
• TRACTION
• COUPLED_TRACTION
• SHORT_FIBER
• SHEAR
The default value is ISOTROPIC.
noCompression
A Boolean specifying whether compressive stress is allowed. The default value is OFF.
noTension
A Boolean specifying whether tensile stress is allowed. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
moduli
A SymbolicConstant specifying the time-dependence of the elastic material constants. Possible
values are INSTANTANEOUS and LONG_TERM. The default value is LONG_TERM.
Table data
If type=ISOTROPIC, the table data specify the following:
• The Young’s modulus, .
• The Poisson’s ratio, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=SHEAR, the table data specify the following:
• The shear modulus, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–134

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Value of the second field variable.

• Etc.
If type=ENGINEERING_CONSTANTS, the table data specify the following:
• .
• .
• .
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=LAMINA, the table data specify the following:
• .
• .
• .
• .
• . This shear modulus is needed to define transverse shear behavior in shells.
• . This shear modulus is needed to define transverse shear behavior in shells.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• .
• .
• .
• .

26–135

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ANISOTROPIC, the table data specify the following:
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=TRACTION, the table data specify the following:
• .
• .

26–136

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=COUPLED_TRACTION, the table data specify the following:
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=SHORT_FIBER, there is no table data.

Return value
An Elastic object.

Exceptions
RangeError.

26.45.2 setValues(...)
This method modifies the Elastic object.

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

Return value
None

26–137

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
RangeError.

26.45.3 Members
The Elastic object has members with the same names and descriptions as the arguments to the Elastic
method.
In addition, the Elastic object can have the following members:
failStress
A FailStress object.
failStrain
A FailStrain object.

26.45.4 Corresponding analysis keywords

*ELASTIC

26.46 ElectricalConductivity object

The ElectricalConductivity object specifies electrical conductivity.

Access
import material
mdb.models[name].materials[name].electricalConductivity
import odbMaterial
session.odbs[name].materials[name].electricalConductivity

26.46.1 ElectricalConductivity(...)
This method creates an ElectricalConductivity object.

Path
mdb.models[name].materials[name].ElectricalConductivity
session.odbs[name].materials[name].ElectricalConductivity

26–138

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the type of electrical conductivity. Possible values are
ISOTROPIC, ORTHOTROPIC, and ANISOTROPIC. The default value is ISOTROPIC.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=ISOTROPIC, the table data specify the following:
• Electrical conductivity.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ANISOTROPIC, the table data specify the following:
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–139

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Value of the second field variable.

• Etc.

Return value
An ElectricalConductivity object.

Exceptions
RangeError.

26.46.2 setValues(...)
This method modifies the ElectricalConductivity object.

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

Return value
None

Exceptions
RangeError.

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

26.46.4 Corresponding analysis keywords

*ELECTRICAL CONDUCTIVITY

26–140

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.47 Eos object

The Eos object specifies an equation of state model.

Access
import material
mdb.models[name].materials[name].eos
import odbMaterial
session.odbs[name].materials[name].eos

26.47.1 Eos(...)
This method creates an Eos object.

Path
mdb.models[name].materials[name].Eos
session.odbs[name].materials[name].Eos

Required arguments
None.
Optional arguments
type
A SymbolicConstant specifying the equation of state. Possible values are USUP, JWL,
IDEALGAS, TABULAR, and IGNITIONANDGROWTH. The default value is IDEALGAS.
temperatureDependency
A Boolean specifying whether the data in gasSpecificTable depend on temperature. The default
value is OFF.
dependencies
An Int specifying the number of field variable dependencies for the data in gasSpecificTable. The
default value is 0.
detonationEnergy
A Float specifying the detonation energy text field. The default value is 0.0.
solidTable
A sequence of sequences of Floats specifying the following:
• $A_{s}$.
• $B_{s}$.
• ${\omega}_{s}$.

26–141

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• $R_{1s}$.
• $R_{2s}$.
The default value is an empty sequence.
gasTable
A sequence of sequences of Floats specifying the following:
• $A_{g}$.
• $B_{g}$.
• ${\omega}_{g}$.
• $R_{1g}$.
• $R_{2g}$.
The default value is an empty sequence.
reactionTable
A sequence of sequences of Floats specifying the following:
• Initial Pressure, $I$.
• Product co-volume, $a$.
• Exponent on the unreacted fraction (ignition term), $x$.
• First burn rate coefficient, $G_{1}$
• Exponent on the unreacted fraction (growth term), $c$.
• Exponent on the reacted fraction (growth term), $d$.
• Pressure exponent (growth term), $y$.
• Second burn rate coefficient, $G_{2}$.
• Exponent on the unreacted fraction (completion term), $e$.
• Exponent on the reacted fraction (completion term), $g$.
• Pressure exponent (completion term), $z$.
• Initial reacted fraction, ${F^{max}}_{ig}$.
• Maximum reacted fraction for the growth term, ${F^{max}}_{G1}$.
• Minimum reacted fraction, ${F^{min}}_{G2}$.
The default value is an empty sequence.
gasSpecificTable
A sequence of sequences of Floats specifying the following:
• Specific Heat per unit mass.
• Temperature dependent data.
• Value of first field variable.
• Value of second field variable.
• Etc.

26–142

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

The default value is an empty sequence.

table
A sequence of sequences of Floats specifying the items described below. The default value is an
empty sequence.
Table data
If type=IDEALGAS, the table data represents the following:
• Gas constant, .
• The ambient pressure, . If this field is left blank, a default of 0.0 is used.
If type=JWL, the table data represents the following:
• Detonation wave speed, .
• .
• .
• . (Dimensionless.)
• . (Dimensionless.)
• . (Dimensionless.)
• Pre-detonation bulk modulus, .
• Detonation energy density, .
If type=USUP, the table data represents the following:
• .
• . (Dimensionless.)
• . (Dimensionless.)
If type=TABULAR, the table data represents the following:
• .
• .
• . (Dimensionless.)

Return value
An Eos object.

Exceptions
None.

26.47.2 setValues(...)
This method modifies the Eos object.

26–143

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

Return value
None

Exceptions
None.

26.47.3 Members
The Eos object has members with the same names and descriptions as the arguments to the Eos method.
In addition, the Eos object can have the following members:
detonationPoint
A DetonationPoint object.
eosCompaction
An EosCompaction object.

26.47.4 Corresponding analysis keywords

*EOS

26.48 EosCompaction object

The EosCompaction object specifies material eos compaction.

Access
import material
mdb.models[name].materials[name].eos.eosCompaction
import odbMaterial
session.odbs[name].materials[name].eos.eosCompaction

26–144

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.48.1 EosCompaction(...)
This method creates a EosCompaction object.

Path
mdb.models[name].materials[name].eos.EosCompaction
session.odbs[name].materials[name].eos.EosCompaction

Required arguments
soundSpeed
A Float specifying reference sound speed in the porous material.
porosity
A Float specifying value of the porosity of the unloaded material.
pressure
A Float specifying pressure required to initialize plastic behavior.
compactionPressure
A Float specifying compaction pressure at which all pores are crushed.
Optional arguments
None.

Return value
An EosCompaction object.

Exceptions
RangeError.

26.48.2 setValues(...)
This method modifies the EosCompaction object.

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

Return value
None

26–145

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
RangeError.

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

26.48.4 Corresponding analysis keywords

*EOS COMPACTION

26.49 Expansion object

The Expansion object specifies thermal expansion.

Access
import material
mdb.models[name].materials[name].expansion
import odbMaterial
session.odbs[name].materials[name].expansion

26.49.1 Expansion(...)
This method creates an Expansion object.

Path
mdb.models[name].materials[name].Expansion
session.odbs[name].materials[name].Expansion

Required arguments
None.

26–146

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
type
A SymbolicConstant specifying the type of expansion. Possible values are ISOTROPIC,
ORTHOTROPIC, ANISOTROPIC, and SHORT_FIBER. The default value is ISOTROPIC.
userSubroutine
A Boolean specifying whether a user subroutine is used to define the increments of thermal strain.
The default value is OFF.
zero
A Float specifying the value of if the thermal expansion is temperature-dependent or field-
variable-dependent. The default value is 0.0.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
table
A sequence of sequences of Floats specifying the items described below. The default value is an
empty sequence.
This argument is required only if type is not USER.
Table data
If type=ISOTROPIC, the table data specify the following:
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=ANISOTROPIC, the table data specify the following:
• .
• .
• . (Not used for plane stress case.)

26–147

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=SHORT_FIBER, there is no table data.

Return value
An Expansion object.

Exceptions
RangeError.

26.49.2 setValues(...)
This method modifies the Expansion object.

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

Return value
None

Exceptions
RangeError.

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

26.49.4 Corresponding analysis keywords

26–148

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

*EXPANSION

26.50 FailStrain object

The FailStrain object defines parameters for strain-based failure measures.

Access
import material
mdb.models[name].materials[name].elastic.failStrain
import odbMaterial
session.odbs[name].materials[name].elastic.failStrain

26.50.1 FailStrain(...)
This method creates a FailStrain object.

Path
mdb.models[name].materials[name].elastic.FailStrain
session.odbs[name].materials[name].elastic.FailStrain

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Tensile strain limit in fiber direction, .

• Compressive strain limit in fiber direction, .
• Tensile strain limit in transverse direction, .
• Compressive strain limit in transverse direction, .
• Shear strain limit in the – plane, .

26–149

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A FailStrain object.

Exceptions
RangeError.

26.50.2 setValues(...)
This method modifies the FailStrain object.

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

Return value
None

Exceptions
RangeError.

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

26.50.4 Corresponding analysis keywords

*FAIL STRAIN

26–150

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.51 FailStress object

The FailStress object defines parameters for stress-based failure measures.

Access
import material
mdb.models[name].materials[name].elastic.failStress
import odbMaterial
session.odbs[name].materials[name].elastic.failStress

26.51.1 FailStress(...)
This method creates a FailStress object.

Path
mdb.models[name].materials[name].elastic.FailStress
session.odbs[name].materials[name].elastic.FailStress

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Tensile stress limit in fiber direction, .

• Compressive stress limit in fiber direction, .
• Tensile stress limit in transverse direction, .
• Compressive stress limit in transverse direction, .
• Shear strength in the – plane, .
• Cross product term coefficient, ( ). The default value is zero.
• Biaxial stress limit, .
• Temperature, if the data depend on temperature.

26–151

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A FailStress object.

Exceptions
RangeError.

26.51.2 setValues(...)
This method modifies the FailStress object.

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

Return value
None

Exceptions
RangeError.

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

26.51.4 Corresponding analysis keywords

*FAIL STRESS

26–152

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.52 FailureRatios object

The FailureRatios object specifies the shape of the failure surface for a Concrete model.

Access
import material
mdb.models[name].materials[name].concrete.failureRatios
import odbMaterial
session.odbs[name].materials[name].concrete.failureRatios

26.52.1 FailureRatios(...)
This method creates a FailureRatios object.

Path
mdb.models[name].materials[name].concrete.FailureRatios
session.odbs[name].materials[name].concrete.FailureRatios

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Ratio of the ultimate biaxial compressive stress to the uniaxial compressive ultimate stress. The
default value is 1.16.
• Absolute value of the ratio of the uniaxial tensile stress at failure to the uniaxial compressive stress
at failure. The default value is 0.09.
• Ratio of the magnitude of a principal component of plastic strain at ultimate stress in biaxial
compression to the plastic strain at ultimate stress in uniaxial compression. The default value is
1.28.

26–153

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Ratio of the tensile principal stress value at shear in plane stress, when the other nonzero principal
stress component is at the ultimate compressive stress value, to the tensile cracking stress under
uniaxial tension. The default value is 1/3.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A FailureRatios object.

Exceptions
RangeError.

26.52.2 setValues(...)
This method modifies the FailureRatios object.

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

Return value
None

Exceptions
RangeError.

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

26.52.4 Corresponding analysis keywords

*FAILURE RATIOS

26–154

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.53 FluidLeakoff object

The FluidLeakoff object specifies leak-off coefficients for pore pressure cohesive elements.

Access
import material
mdb.models[name].materials[name].fluidLeakoff
import odbMaterial
session.odbs[name].materials[name].fluidLeakoff

26.53.1 FluidLeakoff(...)
This method creates an FluidLeakoff object.

Path
mdb.models[name].materials[name].FluidLeakoff
session.odbs[name].materials[name].FluidLeakoff

Required arguments
None.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
type
A SymbolicConstant specifying the type of fluid leak-off. Possible values are COEFFICIENTS
and USER. The default value is COEFFICIENTS.
table
A sequence of sequences of Floats specifying the items described below. The default value is an
empty sequence.
Table data
The table data specify the following:
• Fluid leak-off coefficient at top element surface.
• Fluid leak-off coefficient at bottom element surface.

26–155

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A FluidLeakoff object.

Exceptions
None.

26.53.2 setValues(...)
This method modifies the FluidLeakoff object.

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

Return value
None

Exceptions
None.

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

26.53.4 Corresponding analysis keywords

*FLUID LEAKOFF

26–156

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.54 GapFlow object

The GapFlow object specifies tangential flow constitutive parameters for pore pressure cohesive
elements.

Access
import material
mdb.models[name].materials[name].gapFlow
import odbMaterial
session.odbs[name].materials[name].gapFlow

26.54.1 GapFlow(...)
This method creates an GapFlow object.

Path
mdb.models[name].materials[name].GapFlow
session.odbs[name].materials[name].GapFlow

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
kmax
None or a Float specifying the maximum permeability value that should be used. If kmax=None,
Abaqus assumes that the permeability is not bounded. This value is meaningful only when
type=NEWTONIAN. The default value is None.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
type
A SymbolicConstant specifying the type of gap flow. Possible values are NEWTONIAN and
POWER_LAW. The default value is NEWTONIAN.
Table data
If type=NEWTONIAN the table data specify the following:
• Pore viscosity.

26–157

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=POWER_LAW the table data specify the following:
• Consistency.
• Exponent.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A GapFlow object.

Exceptions
None.

26.54.2 setValues(...)
This method modifies the GapFlow object.

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

Return value
None

Exceptions
None.

26–158

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

26.54.4 Corresponding analysis keywords

*GAP FLOW

26.55 GasketMembraneElastic object

The GasketMembraneElastic object defines the elastic parameters for the membrane shear behavior of a
gasket.

Access
import material
mdb.models[name].materials[name].gasketMembraneElastic
import odbMaterial
session.odbs[name].materials[name].gasketMembraneElastic

26.55.1 GasketMembraneElastic(...)
This method creates a GasketMembraneElastic object.

Path
mdb.models[name].materials[name].GasketMembraneElastic
session.odbs[name].materials[name].GasketMembraneElastic

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–159

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Table data

• Young’s modulus, .
• Poisson’s ratio, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A GasketMembraneElastic object.

Exceptions
RangeError.

26.55.2 setValues(...)
This method modifies the GasketMembraneElastic object.

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

Return value
None

Exceptions
RangeError.

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

26–160

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.55.4 Corresponding analysis keywords

*GASKET ELASTICITY

26.56 GasketThicknessBehavior object

The GasketThicknessBehavior object defines the behavior in the thickness direction for a gasket.

Access
import material
mdb.models[name].materials[name].gasketThicknessBehavior
import odbMaterial
session.odbs[name].materials[name].gasketThicknessBehavior

26.56.1 GasketThicknessBehavior(...)
This method creates a GasketThicknessBehavior object.

Path
mdb.models[name].materials[name].GasketThicknessBehavior
session.odbs[name].materials[name].GasketThicknessBehavior

Required argument
table
A sequence of sequences of Floats specifying loading data. The first sequence must contain only
0. At least two sequences must be specified if type=DAMAGE, and at least 3 sequences must be
specified if type=ELASTIC_PLASTIC. The items in the table data are described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the loading data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies included in the definition of the loading
data, in addition to temperature. The default value is 0.

26–161

Abaqus ID:
Printed on:
MATERIAL COMMANDS

tensileStiffnessFactor
A Float specifying the fraction of the initial compressive stiffness that defines the stiffness in
tension. The default value is 10–3 .
type
A SymbolicConstant specifying a damage elasticity model or an elastic-plastic model for gasket
thickness-direction behavior. Possible values are ELASTIC_PLASTIC and DAMAGE. The
default value is ELASTIC_PLASTIC.
unloadingDependencies
An Int specifying the number of field variable dependencies included in the definition of the
unloading data, in addition to temperature. The default value is 0.
unloadingTemperatureDependency
A Boolean specifying whether unloading data depends on temperature. The default value is OFF.
variableUnits
A SymbolicConstant specifying the behavior in terms of units of force (or force in unit length)
versus closure or pressure versus closure. Possible values are STRESS and FORCE. The default
value is STRESS.
yieldOnset
A Float specifying the closure value at which the onset of yield occurs or the relative drop in
slope on the loading curve that defines the onset of plastic deformation (depending on the value of
yieldOnsetMethod). The default value is 0.1.
yieldOnsetMethod
A SymbolicConstant specifying the method used to determine yield onset. Possible
values are RELATIVE_SLOPE_DROP and CLOSURE_VALUE. The default value is
RELATIVE_SLOPE_DROP.
unloadingTable
A sequence of sequences of Floats specifying unloading data. The items in the table data are
described below. The default value is an empty sequence.
Table data
If variableUnits=STRESS, the loading table data specify the following:
• Pressure; this value must be positive.
• Closure; this value must be positive.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If variableUnits=FORCE, the loading table data specify the following:
• Force or force per unit length; this value must be positive.
• Closure; this value must be positive.

26–162

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If variableUnits=STRESS and type=ELASTIC_PLASTIC, the unloadingTable data specify the
following:
• Pressure; this value must be positive.
• Closure; this value must be positive.
• Plastic closure; this value must be positive.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If variableUnits=FORCE and type=ELASTIC_PLASTIC, the unloadingTable data specify the
following:
• Pressure; this value must be positive.
• Closure; this value must be positive.
• Plastic closure; this value must be positive.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If variableUnits=STRESS and type=DAMAGE, the unloadingTable data specify the following:
• Pressure; this value must be positive.
• Closure; this value must be positive.
• Maximum closure reached while loading the gasket; this value must be positive.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If variableUnits=FORCE and type=DAMAGE, the unloadingTable data specify the following:
• Force or force per unit length; this value must be positive.
• Closure; this value must be positive.
• Maximum closure reached while loading the gasket; this value must be positive.
• Temperature, if the data depend on temperature.

26–163

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A GasketThicknessBehavior object.

Exceptions
RangeError.

26.56.2 setValues(...)
This method modifies the GasketThicknessBehavior object.

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

Return value
None

Exceptions
RangeError.

26.56.3 Members
The GasketThicknessBehavior object has members with the same names and descriptions as the
arguments to the GasketThicknessBehavior method.
In addition, the GasketThicknessBehavior object can have the following member:
contactArea
A ContactArea object.

26.56.4 Corresponding analysis keywords

*GASKET THICKNESS BEHAVIOR

26–164

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.57 GasketTransverseShearElastic object

The GasketTransverseShearElastic object defines the elastic parameters for the transverse shear behavior
of a gasket.

Access
import material
mdb.models[name].materials[name].gasketTransverseShearElastic
import odbMaterial
session.odbs[name].materials[name].gasketTransverseShearElastic

26.57.1 GasketTransverseShearElastic(...)
This method creates a GasketTransverseShearElastic object.

Path
mdb.models[name].materials[name].GasketTransverseShearElastic
session.odbs[name].materials[name].GasketTransverseShearElastic

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
variableUnits
A SymbolicConstant specifying the unit system in which the transverse shear behavior will be
defined. Possible values are STRESS and FORCE. The default value is STRESS.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Shear stiffness. (This value cannot be negative.)

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–165

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Value of the second field variable.

• Etc.

Return value
A GasketTransverseShearElastic object.

Exceptions
RangeError.

26.57.2 setValues(...)
This method modifies the GasketTransverseShearElastic object.

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

Return value
None

Exceptions
RangeError.

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

26.57.4 Corresponding analysis keywords

*GASKET ELASTICITY

26–166

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.58 Gel object

The Gel object defines a swelling gel.

Access
import material
mdb.models[name].materials[name].gel
import odbMaterial
session.odbs[name].materials[name].gel

26.58.1 Gel(...)
This method creates a Gel object.

Path
mdb.models[name].materials[name].Gel
session.odbs[name].materials[name].Gel

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• Radius of gel particles when completely dry, .

• Fully swollen radius of gel particles, .
• Number of gel particles per unit volume, .
• Relaxation time constant for long-term swelling of gel particles, .

Return value
A Gel object.

Exceptions
None.

26–167

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.58.2 setValues(...)
This method modifies the Gel object.

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

Return value
None

Exceptions
None.

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

26.58.4 Corresponding analysis keywords

*GEL

26.59 HeatGeneration object

The HeatGeneration object includes volumetric heat generation in heat transfer analyses.

Access
import material
mdb.models[name].materials[name].heatGeneration
import odbMaterial
session.odbs[name].materials[name].heatGeneration

26–168

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.59.1 HeatGeneration()
This method creates a HeatGeneration object.

Path
mdb.models[name].materials[name].HeatGeneration
session.odbs[name].materials[name].HeatGeneration

Arguments
None.

Return value
A HeatGeneration object.

Exceptions
None.

26.59.2 Members
The HeatGeneration object has no members.

26.59.3 Corresponding analysis keywords

*HEAT GENERATION

26.60 Hyperelastic object

The Hyperelastic object specifies elastic properties for approximately incompressible elastomers.

Access
import material
mdb.models[name].materials[name].hyperelastic
import odbMaterial
session.odbs[name].materials[name].hyperelastic

26–169

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.60.1 Hyperelastic(...)
This method creates a Hyperelastic object.

Path
mdb.models[name].materials[name].Hyperelastic
session.odbs[name].materials[name].Hyperelastic

Required argument
table
A sequence of sequences of Floats specifying the items described below. This argument is valid
only if testData=OFF.
Optional arguments
type
A SymbolicConstant specifying the type of strain energy potential. Possible values are:
• ARRUDA_BOYCE
• MARLOW
• MOONEY_RIVLIN
• NEO_HOOKE
• OGDEN
• POLYNOMIAL
• REDUCED_POLYNOMIAL
• USER
• VAN_DER_WAALS
• YEOH
• UNKNOWN
The default value is UNKNOWN.
moduliTimeScale
A SymbolicConstant specifying the nature of the time response. Possible values are
INSTANTANEOUS and LONG_TERM. The default value is LONG_TERM.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
n
An Int specifying the order of the strain energy potential. The default value is 1.
If testData=ON and type=POLYNOMIAL, n can take only the values 1 or 2.
If testData=ON and type=OGDEN or if testData=OFF for either type, 1 6.
If type=USER, this argument cannot be used.

26–170

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

beta
The SymbolicConstant FITTED_VALUE or a Float specifying the invariant mixture parameter.
This argument is valid only if testData=ON and type=VAN_DER_WAALS. The default value is
FITTED_VALUE.
testData
A Boolean specifying whether test data are supplied. The default value is ON.
compressible
A Boolean specifying whether the hyperelastic material is compressible. This parameter is
applicable only to user-defined hyperelastic materials. The default value is OFF.
properties
An Int specifying the number of property values needed as data for the user-defined hyperelastic
material. The default value is 0.
deviatoricResponse
A SymbolicConstant specifying which test data to use. Possible values are UNIAXIAL,
BIAXIAL, and PLANAR. The default value is UNIAXIAL.
volumetricResponse
A SymbolicConstant specifying the volumetric response. Possible values are DEFAULT,
VOLUMETRIC_DATA, POISSON_RATIO, and LATERAL_NOMINAL_STRAIN. The default
value is DEFAULT.
poissonRatio
A Float specifying the poisson ratio. This argument is valid only if
volumetricResponse=POISSON_RATIO. The default value is 0.0.
Table data
If type=ARRUDA_BOYCE, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
If type=MOONEY_RIVLIN, the table data specify the following:
• .
• .
• .
• Temperature, if the data depend on temperature.
If type=NEO_HOOKE, the table data specify the following:
• .
• .
• Temperature, if the data depend on temperature.

26–171

Abaqus ID:
Printed on:
MATERIAL COMMANDS

If type=OGDEN, the table data specify the following for values of :

• and for from 1 to .
• coefficients .
• Temperature, if the data depend on temperature. Temperature dependence is not allowed for 4
6 in an Abaqus/Explicit analysis.
If type=POLYNOMIAL, the table data specify the following for values of :
• for each value of from to with decreasing from to zero and increasing
from zero to .
• coefficients .
• Temperature, if the data depend on temperature. Temperature dependence is not allowed for 3
6 in an Abaqus/Explicit analysis.
If type=REDUCED_POLYNOMIAL, the table data specify the following for values of :
• for from 1 to .
• coefficients .
• Temperature, if the data depend on temperature. Temperature dependence is not allowed for 4
6 in an Abaqus/Explicit analysis.
If type=VAN_DER_WAALS, the table data specify the following:
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
If type=YEOH, the table data specify the following:
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature. Temperature dependence is not allowed in an
Abaqus/Explicit analysis.
The None object is the default value if testData=ON.

26–172

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
A Hyperelastic object.

Exceptions
InvalidNameError and RangeError.

26.60.2 setValues(...)
This method modifies the Hyperelastic object.

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

Return value
None

Exceptions
RangeError.

26.60.3 Members
The Hyperelastic object has members with the same names and descriptions as the arguments to the
Hyperelastic method.
In addition, the Hyperelastic object can have the following members:
biaxialTestData
A BiaxialTestData object.
planarTestData
A PlanarTestData object.
uniaxialTestData
A UniaxialTestData object.
volumetricTestData
A VolumetricTestData object.
hysteresis
A Hysteresis object.

26–173

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.60.4 Corresponding analysis keywords

*HYPERELASTIC

26.61 Hyperfoam object

The Hyperfoam object specifies elastic properties for a hyperelastic foam.

Access
import material
mdb.models[name].materials[name].hyperfoam
import odbMaterial
session.odbs[name].materials[name].hyperfoam

26.61.1 Hyperfoam(...)
This method creates a Hyperfoam object.

Path
mdb.models[name].materials[name].Hyperfoam
session.odbs[name].materials[name].Hyperfoam

Required arguments
None.
Optional arguments
testData
A Boolean specifying whether test data are supplied. The default value is OFF.
poisson
None or a Float specifying the effective Poisson’s ratio, , of the material. This argument is valid
only when testData=ON. The default value is None.
n
An Int specifying the order of the strain energy potential. Possible values are 1 6. The
default value is 1.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.

26–174

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

moduli
A SymbolicConstant specifying the time-dependence of the material constants. Possible values
are INSTANTANEOUS and LONG_TERM. The default value is LONG_TERM.
table
A sequence of sequences of Floats specifying the items described below. This argument is valid
only when testData=OFF. The default value is an empty sequence.
Table data
The items in the table data specify the following for values of :
• and for from 1 to .
• .
• Temperature, if the data depend on temperature. Temperature dependence is not allowed for 4
6 in an Abaqus/Explicit analysis.

Return value
A Hyperfoam object.

Exceptions
RangeError.

26.61.2 setValues(...)
This method modifies the Hyperfoam object.

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

Return value
None

Exceptions
RangeError.

26–175

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.61.3 Members
The Hyperfoam object has members with the same names and descriptions as the arguments to the
Hyperfoam method.
In addition, the Hyperfoam object can have the following members:
biaxialTestData
A BiaxialTestData object.
volumetricTestData
A VolumetricTestData object.
planarTestData
A PlanarTestData object.
simpleShearTestData
A SimpleShearTestData object.
uniaxialTestData
A UniaxialTestData object.

26.61.4 Corresponding analysis keywords

*HYPERFOAM

26.62 Hypoelastic object

The Hypoelastic object specifies hypoelastic material properties.

Access
import material
mdb.models[name].materials[name].hypoelastic
import odbMaterial
session.odbs[name].materials[name].hypoelastic

26.62.1 Hypoelastic(...)
This method creates a Hypoelastic object.

Path
mdb.models[name].materials[name].Hypoelastic

26–176

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

session.odbs[name].materials[name].Hypoelastic

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional argument
user
A Boolean specifying that hypoelasticity is defined by user subroutine UHYPEL. The default value
is OFF.
Table data

• Instantaneous Young’s modulus, .

• Instantaneous Poisson’s ratio, .
• First strain invariant, .
• Second strain invariant, .
• Third strain invariant, .

Return value
A Hypoelastic object.

Exceptions
None.

26.62.2 setValues(...)
This method modifies the Hypoelastic object.

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

Return value
None

26–177

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
None.

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

26.62.4 Corresponding analysis keywords

*HYPOELASTIC

26.63 Hysteresis object

The Hysteresis object specifies the creep part of the material model for the hysteretic behavior of
elastomers.

Access
import material
mdb.models[name].materials[name].hyperelastic.hysteresis
import odbMaterial
session.odbs[name].materials[name].hyperelastic.hysteresis

26.63.1 Hysteresis(...)
This method creates a Hysteresis object.

Path
mdb.models[name].materials[name].hyperelastic.Hysteresis
session.odbs[name].materials[name].hyperelastic.Hysteresis

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–178

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
None.
Table data

• Stress scaling factor.

• Creep parameter.
• Effective stress exponent.
• Creep strain exponent.

Return value
A Hysteresis object.

Exceptions
RangeError.

26.63.2 setValues(...)
This method modifies the Hysteresis object.

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

Return value
None

Exceptions
RangeError.

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

26.63.4 Corresponding analysis keywords

26–179

Abaqus ID:
Printed on:
MATERIAL COMMANDS

*HYSTERESIS

26.64 InelasticHeatFraction object

The InelasticHeatFraction object defines the fraction of the rate of inelastic dissipation that appears as a
heat source.

Access
import material
mdb.models[name].materials[name].inelasticHeatFraction
import odbMaterial
session.odbs[name].materials[name].inelasticHeatFraction

26.64.1 InelasticHeatFraction(...)
This method creates an InelasticHeatFraction object.

Path
mdb.models[name].materials[name].InelasticHeatFraction
session.odbs[name].materials[name].InelasticHeatFraction

Required arguments
None.
Optional argument
fraction
A Float specifying the fraction of inelastic dissipation rate that appears as a heat flux per unit
volume. The fraction may include a unit conversion factor if required. Possible values are 0.0
fraction 1.0. The default value is 0.9.

Return value
An InelasticHeatFraction object.

Exceptions
RangeError.

26–180

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.64.2 setValues(...)
This method modifies the InelasticHeatFraction object.

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

Return value
None

Exceptions
RangeError.

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

26.64.4 Corresponding analysis keywords

*INELASTIC HEAT FRACTION

26.65 JouleHeatFraction object

The JouleHeatFraction object defines the fraction of electric energy released as heat.

Access
import material
mdb.models[name].materials[name].jouleHeatFraction
import odbMaterial
session.odbs[name].materials[name].jouleHeatFraction

26–181

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.65.1 JouleHeatFraction(...)
This method creates a JouleHeatFraction object.

Path
mdb.models[name].materials[name].JouleHeatFraction
session.odbs[name].materials[name].JouleHeatFraction

Required arguments
None.
Optional argument
fraction
A Float specifying the fraction of electrical energy released as heat, including any unit conversion
factor. Possible values are 0.0 fraction 1.0. The default value is 1.0.

Return value
A JouleHeatFraction object.

Exceptions
RangeError.

26.65.2 setValues(...)
This method modifies the JouleHeatFraction object.

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

Return value
None

Exceptions
RangeError.

26–182

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

26.65.4 Corresponding analysis keywords

*JOULE HEAT FRACTION

26.66 LatentHeat object

The LatentHeat object specifies a material’s latent heat.

Access
import material
mdb.models[name].materials[name].latentHeat
import odbMaterial
session.odbs[name].materials[name].latentHeat

26.66.1 LatentHeat(...)
This method creates a LatentHeat object.

Path
mdb.models[name].materials[name].LatentHeat
session.odbs[name].materials[name].LatentHeat

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• Latent heat per unit mass.

• Solidus temperature.

26–183

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Liquidus temperature.

Return value
A LatentHeat object.

Exceptions
RangeError.

26.66.2 setValues(...)
This method modifies the LatentHeat object.

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

Return value
None

Exceptions
RangeError.

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

26.66.4 Corresponding analysis keywords

*LATENT HEAT

26.67 LowDensityFoam object

The LowDensityFoam object specifies properties for low-density foam.

26–184

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].lowDensityFoam
import odbMaterial
session.odbs[name].materials[name].lowDensityFoam

26.67.1 LowDensityFoam(...)
This method creates a LowDensityFoam object.

Path
mdb.models[name].materials[name].LowDensityFoam
session.odbs[name].materials[name].LowDensityFoam

Required arguments
None.
Optional arguments
elementRemoval
A Boolean specifying whether elements are removed if exceeding maximum principal tensile
stress. This argument is valid only when maxAllowablePrincipalStress is defined. The default
value is OFF.
maxAllowablePrincipalStress
None or a Float specifying the maximum allowable principal tensile stress. The default value is
None.
extrapolateStressStrainCurve
A Boolean specifying whether the stress-strain curve is extrapolated if exceeding maximum strain
rate. The default value is OFF.
strainRateType
A SymbolicConstant specifying strain rate measure used for constitutive calculations. Possible
values are PRINCIPAL and VOLUMETRIC. The default value is VOLUMETRIC.
mu0
A Float specifying the relaxation coefficient . The default value is 10–4 .
mu1
A Float specifying the relaxation coefficient . The default value is 0.5×10–2 .
alpha
A Float specifying the relaxation coefficient . The default value is 2.0.

26–185

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A LowDensityFoam object.

Exceptions
RangeError.

26.67.2 setValues(...)
This method modifies the LowDensityFoam object.

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

Return value
None

Exceptions
RangeError.

26.67.3 Members
The LowDensityFoam object has members with the same names and descriptions as the arguments to
the LowDensityFoam method.
In addition, the LowDensityFoam object can have the following members:
uniaxialTensionTestData
A UniaxialTestData object.
uniaxialCompressionTestData
A UniaxialTestData object.

26.67.4 Corresponding analysis keywords

*LOW DENSITY FOAM

26–186

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.68 MohrCoulombHardening object

The MohrCoulombHardening object specifies hardening for the Mohr-Coulomb plasticity model.

Access
import material
mdb.models[name].materials[name].mohrCoulombPlasticity\
.mohrCoulombHardening
import odbMaterial
session.odbs[name].materials[name].mohrCoulombPlasticity\
.mohrCoulombHardening

26.68.1 MohrCoulombHardening(...)
This method creates a MohrCoulombHardening object.

Path
mdb.models[name].materials[name].mohrCoulombPlasticity\
.MohrCoulombHardening
session.odbs[name].materials[name].mohrCoulombPlasticity\
.MohrCoulombHardening

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Cohesion yield stress.

• The absolute value of the corresponding plastic strain.(The first tabular value entered must always
be zero.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–187

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Value of the second field variable.

• Etc.

Return value
A MohrCoulombHardening object.

Exceptions
RangeError.

26.68.2 setValues(...)
This method modifies the MohrCoulombHardening object.

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

Return value
None

Exceptions
RangeError.

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

26.68.4 Corresponding analysis keywords

*MOHR COULOMB HARDENING

26–188

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.69 MohrCoulombPlasticity object

The MohrCoulombPlasticity object specifies the extended Mohr-Coulomb plasticity model.

Access
import material
mdb.models[name].materials[name].mohrCoulombPlasticity
import odbMaterial
session.odbs[name].materials[name].mohrCoulombPlasticity

26.69.1 MohrCoulombPlasticity(...)
This method creates a MohrCoulombPlasticity object.

Path
mdb.models[name].materials[name].MohrCoulombPlasticity
session.odbs[name].materials[name].MohrCoulombPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
deviatoricEccentricity
None or a Float specifying the flow potential eccentricity in the deviatoric plane, ; 1/2 1.0.
If deviatoricEccentricity=None, Abaqus calculates the value using the specified Mohr-Coulomb
angle of friction. The default value is None.
meridionalEccentricity
A Float specifying the flow potential eccentricity in the meridional plane, . The default value is
0.1.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
useTensionCutoff
A Boolean specifying whether tension cutoff specification is needed. The default value is OFF.
Table data
The table data specify the following:

26–189

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Friction angle (given in degrees), , at high confining pressure in the – plane.

• Dilation angle, , at high confining pressure in the – plane.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A MohrCoulombPlasticity object.

Exceptions
RangeError.

26.69.2 setValues(...)
This method modifies the MohrCoulombPlasticity object.

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

Return value
None

Exceptions
RangeError.

26.69.3 Members
The MohrCoulombPlasticity object has members with the same names and descriptions as the arguments
to the MohrCoulombPlasticity method.
In addition, the MohrCoulombPlasticity object can have the following members:
mohrCoulombHardening
A MohrCoulombHardening object.

26–190

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

tensionCutOff
A TensionCutOff object.

26.69.4 Corresponding analysis keywords

*MOHR COULOMB

26.70 MoistureSwelling object

The MoistureSwelling object defines moisture-driven swelling.

Access
import material
mdb.models[name].materials[name].moistureSwelling
import odbMaterial
session.odbs[name].materials[name].moistureSwelling

26.70.1 MoistureSwelling(...)
This method creates a MoistureSwelling object.

Path
mdb.models[name].materials[name].MoistureSwelling
session.odbs[name].materials[name].MoistureSwelling

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• Volumetric moisture swelling strain, .

• Saturation, . This value must lie in the range .

26–191

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A MoistureSwelling object.

Exceptions
None.

26.70.2 setValues(...)
This method modifies the MoistureSwelling object.

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

Return value
None

Exceptions
None.

26.70.3 Members
The MoistureSwelling object has members with the same names and descriptions as the arguments to
the MoistureSwelling method.
In addition, the MoistureSwelling object can have the following member:
ratios
A Ratios object.

26.70.4 Corresponding analysis keywords

*MOISTURE SWELLING

26–192

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.71 MullinsEffect object

The MullinsEffect specifies properties for mullins data.

Access
import material
mdb.models[name].materials[name].mullinsEffect
import odbMaterial
session.odbs[name].materials[name].mullinsEffect

26.71.1 Members
The MullinsEffect object can have the following members:
definition
A SymbolicConstant specifying the method of specifying the data. Possible values are USER,
CONSTANTS, and TEST_DATA. The default value is CONSTANTS.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
properties
An Int specifying the number of property values needed as data for the user-defined hyperelastic
material. The default value is 0.
table
A tuple of tuples of Floats specifying the items described below. The default value is an empty
sequence.
uniaxialTests
A UniaxialTestDataArray object.
biaxialTests
A BiaxialTestDataArray object.
planarTests
A PlanarTestDataArray object.

26.72 Ornl object

The Ornl object specifies the constitutive model developed by Oak Ridge National Laboratory.

26–193

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].creep.ornl
mdb.models[name].materials[name].plastic.ornl
import odbMaterial
session.odbs[name].materials[name].creep.ornl
session.odbs[name].materials[name].plastic.ornl

26.72.1 Ornl(...)
This method creates an Ornl object.

Path
mdb.models[name].materials[name].creep.Ornl
mdb.models[name].materials[name].plastic.Ornl
session.odbs[name].materials[name].creep.Ornl
session.odbs[name].materials[name].plastic.Ornl

Required arguments
None.
Optional arguments
a
A Float specifying the saturation rates for kinematic shift caused by creep strain, as defined by
Equation (15) of Section 4.3.3–3 of the Nuclear Standard. The default value corresponds to that
section of the Standard. Set a=0.0 to use the 1986 revision of the Standard. The default value is
0.3.
h
None or a Float specifying the rate of kinematic shift with respect to creep strain [Equation (7)
of Section 4.3.2–1 of the Nuclear Standard]. If h=None, the value of h is determined according
to Section 4.3.3–3 of the 1981 revision of the Standard. Set h=0.0 to use the 1986 revision of the
Standard. The default value is None.
reset
A Boolean specifying whether to invoke the optional reset procedure described in Section 4.3.5
of the Nuclear Standard. The default value is OFF.

Return value
An Ornl object.

26–194

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

26.72.2 setValues(...)
This method modifies the Ornl object.

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

Return value
None

Exceptions
RangeError.

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

26.72.4 Corresponding analysis keywords

*ORNL

26.73 Permeability object

The Permeability object defines permeability for pore fluid flow.

Access
import material
mdb.models[name].materials[name].permeability

26–195

Abaqus ID:
Printed on:
MATERIAL COMMANDS

import odbMaterial
session.odbs[name].materials[name].permeability

26.73.1 Permeability(...)
This method creates a Permeability object.

Path
mdb.models[name].materials[name].Permeability
session.odbs[name].materials[name].Permeability

Required arguments
specificWeight
A Float specifying the specific weight of the wetting liquid, .
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the type of permeability. Possible values are ISOTROPIC,
ORTHOTROPIC, and ANISOTROPIC. The default value is ISOTROPIC.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
Table data
If type=ISOTROPIC, the table data specify the following:
• .
• Void ratio, .
• Temperature, if the data depend on temperature.
If type=ORTHOTROPIC, the table data specify the following:
• .
• .
• .
• Void ratio, .
• Temperature, if the data depend on temperature.
If type=ANISOTROPIC, the table data specify the following:
• .
• .
• .

26–196

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• .
• .
• .
• Void ratio, .
• Temperature, if the data depend on temperature.

Return value
A Permeability object.

Exceptions
RangeError.

26.73.2 setValues(...)
This method modifies the Permeability object.

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

Return value
None

Exceptions
RangeError.

26.73.3 Members
The Permeability object has members with the same names and descriptions as the arguments to the
Permeability method.
In addition, the Permeability object can have the following members:
saturationDependence
A SaturationDependence object specifying the dependence of the permeability of a material on the
saturation of the wetting liquid.

26–197

Abaqus ID:
Printed on:
MATERIAL COMMANDS

velocityDependence
A VelocityDependence object specifying the dependence of the permeability of a material on the
velocity of fluid flow.

26.73.4 Corresponding analysis keywords

*PERMEABILITY

26.74 Piezoelectric object

The Piezoelectric object specifies piezoelectric material properties.

Access
import material
mdb.models[name].materials[name].piezoelectric
import odbMaterial
session.odbs[name].materials[name].piezoelectric

26.74.1 Piezoelectric(...)
This method creates a Piezoelectric object.

Path
mdb.models[name].materials[name].Piezoelectric
session.odbs[name].materials[name].Piezoelectric

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the type of material coefficients for the piezoelectric property.
Possible values are STRAIN and STRESS. The default value is STRESS.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.

26–198

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=STRESS, the table data specify the following:
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=STRAIN, the table data specify the following:
• .
• .
• .
• .
• .
• .
• .
• .

26–199

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• .
• .
• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Piezoelectric object.

Exceptions
None.

26.74.2 setValues(...)
This method modifies the Piezoelectric object.

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

Return value
None

Exceptions
None.

26–200

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

26.74.4 Corresponding analysis keywords

*PIEZOELECTRIC

26.75 PlanarTestData object

The PlanarTestData object specifies planar test (or pure shear) data (compression and/or tension).

Access
import material
mdb.models[name].materials[name].hyperelastic.planarTestData
mdb.models[name].materials[name].hyperfoam.planarTestData
mdb.models[name].materials[name].mullinsEffect.planarTests[i]
import odbMaterial
session.odbs[name].materials[name].hyperelastic.planarTestData
session.odbs[name].materials[name].hyperfoam.planarTestData
session.odbs[name].materials[name].mullinsEffect.planarTests[i]

26.75.1 PlanarTestData(...)
This method creates a PlanarTestData object.

Path
mdb.models[name].materials[name].hyperelastic.PlanarTestData
mdb.models[name].materials[name].hyperfoam.PlanarTestData
mdb.models[name].materials[name].mullinsEffect.PlanarTestData
session.odbs[name].materials[name].hyperelastic.PlanarTestData
session.odbs[name].materials[name].hyperfoam.PlanarTestData
session.odbs[name].materials[name].mullinsEffect.PlanarTestData

26–201

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
smoothing
None or an Int specifying the value for smoothing. If smoothing=None, no smoothing is
employed. The default value is None.
lateralNominalStrain
A Boolean specifying whether to include lateral nominal strain. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
For a hyperelastic material model, the table data specify the following:
• Nominal stress, .
• Nominal strain in the direction of loading, .
For a hyperfoam material model, the table data specify the following:
• Nominal stress, .
• Nominal strain in the direction of loading, .
• Nominal transverse strain, . The default value is 0.

Return value
A PlanarTestData object.

Exceptions
None.

26.75.2 setValues(...)
This method modifies the PlanarTestData object.

Arguments
Required arguments
None.

26–202

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the PlanarTestData
method.

Return value
None

Exceptions
None.

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

26.75.4 Corresponding analysis keywords

*PLANAR TEST DATA

26.76 Plastic object

The Plastic object specifies a metal plasticity model.

Access
import material
mdb.models[name].materials[name].plastic
import odbMaterial
session.odbs[name].materials[name].plastic

26.76.1 Plastic(...)
This method creates a Plastic object.

Path
mdb.models[name].materials[name].Plastic
session.odbs[name].materials[name].Plastic

26–203

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
hardening
A SymbolicConstant specifying the type of hardening. Possible values are ISOTROPIC,
KINEMATIC, COMBINED, JOHNSON_COOK, and USER. The default value is ISOTROPIC.
rate
A Boolean specifying whether the data depend on rate. The default value is OFF.
dataType
A SymbolicConstant specifying the type of combined hardening. This argument is only
valid if hardening=COMBINED. Possible values are HALF_CYCLE, PARAMETERS, and
STABILIZED. The default value is HALF_CYCLE.
strainRangeDependency
A Boolean specifying whether the data depend on strain range. This argument is only valid if
hardening=COMBINED and dataType=STABILIZED. The default value is OFF.
numBackstresses
An Int specifying the number of backstresses. This argument is only valid if
hardening=COMBINED. The default value is 1.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If hardening=ISOTROPIC, or if hardening=COMBINED and dataType=HALF_CYCLE, the table data
specify the following:
• Yield stress.
• Plastic strain.
• Equivalent plastic strain rate, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If hardening=COMBINED and dataType=STABILIZED, the table data specify the following:
• Yield stress.
• Plastic strain.

26–204

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Strain range, if the data depend on strain range.

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If hardening=COMBINED and dataType=PARAMETERS, the table data specify the following:
• Yield stress at zero plastic strain.
• The first kinematic hardening parameter, .
• The first kinematic hardening parameter, .
• If applicable, the second kinematic hardening parameter, .
• If applicable, the second kinematic hardening parameter, .
• Etc.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If hardening=KINEMATIC, the table data specify the following:
• Yield stress.
• Plastic strain.
• Temperature, if the data depend on temperature.
If hardening=JOHNSON_COOK, the table data specify the following:
• A.
• B.
• n.
• m.
• Melting temperature.
• Transition temperature.
If hardening=USER, the table data specify the following:
• Hardening properties.

Return value
A Plastic object.

26–205

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Exceptions
RangeError.

26.76.2 setValues(...)
This method modifies the Plastic object.

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

Return value
None

Exceptions
RangeError.

26.76.3 Members
The Plastic object has members with the same names and descriptions as the arguments to the Plastic
method.
In addition, the Plastic object can have the following members:
rateDependent
A RateDependent object.
potential
A Potential object.
cyclicHardening
A CyclicHardening object.
ornl
An Ornl object.
cycledPlastic
A CycledPlastic object.
annealTemperature
An AnnealTemperature object.

26–206

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.76.4 Corresponding analysis keywords

*PLASTIC

26.77 PoreFluidExpansion object

The PoreFluidExpansion object specifies the thermal expansion coefficient for a hydraulic fluid.

Access
import material
mdb.models[name].materials[name].poreFluidExpansion
import odbMaterial
session.odbs[name].materials[name].poreFluidExpansion

26.77.1 PoreFluidExpansion(...)
This method creates a PoreFluidExpansion object.

Path
mdb.models[name].materials[name].PoreFluidExpansion
session.odbs[name].materials[name].PoreFluidExpansion

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
zero
A Float specifying the value of . The default value is 0.0.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Mean coefficient of thermal expansion, .

26–207

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A PoreFluidExpansion object.

Exceptions
RangeError.

26.77.2 setValues(...)
This method modifies the PoreFluidExpansion object.

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

Return value
None

Exceptions
RangeError.

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

26.77.4 Corresponding analysis keywords

*EXPANSION

26–208

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.78 PorousBulkModuli object

The PorousBulkModuli object defines bulk moduli for soils and rocks.

Access
import material
mdb.models[name].materials[name].porousBulkModuli
import odbMaterial
session.odbs[name].materials[name].porousBulkModuli

26.78.1 PorousBulkModuli(...)
This method creates a PorousBulkModuli object.

Path
mdb.models[name].materials[name].PorousBulkModuli
session.odbs[name].materials[name].PorousBulkModuli

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional argument
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
Table data

• Bulk modulus of solid grains.

• Bulk modulus of permeating fluid.
• Temperature, if the data depend on temperature.

Return value
A PorousBulkModuli object.

Exceptions
None.

26–209

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.78.2 setValues(...)
This method modifies the PorousBulkModuli object.

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

Return value
None

Exceptions
None.

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

26.78.4 Corresponding analysis keywords

*POROUS BULK MODULI

26.79 PorousElastic object

The PorousElastic object specifies elastic material properties for porous materials.

Access
import material
mdb.models[name].materials[name].porousElastic
import odbMaterial
session.odbs[name].materials[name].porousElastic

26–210

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.79.1 PorousElastic(...)
This method creates a PorousElastic object.

Path
mdb.models[name].materials[name].PorousElastic
session.odbs[name].materials[name].PorousElastic

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
shear
A SymbolicConstant specifying the shear definition form. Possible values are G and POISSON.
The default value is POISSON.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If shear=G, the table data specify the following:
• The logarithmic bulk modulus, . (Dimensionless.)
• The shear modulus, .
• The elastic tensile limit, . (This value cannot be negative.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If shear=POISSON, the table data specify the following:
• The logarithmic bulk modulus, . (Dimensionless.)
• The Poisson’s ratio, .
• The elastic tensile limit, . (This value cannot be negative.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

26–211

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A PorousElastic object.

Exceptions
RangeError.

26.79.2 setValues(...)
This method modifies the PorousElastic object.

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

Return value
None

Exceptions
RangeError.

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

26.79.4 Corresponding analysis keywords

*POROUS ELASTIC

26.80 PorousFailureCriteria object

The PorousFailureCriteria object specifies the material failure criteria for a porous metal.

26–212

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].porousMetalPlasticity\
.porousFailureCriteria
import odbMaterial
session.odbs[name].materials[name].porousMetalPlasticity\
.porousFailureCriteria

26.80.1 PorousFailureCriteria(...)
This method creates a PorousFailureCriteria object.

Path
mdb.models[name].materials[name].porousMetalPlasticity\
.PorousFailureCriteria
session.odbs[name].materials[name].porousMetalPlasticity\
.PorousFailureCriteria

Required arguments
None.
Optional arguments
fraction
A Float specifying the void volume fraction at total failure, . The default value is 1.0.
criticalFraction
A Float specifying the critical void volume fraction, . The default value is 1.0.

Return value
A PorousFailureCriteria object.

Exceptions
RangeError.

26.80.2 setValues(...)
This method modifies the PorousFailureCriteria object.

26–213

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.80.4 Corresponding analysis keywords

*POROUS FAILURE CRITERIA

26.81 PorousMetalPlasticity object

The PorousMetalPlasticity object specifies a porous metal plasticity model.

Access
import material
mdb.models[name].materials[name].porousMetalPlasticity
import odbMaterial
session.odbs[name].materials[name].porousMetalPlasticity

26.81.1 PorousMetalPlasticity(...)
This method creates a PorousMetalPlasticity object.

26–214

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].PorousMetalPlasticity
session.odbs[name].materials[name].PorousMetalPlasticity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
relativeDensity
None or a Float specifying the initial relative density of the material, . The default value is
None.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A PorousMetalPlasticity object.

Exceptions
RangeError.

26.81.2 setValues(...)
This method modifies the PorousMetalPlasticity object.

26–215

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

26.81.3 Members
The PorousMetalPlasticity object has members with the same names and descriptions as the arguments
to the PorousMetalPlasticity method.
In addition, the PorousMetalPlasticity object can have the following members:
porousFailureCriteria
A PorousFailureCriteria object.
voidNucleation
A VoidNucleation object.

26.81.4 Corresponding analysis keywords

*POROUS METAL PLASTICITY

26.82 Potential object

The Potential object defines an anisotropic yield/creep model.

Access
import material
mdb.models[name].materials[name].creep.potential
mdb.models[name].materials[name].plastic.potential

26–216

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

mdb.models[name].materials[name].viscous.potential
import odbMaterial
session.odbs[name].materials[name].creep.potential
session.odbs[name].materials[name].plastic.potential
session.odbs[name].materials[name].viscous.potential

26.82.1 Potential(...)
This method creates a Potential object.

Path
mdb.models[name].materials[name].creep.Potential
mdb.models[name].materials[name].plastic.Potential
mdb.models[name].materials[name].viscous.Potential
session.odbs[name].materials[name].creep.Potential
session.odbs[name].materials[name].plastic.Potential
session.odbs[name].materials[name].viscous.Potential

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• .
• .
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

26–217

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
A Potential object.

Exceptions
RangeError.

26.82.2 setValues(...)
This method modifies the Potential object.

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

Return value
None

Exceptions
RangeError.

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

26.82.4 Corresponding analysis keywords

*POTENTIAL

26.83 PressureEffect object

The PressureEffect object defines equivalent pressure stress driven mass diffusion.

26–218

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Access
import material
mdb.models[name].materials[name].diffusivity.pressureEffect
import odbMaterial
session.odbs[name].materials[name].diffusivity.pressureEffect

26.83.1 PressureEffect(...)
This method creates a PressureEffect object.

Path
mdb.models[name].materials[name].diffusivity.PressureEffect
session.odbs[name].materials[name].diffusivity.PressureEffect

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Pressure stress factor, .

• Concentration.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A PressureEffect object.

Exceptions
RangeError.

26–219

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.83.2 setValues(...)
This method modifies the PressureEffect object.

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

Return value
None

Exceptions
RangeError.

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

26.83.4 Corresponding analysis keywords

*KAPPA

26.84 RateDependent object

The RateDependent object defines a rate-dependent viscoplastic model.

Access
import material
mdb.models[name].materials[name].crushableFoam.rateDependent
mdb.models[name].materials[name].druckerPrager.rateDependent
mdb.models[name].materials[name].plastic.rateDependent
import odbMaterial

26–220

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

session.odbs[name].materials[name].crushableFoam.rateDependent
session.odbs[name].materials[name].druckerPrager.rateDependent
session.odbs[name].materials[name].plastic.rateDependent

26.84.1 RateDependent(...)
This method creates a RateDependent object.

Path
mdb.models[name].materials[name].crushableFoam.RateDependent
mdb.models[name].materials[name].druckerPrager.RateDependent
mdb.models[name].materials[name].plastic.RateDependent
session.odbs[name].materials[name].crushableFoam.RateDependent
session.odbs[name].materials[name].druckerPrager.RateDependent
session.odbs[name].materials[name].plastic.RateDependent

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the type of rate-dependent data. Possible values are
POWER_LAW, YIELD_RATIO, and JOHNSON_COOK. The default value is POWER_LAW.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=POWER_LAW, the table data specify the following:
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=YIELD_RATIO, the table data specify the following:
• Yield stress ratio, .
• Equivalent plastic strain rate, .

26–221

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Temperature, if the data depend on temperature.

• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=JOHNSON_COOK, the table data specify the following:
• .
• .

Return value
A RateDependent object.

Exceptions
RangeError.

26.84.2 setValues(...)
This method modifies the RateDependent object.

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

Return value
None

Exceptions
RangeError.

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

26.84.4 Corresponding analysis keywords

26–222

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

*RATE DEPENDENT

26.85 Ratios object

The Ratios object specifies ratios that define anisotropic swelling.

Access
import material
mdb.models[name].materials[name].moistureSwelling.ratios
mdb.models[name].materials[name].swelling.ratios
import odbMaterial
session.odbs[name].materials[name].moistureSwelling.ratios
session.odbs[name].materials[name].swelling.ratios

26.85.1 Ratios(...)
This method creates a Ratios object.

Path
mdb.models[name].materials[name].moistureSwelling.Ratios
mdb.models[name].materials[name].swelling.Ratios
session.odbs[name].materials[name].moistureSwelling.Ratios
session.odbs[name].materials[name].swelling.Ratios

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• .
• .

26–223

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Ratios object.

Exceptions
RangeError.

26.85.2 setValues(...)
This method modifies the Ratios object.

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

Return value
None

Exceptions
RangeError.

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

26.85.4 Corresponding analysis keywords

*RATIOS

26–224

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.86 Regularization object

The Regularization object defines the tolerance to be used for regularizing material data.

Access
import material
mdb.models[name].materials[name].regularization
import odbMaterial
session.odbs[name].materials[name].regularization

26.86.1 Regularization(...)
This method creates a Regularization object.

Path
mdb.models[name].materials[name].Regularization
session.odbs[name].materials[name].Regularization

Required arguments
None.
Optional arguments
rtol
A Float specifying the tolerance to be used for regularizing material data. The default value is
0.03.
strainRateRegularization
A SymbolicConstant specifying the form of regularization of strain-rate-dependent material data.
Possible values are LOGARITHMIC and LINEAR. The default value is LOGARITHMIC.

Return value
A Regularization object.

Exceptions
RangeError.

26.86.2 setValues(...)
This method modifies the Regularization object.

26–225

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.86.4 Corresponding analysis keywords

*DASHPOT

26.87 SaturationDependence object

The SaturationDependence object specifies the dependence of the permeability of a material on the
saturation of the wetting liquid.

Access
import material
mdb.models[name].materials[name].permeability.saturationDependence
import odbMaterial
session.odbs[name].materials[name].permeability.saturationDependence

26.87.1 SaturationDependence(...)
This method creates a SaturationDependence object.

26–226

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].permeability.SaturationDependence
session.odbs[name].materials[name].permeability.SaturationDependence

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• . (Dimensionless.)
• Saturation, . (Dimensionless.)

Return value
A SaturationDependence object.

Exceptions
RangeError.

26.87.2 setValues(...)
This method modifies the SaturationDependence object.

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

Return value
None

Exceptions
RangeError.

26–227

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

26.87.4 Corresponding analysis keywords

*PERMEABILITY

26.88 Shear object

The Shear object specifies elastic shear.

Access
import material
mdb.models[name].materials[name].shear
import odbMaterial
session.odbs[name].materials[name].shear

26.88.1 Shear(...)
This method creates a Shear object.

Path
mdb.models[name].materials[name].Shear
session.odbs[name].materials[name].Shear

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.

26–228

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Table data

• Shear.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Shear object.

Exceptions
RangeError.

26.88.2 setValues(...)
This method modifies the Shear object.

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

Return value
None

Exceptions
RangeError.

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

26.88.4 Corresponding analysis keywords

*SHEAR

26–229

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.89 ShearRetention object

The ShearRetention object defines the reduction of the shear modulus associated with crack surfaces in
a Concrete model as a function of the tensile strain across the crack.

Access
import material
mdb.models[name].materials[name].concrete.shearRetention
import odbMaterial
session.odbs[name].materials[name].concrete.shearRetention

26.89.1 ShearRetention(...)
This method creates a ShearRetention object.

Path
mdb.models[name].materials[name].concrete.ShearRetention
session.odbs[name].materials[name].concrete.ShearRetention

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• for dry concrete. The default value is 1.0.

• for dry concrete. The default value is a very large number (full shear retention).
• for wet concrete. The default value is 1.0.
• for wet concrete. The default value is a very large number (full shear retention).
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.

26–230

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Value of the second field variable.

• Etc.

Return value
A ShearRetention object.

Exceptions
RangeError.

26.89.2 setValues(...)
This method modifies the ShearRetention object.

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

Return value
None

Exceptions
RangeError.

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

26.89.4 Corresponding analysis keywords

*SHEAR RETENTION

26–231

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.90 ShearTestData object

The ShearTestData object specifies the normalized shear creep compliance or relaxation modulus as a
function of time.

Access
import material
mdb.models[name].materials[name].viscoelastic.shearTestData
import odbMaterial
session.odbs[name].materials[name].viscoelastic.shearTestData

26.90.1 ShearTestData(...)
This method creates a ShearTestData object.

Path
mdb.models[name].materials[name].viscoelastic.ShearTestData
session.odbs[name].materials[name].viscoelastic.ShearTestData

Required argument
table
A sequence of sequences of Floats specifying values that depend on the time member of the
Viscoelastic object.
If time=RELAXATION_TEST_DATA, the table data specify the following:
• Normalized shear relaxation modulus . .
• Time . .
If time=CREEP_TEST_DATA, the table data specify the following:
• Normalized shear compliance . .
• Time . .

Optional argument
shrinf
None or a Float specifying a normalized shear. The value of shrinf depends on the value of the
time member of the Viscoelastic object. The default value is None.
If time=RELAXATION_TEST_DATA, shrinf specifies the value of the long-term,
normalized shear modulus .

26–232

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

If time=CREEP_TEST_DATA, shrinf specifies the value of the long-term, normalized shear

compliance .

Return value
A ShearTestData object.

Exceptions
None.

26.90.2 setValues(...)
This method modifies the ShearTestData object.

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

Return value
None

Exceptions
None.

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

26.90.4 Corresponding analysis keywords

*SHEAR TEST DATA

26–233

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.91 SimpleShearTestData object

The SimpleShearTestData object provides simple shear test data.

Access
import material
mdb.models[name].materials[name].hyperfoam.simpleShearTestData
import odbMaterial
session.odbs[name].materials[name].hyperfoam.simpleShearTestData

26.91.1 SimpleShearTestData(...)
This method creates a SimpleShearTestData object.

Path
mdb.models[name].materials[name].hyperfoam.SimpleShearTestData
session.odbs[name].materials[name].hyperfoam.SimpleShearTestData

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• Nominal shear stress, .

• Nominal shear strain, .
• Nominal transverse stress, (normal to edge with shear stress). This stress value is optional.

Return value
A SimpleShearTestData object.

Exceptions
None.

26–234

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

26.91.2 setValues(...)
This method modifies the SimpleShearTestData object.

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

Return value
None

Exceptions
None.

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

26.91.4 Corresponding analysis keywords

*SIMPLE SHEAR TEST DATA

26.92 Solubility object

The Solubility object specifies solubility.

Access
import material
mdb.models[name].materials[name].solubility
import odbMaterial
session.odbs[name].materials[name].solubility

26–235

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.92.1 Solubility(...)
This method creates a Solubility object.

Path
mdb.models[name].materials[name].Solubility
session.odbs[name].materials[name].Solubility

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Solubility.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Solubility object.

Exceptions
RangeError.

26.92.2 setValues(...)
This method modifies the Solubility object.

Arguments
Required arguments
None.

26–236

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the Solubility method.

Return value
None

Exceptions
RangeError.

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

26.92.4 Corresponding analysis keywords

*SOLUBILITY

26.93 SoretEffect object

The SoretEffect object defines temperature gradient driven mass diffusion.

Access
import material
mdb.models[name].materials[name].diffusivity.soretEffect
import odbMaterial
session.odbs[name].materials[name].diffusivity.soretEffect

26.93.1 SoretEffect(...)
This method creates a SoretEffect object.

Path
mdb.models[name].materials[name].diffusivity.SoretEffect
session.odbs[name].materials[name].diffusivity.SoretEffect

26–237

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Soret effect factor, .

• Concentration.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A SoretEffect object.

Exceptions
RangeError.

26.93.2 setValues(...)
This method modifies the SoretEffect object.

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

Return value
None

26–238

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

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

26.93.4 Corresponding analysis keywords

*KAPPA

26.94 Sorption object

The Sorption object defines absorption and exsorption behaviors of a partially saturated porous medium
in the analysis of coupled wetting liquid flow and porous medium stress.

Access
import material
mdb.models[name].materials[name].sorption
import odbMaterial
session.odbs[name].materials[name].sorption

26.94.1 Sorption(...)
This method creates a Sorption object.

Path
mdb.models[name].materials[name].Sorption
session.odbs[name].materials[name].Sorption

Required argument
absorptionTable
A sequence of sequences of Floats specifying the items described below.

26–239

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
lawAbsorption
A SymbolicConstant specifying absorption behavior. Possible values are LOG and TABULAR.
The default value is TABULAR.
exsorption
A Boolean specifying whether the exsorption data is specified. The default value is OFF.
lawExsorption
A SymbolicConstant specifying exsorption behavior. Possible values are LOG and TABULAR.
The default value is TABULAR.
scanning
A Float specifying the slope of the scanning line, . This slope must be positive and
larger than the slope of the absorption or exsorption behaviors. The default value is 0.0.
exsorptionTable
A sequence of sequences of Floats specifying the items described below. The default value is an
empty sequence.
Table data
If lawAbsorption=TABULAR or lawExsorption=TABULAR, the absorptionTable and exsorptionTable
data respectively specify the following:
• Pore pressure, .
• Saturation, .
If lawAbsorption=LOG or lawExsorption=LOG, the absorptionTable and exsorptionTable data
respectively specify the following:
• A.
• B.
• .
• .

Return value
A Sorption object.

Exceptions
RangeError.

26.94.2 setValues(...)
This method modifies the Sorption object.

26–240

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.94.4 Corresponding analysis keywords

*SORPTION

26.95 SpecificHeat object

The SpecificHeat object specifies a material’s specific heat.

Access
import material
mdb.models[name].materials[name].specificHeat
import odbMaterial
session.odbs[name].materials[name].specificHeat

26.95.1 SpecificHeat(...)
This method creates a SpecificHeat object.

26–241

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Path
mdb.models[name].materials[name].SpecificHeat
session.odbs[name].materials[name].SpecificHeat

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
law
A SymbolicConstant specifying the specific heat behavior. Possible values
are CONSTANTVOLUME and CONSTANTPRESSURE. The default value is
CONSTANTVOLUME.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Specific heat per unit mass.

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A SpecificHeat object.

Exceptions
RangeError.

26.95.2 setValues(...)
This method modifies the SpecificHeat object.

Arguments
Required arguments
None.

26–242

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the SpecificHeat method.

Return value
None

Exceptions
RangeError.

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

26.95.4 Corresponding analysis keywords

*SPECIFIC HEAT

26.96 Swelling object

The Swelling object specifies time-dependent volumetric swelling for a material.

Access
import material
mdb.models[name].materials[name].swelling
import odbMaterial
session.odbs[name].materials[name].swelling

26.96.1 Swelling(...)
This method creates a Swelling object.

Path
mdb.models[name].materials[name].Swelling
session.odbs[name].materials[name].Swelling

26–243

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
This argument is valid only when law=INPUT.
Optional arguments
law
A SymbolicConstant specifying the type of data defining the swelling behavior. Possible values
are INPUT and USER. The default value is INPUT.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Volumetric swelling strain rate.

• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Swelling object.

Exceptions
RangeError.

26.96.2 setValues(...)
This method modifies the Swelling object.

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

26–244

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
None

Exceptions
RangeError.

26.96.3 Members
The Swelling object has members with the same names and descriptions as the arguments to the
Swelling method.
In addition, the Swelling object can have the following member:
ratios
A Ratios object.

26.96.4 Corresponding analysis keywords

*SWELLING

26.97 TensionCutOff object

The TensionCutOff object specifies tension cutoff for different material models for example the Mohr-
Coulomb plasticity model.

Access
import material
mdb.models[name].materials[name].mohrCoulombPlasticity.tensionCutOff
import odbMaterial
session.odbs[name].materials[name].mohrCoulombPlasticity.tensionCutOff

26.97.1 TensionCutOff(...)
This method creates a TensionCutOff object.

Path
mdb.models[name].materials[name].mohrCoulombPlasticity.TensionCutOff

26–245

Abaqus ID:
Printed on:
MATERIAL COMMANDS

session.odbs[name].materials[name].mohrCoulombPlasticity.TensionCutOff

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• Tension cutoff stress.

• The value of the corresponding tensile plastic strain.(The first tabular value entered must always be
zero.)
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A TensionCutOff object.

Exceptions
RangeError.

26.97.2 setValues(...)
This method modifies the TensionCutOff object.

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

26–246

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
None

Exceptions
RangeError.

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

26.97.4 Corresponding analysis keywords

*TENSION CUTOFF

26.98 TensionStiffening object

The TensionStiffening object defines the retained tensile stress normal to a crack in a Concrete model.

Access
import material
mdb.models[name].materials[name].concrete.tensionStiffening
import odbMaterial
session.odbs[name].materials[name].concrete.tensionStiffening

26.98.1 TensionStiffening(...)
This method creates a TensionStiffening object.

Path
mdb.models[name].materials[name].concrete.TensionStiffening
session.odbs[name].materials[name].concrete.TensionStiffening

Required argument
table
A sequence of sequences of Floats specifying the items described below.

26–247

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
type
A SymbolicConstant specifying how the postcracking behavior is defined. Possible values are
DISPLACEMENT and STRAIN. The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=STRAIN, the table data specify the following:
• Fraction of remaining stress to stress at cracking.
• Absolute value of the direct strain minus the direct strain at cracking.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If type=DISPLACEMENT, the table data specify the following:
• Displacement, , at which a linear loss of strength after cracking gives zero stress.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A TensionStiffening object.

Exceptions
RangeError.

26.98.2 setValues(...)
This method modifies the TensionStiffening object.

Arguments
Required arguments
None.

26–248

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the TensionStiffening
method.

Return value
None

Exceptions
RangeError.

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

26.98.4 Corresponding analysis keywords

*TENSION STIFFENING

26.99 TriaxialTestData object

The TriaxialTestData object provides triaxial test data.

Access
import material
mdb.models[name].materials[name].druckerPrager.triaxialTestData
import odbMaterial
session.odbs[name].materials[name].druckerPrager.triaxialTestData

26.99.1 TriaxialTestData(...)
This method creates a TriaxialTestData object.

Path
mdb.models[name].materials[name].druckerPrager.TriaxialTestData
session.odbs[name].materials[name].druckerPrager.TriaxialTestData

26–249

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
a
None or a Float specifying the value of the material constant . None is used when the value is
unknown or it is not held fixed at the input value. The default value is None.
b
None or a Float specifying the value of the material constant . None is used when the value is
unknown or it is not held fixed at the input value. The default value is None.
pt
None or a Float specifying the value of the material constant . None is used when the value is
unknown or it is not held fixed at the input value. The default value is None.
Table data

• Sign and magnitude of confining stress, .

• Sign and magnitude of the stress in loading direction, .

Return value
A TriaxialTestData object.

Exceptions
RangeError.

26.99.2 setValues(...)
This method modifies the TriaxialTestData object.

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

Return value
None

26–250

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

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

26.99.4 Corresponding analysis keywords

*TRIAXIAL TEST DATA

26.100 Trs object

The Trs object defines the temperature-time shift for time history viscoelastic analysis.

Access
import material
mdb.models[name].materials[name].viscoelastic.trs
mdb.models[name].materials[name].viscosity.trs
import odbMaterial
session.odbs[name].materials[name].viscoelastic.trs
session.odbs[name].materials[name].viscosity.trs

26.100.1 Trs(...)
This method creates a Trs object.

Path
mdb.models[name].materials[name].viscoelastic.Trs
mdb.models[name].materials[name].viscosity.Trs
session.odbs[name].materials[name].viscoelastic.Trs
session.odbs[name].materials[name].viscosity.Trs

Required arguments
None.

26–251

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Optional arguments
definition
A SymbolicConstant specifying the definition of the shift function. Possible values are WLF,
ARRHENIUS, and USER. The default value is WLF.
table
A sequence of sequences of Floats specifying the items described below. The default value is an
empty sequence.
This argument is valid only when definition=WLF.
Table data

• Reference temperature, .
• Calibration constant, .
• Calibration constant, .

Return value
A Trs object.

Exceptions
None.

26.100.2 setValues(...)
This method modifies the Trs object.

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

Return value
None

Exceptions
None.

26–252

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

26.100.4 Corresponding analysis keywords

*TRS

26.101 UniaxialTestData object

The UniaxialTestData object provides uniaxial test data (compression and/or tension).

Access
import material
mdb.models[name].materials[name].hyperelastic.uniaxialTestData
mdb.models[name].materials[name].hyperfoam.uniaxialTestData
mdb.models[name].materials[name].lowDensityFoam\
.uniaxialCompressionTestData
mdb.models[name].materials[name].lowDensityFoam\
.uniaxialTensionTestData
mdb.models[name].materials[name].mullinsEffect.uniaxialTests[i]
import odbMaterial
session.odbs[name].materials[name].hyperelastic.uniaxialTestData
session.odbs[name].materials[name].hyperfoam.uniaxialTestData
session.odbs[name].materials[name].lowDensityFoam\
.uniaxialCompressionTestData
session.odbs[name].materials[name].lowDensityFoam\
.uniaxialTensionTestData
session.odbs[name].materials[name].mullinsEffect.uniaxialTests[i]

26.101.1 UniaxialTestData(...)
This method creates a UniaxialTestData object.

Path
mdb.models[name].materials[name].hyperelastic.UniaxialTestData
mdb.models[name].materials[name].hyperfoam.UniaxialTestData

26–253

Abaqus ID:
Printed on:
MATERIAL COMMANDS

mdb.models[name].materials[name].lowDensityFoam.UniaxialTestData
mdb.models[name].materials[name].mullinsEffect.UniaxialTestData
session.odbs[name].materials[name].hyperelastic.UniaxialTestData
session.odbs[name].materials[name].hyperfoam.UniaxialTestData
session.odbs[name].materials[name].lowDensityFoam.UniaxialTestData
session.odbs[name].materials[name].mullinsEffect.UniaxialTestData

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
smoothing
None or an Int specifying the value for smoothing. If smoothing=None, no smoothing is
employed. The default value is None.
lateralNominalStrain
A Boolean specifying whether to include lateral nominal strain. The default value is OFF.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
For a hyperelastic material model, the table data specify the following:
• Nominal stress, .
• Nominal strain, .
For a hyperfoam material model, the table data specify the following:
• Nominal stress, .
• Nominal strain, .
• Nominal lateral strain, . The default value is 0.
For a low-density foam material model, the table data specify the following:
• Nominal stress, .
• Nominal strain, .
• Nominal strain rate, .

Return value
A UniaxialTestData object.

26–254

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
None.

26.101.2 setValues(...)
This method modifies the UniaxialTestData object.

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

Return value
None

Exceptions
None.

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

26.101.4 Corresponding analysis keywords

*UNIAXIAL TEST DATA

26.102 UserDefinedField object

The UserDefinedField object redefines field variables at a material point.

Access
import material

26–255

Abaqus ID:
Printed on:
MATERIAL COMMANDS

mdb.models[name].materials[name].userDefinedField
import odbMaterial
session.odbs[name].materials[name].userDefinedField

26.102.1 UserDefinedField()
This method defines a UserDefinedField object.

Path
mdb.models[name].materials[name].UserDefinedField
session.odbs[name].materials[name].UserDefinedField

Arguments
None.

Return value
A UserDefinedField object.

Exceptions
None.

26.102.2 Members
The UserDefinedField object has no members.

26.102.3 Corresponding analysis keywords

*USER DEFINED FIELD

26.103 UserMaterial object

The UserMaterial object defines material constants for use in subroutines UMAT, UMATHT, or VUMAT.

Access
import material
mdb.models[name].materials[name].userMaterial

26–256

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

import odbMaterial
session.odbs[name].materials[name].userMaterial

26.103.1 UserMaterial(...)
This method creates a UserMaterial object.

Path
mdb.models[name].materials[name].UserMaterial
session.odbs[name].materials[name].UserMaterial

Required arguments
None.
Optional arguments
type
A SymbolicConstant specifying the type of material behavior defined by the command. Possible
values are MECHANICAL, THERMAL, and THERMOMECHANICAL. The default value is
MECHANICAL.
unsymm
A Boolean specifying if the material stiffness matrix, , is not symmetric or, when a
thermal constitutive model is used, if is not symmetric. The default value is OFF.
This argument is valid only for an Abaqus/Standard analysis.
mechanicalConstants
A sequence of Floats specifying the mechanical constants of the material. This argument is valid
only when type=MECHANICAL or THERMOMECHANICAL. The default value is an empty
sequence.
thermalConstants
A sequence of Floats specifying the thermal constants of the material. This argument is valid only
when type=THERMAL or THERMOMECHANICAL. The default value is an empty sequence.

Return value
A UserMaterial object.

Exceptions
RangeError.

26.103.2 setValues(...)
This method modifies the UserMaterial object.

26–257

Abaqus ID:
Printed on:
MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

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

26.103.4 Corresponding analysis keywords

*USER MATERIAL

26.104 UserOutputVariables object

The UserOutputVariables object specifies the number of user-defined output variables.

Access
import material
mdb.models[name].materials[name].userOutputVariables
import odbMaterial
session.odbs[name].materials[name].userOutputVariables

26.104.1 UserOutputVariables(...)
This method creates a UserOutputVariables object.

26–258

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Path
mdb.models[name].materials[name].UserOutputVariables
session.odbs[name].materials[name].UserOutputVariables

Required arguments
None.
Optional argument
n
An Int specifying the number of user-defined variables required at each material point. The default
value is 0.

Return value
A UserOutputVariables object.

Exceptions
RangeError.

26.104.2 setValues(...)
This method modifies the UserOutputVariables object.

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

Return value
None

Exceptions
RangeError.

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

26–259

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.104.4 Corresponding analysis keywords

*USER OUTPUT VARIABLES

26.105 VelocityDependence object

The VelocityDependence object specifies the dependence of the permeability of a material on the velocity
of fluid flow.

Access
import material
mdb.models[name].materials[name].permeability.velocityDependence
import odbMaterial
session.odbs[name].materials[name].permeability.velocityDependence

26.105.1 VelocityDependence(...)
This method creates a VelocityDependence object.

Path
mdb.models[name].materials[name].permeability.VelocityDependence
session.odbs[name].materials[name].permeability.VelocityDependence

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
None.
Table data

• . Only 0.0 is allowed.

• Void ratio, .

Return value
A VelocityDependence object.

26–260

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Exceptions
RangeError.

26.105.2 setValues(...)
This method modifies the VelocityDependence object.

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

Return value
None

Exceptions
RangeError.

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

26.105.4 Corresponding analysis keywords

*PERMEABILITY

26.106 Viscoelastic object

The Viscoelastic object specifies dissipative behavior for use with elasticity.

Access
import material

26–261

Abaqus ID:
Printed on:
MATERIAL COMMANDS

mdb.models[name].materials[name].viscoelastic
import odbMaterial
session.odbs[name].materials[name].viscoelastic

26.106.1 Viscoelastic(...)
This method creates a Viscoelastic object.

Path
mdb.models[name].materials[name].Viscoelastic
session.odbs[name].materials[name].Viscoelastic

Required arguments
domain
A SymbolicConstant specifying the domain definition. Possible values are:
• FREQUENCY, specifying a frequency domain. This domain is only available for an
Abaqus/Standard analysis.
• TIME, specifying a time domain.

table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
frequency
A SymbolicConstant specifying the frequency domain definition. This argument is required
only when domain=FREQUENCY. Possible values are FORMULA, TABULAR, PRONY,
CREEP_TEST_DATA, and RELAXATION_TEST_DATA. The default value is FORMULA.
type
A SymbolicConstant specifying the type. This argument is required only when
domain=FREQUENCY and frequency=TABULAR. Possible values are ISOTROPIC and
TRACTION. The default value is ISOTROPIC.
preload
A SymbolicConstant specifying the preload. This argument is required only when
domain=FREQUENCY and frequency=TABULAR. Possible values are NONE, UNIAXIAL,
VOLUMETRIC, and UNIAXIAL_VOLUMETRIC. The default value is NONE.
time
A SymbolicConstant specifying the time domain definition. This argument is required
only when domain=TIME. Possible values are PRONY, CREEP_TEST_DATA,
RELAXATION_TEST_DATA, and FREQUENCY_DATA. The default value is PRONY.

26–262

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

errtol
A Float specifying the allowable average root-mean-square error of the data points in the least-
squares fit. The Float values correspond to percentages; for example, 0.01 is 1%. The default
value is 0.01.
This argument is valid only when time=CREEP_TEST_DATA,
RELAXATION_TEST_DATA or FREQUENCY_DATA; or only when
frequency=CREEP_TEST_DATA or RELAXATION_TEST_DATA.
nmax
An Int specifying the maximum number of terms in the Prony series. The maximum value is
13. The default value is 13.
This argument is valid only when time=CREEP_TEST_DATA,
RELAXATION_TEST_DATA or FREQUENCY_DATA; or only when
frequency=CREEP_TEST_DATA or RELAXATION_TEST_DATA.
volumetricTable
A sequence of sequences of Floats specifying the items described below. The default value is an
empty sequence.
Table data
If frequency=FORMULA, the table data for table specify the following:
• Real part of .
• Imaginary part of .
• Value of .
• Real part of . If the material is incompressible, this value is ignored.
• Imaginary part of . If the material is incompressible, this value is ignored.
• Value of . If the material is incompressible, this value is ignored.
If frequency=TABULAR and type=ISOTROPIC and preload=NONE, or time=FREQUENCY_DATA
the table data for table specify the following:
• Real part of .
• Imaginary part of .
• Real part of . If the material is incompressible, this value is ignored.
• Imaginary part of . If the material is incompressible, this value is
ignored.
• Frequency in cycles per time.
If frequency=TABULAR and type=ISOTROPIC and preload=UNIAXIAL the table data for table specify
the following:
• Loss modulus.
• Storage modulus.
• Frequency.

26–263

Abaqus ID:
Printed on:
MATERIAL COMMANDS

• Uniaxial strain.
If frequency=TABULAR and type=TRACTION and preload=NONE the table data for table specify the
following:
• Normalized loss modulus.
• Normalized shear modulus.
• Frequency.
If frequency=TABULAR and type=TRACTION and preload=UNIAXIAL or
preload=UNIAXIAL_VOLUMETRIC the table data for table specify the following:
• Loss modulus.
• Storage modulus.
• Frequency.
• Closure.
If time=PRONY or frequency=PRONY, the table data for table specify the following:
• , the modulus ratio in the first term in the Prony series expansion of the shear relaxation modulus.
• , the modulus ratio in the first term in the Prony series expansion of the bulk relaxation modulus.
• , the relaxation time for the first term in the Prony series expansion.
If frequency=TABULAR and type=ISOTROPIC and preload=VOLUMETRIC or
preload=UNIAXIAL_VOLUMETRIC the table data for volumetricTable specify the following:
• Loss modulus.
• Storage modulus.
• Frequency.
• Volume ratio.

Return value
A Viscoelastic object.

Exceptions
RangeError.

26.106.2 setValues(...)
This method modifies the Viscoelastic object.

Arguments
Required arguments
None.

26–264

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
The optional arguments to setValues are the same as the arguments to the Viscoelastic method.

Return value
None

Exceptions
RangeError.

26.106.3 Members
The Viscoelastic object has members with the same names and descriptions as the arguments to the
Viscoelastic method.
In addition, the Viscoelastic object can have the following members:
combinedTestData
A CombinedTestData object.
shearTestData
A ShearTestData object.
trs
A Trs object.
volumetricTestData
A VolumetricTestData object.

26.106.4 Corresponding analysis keywords

*VISCOELASTIC

26.107 Viscosity object

The Viscosity object specifies mechanical viscosity.

Access
import material
mdb.models[name].materials[name].viscosity
import odbMaterial
session.odbs[name].materials[name].viscosity

26–265

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.107.1 Viscosity(...)
This method creates a Viscosity object.

Path
mdb.models[name].materials[name].Viscosity
session.odbs[name].materials[name].Viscosity

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
type
A SymbolicConstant specifying the type of viscosity. The default value is NEWTONIAN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If type=NEWTONIAN, the table data specify the following:
• Viscosity, .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

Return value
A Viscosity object.

Exceptions
RangeError.

26.107.2 setValues(...)
This method modifies the Viscosity object.

26–266

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

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

Return value
None

Exceptions
RangeError.

26.107.3 Members
The Viscosity object has members with the same names and descriptions as the arguments to the
Viscosity method.
In addition, the Viscosity object can have the following member:
trs
A Trs object.

26.107.4 Corresponding analysis keywords

*VISCOSITY

26.108 Viscous object

The Viscous object specifies the viscous properties for a two-layer viscoplastic material model.

Access
import material
mdb.models[name].materials[name].viscous
import odbMaterial
session.odbs[name].materials[name].viscous

26–267

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.108.1 Viscous(...)
This method creates a Viscous object.

Path
mdb.models[name].materials[name].Viscous
session.odbs[name].materials[name].Viscous

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
law
A SymbolicConstant specifying the creep law. Possible values are STRAIN, TIME, and USER.
The default value is STRAIN.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
If law=STRAIN or law=TIME, the table data specify the following:
• .
• .
• .
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.
If law=USER, the table data specify the following:
• .
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.
• Etc.

26–268

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Return value
A Viscous object.

Exceptions
None.

26.108.2 setValues(...)
This method modifies the Viscous object.

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

Return value
None

Exceptions
None.

26.108.3 Members
The Viscous object has members with the same names and descriptions as the arguments to the Viscous
method.
In addition, the Viscous object can have the following member:
potential
A Potential object.

26.108.4 Corresponding analysis keywords

*VISCOUS

26–269

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.109 VoidNucleation object

The VoidNucleation object defines the nucleation of voids in a porous material.

Access
import material
mdb.models[name].materials[name].porousMetalPlasticity.voidNucleation
import odbMaterial
session.odbs[name].materials[name].porousMetalPlasticity\
.voidNucleation

26.109.1 VoidNucleation(...)
This method creates a VoidNucleation object.

Path
mdb.models[name].materials[name].porousMetalPlasticity.VoidNucleation
session.odbs[name].materials[name].porousMetalPlasticity\
.VoidNucleation

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data

• , the mean value of the nucleation-strain normal distribution.

• , the standard deviation of the nucleation-strain normal distribution.
• , the volume fraction of nucleating voids.
• Temperature, if the data depend on temperature.
• Value of the first field variable, if the data depend on field variables.
• Value of the second field variable.

26–270

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

• Etc.

Return value
A VoidNucleation object.

Exceptions
RangeError.

26.109.2 setValues(...)
This method modifies the VoidNucleation object.

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

Return value
None

Exceptions
RangeError.

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

26.109.4 Corresponding analysis keywords

*VOID NUCLEATION

26–271

Abaqus ID:
Printed on:
MATERIAL COMMANDS

26.110 VolumetricTestData object

The VolumetricTestData object provides volumetric test data.

Access
import material
mdb.models[name].materials[name].hyperelastic.volumetricTestData
mdb.models[name].materials[name].hyperfoam.volumetricTestData
mdb.models[name].materials[name].viscoelastic.volumetricTestData
import odbMaterial
session.odbs[name].materials[name].hyperelastic.volumetricTestData
session.odbs[name].materials[name].hyperfoam.volumetricTestData
session.odbs[name].materials[name].viscoelastic.volumetricTestData

26.110.1 VolumetricTestData(...)
This method creates a VolumetricTestData object.

Path
mdb.models[name].materials[name].hyperelastic.VolumetricTestData
mdb.models[name].materials[name].hyperfoam.VolumetricTestData
mdb.models[name].materials[name].viscoelastic.VolumetricTestData
session.odbs[name].materials[name].hyperelastic.VolumetricTestData
session.odbs[name].materials[name].hyperfoam.VolumetricTestData
session.odbs[name].materials[name].viscoelastic.VolumetricTestData

Required argument
table
A sequence of sequences of Floats specifying the items described below.
Optional arguments
volinf
None or a Float specifying a normalized volumetric value that depends on the value of the time
member of the Viscoelastic object. The default value is None.
If time=RELAXATION_TEST_DATA, volinf specifies the value of the long-term,
normalized volumetric modulus, .
If time=CREEP_TEST_DATA, volinf specifies the value of the long-term, normalized
volumetric compliance, .
This argument is valid only for a viscoelastic material model.

26–272

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

smoothing
None or an Int specifying the value for smoothing. If smoothing=None, no smoothing is
employed. The default value is None.
temperatureDependency
A Boolean specifying whether the data depend on temperature. The default value is OFF.
dependencies
An Int specifying the number of field variable dependencies. The default value is 0.
Table data
For a hyperelastic or hyperfoam material model, the table data specify the following:
• Pressure, .
• Volume ratio, (current volume/original volume).
For a viscoelastic material model, the values depend on the value of the time member of the Viscoelastic
object.
If time=RELAXATION_TEST_DATA, the table data specify the following:
• Normalized volumetric (bulk) modulus .
• Time .
If time=CREEP_TEST_DATA, the table data specify the following:
• Normalized volumetric (bulk) compliance .
• Time .

Return value
A VolumetricTestData object.

Exceptions
None.

26.110.2 setValues(...)
This method modifies the VolumetricTestData object.

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

26–273

Abaqus ID:
Printed on:
MATERIAL COMMANDS

Return value
None

Exceptions
None.

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

26.110.4 Corresponding analysis keywords

*VOLUMETRIC TEST DATA

26.111 evaluateMaterial

This command evaluates the behavior of a hyperelastic material under standard test conditions.

Access
from material import evaluateMaterial

26.111.1 evaluateMaterial(...)
This method evaluates the behavior of a hyperelastic material under standard test conditions.

Path
evaluateMaterial

Arguments
Required arguments
material
A Material object.
simulationName
A String specifying the name to be used for the material evaluation simulation.

26–274

Abaqus ID:
Printed on:
 MATERIAL COMMANDS

Optional arguments
Note: Although uniaxialStrainRange, biaxialStrainRange, planarStrainRange, volumeRatioRange, and
simpleShearStrainRange are optional arguments, at least one of them must be specified with a nonzero
value.
dataSource
A SymbolicConstant specifying whether test data or coefficients should be used for the material
definition in the unit element tests. Possible values are TEST_DATA or COEFFICIENTS.
strainEnergyPotentials
A sequence of SymbolicConstants specifying for which material models the material
is to be evaluated. Possible values are POLY_N1, POLY_N2, POLY_N3, POLY_N4,
POLY_N5, POLY_N6, OGDEN_N1, OGDEN_N2, OGDEN_N3, OGDEN_N4, OGDEN_N5,
OGDEN_N6, REDUCED_POLY_N1, REDUCED_POLY_N2, REDUCED_POLY_N3,
REDUCED_POLY_N4, REDUCED_POLY_N5, REDUCED_POLY_N6, ARRUDA_BOYCE,
VAN_DER_WAALS, YEOH, MOONEY_RIVLIN, and NEO_HOOKE.
Note: The options POLY_N3, POLY_N4, POLY_N5, and POLY_N6 are valid only if the material
was defined by providing coefficients of the strain energy potential.
marlowData
None or a sequence of SymbolicConstants specifying the types of test data to be included in the
material definition of the Marlow material that is being evaluated. Possible values are UNIAXIAL,
BIAXIAL, PLANAR, or VOLUMETRIC. The default value is None.
marlowDataType
None or a SymbolicConstant specifying the input data type for the Marlow material model.
Possible values are TENSION, COMPRESSION, or BOTH.
testDataTypes
A sequence of SymbolicConstants specifying the types of test data to be included in the material
definition of the material being evaluated. Possible values are UNIAXIAL, BIAXIAL, PLANAR,
and VOLUMETRIC.
uniaxialStrainRange
A tuple of Floats specifying minimum and maximum nominal strains to be applied in the uniaxial
tension test.
biaxialStrainRange
A tuple of Floats specifying the minimum and maximum nominal strains to be applied in the biaxial
tension test.
planarStrainRange
A tuple of Floats specifying the minimum and maximum nominal strains to be applied in the planar
test. The planar test is equivalent to a pure shear test.
volumeRatioRange
A tuple of Floats specifying the minimum and maximum compressive volume ratio.

26–275

Abaqus ID:
Printed on:
MATERIAL COMMANDS

simpleShearStrainRange
A tuple of Floats specifying the minimum and maximum nominal strains to be applied in the simple
shear test.
viscoDataSource
None or a SymbolicConstant specifying whether test data or coefficients should be used for
the viscoelastic material definition in the element tests. Possible values are TEST_DATA or
COEFFICIENTS. The default value is None.
viscoTestDataTypes
None or a sequence of SymbolicConstants specifying the types of test data to be included in the
material definition of the viscoelastic material being evaluated. Possible values are UNIAXIAL,
BIAXIAL, PLANAR, or VOLUMETRIC. The default value is None.
relaxationTime
None or a Float specifying the time period for the stress relaxation response mode. The default
value is None.
creepTime
None or a Float specifying the time period for the creep response mode. The default value is
None.

Return value
None

Exceptions
If dataSource=TEST_DATA and strainEnergyPotentials contains POLY_N3, POLY_N4, POLY_N5, or
POLY_N6:
MaterialEvaluationError: POLY_N3, POLY_N4, POLY_N5, or POLY_N6
not allowed for dataSource=TEST_DATA.
If the material evaluation failed:
MaterialEvaluationError: material evaluation failed, see
path to data file.
If the material type of the material to be evaluated is not hyperelastic:
MaterialEvaluationError: Material evaluation is currently
supported only for hyperelastic materials.

26–276

Abaqus ID:
Printed on:
 MDB COMMANDS

27. Mdb commands

27.1 Mdb object

The Mdb object is the high-level Abaqus model database. A model database stores models and analysis
controls.

Access
mdb

27.1.1 Mdb(...)
This constructor creates an empty Mdb object.

Path
Mdb

Required arguments
None.
Optional argument
pathName
A String specifying the path to be used when the model database is saved to a file. If you do
not provide a file extension, .cae is appended automatically to the path. The default value is an
empty string.

Return value
A Mdb object.

Exceptions
None.

27.1.2 importDxf(...)
This method creates a ConstrainedSketch object from a file containing dxf-format (AutoCAD) geometry.
Only a limited number of entities are supported. This format should be used only if no other formats are
available.

27–1

Abaqus ID:
Printed on:
MDB COMMANDS

Path
importDxf

Required argument
fileName
A String specifying the path to the dxf file to open.
Optional arguments
None.

Return value
A Mdb object.

Exceptions
None.

27.1.3 openMdb(...)
This method opens an existing model database file.

Path
openMdb

Required argument
pathName
A String specifying the path to the model database file to open. If you do not provide a file
extension, Abaqus/CAE attempts to open the file with .cae appended to the path.
Optional arguments
None.

Return value
An Mdb object.

Exceptions
If the file is an invalid model database:
MdbError: invalid model database.

27–2

Abaqus ID:
Printed on:
 MDB COMMANDS

If the file contains a model database from an Abaqus release other than the Abaqus release you are
currently running:
MdbError: incompatible release number, expected <Abaqus release>, got <earlier or later
Abaqus release>
If the model database file is already opened in write mode:
MdbError: cannot open file: May be in use by another CAE session
If the command fails to open the model database file for reasons not mentioned above:
MdbError: cannot open file...

27.1.4 openAcis(...)
This method creates an AcisFile object from a file containing ACIS-format geometry. This object is
subsequently used by the PartFromGeometryFile method.

Path
openAcis

Required argument
fileName
A String specifying the path to the ACIS file to open.
Optional argument
scaleFromFile
A Boolean specifying whether to scale, rotate, and translate the part using the transform read from
the ACIS file. The default value is OFF.

Return value
An AcisFile object.

Exceptions
File is from a newer version of ACIS than the CAE kernel.
Texterror: ACIS File version exceeds Kernel.
The data in the ACIS file are corrupted.
Texterror: Failed to read ACIS file.

27.1.5 openCatia(...)
This method creates an AcisFile object from a file containing CATIA V4-format or V5–format geometry.
This object is subsequently used by the PartFromGeometryFile method.

27–3

Abaqus ID:
Printed on:
MDB COMMANDS

Path
openCatia

Required argument
fileName
A String specifying the path to the CATIA file to open.
Optional arguments
topology
A SymbolicConstant specifying the topology of the data to be read from the file and of the part to
be created. Possible values are SOLID , SHELL, and WIRE. If topology=SOLID, Abaqus/CAE
attempts to attach cells to create a solid. If topology=SHELL, Abaqus/CAE builds the body as a
shell entity and not as a solid entity. If a CATIA V4-format file contains different toplogies, only
the selected topology is imported from the file. The default value is SOLID .
convertUnits
A SymbolicConstant specifying whether the original units should be retained. Possible values are
ON and OFF. The default value is OFF.
combineBodies
A Boolean specifying whether to combine the bodies in the CATPart file. If the bodies to be
combined touch or overlap, invalid entities would result. For V4–format and CATProduct files,
this option will be ignored.

Return value
An AcisFile object.

Exceptions
None.

27.1.6 openEnf(...)
This method creates an AcisFile object from a file containing Elysium Neutral File-format geometry
that was created by CATIA V5, I-DEAS, or Pro/ENGINEER. This object is subsequently used by the
PartFromGeometryFile method.

Path
openEnf

27–4

Abaqus ID:
Printed on:
 MDB COMMANDS

Required arguments
fileName
A String specifying the path to the Elysium Neutral File that was created by I-DEAS,
Pro/ENGINEER, or CATIA V5.
fileType
A String specifying the type of CAD system that created the file. Possible values are “ideas”,
“proe”, or “catiav5”.
Optional arguments
topology
A SymbolicConstant specifying the topology of the data to be read from the file and of the part to
be created. Possible values are SOLID , SHELL, and WIRE. If topology=SOLID, Abaqus/CAE
attempts to attach cells to create a solid. If topology=SHELL, Abaqus/CAE builds the body as a
shell entity and not as a solid entity. The default value is SOLID.
convertUnits
A Boolean specifying if the dimensions of the part should be converted to millimeters. The default
value is OFF.

Return value
An AcisFile object.

Exceptions
None.

27.1.7 openIges(...)
This method creates an AcisFile object from a file containing IGES-format geometry. This object is
subsequently used by the PartFromGeometryFile method.

Path
openIges

Required argument
fileName
A String specifying the path to the IGES file to open.

27–5

Abaqus ID:
Printed on:
MDB COMMANDS

Optional arguments
trimCurve
A SymbolicConstant specifying the method used to define the trim curves that bound parametric
surfaces. Possible values are:

• DEFAULT, use either of the following as specified by the contents of the IGES file.
• PARAMETRIC_DATA, use the parameter space of the surface being trimmed.
• THREED_DATA, use real space—the coordinate system of the part along with an indication
that the trim curve lies on the parametric surface.
The default value is DEFAULT.
scaleFromFile
A SymbolicConstant specifying whether the imported geometry needs to be scaled using the units
information available in the IGES file. Possible values are ON and OFF. The default value is OFF.
When the argument is set to ON, the geometry is scaled to millimeters with respect to the unit
system specified in the IGES file.
msbo
A Boolean specifying if the IGES file contains MSBO (Manifold Solid B-Rep Object) entities.
The default value is False.
includedLayers
A sequence of Ints specifying the levels or layers of entities that will be translated from the IGES
file to build the part. The default is to include all the layers.
topology
A SymbolicConstant specifying the topology of the data to be read from the file and of the part to
be created. Possible values are SOLID , SHELL, and WIRE. If topology=SOLID, Abaqus/CAE
attempts to attach cells to create a solid. If topology=SHELL, Abaqus/CAE builds the body as a
shell entity and not as a solid entity. The default value is SOLID.
uniteWires
A SymbolicConstant specifying whether the imported wires need to be united or not. Possible
values are ON and OFF. The default value is ON. When importing a sketch, this value is set to
OFF.

Return value
An AcisFile object.

Exceptions
The data in the IGES file are corrupted.
Texterror: Failed to read IGES file.

27–6

Abaqus ID:
Printed on:
 MDB COMMANDS

27.1.8 openParasolid(...)
This method creates an AcisFile object from a file containing Parasolid-format geometry. This object is
subsequently used by the PartFromGeometryFile method.

Path
openParasolid

Required argument
fileName
A String specifying the path to the Parasolid file to open.
Optional argument
topology
A SymbolicConstant specifying the topology of the data to be read from the file and of the part to
be created. Possible values are SOLID , SHELL, and WIRE. If topology=SOLID, Abaqus/CAE
attempts to attach cells to create a solid. If topology=SHELL, Abaqus/CAE builds the body as a
shell entity and not as a solid entity. The default value is SOLID.

Return value
An AcisFile object.

Exceptions
None.

27.1.9 openStep(...)
This method creates an AcisFile object from a file containing STEP-format geometry. This object is
subsequently used by the PartFromGeometryFile method.

Path
openStep

Required argument
fileName
A String specifying the path to the STEP file to open.

27–7

Abaqus ID:
Printed on:
MDB COMMANDS

Optional argument
scale
A Float specifying the scaling factor to apply to the imported geometric entities. The default value
is 1.0.

Return value
An AcisFile object.

Exceptions
The data in the STEP file are corrupted.
Texterror: Failed to read STEP file.

27.1.10 openVda(...)
This method creates an AcisFile object from a file containing VDA-FS-format geometry. This object is
subsequently used by the PartFromGeometryFile method.

Path
openVda

Required argument
fileName
A String specifying the path to the VDA-FS file to open.
Optional arguments
None.

Return value
An AcisFile object.

Exceptions
The data in the VDA-FS file are corrupted.
Texterror: Failed to read VDA file.

27.1.11 close()
This method closes an open Mdb object but does not save the Mdb object to disk. After closing the Mdb
object, this method creates a new unnamed empty Mdb object.

27–8

Abaqus ID:
Printed on:
 MDB COMMANDS

Arguments
None.

Return value
None

Exceptions
None.

27.1.12 save()
This method saves an Mdb object to disk at the location specified by pathName (pathName is a member
of the Mdb object).

Arguments
None.

Return value
None

Exceptions
If pathName is empty:
MdbError: cannot save file: pathname member is empty
If pathName is abaqus.cae:
MdbError: “abaqus.cae” is an invalid CAE filename.
If the command fails to save the Mdb object to disk for reasons not mentioned above:
MdbError: cannot save file...

27.1.13 saveAs(...)
This method saves an Mdb object to disk at the specified location.

Arguments
Required argument
pathName
A String specifying the path to be used when the model database is saved to a file. If you do not
provide a file extension, .cae is appended automatically to the path.

27–9

Abaqus ID:
Printed on:
MDB COMMANDS

Optional arguments
None.

Return value
None

Exceptions
If pathName is abaqus.cae:
MdbError: “abaqus.cae” is an invalid CAE filename.
If the command fails to save the Mdb object to disk for reasons not mentioned above:
MdbError: cannot save file...

27.1.14 openAuxMdb(...)
This method opens an auxiliary Mdb object on the disk at the specified location. This enables models
from the auxiliary Mdb object to be copied into the current Mdb

Arguments
Required argument
pathName
A String specifying the path to the auxiliary Mdb which is to be opened. If you do not provide a
file extension,.cae is appended automatically to the path.
Optional arguments
None.

Return value
None

Exceptions
If the file is an invalid model database:
MdbError: invalid model database.
If the file contains a model database from an Abaqus release other than the Abaqus release you are
currently running:
MdbError: incompatible release number, expected <Abaqus release>, got <earlier or later
Abaqus release>
If the command fails to open the model database file for reasons not mentioned above:
MdbError: cannot open file...

27–10

Abaqus ID:
Printed on:
 MDB COMMANDS

27.1.15 closeAuxMdb()
This method closes the auxiliary Mdb which had been opened earlier using the openAuxMdb command.

Arguments
None.

Return value
None

Exceptions
If the auxiliary Mdb was not opened earlier.
MdbError: The auxiliary Mdb was not opened..

27.1.16 getAuxMdbModelNames()
This method returns a list of model names present in the auxiliaryMdb which had been opened earlier
using the openAuxMdb command.

Arguments
None.

Return value
A list of model names present in the auxiliary Mdb

Exceptions
If the auxiliary Mdb was not opened earlier.
MdbError: The auxiliary Mdb was not opened..

27.1.17 copyAuxMdbModel(...)
This method copies a specified model from the auxiliaryMdb which had been opened earlier using the
openAuxMdb command.

Arguments
Required argument
fromName
A String specifying the model name in the auxiliary Mdb which is to be copied.

27–11

Abaqus ID:
Printed on:
MDB COMMANDS

Optional argument
toName
A String specifying the name to be given to the model after it is copied into the Mdb. If this
argument is not specified toNameis assumed to be the same as fromName. If a model with name
toName already exists in Mdb, it is overwritten.

Return value
None

Exceptions
If the auxiliary Mdb was not opened earlier.
MdbError: The auxiliary Mdb was not opened.
If the model fromName does not exist in the auxiliary Mdb.
KeyError: fromName does not exist.

27.1.18 Members
The Mdb object has members with the same names and descriptions as the arguments to the Mdb method.
In addition, the Mdb object can have the following members:
version
An Int specifying the release number of the Mdb object in memory.
lastChangedCount
A Float specifying the value of a counter associated with the Mdb object. The counter indicates
when the Mdb object was last changed.
jobs
A repository of Job objects.
adaptivityProcesses
A repository of AdaptivityProcess objects.
coexecutions
A repository of Coexecution objects.
meshEditOptions
A MeshEditOptions object specifying the undo/redo behavior when editing meshes on parts or
part instances.
models
A repository of Model objects.
customData
A RepositorySupport object.
annotations
A repository of Annotation objects.

27–12

Abaqus ID:
Printed on:
 MDB COMMANDS

27.2 Mdb commands

The following command upgrades a model database (.cae) to the current release and writes the
upgraded model database to a new file.

27.2.1 upgradeMdb(...)
This method upgrades an existing Mdb object to the current release and writes the upgraded version of
the Mdb object to a file. In addition, Abaqus/CAE writes information about the status of the upgrade to
the log file (upgradedMdbPath.log).

Path
upgradeMdb

Arguments
Required arguments
existingMdbPath
A String specifying the path to the file containing the model database to be upgraded.
upgradedMdbPath
A String specifying the path to the file that will contain the upgraded model database.
Optional arguments
None.

Return value
None

Exceptions
If the model database upgrade fails:
MdbError: cannot convert file

27–13

Abaqus ID:
Printed on:
 MESH COMMANDS

28. Mesh commands

Mesh commands are used to mesh part instances and regions. Mesh commands are also used to assign
element sizes, element types, and mesh control parameters.

28.1 Assembly object

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

Access
import mesh

28.1.1 associateMeshWithGeometry(...)
This method associates a geometric entity with mesh entities that were created using the bottom-up
meshing technique.

Arguments
Required argument
geometricEntity
A Face , an Edge , or a Vertex object specifying geometric entity to be associated with one or more
mesh entities.
If the geometric entity is a Face object then the argument elemFaces must be specified.
If the geometric entity is an Edge object then the argument elemEdges must be specified.
If the geometric entity is a Vertex object then the argument node must be specified.
Optional arguments
elemFaces
A sequence of MeshFace objects specifying the element faces to be associated with the geometric
face.
elemEdges
A sequence of MeshEdge objects specifying the element edges to be associated with the geometric
edge.
node
A MeshNode object specifying the mesh node to be associated with the geometric vertex.

28–1

Abaqus ID:
Printed on:
MESH COMMANDS

Return value
None

Exceptions
None.

28.1.2 createVirtualTopology(...)
This method creates a virtual topology feature by automatically merging faces and edges based on a set
of geometric parameters. The edges and vertices that are being merged will be ignored during mesh
generation.

Arguments
Required argument
regions
A sequence of Face objects or PartInstance objects specifying the domain to search for geometric
entities that need to be merged. Entities identified as candidates to be merged may be merged with
entities from outside the specified region.
Optional arguments
mergeShortEdges
A Boolean specifying whether to merge short edges. The default value is False.
shortEdgeThreshold
A Float specifying a threshold that determines which edges are considered to be short. These edges
are the candidate entities to be merged. This argument is a required argument if the argument
mergeShortEdges equals True and it is ignored if the argument mergeShortEdges equal False.
mergeSmallFaces
A Boolean specifying whether to merge faces with small area. The default value is False.
smallFaceAreaThreshold
A Float specifying a threshold that determines which faces are considered to have a small area.
These faces are the candidate entities to be merged. This argument is a required argument if the
argument mergeSmallFaces equals False and it is ignored if the argument mergeSmallFaces equals
False.
mergeSliverFaces
A Boolean specifying whether to merge faces with high aspect ratio. The default value is False.
faceAspectRatioThreshold
A Float specifying a threshold that determines which faces are considered to have high aspect
ratio. These faces are candidate entities to be merged. This argument is a required argument if the

28–2

Abaqus ID:
Printed on:
 MESH COMMANDS

argument mergeSliverFaces equals True and it is ignored if the argument mergeSliverFaces equals
False.
mergeSmallAngleFaces
A Boolean specifying whether to merge faces that have a sharp corner angle. The default value is
False.
smallFaceCornerAngleThreshold
A Float specifying a threshold that determines which face corner angles are considered to
be small. These faces will be candidate entities to be merged. This argument is a required
argument if the argument mergeSmallAngleFaces equals True and it is ignored if the argument
mergeSmallAngleFaces equals False.
mergeThinStairFaces
A Boolean specifying whether to merge faces that represent a thin stair-like feature. The default
value is False.
thinStairFaceThreshold
A Float specifying a threshold that determines which faces representing small stair-like features
are considered thin. These faces will be candidate entities to be merged. This argument is required
if the argument mergeThinStairFaces is True and it is ignored if mergeThinStairFaces is False.
ignoreRedundantEntities
A Boolean specifying whether to abstract away redundant edges and vertices. The default value
is False.
cornerAngleTolerance
A Float specifying the angle deviation from 180 degrees at a vertex or at an edge such that the two
edges radiating from the vertex or the two faces bounded by the edge can be merged. The default
value is 30.0 degrees.
applyBlendControls
A Boolean specifying whether to verify that blend faces can be merged with neighboring
faces. If applyBlendControls is True then all faces that have angle larger than
blendSubtendedAngleTolerance and a radius smaller than blendRadiusTolerance will not be
merged with neighboring faces unless the neighboring faces are also blend faces with similar
geometric characteristics. The default value is False.
blendSubtendedAngleTolerance
A Float specifying the largest subtended angle of blend faces that can be merged with neighboring
faces. This argument is a required argument if the argument applyBlendControls equals True and
it is ignored if the argument applyBlendControls equals False.
blendRadiusTolerance
A Float specifying the smallest radius of curvature of blend faces that can be merged with
neighboring faces. This argument is a required argument if the argument applyBlendControls
equals True and it is ignored if the argument applyBlendControls equals False.

28–3

Abaqus ID:
Printed on:
MESH COMMANDS

Return value
A Feature object.

Exceptions
None.

28.1.3 deleteMesh(...)
This method deletes the mesh from the given part instances or regions.

Arguments
Required argument
regions
A sequence of PartInstance objects or Region objects specifying the part instances or regions from
where the mesh is to be deleted.
Optional arguments
None.

Return value
None

Exceptions
None.

28.1.4 deletePreviewMesh()
This method deletes all boundary meshes in the assembly. See the boundaryPreview argument of
generateMesh for information about generating boundary meshes.

Arguments
None.

Return value
None

Exceptions
None.

28–4

Abaqus ID:
Printed on:
 MESH COMMANDS

28.1.5 deleteSeeds(...)
This method deletes the global edge seeds from the given part instances or deletes the local edge seeds
from the given edges.

Arguments
Required argument
regions
A sequence of PartInstance objects or Edge objects specifying the part instances or edges from
which the seeds are to be deleted.
Optional arguments
None.

Return value
None

Exceptions
None.

28.1.6 generateBottomUpExtrudedMesh(...)
This method generates a mesh in a cell region of a part instance using a bottom-up meshing technique
that is based on extruding a 2D mesh along a vector.

Arguments
Required arguments
cell
A Cell object specifying the region where the mesh is to be generated.
numberOfLayers
An Int specifying the number of layers to be generated along the extrusion vector.
extrudeVector
A sequence of sequences of Floats specifying the start point and end point of a vector. Each point is
defined by a tuple of three coordinates indicating its position. The direction of the mesh extrusion
operation is from the first point to the second point, and the distance of the mesh extrusion operation
is the length of the vector.
Optional arguments
At least one of the three optional arguments must be specified.

28–5

Abaqus ID:
Printed on:
MESH COMMANDS

geometrySourceSide
A sequence of Face objects specifying the geometric domain to be used as the source for the extrude
meshing operation.
elemFacesSourceSide
A sequence of MeshFace objects specifying the faces of 3D elements to be used as the source for
the extrude meshing operation.
elemSourceSide
A sequence of 2D MeshElement objects specifying the elements to be used as the source for the
extrude meshing operation.

Return value
None

Exceptions
None.

28.1.7 generateBottomUpSweptMesh(...)
This method generates a mesh in a cell region of a part instance using a bottom-up meshing technique
that is based on sweeping a 2D mesh.

Arguments
Required argument
cell
A Cell object specifying the region where the mesh is to be generated.
Optional arguments
At least one of the following three arguments must be specified: geometrySourceSide,
elemFacesSourceSide, or elemSourceSide.
In addition one of the following two sets of arguments must also be specified:
• One of the following three arguments geometryConnectingSides, elemFacesConnectingSides, or
elemConnectingSides. In this case the targetSide is an optional argument.
• targetSide and numberOfLayers.
geometrySourceSide
A sequence of Face objects specifying the geometric domain to be used as the source for the sweep
meshing operation.
elemFacesSourceSide
A sequence of MeshFace objects specifying the faces of 3D elements to be used as the source for
the sweep meshing operation.

28–6

Abaqus ID:
Printed on:
 MESH COMMANDS

elemSourceSide
A sequence of 2D MeshElement objects specifying the elements to be used as the source for the
sweep meshing operation.
geometryConnectingSides
A sequence of Face objects specifying connecting sides of the sweep meshing operation.
elemFacesConnectingSides
A sequence of MeshFace objects specifying connecting sides of the sweep meshing operation.
elemConnectingSides
A sequence of 2D MeshElement objects specifying connecting sides of the sweep meshing
operation.
targetSide
A Face object specifying the target side of the sweep meshing operation.
numberOfLayers
An Int specifying the number of layers to be generated along the sweep direction.

Return value
None

Exceptions
None.

28.1.8 generateBottomUpRevolvedMesh(...)
This method generates a mesh in a cell region of a part instance using a bottom-up meshing technique
that is based on revolving a 2D mesh.

Arguments
Required arguments
cell
A Cell object specifying the region where the mesh is to be generated.
numberOfLayers
An Int specifying the number of layers of elements to be generated around the axis of revolution.
axisOfRevolution
A sequence of sequences of Floats specifying the two points of the vector that describes the axis
of revolution. Each point is defined by a tuple of three coordinates indicating its position. The
direction of the axis of revolution is from the first point to the second point. The orientation of the
revolution operation follows the right-hand-rule about the axis of revolution.
angleOfRevolution
A Float specifying the angle of revolution.

28–7

Abaqus ID:
Printed on:
MESH COMMANDS

Optional arguments
At least one of the three optional arguments must be specified.
geometrySourceSide
A sequence of Face objects specifying the geometric domain to be used as the source for the revolve
meshing operation.
elemFacesSourceSide
A sequence of MeshFace objects specifying the faces of 3D elements to be used as the source for
the revolve meshing operation.
elemSourceSide
A sequence of 2D MeshElement objects specifying the elements to be used as the source for the
revolve meshing operation.

Return value
None

Exceptions
None.

28.1.9 generateMesh(...)
This method generates a mesh in the given part instances or regions.

Arguments
Required argument
regions
A sequence of PartInstance objects or Region objects specifying the part instances or regions where
the mesh is to be generated.
Optional arguments
seedConstraintOverride
A Boolean specifying whether mesh generation is allowed to modify seed constraints. The default
value is OFF.
meshTechniqueOverride
A Boolean specifying whether mesh generation is allowed to modify the existing mesh techniques
so that a compatible mesh can be generated. The default value is OFF.
boundaryPreview
A Boolean specifying whether the generated mesh should be a boundary mesh. This option will
only have an effect if any of the specified regions are to be meshed with tetrahedral elements or
using the bottom-up technique with hexahedral or wedge elements. The default value is OFF.

28–8

Abaqus ID:
Printed on:
 MESH COMMANDS

boundaryMeshOverride
A Boolean specifying whether mesh generation is allowed to modify an existing boundary preview
mesh. This option will only have an effect if any of the specified regions are to be meshed with
tetrahedral elements and a boundary preview mesh already exists. The default value is OFF.

Return value
None

Exceptions
None.

28.1.10 getEdgeSeeds(...)
This method returns an edge seed parameter for a specified edge of an assembly.

Arguments
Required arguments
edge
An Edge object specifying the edge to be queried.
attribute
A SymbolicConstant specifying the type of edge seed attribute to return. Possible values are:
• EDGE_SEEDING_METHOD
• BIAS_METHOD
• NUMBER
• AVERAGE_SIZE
• DEVIATION_FACTOR
• MIN_SIZE_FACTOR
• BIAS_RATIO
• BIAS_MIN_SIZE
• BIAS_MAX_SIZE
• VERTEX_ADJ_TO_SMALLEST_ELEM
• SMALLEST_ELEM_LOCATION
• CONSTRAINT
The return value is dependent on the attribute argument.
• If attribute=EDGE_SEEDING_METHOD, the return value is a SymbolicConstant
specifying the edge seeding method used to create the seeds along the edge. Possible values
are:

28–9

Abaqus ID:
Printed on:
MESH COMMANDS

– UNIFORM_BY_NUMBER
– UNIFORM_BY_SIZE
– CURVATURE_BASED_BY_SIZE
– BIASED
– NONE

• If attribute=BIAS_METHOD, the return value is a SymbolicConstant specifying the bias

type used to create the seeds along the edge. Possible values are:
– SINGLE
– DOUBLE
– NONE

• If attribute=NUMBER, the return value is an Int specifying the number of element seeds
along the edge.
• If attribute=AVERAGE_SIZE, the return value is a Float specifying the average element size
along the edge.
• If attribute=DEVIATION_FACTOR, the return value is a Float specifying the deviation
factor , where is the chordal deviation and is the element length. If edge seeds are
not defined, the return value is zero.
• If attribute=MIN_SIZE_FACTOR, the return value is a Float specifying the size of the
smallest allowable element as a fraction of the specified global element size. If edge seeds
are not defined, the return value is zero.
• If attribute=BIAS_RATIO, the return value is a Float specifying the length ratio of the largest
element to the smallest element.
• If attribute=BIAS_MIN_SIZE, the return value is a Float specifying the length of the largest
element; only applicable if the EDGE_SEEDING_METHOD is BIASED and seeds were
specified by minimum and maximum sizes.
• If attribute=BIAS_MAX_SIZE, the return value is a Float specifying the length of the largest
element; only applicable if the EDGE_SEEDING_METHOD is BIASED and seeds were
specified by minimum and maximum sizes.
• If attribute=VERTEX_ADJ_TO_SMALLEST_ELEM, the return value is an Int
specifying the ID of the vertex next to the smallest element; only applicable if the
EDGE_SEEDING_METHOD is BIASED.
• If attribute=SMALLEST_ELEM_LOCATION, the return value is a SymbolicConstant
specifying the location of smallest elements for double bias seeds; only applicable if the
EDGE_SEEDING_METHOD is BIASED and BIAS_METHOD is DOUBLE. Possible
values are:

28–10

Abaqus ID:
Printed on:
 MESH COMMANDS

– SMALLEST_ELEM_AT_CENTER
– SMALLEST_ELEM_AT_ENDS
– NONE

• If attribute=CONSTRAINT, the return value is a SymbolicConstant specifying how close the

seeds must be matched by the mesh. Possible values are:
– FREE
– FINER
– FIXED
– NONE
A value of NONE indicates that the edge is not seeded.

Optional arguments
None.

Return value
The return value is a Float, an Int, or a SymbolicConstant depending on the value of the attribute
argument.

Exceptions
None.

28.1.11 getElementType(...)
This method returns the ElemType object of a given element shape assigned to a region of the assembly.

Arguments
Required arguments
region
A Cell , a Face , or an Edge object specifying the region to be queried.
elemShape
A SymbolicConstant specifying the shape of the element for which to return the element type.
Possible values are:
• LINE
• QUAD
• TRI

28–11

Abaqus ID:
Printed on:
MESH COMMANDS

• HEX
• WEDGE
• TET

Optional arguments
None.

Return value
ElemType object.

Exceptions
TypeError
If the region cannot be associated with element types or if the elemShape is not consistent with
the dimension of the region.

28.1.12 getIncompatibleMeshInterfaces(...)
This method returns a sequence of face objects that are meshed with incompatible elements.

Arguments
Required arguments
None.
Optional argument
cells
A sequence of cell objects which will be used to search the incompatible faces.

Return value
A sequence of Face objects.

Exceptions
None.

28.1.13 getMeshControl(...)
This method returns a mesh control parameter for the specified region of the assembly.

28–12

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required arguments
region
A Cell , a Face , or an Edge object specifying the region to be queried.
attribute
A SymbolicConstant specifying the mesh control attribute to return. Possible values are:
• ELEM_SHAPE
• TECHNIQUE
• ALGORITHM
• MIN_TRANSITION
The return value is dependent on the attribute argument.
• If attribute=ELEM_SHAPE, the return value is a SymbolicConstant specifying the element
shape used during meshing. Possible values are:
– LINE
– QUAD
– TRI
– QUAD_DOMINATED
– HEX
– TET
– WEDGE
– HEX_DOMINATED

• If attribute=TECHNIQUE, the return value is a SymbolicConstant specifying the meshing

technique to be used during meshing. Possible values are:
– FREE
– STRUCTURED
– SWEEP
– UNMESHABLE
Where UNMESHABLE indicates that no meshing technique is applicable with the currently
assigned element shape.
• If attribute=ALGORITHM, the return value is a SymbolicConstant specifying the meshing
algorithm to be used during meshing. Possible values are:
– MEDIAL_AXIS
– ADVANCING_FRONT
– DEFAULT

28–13

Abaqus ID:
Printed on:
MESH COMMANDS

– NON_DEFAULT
– NONE
Where NONE indicates that no algorithm is applicable.
• If attribute=MIN_TRANSITION, the return value is a Boolean indicating whether minimum
transition will be used during meshing. This option is applicable only to the following:
– Free quadrilateral meshing or sweep hexahedral meshing with
algorithm=MEDIAL_AXIS.
– Structured quadrilateral meshing.

Optional arguments
None.

Return value
The return value is a SymbolicConstant or a Boolean depending on the value of the attribute argument.

Exceptions
TypeError
The region cannot carry mesh controls.

28.1.14 getMeshStats(...)
This method returns the mesh statistics for the given part instances or regions.

Arguments
Required argument
regions
A sequence or tuple of PartInstance objects or Geometry regions for which mesh statistics should
be returned.
Optional arguments
None.

Return value
A MeshStats object.

Exceptions
None.

28–14

Abaqus ID:
Printed on:
 MESH COMMANDS

28.1.15 getPartSeeds(...)
This method returns a part seed parameter for the specified instance.

Arguments
Required arguments
region
A PartInstance object specifying the part instance to be queried.
attribute
A SymbolicConstant specifying the type of part seed attribute to return. Possible values are:
• SIZE
• DEFAULT_SIZE
• DEVIATION_FACTOR
• MIN_SIZE_FACTOR
The return value is dependent on the value of the attribute argument.
• If attribute=SIZE, the return value is a Float specifying the assigned global element size. If
part seeds are not defined, the return value is zero.
• If attribute=DEFAULT_SIZE, the return value is a Float specifying a suggested default global
element size based upon the part geometry.
• If attribute=DEVIATION_FACTOR, the return value is a Float specifying the deviation
factor , where is the chordal deviation and is the element length. If part seeds are
not defined, the return value is zero.
• If attribute=MIN_SIZE_FACTOR, the return value is a Float specifying the size of the
smallest allowable element as a fraction of the specified global element size. If part seeds
are not defined, the return value is zero.

Optional arguments
None.

Return value
The return value is a Float, and its value is dependent on the attribute argument.

Exceptions
An exception occurs if the part instance does not contain native geometry.
Error: Part instance does not contain native geometry

28–15

Abaqus ID:
Printed on:
MESH COMMANDS

28.1.16 getUnmeshedRegions()
This method returns all geometric regions in the assembly that require a mesh for submitting an analysis
but are either unmeshed or are meshed incompletely.

Arguments
None.

Return value
A Region object, or None.

Exceptions
None.

28.1.17 ignoreEntity(...)
This method creates a virtual topology feature. Virtual topology allows unimportant entities to be ignored
during mesh generation. You can combine two adjacent faces by specifying a common edge to ignore.
Similarly, you can combine two adjacent edges by specifying a common vertex to ignore.

Arguments
Required argument
entities
A sequence of vertices and edges specifying the entities to be ignored during meshing.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

28.1.18 restoreIgnoredEntity(...)
This method restores vertices and edges that have been merged using a virtual topology feature.

28–16

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required argument
entities
A sequence of IgnoredVertex objects and IgnoredEdge objects specifying the entities to be restored.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

28.1.19 seedEdgeByBias(...)
This method seeds the given edges nonuniformly using the specified number of elements and bias ratio
or the specified minimum and maximum element sizes.

Arguments
Required arguments
biasMethod
A SymbolicConstant specifying whether single- or double-biased seed distribution will be applied.
If unspecified, single-biased seed distribution will be applied. Possible values are:
• SINGLE: Single-biased seed distribution will be applied.
• DOUBLE: Double-biased seed distribution will be applied.

end1Edges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near the end where the normalized curve parameter=0.0. You must provide either the end1Edges
or the end2Edges argument or both when biasMethod=SINGLE and omit both of them when
biasMethod=DOUBLE.

Note: You cannot determine from the Abaqus Scripting Interface which end is which. However,
Abaqus/CAE displays the orientation of the bias when the edge is picked.

end2Edges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near the end where the normalized curve parameter=1.0.

28–17

Abaqus ID:
Printed on:
MESH COMMANDS

centerEdges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near edge center. You must provide either the centerEdges or the endEdges argument or both when
biasMethod=DOUBLE and omit both of them when biasMethod=SINGLE.
endEdges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near edge ends.
ratio
A Float specifying the ratio of the largest element to the smallest element. Possible values are 1.0
ratio 106 .
number
An Int specifying the number of elements along each edge. Possible values are 1 number 104 .
minSize
A Float specifying the desired smallest element size.
maxSize
A Float specifying the desired largest element size.

Note: You must specify either the ratio and number or minSize and maxSize pair of arguments.
Optional argument
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.
• FIXED: The seeds must be exactly matched by the mesh (only with respect to the number of
elements, not to the nodal positioning).

Return value
None

Exceptions
None.

28.1.20 seedEdgeByNumber(...)
This method seeds the given edges uniformly based on the number of elements along the edges.

28–18

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required arguments
edges
A sequence of Edge objects specifying the edges to seed.
number
An Int specifying the number of elements along each edge. Possible values are 1 number 104 .
Optional argument
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.
• FIXED: The seeds must be exactly matched by the mesh (only with respect to the number of
elements, not to the nodal positioning).

Return value
None

Exceptions
None.

28.1.21 seedEdgeBySize(...)
This method seeds the given edges either uniformly or following edge curvature distribution, based on
the desired element size.

Arguments
Required arguments
edges
A sequence of Edge objects specifying the edges to seed.
size
A Float specifying the desired element size.
Optional arguments
deviationFactor
A Float specifying the deviation factor , where is the chordal deviation and is the element
length.

28–19

Abaqus ID:
Printed on:
MESH COMMANDS

minSizeFactor
A Float specifying the size of the smallest allowable element as a fraction of the specified global
element size.
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.
• FIXED: The seeds must be exactly matched by the mesh (only with respect to the number of
elements, not to the nodal positioning).

Return value
None

Exceptions
None.

28.1.22 seedPartInstance(...)
This method assigns global edge seeds to the given part instances.

Arguments
Required arguments
regions
A sequence of PartInstance objects specifying the part instances to seed.
size
A Float specifying the desired global element size for the edges.
Optional arguments
deviationFactor
A Float specifying the deviation factor , where is the chordal deviation and is the element
length.
minSizeFactor
A Float specifying the size of the smallest allowable element as a fraction of the specified global
element size.
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:

28–20

Abaqus ID:
Printed on:
 MESH COMMANDS

• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.

Return value
None

Exceptions
None.

28.1.23 setElementType(...)
This method assigns element types to the specified regions.

Arguments
Required arguments
regions
A sequence of Geometry regions or MeshElement objects, or a Set object containing either
geometry regions or elements, specifying the regions to which element types are to be assigned.
elemTypes
A sequence of ElemType objects, one for each element shape applicable to the regions.
Note: If an ElemType object has an UNKNOWN_xxx value for elemCode, its order will be
deduced from the order of other valid ElemType objects within the same setElementType
command. If no valid ElemType objects can be found, the order will remain unchanged.

Optional arguments
None.

Return value
None

Exceptions
As a result of the element assignment, a region must have the same library, family, and order for all its
assigned element types. Otherwise, an exception will be thrown.
For example, suppose the Hex, Wedge, and Tet elements previously assigned to a cell are all linear.
The user now constructs an ElemType object with a quadratic Hex element and includes only this object

28–21

Abaqus ID:
Printed on:
MESH COMMANDS

in the setElementType command. An exception will be thrown because the Wedge and Tet elements
will remain linear (i.e., As Is) and become incompatible with the newly assigned quadratic Hex element.

28.1.24 setLogicalCorners(...)
This method sets the logical corners for a mappable face region.

Arguments
Required arguments
region
A Face region.
corners
Three, four, or five Vertex objects defining the logical corners for a given mappable face region.
Optional arguments
None.

Return value
None

Exceptions
None.

28.1.25 setMeshControls(...)
This method sets the mesh control parameters for the specified regions.

Arguments
Required argument
regions
A sequence of Face or Cell regions specifying the regions for which to set the mesh control
parameters.
Optional arguments
elemShape
A SymbolicConstant specifying the element shape to be used for meshing. The default value is
QUAD for Face regions and HEX for Cell regions. If unspecified, the existing element shape will
remain unchanged. Possible values are:
• QUAD: Quadrilateral mesh.
• QUAD_DOMINATED: Quadrilateral-dominated mesh.

28–22

Abaqus ID:
Printed on:
 MESH COMMANDS

• TRI: Triangular mesh.

• HEX: Hexahedral mesh.
• HEX_DOMINATED: Hex-dominated mesh.
• TET: Tetrahedral mesh.
• WEDGE: Wedge mesh.

technique
A SymbolicConstant specifying the mesh technique to be used. The default value is FREE for
Face regions. For Cell regions the initial value depends on the geometry of the regions and can
be STRUCTURED, SWEEP, or “unmeshable.” If unspecified, the existing mesh technique(s) will
remain unchanged. Possible values are:

• FREE: Free mesh technique.

• STRUCTURED: Structured mesh technique.
• SWEEP: Sweep mesh technique.
• BOTTOM-UP: Bottom-up mesh technique. Only applicable for cell regions.
• SYSTEM_ASSIGN: Allow the system to assign a suitable technique. The actual technique
assigned can be STRUCTURED, SWEEP, or “unmeshable.”

algorithm
A SymbolicConstant specifying the algorithm used to generate the mesh for the specified
regions. Possible values are MEDIAL_AXIS, ADVANCING_FRONT, and NON_DEFAULT.
If unspecified, the existing value will remain unchanged. This option is applicable only to the
following:

• Free quadrilateral or quadrilateral-dominated meshing. In this case the possible values are
MEDIAL_AXIS and ADVANCING_FRONT.
• Sweep hexahedral or hexahedral-dominated meshing. In this case the possible values are
MEDIAL_AXIS and ADVANCING_FRONT.
• Free tetrahedral meshing. In this case the only possible value is NON_DEFAULT, and it
indicates that the free tetrahedral-meshing technique available in Abaqus 6.4 or earlier will
be used. If algorithm is not specified, the default tetrahedral-meshing technique will be used.

minTransition
A Boolean specifying whether minimum transition is to be applied. The default value is ON.
If unspecified, the existing value will remain unchanged. This option is applicable only in the
following cases:

• Free quadrilateral meshing or hexahedral sweep meshing with algorithm=MEDIAL_AXIS.

• Structured quadrilateral meshing.

28–23

Abaqus ID:
Printed on:
MESH COMMANDS

sizeGrowth
A SymbolicConstant specifying element size growth to be applied when generating the interior of
a tetrahedral mesh. Possible values are MODERATE and MAXIMUM. If unspecified, the existing
value will remain unchanged. This option only applies to the default tetrahedral mesher.
allowMapped
A Boolean specifying whether mapped meshing can be used to replace the selected mesh technique.
The allowMapped argument is applicable only in the following cases:
• Free triangular meshing.
• Free quadrilateral or quadrilateral-dominated meshing with
algorithm=ADVANCING_FRONT.
• Hexahedral or hexahedral-dominated sweep meshing with
algorithm=ADVANCING_FRONT.
• Free tetrahedral meshing. allowMapped=True implies that mapped triangular meshing can
be used on faces that bound three-dimensional regions.

Return value
None

Exceptions
None.

28.1.26 setSweepPath(...)
This method sets the sweep path for a sweepable region or the revolve path for a revolvable region.

Arguments
Required arguments
region
A sweepable region.
edge
An Edge object specifying the sweep or revolve path.
sense
A SymbolicConstant specifying the sweep sense. The sense will affect only how gasket elements
will be created; it will have no effect if gasket elements are not used. Possible values are
FORWARD or REVERSE.
If sense=FORWARD, the sense of the given edge’s underlying curve will be used.

28–24

Abaqus ID:
Printed on:
 MESH COMMANDS

Optional arguments
None.

Return value
None

Exceptions
None.

28.1.27 verifyMeshQuality(...)
This method tests the quality of part instance meshes and returns poor-quality elements.

Arguments
Required argument
criterion
A SymbolicConstant specifying the criterion used for the quality check. Possible values are:
ANALYSIS_CHECKS
When this criterion is specified Abaqus/CAE will invoke the element quality checks included
with the input file processor for Abaqus/Standard and Abaqus/Explicit.

ANGULAR_DEVIATION
The maximum amount (in degrees) that an element’s face corner angles deviate from the ideal
angle. The ideal angle is 90° for quadrilateral element faces and 60° for triangular element
faces. Elements with an angular deviation larger than the specified threshold will fail this test.

ASPECT_RATIO
The ratio between the lengths of the longest and shortest edges of an element. Elements with
an aspect ratio larger than the specified threshold will fail this test.

GEOM_DEVIATION_FACTOR
The largest geometric deviation factor evaluated along any of the element edges associated
with geometric edges or faces. The geometric deviation factor along an element edge
is calculated by dividing the maximum gap between the element edge and its associated
geometry by the length of the element edge. Elements with a geometric deviation factor
larger than the specified threshold will fail this test.

LARGE_ANGLE
The largest corner angle on any of an element’s faces. Elements with face angles larger than
the specified threshold (in degrees) will fail this test.

28–25

Abaqus ID:
Printed on:
MESH COMMANDS

LONGEST_EDGE
The length of an element’s longest edge. Elements with an edge longer than the specified
threshold will fail this test.

MAX_FREQUENCY
An estimate of an element’s contribution to the initial maximum allowable frequency for
Abaqus/Standard analyses. This calculation requires appropriate section assignments and
material definitions. Elements whose maximum allowable frequency is smaller than the given
value will fail this test.

SHAPE_FACTOR
The shape factor for triangular and tetrahedral elements. This is the ratio between the element
area or volume and the optimal element area or volume. Elements with a shape factor smaller
than the specified threshold will fail this test.

SHORTEST_EDGE
The length of an element’s shortest edge. Elements with an edge shorter than the specified
threshold will fail this test.

SMALL_ANGLE
The smallest corner angle on any of an element’s faces. Elements with face angles smaller
than the given value (in degrees) will fail this test.

STABLE_TIME_INCREMENT
An estimate of an element’s contribution to the initial maximum stable time increment for
Abaqus/Explicit analyses. This calculation requires appropriate section assignments and
material definitions. Elements that require a time increment smaller than the given value
will fail this test.

Optional arguments
threshold
A Float value used to determine low quality elements according to the specified criterion. This
argument is ignored when the ANALYSIS_CHECKS criterion is used. For other criterion, if this
argument is unspecified then no list of failed elements will be returned.
elemShape
A SymbolicConstant specifying an element shape for limiting the query. Possible values are LINE,
QUAD, TRI, HEX, WEDGE, and TET.
regions
A sequence of Region or MeshElement objects. If you do not specify the regions argument, all
meshes in the assembly are considered.

28–26

Abaqus ID:
Printed on:
 MESH COMMANDS

Return value
A Dictionary object containing values for some number of the following keys: failedElements,
warningElements, naElements (sequences of MeshElement objects); numElements (Int); average, worst
(Float); worstElement ( MeshElement object)

Exceptions
None.

28.2 Part object

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

Access
import mesh

28.2.1 associateMeshWithGeometry(...)
This method associates a geometric entity with mesh entities that were created using the bottom-up
meshing technique.

Arguments
Required argument
geometricEntity
A Face , an Edge , or a Vertex object specifying geometric entity to be associated with one or more
mesh entities.
If the geometric entity is a Face object then the argument elemFaces must be specified.
If the geometric entity is an Edge object then the argument elemEdges must be specified.
If the geometric entity is a Vertex object then the argument node must be specified.
Optional arguments
elemFaces
A sequence of MeshFace objects specifying the element faces to be associated with the geometric
face.
elemEdges
A sequence of MeshEdge objects specifying the element edges to be associated with the geometric
edge.

28–27

Abaqus ID:
Printed on:
MESH COMMANDS

node
A MeshNode object specifying the mesh node to be associated with the geometric vertex.

Return value
None

Exceptions
None.

28.2.2 createVirtualTopology(...)
This method creates a virtual topology feature by automatically merging faces and edges based on a set
of geometric parameters. The edges and vertices that are being merged will be ignored during mesh
generation.

Arguments
Required arguments
None.
Optional arguments
regions
A sequence of Face objects specifying the domain to search for geometric entities that need to be
merged. Entities identified as candidates to be merged may be merged with entities from outside
the specified region. If regions is not specified then the entire part is the domain for searching
geometric entities that need to be merged.
mergeShortEdges
A Boolean specifying whether to merge short edges. The default value is False.
shortEdgeThreshold
A Float specifying a threshold that determines which edges are considered to be short. These
edges are the candidate entities to be merged. This argument is a required argument if the
argumentmergeShortEdges equals True and it is ignored if the argument mergeShortEdges equals
False.
mergeSmallFaces
A Boolean specifying whether to merge faces with small area. The default value is False.
smallFaceAreaThreshold
A Float specifying a threshold that determines which faces are considered to have a small area.
These faces are the candidate entities to be merged. This argument is a required argument if the
argumentmergeSmallFaces equals True and it is ignored if the argument mergeSmallFaces equals
False.

28–28

Abaqus ID:
Printed on:
 MESH COMMANDS

mergeSliverFaces
A Boolean specifying whether to merge faces with high aspect ratio. The default value is False.
faceAspectRatioThreshold
A Float specifying a threshold that determines which faces are considered to have high aspect ratio.
These faces are the candidate entities to be merged. This argument is a required argument if the
argumentmergeSliverFaces equals True and it is ignored if the argument mergeSliverFaces equals
False.
mergeSmallAngleFaces
A Boolean specifying whether to merge faces that have a sharp corner angle. The default value is
False.
smallFaceCornerAngleThreshold
A Float specifying a threshold that determines which face corner angles are considered to
be small. These faces will be candidate entities to be merged. This argument is a required
argument if the argumentmergeSmallAngleFaces equals True and it is ignored if the argument
mergeSmallAngleFaces equals False.
mergeThinStairFaces
A Boolean specifying whether to merge faces that represent a thin stair-like feature. The default
value is False.
thinStairFaceThreshold
A Float specifying a threshold that determines which faces representing small stair-like features
are considered thin. These faces will be candidate entities to be merged. This argument is required
if the argument mergeThinStairFaces is True and it is ignored if mergeThinStairFaces is False.
ignoreRedundantEntities
A Boolean specifying whether to abstract away redundant edges and vertices. The default value
is False.
cornerAngleTolerance
A Float specifying the angle deviation from 180 degrees at a vertex or at an edge such that the two
edges radiating from the vertex or the two faces bounded by the edge can be merged. The default
value is 30.0 degrees.
applyBlendControls
A Boolean specifying whether to verify that blend faces can be merged with neighboring
faces. If applyBlendControls is true then all faces that have angle larger than
blendSubtendedAngleTolerance and a radius smaller than blendRadiusTolerance will not be
merged with neighboring faces unless the neighboring faces are also blend faces with similar
geometric characteristics. The default value is False.
blendSubtendedAngleTolerance
A Float specifying the largest subtended angle of blend faces that can be merged with neighboring
faces. This argument is a required argument if the argument applyBlendControls equals True and
it is ignored if the argument applyBlendControls equals False.

28–29

Abaqus ID:
Printed on:
MESH COMMANDS

blendRadiusTolerance
A Float specifying the smallest radius of curvature of blend faces that can be merged with
neighboring faces. This argument is a required argument if the argument applyBlendControls
equals True and it is ignored if the argument applyBlendControls equals False.

Return value
A Feature object.

Exceptions
None.

28.2.3 deleteMesh(...)
This method deletes the mesh from the given parts or regions.

Arguments
Required argument
regions
A sequence of Part objects or Region objects specifying the parts or regions from where the mesh
is to be deleted.
Optional arguments
None.

Return value
None

Exceptions
None.

28.2.4 deletePreviewMesh()
This method deletes all boundary meshes in the parts. See the boundaryPreview argument of
generateMesh for information about generating boundary meshes.

Arguments
None.

28–30

Abaqus ID:
Printed on:
 MESH COMMANDS

Return value
None

Exceptions
None.

28.2.5 deleteSeeds(...)
This method deletes the global edge seeds from the given parts or deletes the local edge seeds from the
given edges.

Arguments
Required argument
regions
A sequence of Part objects or Edge objects specifying the parts or edges from which the seeds are
to be deleted.
Optional arguments
None.

Return value
None

Exceptions
None.

28.2.6 generateMesh(...)
This method generates a mesh in the given parts or regions.

Arguments
Required argument
regions
A sequence of Part objects or Region objects specifying the parts or regions where the mesh is to
be generated.

28–31

Abaqus ID:
Printed on:
MESH COMMANDS

Optional arguments
seedConstraintOverride
A Boolean specifying whether mesh generation is allowed to modify seed constraints. The default
value is OFF.
meshTechniqueOverride
A Boolean specifying whether mesh generation is allowed to modify the existing mesh techniques
so that a compatible mesh can be generated. The default value is OFF.
boundaryPreview
A Boolean specifying whether the generated mesh should be a boundary preview mesh. This
option will only have an effect if any of the specified regions are to be meshed with tetrahedral
elements or using the bottom-up technique with hexahedral or wedge elements. The default value
is OFF.
boundaryMeshOverride
A Boolean specifying whether mesh generation is allowed to modify an existing boundary preview
mesh. This option will only have an effect if any of the specified regions are to be meshed with
tetrahedral elements and a boundary preview mesh already exists. The default value is OFF.

Return value
None

Exceptions
None.

28.2.7 generateBottomUpExtrudedMesh(...)
This method generates a mesh in a cell region of a part using a bottom-up meshing technique that is
based on extruding a 2D mesh along a vector.

Arguments
Required arguments
cell
A Cell object specifying the region where the mesh is to be generated.
numberOfLayers
An Int specifying the number of layers to be generated along the extrusion vector.
extrudeVector
A sequence of sequences of Floats specifying the start point and end point of a vector. Each point is
defined by a tuple of three coordinates indicating its position. The direction of the mesh extrusion
operation is from the first point to the second point, and the distance of the mesh extrusion operation
is the length of the vector.

28–32

Abaqus ID:
Printed on:
 MESH COMMANDS

Optional arguments
At least one of the three optional arguments must be specified.
geometrySourceSide
A sequence of Face objects specifying the geometric domain to be used as the source for the extrude
meshing operation.
elemFacesSourceSide
A sequence of MeshFace objects specifying the faces of 3D elements to be used as the source for
the extrude meshing operation.
elemSourceSide
A sequence of 2D MeshElement objects specifying the elements to be used as the source for the
extrude meshing operation.

Return value
None

Exceptions
None.

28.2.8 generateBottomUpSweptMesh(...)
This method generates a mesh in a cell region of a part using a bottom-up meshing technique that is
based on sweeping a 2D mesh.

Arguments
Required argument
cell
A Cell object specifying the region where the mesh is to be generated.
Optional arguments
At least one of the following three arguments must be specified: geometrySourceSide,
elemFacesSourceSide, or elemSourceSide.
In addition one of the following two sets of arguments must also be specified:
• One of the following three arguments geometryConnectingSides, elemFacesConnectingSides, or
elemConnectingSides. In this case the targetSide is an optional argument.
• targetSide and numberOfLayers.
geometrySourceSide
A sequence of Face objects specifying the geometric domain to be used as the source for the sweep
meshing operation.

28–33

Abaqus ID:
Printed on:
MESH COMMANDS

elemFacesSourceSide
A sequence of MeshFace objects specifying the faces of 3D elements to be used as the source for
the sweep meshing operation.
elemSourceSide
A sequence of 2D MeshElement objects specifying the elements to be used as the source for the
sweep meshing operation.
geometryConnectingSides
A sequence of Face objects specifying connecting sides of the sweep meshing operation.
elemFacesConnectingSides
A sequence of MeshFace objects specifying connecting sides of the sweep meshing operation.
elemConnectingSides
A sequence of 2D MeshElement objects specifying connecting sides of the sweep meshing
operation.
targetSide
A Face object specifying the target side of the sweep meshing operation.
numberOfLayers
An Int specifying the number of layers to be generated along the sweep direction.

Return value
None

Exceptions
None.

28.2.9 generateBottomUpRevolvedMesh(...)
This method generates a mesh in a cell region of a part using a bottom-up meshing technique that is
based on revolving a 2D mesh.

Arguments
Required arguments
cell
A Cell object specifying the region where the mesh is to be generated.
numberOfLayers
An Int specifying the number of layers of elements to be generated around the axis of revolution.
axisOfRevolution
A sequence of sequences of Floats specifying the two points of the vector that describes the axis
of revolution. Each point is defined by a tuple of three coordinates indicating its position. The

28–34

Abaqus ID:
Printed on:
 MESH COMMANDS

direction of the axis of revolution is from the first point to the second point. The orientation of the
revolution operation follows the right-hand-rule about the axis of revolution.
angleOfRevolution
A Float specifying the angle of revolution.
Optional arguments
At least one of the three optional arguments must be specified.
geometrySourceSide
A sequence of Face objects specifying the geometric domain to be used as the source for the revolve
meshing operation.
elemFacesSourceSide
A sequence of MeshFace objects specifying the faces of 3D elements to be used as the source for
the revolve meshing operation.
elemSourceSide
A sequence of 2D MeshElement objects specifying the elements to be used as the source for the
revolve meshing operation.

Return value
None

Exceptions
None.

28.2.10 getEdgeSeeds(...)
This method returns an edge seed parameter for a specified edge of a part.

Arguments
Required arguments
edge
An Edge object specifying the edge to be queried.
attribute
A SymbolicConstant specifying the type of edge seed attribute to return. Possible values are:
• EDGE_SEEDING_METHOD
• BIAS_METHOD
• NUMBER
• AVERAGE_SIZE
• DEVIATION_FACTOR
• MIN_SIZE_FACTOR

28–35

Abaqus ID:
Printed on:
MESH COMMANDS

• BIAS_RATIO
• BIAS_MIN_SIZE
• BIAS_MAX_SIZE
• VERTEX_ADJ_TO_SMALLEST_ELEM
• SMALLEST_ELEM_LOCATION
• CONSTRAINT
The return value is dependent on the attribute argument.
• If attribute=EDGE_SEEDING_METHOD, the return value is a SymbolicConstant
specifying the edge seeding method used to create the seeds along the edge. Possible values
are:
– UNIFORM_BY_NUMBER
– UNIFORM_BY_SIZE
– CURVATURE_BASED_BY_SIZE
– BIASED
– NONE

• If attribute=BIAS_METHOD, the return value is a SymbolicConstant specifying the bias

type used to create the seeds along the edge. Possible values are:
– SINGLE
– DOUBLE
– NONE

• If attribute=NUMBER, the return value is an Int specifying the number of element seeds
along the edge.
• If attribute=AVERAGE_SIZE, the return value is a Float specifying the average element size
along the edge.
• If attribute=DEVIATION_FACTOR, the return value is a Float specifying the deviation
factor , where is the chordal deviation and is the element length. If edge seeds are
not defined, the return value is zero.
• If attribute=MIN_SIZE_FACTOR, the return value is a Float specifying the size of the
smallest allowable element as a fraction of the specified global element size. If edge seeds
are not defined, the return value is zero.
• If attribute=BIAS_RATIO, the return value is a Float specifying the length ratio of the largest
element to the smallest element.

28–36

Abaqus ID:
Printed on:
 MESH COMMANDS

• If attribute=BIAS_MIN_SIZE, the return value is a Float specifying the length of the largest
element; only applicable if the EDGE_SEEDING_METHOD is BIASED and seeds were
specified by minimum and maximum sizes.
• If attribute=BIAS_MAX_SIZE, the return value is a Float specifying the length of the largest
element; only applicable if the EDGE_SEEDING_METHOD is BIASED and seeds were
specified by minimum and maximum sizes.
• If attribute=VERTEX_ADJ_TO_SMALLEST_ELEM, the return value is an Int
specifying the ID of the vertex next to the smallest element; only applicable if the
EDGE_SEEDING_METHOD is BIASED.
• If attribute=SMALLEST_ELEM_LOCATION, the return value is a SymbolicConstant
specifying the location of smallest elements for double bias seeds; only applicable if the
EDGE_SEEDING_METHOD is BIASED and BIAS_METHOD is DOUBLE. Possible
values are:
– SMALLEST_ELEM_AT_CENTER
– SMALLEST_ELEM_AT_ENDS
– NONE

• If attribute=CONSTRAINT, the return value is a SymbolicConstant specifying how close the

seeds must be matched by the mesh. Possible values are:
– FREE
– FINER
– FIXED
– NONE
A value of NONE indicates that the edge is not seeded.

Optional arguments
None.

Return value
The return value is a Float, an Int, or a SymbolicConstant depending on the value of the attribute
argument.

Exceptions
None.

28–37

Abaqus ID:
Printed on:
MESH COMMANDS

28.2.11 getElementType(...)
This method returns the ElemType object of a given element shape assigned to a region of a part.

Arguments
Required arguments
region
A Cell , a Face , or an Edge object specifying the region to be queried.
elemShape
A SymbolicConstant specifying the shape of the element for which to return the element type.
Possible values are:
• LINE
• QUAD
• TRI
• HEX
• WEDGE
• TET

Optional arguments
None.

Return value
ElemType object.

Exceptions
TypeError
The region cannot be associated with element types or the elemShape is not consistent with the
dimension of the region.

28.2.12 getIncompatibleMeshInterfaces(...)
This method returns a sequence of face objects that are meshed with incompatible elements.

Arguments
Required arguments
None.

28–38

Abaqus ID:
Printed on:
 MESH COMMANDS

Optional argument
cells
A sequence of cell objects which will be used to search the incompatible faces.

Return value
A sequence of Face objects.

Exceptions
None.

28.2.13 getMeshControl(...)
This method returns a mesh control parameter for the specified region of a part.

Arguments
Required arguments
region
A Cell , a Face , or an Edge object specifying the region to be queried.
attribute
A SymbolicConstant specifying the mesh control attribute to return. Possible values are:
• ELEM_SHAPE
• TECHNIQUE
• ALGORITHM
• MIN_TRANSITION
The return value depends on the value of the attribute argument.
• If attribute=ELEM_SHAPE, the return value is a SymbolicConstant specifying the element
shape used during meshing. Possible values are:
– LINE
– QUAD
– TRI
– QUAD_DOMINATED
– HEX
– TET
– WEDGE
– HEX_DOMINATED

28–39

Abaqus ID:
Printed on:
MESH COMMANDS

• If attribute=TECHNIQUE, the return value is a SymbolicConstant specifying the meshing

technique to be used during meshing. Possible values are:
– FREE
– STRUCTURED
– SWEEP
– UNMESHABLE
Where UNMESHABLE indicates that no meshing technique is applicable with the currently
assigned element shape.
• If attribute=ALGORITHM, the return value is a SymbolicConstant specifying the meshing
algorithm to be used during meshing. Possible values are:
– MEDIAL_AXIS
– ADVANCING_FRONT
– DEFAULT
– NON_DEFAULT
– NONE
Where NONE indicates that no algorithm is applicable.
• If attribute=MIN_TRANSITION, the return value is a Boolean indicating whether minimum
transition will be used during meshing. This option is applicable only to the following:
– Free quadrilateral meshing or sweep hexahedral meshing with
algorithm=MEDIAL_AXIS.
– Structured quadrilateral meshing.

Optional arguments
None.

Return value
The return value is a SymbolicConstant or a Boolean depending on the value of the attribute argument.

Exceptions
TypeError
The region cannot carry mesh controls.

28.2.14 getMeshStats(...)
This method returns the mesh statistics for the given regions.

28–40

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required argument
regions
A sequence or tuple of Geometry regions for which mesh statistics should be returned.
Optional arguments
None.

Return value
A MeshStats object.

Exceptions
None.

28.2.15 getPartSeeds(...)
This method returns a part seed parameter for the part.

Arguments
Required argument
attribute
A SymbolicConstant specifying the type of part seed attribute to return. Possible values are:
• SIZE
• DEFAULT_SIZE
• DEVIATION_FACTOR
• MIN_SIZE_FACTOR
The return value depends on the value of the attribute argument.
• If attribute=SIZE, the return value is a Float specifying the assigned global element size. If
part seeds are not defined, the return value is zero.
• If attribute=DEFAULT_SIZE, the return value is a Float specifying a suggested default global
element size based upon the part geometry.
• If attribute=DEVIATION_FACTOR, the return value is a Float specifying the deviation
factor , where is the chordal deviation and is the element length. If part seeds are
not defined, the return value is zero.
• If attribute=MIN_SIZE_FACTOR, the return value is a Float specifying the size of the
smallest allowable element as a fraction of the specified global element size. If part seeds
are not defined, the return value is zero.

28–41

Abaqus ID:
Printed on:
MESH COMMANDS

Optional arguments
None.

Return value
The return value is a Float that depends on the value of the attribute argument.

Exceptions
An exception occurs if the part does not contain native geometry.
Error: Part does not contain native geometry

28.2.16 getUnmeshedRegions()
This method returns all geometric regions in the part that require a mesh for submitting an analysis but
are either unmeshed or are meshed incompletely.

Arguments
None.

Return value
A Region object, or None.

Exceptions
None.

28.2.17 ignoreEntity(...)
This method creates a virtual topology feature. Virtual topology allows unimportant entities to be ignored
during mesh generation. You can combine two adjacent faces by specifying a common edge to ignore.
Similarly, you can combine two adjacent edges by specifying a common vertex to ignore.

Arguments
Required argument
entities
A sequence of vertices and edges specifying the entities to be ignored during meshing.
Optional arguments
None.

28–42

Abaqus ID:
Printed on:
 MESH COMMANDS

Return value
A Feature object.

Exceptions
None.

28.2.18 restoreIgnoredEntity(...)
This method restores vertices and edges that have been merged using a virtual topology feature.

Arguments
Required argument
entities
A sequence of IgnoredVertex objects and IgnoredEdge objects specifying the entities to be restored.
Optional arguments
None.

Return value
A Feature object.

Exceptions
None.

28.2.19 seedEdgeByBias(...)
This method seeds the given edges nonuniformly using the specified number of elements and bias ratio
or the specified minimum and maximum element sizes.

Arguments
Required arguments
biasMethod
A SymbolicConstant specifying whether single- or double-biased seed distribution will be applied.
If unspecified, single-biased seed distribution will be applied. Possible values are:
• SINGLE: Single-biased seed distribution will be applied.
• DOUBLE: Double-biased seed distribution will be applied.

28–43

Abaqus ID:
Printed on:
MESH COMMANDS

end1Edges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near the end where the normalized curve parameter=0.0. You must provide either the end1Edges
or the end2Edges argument or both when biasMethod=SINGLE and omit both of them when
biasMethod=DOUBLE.

Note: You cannot determine from the Abaqus Scripting Interface which end is which. However,
Abaqus/CAE displays the orientation of the bias when the edge is picked.

end2Edges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near the end where the normalized curve parameter=1.0.
centerEdges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near edge center. You must provide either the centerEdges or the endEdges argument or both when
biasMethod=DOUBLE and omit both of them when biasMethod=SINGLE.
endEdges
A sequence of Edge objects specifying the edges to seed. The smallest elements will be positioned
near edge ends.
ratio
A Float specifying the ratio of the largest element to the smallest element. Possible values are 1.0
ratio 106 .
number
An Int specifying the number of elements along each edge. Possible values are 1 number 104 .
minSize
A Float specifying the desired smallest element size.
maxSize
A Float specifying the desired largest element size.

Note: You must specify either the ratio and number or minSize and maxSize pair of arguments.
Optional argument
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.
• FIXED: The seeds must be exactly matched by the mesh (only with respect to the number of
elements, not to the nodal positioning).

28–44

Abaqus ID:
Printed on:
 MESH COMMANDS

Return value
None

Exceptions
None.

28.2.20 seedEdgeByNumber(...)
This method seeds the given edges uniformly based on the number of elements along the edges.

Arguments
Required arguments
edges
A sequence of Edge objects specifying the edges to seed.
number
An Int specifying the number of elements along each edge. Possible values are 1 number 104 .
Optional argument
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.
• FIXED: The seeds must be exactly matched by the mesh (only with respect to the number of
elements, not to the nodal positioning).

Return value
None

Exceptions
None.

28.2.21 seedEdgeBySize(...)
This method seeds the given edges either uniformly or following edge curvature distribution, based on
the desired element size.

28–45

Abaqus ID:
Printed on:
MESH COMMANDS

Arguments
Required arguments
edges
A sequence of Edge objects specifying the edges to seed.
size
A Float specifying the desired element size.
Optional arguments
deviationFactor
A Float specifying the deviation factor , where is the chordal deviation and is the element
length.
minSizeFactor
A Float specifying the size of the smallest allowable element as a fraction of the specified global
element size.
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.
• FIXED: The seeds must be exactly matched by the mesh (only with respect to the number of
elements, not to the nodal positioning).

Return value
None

Exceptions
None.

28.2.22 seedPart(...)
This method assigns global edge seeds to the given parts.

Arguments
Required arguments
regions
A sequence of Part objects specifying the part instances to seed.

28–46

Abaqus ID:
Printed on:
 MESH COMMANDS

size
A Float specifying the desired global element size for the edges.
Optional arguments
deviationFactor
A Float specifying the deviation factor , where is the chordal deviation and is the element
length.
minSizeFactor
A Float specifying the size of the smallest allowable element as a fraction of the specified global
element size.
constraint
A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The default
value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:
• FREE: The resulting mesh can be finer or coarser than the specified seeds.
• FINER: The resulting mesh can be finer than the specified seeds.

Return value
None

Exceptions
None.

28.2.23 setElementType(...)
This method assigns element types to the specified regions.

Arguments
Required arguments
regions
A sequence of Geometry regions or MeshElement objects, or a Set object containing either
geometry regions or elements, specifying the regions to which element types are to be assigned.
elemTypes
A sequence of ElemType objects, one for each element shape applicable to the regions.
Note: If an ElemType object has an UNKNOWN_xxx value for elemCode, its order will be
deduced from the order of other valid ElemType objects within the same setElementType
command. If no valid ElemType objects can be found, the order will remain unchanged.

28–47

Abaqus ID:
Printed on:
MESH COMMANDS

Optional arguments
None.

Return value
None

Exceptions
As a result of the element assignment, a region must have the same library, family, and order for all its
assigned element types. Otherwise, an exception will be thrown.
For example, suppose the Hex, Wedge, and Tet elements previously assigned to a cell are all linear.
The user now constructs an ElemType object with a quadratic Hex element and includes only this object
in the setElementType command. An exception will be thrown because the Wedge and Tet elements
will remain linear (i.e., As Is) and become incompatible with the newly assigned quadratic Hex element.

28.2.24 setLogicalCorners(...)
This method sets the logical corners for a mappable face region.

Arguments
Required arguments
region
A Face region.
corners
Three, four, or five Vertex objects defining the logical corners for a given mappable face region.
Optional arguments
None.

Return value
None

Exceptions
None.

28.2.25 setMeshControls(...)
This method sets the mesh control parameters for the specified regions.

28–48

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required argument
regions
A sequence of Face or Cell regions specifying the regions for which to set the mesh control
parameters.
Optional arguments
elemShape
A SymbolicConstant specifying the element shape to be used for meshing. The default value is
QUAD for Face regions and HEX for Cell regions. If unspecified, the existing element shape will
remain unchanged. Possible values are:
• QUAD: Quadrilateral mesh.
• QUAD_DOMINATED: Quadrilateral-dominated mesh.
• TRI: Triangular mesh.
• HEX: Hexahedral mesh.
• HEX_DOMINATED: Hex-dominated mesh.
• TET: Tetrahedral mesh.
• WEDGE: Wedge mesh.
technique
A SymbolicConstant specifying the mesh technique to be used. The default value is FREE for
Face regions. For Cell regions the initial value depends on the geometry of the regions and can
be STRUCTURED, SWEEP, or “unmeshable.” If unspecified, the existing mesh technique(s) will
remain unchanged. Possible values are:
• FREE: Free mesh technique.
• STRUCTURED: Structured mesh technique.
• SWEEP: Sweep mesh technique.
• BOTTOM-UP: Bottom-up mesh technique. Only applicable for cell regions.
• SYSTEM_ASSIGN: Allow the system to assign a suitable technique. The actual technique
assigned can be STRUCTURED, SWEEP, or “unmeshable.”
algorithm
A SymbolicConstant specifying the algorithm used to generate the mesh for the specified
regions. Possible values are MEDIAL_AXIS, ADVANCING_FRONT, and NON_DEFAULT.
If unspecified, the existing value will remain unchanged. This option is applicable only to the
following:
• Free quadrilateral or quadrilateral-dominated meshing. In this case the possible values are
MEDIAL_AXIS and ADVANCING_FRONT.

28–49

Abaqus ID:
Printed on:
MESH COMMANDS

• Sweep hexahedral or hexahedral-dominated meshing. In this case the possible values are
MEDIAL_AXIS and ADVANCING_FRONT.
• Free tetrahedral meshing. In this case the only possible value is NON_DEFAULT, and it
indicates that the free tetrahedral-meshing technique available in Abaqus 6.4 or earlier will
be used. If algorithm is not specified, the default tetrahedral-meshing technique will be used.

minTransition
A Boolean specifying whether minimum transition is to be applied. The default value is ON.
If unspecified, the existing value will remain unchanged. This option is applicable only in the
following cases:
• Free quadrilateral meshing or hexahedral sweep meshing with algorithm=MEDIAL_AXIS.
• Structured quadrilateral meshing.

sizeGrowth
A SymbolicConstant specifying element size growth to be applied when generating the interior of
a tetrahedral mesh. Possible values are MODERATE and MAXIMUM. If unspecified, the existing
value will remain unchanged. This option only applies to the default tetrahedral mesher.
allowMapped
A Boolean specifying whether mapped meshing can be used to replace the selected mesh technique.
The allowMapped argument is applicable only in the following cases:
• Free triangular meshing.
• Free quadrilateral or quadrilateral-dominated meshing with
algorithm=ADVANCING_FRONT.
• Hexahedral or hexahedral-dominated sweep meshing with
algorithm=ADVANCING_FRONT.
• Free tetrahedral meshing. allowMapped=True implies that mapped triangular meshing can
be used on faces that bound three-dimensional regions.

Return value
None

Exceptions
None.

28.2.26 setSweepPath(...)
This method sets the sweep path for a sweepable region or the revolve path for a revolvable region.

28–50

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required arguments
region
A sweepable region.
edge
An Edge object specifying the sweep or revolve path.
sense
A SymbolicConstant specifying the sweep sense. The sense will affect only how gasket elements
will be created; it will have no effect if gasket elements are not used. Possible values are
FORWARD or REVERSE.
If sense=FORWARD, the sense of the given edge’s underlying curve will be used.
Optional arguments
None.

Return value
None

Exceptions
None.

28.2.27 verifyMeshQuality(...)
This method tests the mesh quality of a part and returns poor-quality elements.

Arguments
Required argument
criterion
A SymbolicConstant specifying the criterion used for the quality check. Possible values are:
ANALYSIS_CHECKS
When this criterion is specified Abaqus/CAE will invoke the element quality checks included
with the input file processor for Abaqus/Standard and Abaqus/Explicit.

ANGULAR_DEVIATION
The maximum amount (in degrees) that an element’s face corner angles deviate from the ideal
angle. The ideal angle is 90° for quadrilateral element faces and 60° for triangular element
faces. Elements with an angular deviation larger than the specified threshold will fail this test.

28–51

Abaqus ID:
Printed on:
MESH COMMANDS

ASPECT_RATIO
The ratio between the lengths of the longest and shortest edges of an element. Elements with
an aspect ratio larger than the specified threshold will fail this test.

GEOM_DEVIATION_FACTOR
The largest geometric deviation factor evaluated along any of the element edges associated
with geometric edges or faces. The geometric deviation factor along an element edge
is calculated by dividing the maximum gap between the element edge and its associated
geometry by the length of the element edge. Elements with a geometric deviation factor
larger than the specified threshold will fail this test.

LARGE_ANGLE
The largest corner angle on any of an element’s faces. Elements with face angles larger than
the specified threshold (in degrees) will fail this test.

LONGEST_EDGE
The length of an element’s longest edge. Elements with an edge longer than the specified
threshold will fail this test.

MAX_FREQUENCY
An estimate of an element’s contribution to the initial maximum allowable frequency for
Abaqus/Standard analyses. This calculation requires appropriate section assignments and
material definitions. Elements whose maximum allowable frequency is smaller than the given
value will fail this test.

SHAPE_FACTOR
The shape factor for triangular and tetrahedral elements. This is the ratio between the element
area or volume and the optimal element area or volume. Elements with a shape factor smaller
than the specified threshold will fail this test.

SHORTEST_EDGE
The length of an element’s shortest edge. Elements with an edge shorter than the specified
threshold will fail this test.

SMALL_ANGLE
The smallest corner angle on any of an element’s faces. Elements with face angles smaller
than the given value (in degrees) will fail this test.

STABLE_TIME_INCREMENT
An estimate of an element’s contribution to the initial maximum stable time increment for
Abaqus/Explicit analyses. This calculation requires appropriate section assignments and

28–52

Abaqus ID:
Printed on:
 MESH COMMANDS

material definitions. Elements that require a time increment smaller than the given value
will fail this test.

Optional arguments
threshold
A Float value used to determine low quality elements according to the specified criterion. This
argument is ignored when the ANALYSIS_CHECKS criterion is used. For other criterion, if this
argument is unspecified then no list of failed elements will be returned.
elemShape
A SymbolicConstant specifying an element shape for limiting the query. Possible values are LINE,
QUAD, TRI, HEX, WEDGE, and TET.
regions
A sequence of Region or MeshElement objects. If you do not specify the regions argument, the
entire part mesh is considered.

Return value
A Dictionary object containing values for some number of the following keys: failedElements,
warningElements, naElements (sequences of MeshElement objects); numElements (Int); average, worst
(Float); worstElement ( MeshElement object)

Exceptions
None.

28.3 ElemType object

The ElemType object is an argument object used as an argument in the setElementType command.

Access
import mesh

28.3.1 ElemType(...)
This method creates an ElemType object.

Path
ElemType

28–53

Abaqus ID:
Printed on:
MESH COMMANDS

Required argument
elemCode
A SymbolicConstant specifying the Abaqus element code or just the element shape. Possible
values are:
• C3D8R, specifying a 8-node linear brick, reduced integration with hourglass control.
• CODE, specifying add more codes.
• UNKNOWN_TRI, specifying an unknown element type associated with a triangular shape.
• UNKNOWN_QUAD, specifying an unknown element type associated with a quadrilateral
shape.
• UNKNOWN_HEX, specifying an unknown element type associated with a hexahedral
shape.
• UNKNOWN_WEDGE, specifying an unknown element type associated with a wedge shape.
• UNKNOWN_TET, specifying an unknown element type associated with a tetrahedral shape.

Optional arguments
elemLibrary
A SymbolicConstant specifying the Abaqus element library to use. Possible values are
STANDARD and EXPLICIT. The default value is STANDARD.
hourglassStiffness
A Float specifying the hourglass stiffness. (For shell elements this is the membrane hourglass
stiffness.) A value of zero indicates the default value should be used. The default value will be
used where appropriate. The default value is 0.0.
This argument is applicable only to some Abaqus/Standard elements.
bendingHourglass
A Float specifying the bending hourglass stiffness. A value of zero indicates the default value
should be used. The default value will be used where appropriate. The default value is 0.0.
This argument is applicable only to some Abaqus/Standard elements.
drillingHourglass
A Float specifying the drilling hourglass scaling factor. A value of zero indicates the default value
should be used. The default value will be used where appropriate. The default value is 0.0.
This argument is applicable only to some Abaqus/Standard elements.
kinematicSplit
A SymbolicConstant specifying the kinematic split control. Possible values are
AVERAGE_STRAIN, ORTHOGONAL, and CENTROID. The default value is
AVERAGE_STRAIN.
This argument is applicable only to some Abaqus/Explicit elements.

28–54

Abaqus ID:
Printed on:
 MESH COMMANDS

distortionControl
A Boolean specifying whether to prevent negative element volumes or other excessive distortions
in crushable materials. The default value is OFF.
This argument is applicable only to some Abaqus/Explicit elements.
lengthRatio
A Float specifying the length ratio for distortion control in crushable materials. Possible values
are 0.0 lengthRatio 1.0. The default value is lengthRatio=
This argument is applicable only when distortionControl is ON.
secondOrderAccuracy
A Boolean specifying the second-order accuracy option. The default value is OFF.
This argument is applicable only to some Abaqus/Explicit elements.
hourglassControl
A SymbolicConstant specifying the hourglass control. Possible values are RELAX_STIFFNESS,
STIFFNESS, VISCOUS, ENHANCED, and COMBINED. The default value is ENHANCED.
This argument is applicable only to some Abaqus/Explicit elements.
weightFactor
A Float specifying a weight factor when hourglassControl=COMBINED. The default value is 0.5.
This argument is applicable only to some Abaqus/Explicit elements.
displacementHourglass
A Float specifying the displacement hourglass scaling factor. The default value will be used where
appropriate. The default value is 1.0.
This argument is applicable only to some Abaqus/Explicit elements.
rotationalHourglass
A Float specifying the rotational hourglass scaling factor. The default value will be used where
appropriate. The default value is 1.0.
This argument is applicable only to some Abaqus/Explicit elements.
outOfPlaneDisplacementHourglass
A Float specifying the out-of-plane displacement hourglass scaling factor. The default value will
be used where appropriate. The default value is 1.0.
This argument is applicable only to some Abaqus/Explicit elements.

Return value
An ElemType object.

Exceptions
None.

28–55

Abaqus ID:
Printed on:
MESH COMMANDS

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

28.4 MeshEdge object

The MeshEdge object refers to an element edge. It has no constructor or members. A MeshEdge object
can be accessed via a part or part instance using an index that refers to the internal numbering of the
MeshEdgeArray repository.

Access
import part
mdb.models[name].parts[name].elemEdges[i]
mdb.models[name].parts[name].elementEdges[i]
import assembly
mdb.models[name].rootAssembly.instances[name].elemEdges[i]
mdb.models[name].rootAssembly.instances[name].elementEdges[i]

28.4.1 getElements()
This method returns a tuple of elements that share the element edge.

Arguments
None.

Return value
A tuple of MeshElement objects.

Exceptions
None.

28.4.2 getElemFaces()
This method returns a tuple of unique element faces that share the element edge.

Arguments
None.

28–56

Abaqus ID:
Printed on:
 MESH COMMANDS

Return value
A tuple of MeshFace objects.

Exceptions
None.

28.4.3 getNodes()
This method returns a tuple of nodes on the element edge.

Arguments
None.

Return value
A tuple of MeshNode objects.

Exceptions
None.

28.4.4 Members
The MeshEdge object has no members.

28.5 MeshElement object

The MeshElement object refers to an element of a native mesh or an orphan mesh. A MeshElement
object can be accessed via a part or part instance using an index that refers to the internal numbering of
the element repository. The index does not refer to the element label.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].elements[i]
mdb.models[name].parts[name].allInternalSurfaces[name].elements[i]
mdb.models[name].parts[name].allSets[name].elements[i]
mdb.models[name].parts[name].allSurfaces[name].elements[i]
mdb.models[name].parts[name].elements[i]
mdb.models[name].parts[name].sets[name].elements[i]

28–57

Abaqus ID:
Printed on:
MESH COMMANDS

mdb.models[name].parts[name].surfaces[name].elements[i]
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].elements[i]
mdb.models[name].rootAssembly.allInternalSurfaces[name].elements[i]
mdb.models[name].rootAssembly.allSets[name].elements[i]
mdb.models[name].rootAssembly.allSurfaces[name].elements[i]
mdb.models[name].rootAssembly.elements[i]
mdb.models[name].rootAssembly.instances[name].elements[i]
mdb.models[name].rootAssembly.instances[name].sets[name].elements[i]
mdb.models[name].rootAssembly.instances[name].surfaces[name]\
.elements[i]
mdb.models[name].rootAssembly.sets[name].elements[i]
mdb.models[name].rootAssembly.surfaces[name].elements[i]

28.5.1 Element(...)
This method creates an element on an orphan mesh part from a sequence of nodes.

Path
mdb.models[name].parts[name].Element

Required arguments
nodes
A sequence of MeshNode objects.
elemShape
A SymbolicConstant specifying the shape of the new element. Possible values are LINE2, LINE3,
TRI3, TRI6, QUAD4, QUAD8, TET4, TET10, WEDGE6, WEDGE15, HEX8, and HEX20.
Optional argument
label
An Int specifying the element label.

Return value
A MeshElement object.

Exceptions
None.

28–58

Abaqus ID:
Printed on:
 MESH COMMANDS

28.5.2 getNodes()
This method returns a tuple of node objects of the element.

Arguments
None.

Return value
A tuple of MeshNode objects.

Exceptions
None.

28.5.3 getElemEdges()
This method returns a tuple of unique element edge objects on the element.

Arguments
None.

Return value
A tuple of MeshEdge objects.

Exceptions
None.

28.5.4 getElemFaces()
This method returns a tuple of unique element face objects on the element.

Arguments
None.

Return value
A tuple of MeshFace objects.

28–59

Abaqus ID:
Printed on:
MESH COMMANDS

Exceptions
None.

28.5.5 getAdjacentElements()
This method returns an array of element objects adjacent to the mesh element.

Arguments
None.

Return value
A MeshElementArray object which is a sequence of MeshElement objects.

Exceptions
None.

28.5.6 setValues(...)
This method modifies the MeshElement object.

Arguments
Required arguments
None.
Optional argument
label
An Int specifying the element label. This member may only be edited if the element belongs to an
orphan mesh part. The specified label must be non-negative and must not be in use by any other
element of the same part.

Return value
None

Exceptions
None.

28.5.7 Members
The MeshElement object has the following members:

28–60

Abaqus ID:
Printed on:
 MESH COMMANDS

label
An Int specifying the element label.
type
A SymbolicConstant specifying the Abaqus element code.
instanceName
A String specifying the name of the part instance that owns this element.
connectivity
A tuple of Ints specifying the internal node indices that define the nodal connectivity.

28.6 MeshElementArray object

The MeshElementArray is a sequence of MeshElement objects.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].elements
mdb.models[name].parts[name].allInternalSurfaces[name].elements
mdb.models[name].parts[name].allSets[name].elements
mdb.models[name].parts[name].allSurfaces[name].elements
mdb.models[name].parts[name].elements
mdb.models[name].parts[name].sets[name].elements
mdb.models[name].parts[name].surfaces[name].elements
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].elements
mdb.models[name].rootAssembly.allInternalSurfaces[name].elements
mdb.models[name].rootAssembly.allSets[name].elements
mdb.models[name].rootAssembly.allSurfaces[name].elements
mdb.models[name].rootAssembly.elements
mdb.models[name].rootAssembly.instances[name].elements
mdb.models[name].rootAssembly.instances[name].sets[name].elements
mdb.models[name].rootAssembly.instances[name].surfaces[name].elements
mdb.models[name].rootAssembly.sets[name].elements
mdb.models[name].rootAssembly.surfaces[name].elements

28.6.1 getFromLabel(...)
This method returns the object in the MeshElementArray with the given label.

28–61

Abaqus ID:
Printed on:
MESH COMMANDS

Arguments
Required argument
label
An Int specifying the label of the object.
Optional arguments
None.

Return value
A MeshElement object.

Exceptions
None.

28.6.2 getSequenceFromMask(...)
This method returns the object or objects in the MeshElementArray identified using the specified mask.
This command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large
number of objects are involved, this method is highly efficient.

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A MeshElement object.

Exceptions
None.

28.6.3 getByBoundingBox(...)
This method returns an array of element objects that lie within the specified bounding box.

28–62

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required arguments
None.
Optional arguments
xMin
A float specifying the minimum X boundary of the bounding box.
yMin
A float specifying the minimum Y boundary of the bounding box.
zMin
A float specifying the minimum Z boundary of the bounding box.
xMax
A float specifying the maximum X boundary of the bounding box.
yMax
A float specifying the maximum Y boundary of the bounding box.
zMax
A float specifying the maximum Z boundary of the bounding box.

Return value
A MeshElementArray object, which is a sequence of MeshElement objects.

Exceptions
None.

28.6.4 getByBoundingCylinder(...)
This method returns an array of element objects that lie within the specified bounding cylinder.

Arguments
Required arguments
origin1
A tuple of the X-, Y-, and Z-coordinates of the center of the first end of the cylinder.
origin2
A tuple of the X-, Y-, and Z-coordinates of the center of the second end of the cylinder.
radius
A float specifying the radius of the cylinder.
Optional arguments
None.

28–63

Abaqus ID:
Printed on:
MESH COMMANDS

Return value
A MeshElementArray object, which is a sequence of MeshElement objects.

Exceptions
None.

28.6.5 getByBoundingSphere(...)
This method returns an array of element objects that lie within the specified bounding sphere.

Arguments
Required arguments
origin
A tuple of the X-, Y-, and Z-coordinates of the center of the sphere.
radius
A float specifying the radius of the sphere.
Optional arguments
None.

Return value
A MeshElementArray object, which is a sequence of MeshElement objects.

Exceptions
None.

28.6.6 getBoundingBox()
This method returns a dictionary of two tuples representing minimum and maximum boundary values of
the bounding box of the minimum size containing the element sequence.

Arguments
None.

Return value
A Dictionary object with the following items:
low: a tuple of three floats representing the minimum x, y and z boundary values of the bounding
box.

28–64

Abaqus ID:
Printed on:
 MESH COMMANDS

high: a tuple of three floats representing the maximum x, y and z boundary values of the bounding
box.

Exceptions
None.

28.6.7 sequenceFromLabels(...)
This method returns the object or objects in the MeshElementArray identified using the specified labels.

Arguments
Required argument
labels
A sequence of Ints specifying the labels.
Optional arguments
None.

Return value
A MeshElement object.

Exceptions
None.

28.6.8 sequenceFromLabels(...)
This method returns the object or objects in the MeshElementArray identified using the specified labels.

Arguments
Required argument
labels
A sequence of Ints specifying the labels.
Optional arguments
None.

Return value
A MeshElement object.

28–65

Abaqus ID:
Printed on:
MESH COMMANDS

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

28.6.9 Members
The MeshElementArray object has no members.

28.7 MesherOptions object

The MesherOptions object controls the default settings that Abaqus uses for all meshing methods. The
MesherOptions object has no constructor. Abaqus creates the MesherOptions member when a session is
started.
MesherOptions commands are intended for use at the beginning of scripts and in the abaqus_env
file only; they should not be used during an Abaqus/CAE session.

Access
session.defaultMesherOptions

28.7.1 setValues(...)
This method modifies the MesherOptions object.

Arguments
Required arguments
None.
Optional arguments
elemShape2D
A SymbolicConstant specifying the default element shape for meshing two-dimensional
objects. Possible values are QUAD, QUAD_DOMINATED, and TRI. The default value is
QUAD_DOMINATED.
elemShape3D
A SymbolicConstant specifying the default element shape for meshing three-dimensional objects.
Possible values are HEX, HEX_DOMINATED, WEDGE, and TET. The default value is HEX.
quadAlgorithm
A SymbolicConstant specifying the default algorithm for meshing an object with quad- or
quad-dominated elements. Possible values are ADVANCING_FRONT and MEDIAL_AXIS.
The default value is ADVANCING_FRONT.

28–66

Abaqus ID:
Printed on:
 MESH COMMANDS

allowMapped
A Boolean specifying whether Abaqus/CAE should allow mapped meshing, where appropriate.
The default value is OFF.
minTransition
A Boolean specifying whether Abaqus/CAE should attempt to minimize the mesh transition when
it moves from a coarse mesh to a fine mesh. The default value is ON.

Return value
None

Exceptions
None.

28.7.2 Members
The MesherOptions object has members with the same names and descriptions as the arguments to the
setValues method.

28.8 MeshFace object

The MeshFace object refers to an element face. It has no constructor or members. A MeshFace object
can be accessed via a part or part instance using an index that refers to the internal numbering of the
MeshFaceArray repository.

Access
import part
mdb.models[name].parts[name].elementFaces[i]
mdb.models[name].parts[name].elemFaces[i]
import assembly
mdb.models[name].rootAssembly.instances[name].elementFaces[i]
mdb.models[name].rootAssembly.instances[name].elemFaces[i]

28.8.1 getElemEdges()
This method returns a tuple of unique element edges on the element face.

Arguments
None.

28–67

Abaqus ID:
Printed on:
MESH COMMANDS

Return value
A tuple of MeshEdge objects.

Exceptions
None.

28.8.2 getElements()
This method returns a tuple of elements that share the element face.

Arguments
None.

Return value
A tuple of MeshElement objects.

Exceptions
None.

28.8.3 getNodes()
This method returns a tuple of nodes on the element face.

Arguments
None.

Return value
A tuple of MeshNode objects.

Exceptions
None.

28.8.4 getNodesByFaceAngle(...)
This method returns an array of mesh Node objects that are obtained by recursively finding adjacent
element faces that are at an angle of less than or equal to the specified angle.

28–68

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required arguments
None.
Optional argument
angle
A float specifying the value of the face angle.

Return value
A MeshNodeArray object which is a sequence of MeshNode objects.

Exceptions
None.

28.8.5 getElemFacesByFaceAngle(...)
This method returns an array of mesh Element Face objects that are obtained by recursively finding
adjacent element faces that are at an angle of less than or equal to the specified angle.

Arguments
Required arguments
None.
Optional argument
angle
A float specifying the value of the face angle.

Return value
A MeshFaceArray object which is a sequence of MeshFace objects.

Exceptions
None.

28.8.6 getElementsByFaceAngle(...)
This method returns an array of mesh Element objects that are obtained by recursively finding adjacent
element faces that are at an angle of less than or equal to the specified angle.

28–69

Abaqus ID:
Printed on:
MESH COMMANDS

Arguments
Required arguments
None.
Optional argument
angle
A float specifying the value of the face angle.

Return value
A MeshElementArray object which is a sequence of MeshElement objects.

Exceptions
None.

28.8.7 Members
The MeshFace object has the following members:
label
An Int specifying an Int specifying the element label.
face
An Int specifying a symbolic constant specifying the side of the element.

28.9 MeshNode object

The MeshNode object refers to a node of a native mesh or an orphan mesh. A MeshNode object can
be accessed via a part or part instance using an index that refers to the internal numbering of the node
repository. The index does not refer to the node label.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].nodes[i]
mdb.models[name].parts[name].allInternalSurfaces[name].nodes[i]
mdb.models[name].parts[name].allSets[name].nodes[i]
mdb.models[name].parts[name].allSurfaces[name].nodes[i]
mdb.models[name].parts[name].nodes[i]
mdb.models[name].parts[name].sets[name].nodes[i]
mdb.models[name].parts[name].surfaces[name].nodes[i]
import assembly

28–70

Abaqus ID:
Printed on:
 MESH COMMANDS

mdb.models[name].rootAssembly.allInternalSets[name].nodes[i]
mdb.models[name].rootAssembly.allInternalSurfaces[name].nodes[i]
mdb.models[name].rootAssembly.allSets[name].nodes[i]
mdb.models[name].rootAssembly.allSurfaces[name].nodes[i]
mdb.models[name].rootAssembly.instances[name].nodes[i]
mdb.models[name].rootAssembly.instances[name].sets[name].nodes[i]
mdb.models[name].rootAssembly.instances[name].surfaces[name].nodes[i]
mdb.models[name].rootAssembly.nodes[i]
mdb.models[name].rootAssembly.sets[name].nodes[i]
mdb.models[name].rootAssembly.surfaces[name].nodes[i]

28.9.1 Node(...)
This method creates a node on an orphan mesh part.

Path
mdb.models[name].parts[name].Node

Required argument
coordinates
A sequence of three Floats specifying the coordinates of the new node.
Optional arguments
localCsys
A DatumCsys object specifying the local coordinate system. If unspecified, the global coordinate
system will be used.
label
An Int specifying the node label.

Return value
A MeshNode object.

Exceptions
None.

28.9.2 getElemEdges()
This method returns a tuple of element edge objects that share the node.

28–71

Abaqus ID:
Printed on:
MESH COMMANDS

Arguments
None.

Return value
A tuple of MeshEdge objects.

Exceptions
None.

28.9.3 getElemFaces()
This method returns a tuple of element face objects that share the node.

Arguments
None.

Return value
A tuple of MeshFace objects.

Exceptions
None.

28.9.4 getElements()
This method returns a tuple of element objects that share the node.

Arguments
None.

Return value
A tuple of MeshElement objects.

Exceptions
None.

28–72

Abaqus ID:
Printed on:
 MESH COMMANDS

28.9.5 setValues(...)
This method modifies the MeshNode object.

Arguments
Required arguments
None.
Optional argument
label
An Int specifying the node label. This member may only be edited if the node belongs to an orphan
mesh part. The specified label must be non-negative and must not be in use by any other node of
the same part.

Return value
None

Exceptions
None.

28.9.6 Members
The MeshNode object has the following members:
label
An Int specifying the node label.
instanceName
A String specifying the name of the part instance that owns this node.
coordinates
A tuple of three Floats specifying the coordinates of the new node.

28.10 MeshNodeArray object

The MeshNodeArray is a sequence of MeshNode objects.

Access
import part
mdb.models[name].parts[name].allInternalSets[name].nodes
mdb.models[name].parts[name].allInternalSurfaces[name].nodes

28–73

Abaqus ID:
Printed on:
MESH COMMANDS

mdb.models[name].parts[name].allSets[name].nodes
mdb.models[name].parts[name].allSurfaces[name].nodes
mdb.models[name].parts[name].nodes
mdb.models[name].parts[name].sets[name].nodes
mdb.models[name].parts[name].surfaces[name].nodes
import assembly
mdb.models[name].rootAssembly.allInternalSets[name].nodes
mdb.models[name].rootAssembly.allInternalSurfaces[name].nodes
mdb.models[name].rootAssembly.allSets[name].nodes
mdb.models[name].rootAssembly.allSurfaces[name].nodes
mdb.models[name].rootAssembly.instances[name].nodes
mdb.models[name].rootAssembly.instances[name].sets[name].nodes
mdb.models[name].rootAssembly.instances[name].surfaces[name].nodes
mdb.models[name].rootAssembly.nodes
mdb.models[name].rootAssembly.sets[name].nodes
mdb.models[name].rootAssembly.surfaces[name].nodes

28.10.1 getFromLabel(...)
This method returns the object in the MeshNodeArray with the given label.

Arguments
Required argument
label
An Int specifying the label of the object.
Optional arguments
None.

Return value
A MeshNode object.

Exceptions
None.

28.10.2 getSequenceFromMask(...)
This method returns the object or objects in the MeshNodeArray identified using the specified mask. This
command is generated when the JournalOptions are set to COMPRESSEDINDEX. When large number
of objects are involved, this method is highly efficient.

28–74

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A MeshNode object.

Exceptions
None.

28.10.3 getByBoundingBox(...)
This method returns an array of node objects that lie within the specified bounding box.

Arguments
Required arguments
None.
Optional arguments
xMin
A float specifying the minimum X boundary of the bounding box.
yMin
A float specifying the minimum Y boundary of the bounding box.
zMin
A float specifying the minimum Z boundary of the bounding box.
xMax
A float specifying the maximum X boundary of the bounding box.
yMax
A float specifying the maximum Y boundary of the bounding box.
zMax
A float specifying the maximum Z boundary of the bounding box.

Return value
A MeshNodeArray object, which is a sequence of MeshNode objects.

28–75

Abaqus ID:
Printed on:
MESH COMMANDS

Exceptions
None.

28.10.4 getByBoundingCylinder(...)
This method returns an array of node objects that lie within the specified bounding cylinder.

Arguments
Required arguments
origin1
A tuple of the X-, Y-, and Z-coordinates of the center of the first end of the cylinder.
origin2
A tuple of the X-, Y-, and Z-coordinates of the center of the second end of the cylinder.
radius
A float specifying the radius of the cylinder.
Optional arguments
None.

Return value
A MeshNodeArray object, which is a sequence of MeshNode objects.

Exceptions
None.

28.10.5 getByBoundingSphere(...)
This method returns an array of MeshNode objects that lie within the specified bounding sphere.

Arguments
Required arguments
origin
A tuple of the X-, Y-, and Z-coordinates of the center of the sphere.
radius
A float specifying the radius of the sphere.
Optional arguments
None.

28–76

Abaqus ID:
Printed on:
 MESH COMMANDS

Return value
A MeshNodeArray object, which is a sequence of MeshNode objects.

Exceptions
None.

28.10.6 getBoundingBox()
This method returns a dictionary of two tuples representing minimum and maximum boundary values of
the bounding box of the minimum size containing the node sequence.

Arguments
None.

Return value
A Dictionary object with the following items:
low: a tuple of three floats representing the minimum x, y and z boundary values of the bounding
box.
high: a tuple of three floats representing the maximum x, y and z boundary values of the bounding
box.

Exceptions
None.

28.10.7 sequenceFromLabels(...)
This method returns the object or objects in the MeshNodeArray identified using the specified labels.

Arguments
Required argument
labels
A sequence of Ints specifying the labels.
Optional arguments
None.

Return value
A MeshNode object.

28–77

Abaqus ID:
Printed on:
MESH COMMANDS

Exceptions

An exception occurs if the resulting sequence is empty.

Error: The mask results in an empty sequence

28.10.8 Members
The MeshNodeArray object has no members.

28.11 MeshFaceArray object

The MeshFaceArray can either be a repository or a sequence of MeshFace objects depending on how
it is accessed. If accessed using elemFaces it is a repository. Instead, if elementFaces is used, it is a
sequence.
When accessing it as a repository, masked indices should be used. The masked index refers to a
combination of an element and element face. Hence, these indices may not be in order and it may even
be greater than the length of the MeshFaceArray. In addition, the length of this repository will contain
an entry for an element face per element (i.e.,) if an element face is shared by two elements, there will
be two entries to indicate this.
When accessing it as a sequence, regular indices can be used. If masked indices are preferred,
use the getSequenceFromMask method available on elementFaces. The length of this sequence is
unique. Shared element faces have only one entry in this sequence.

Access

import part
mdb.models[name].parts[name].elementFaces
mdb.models[name].parts[name].elemFaces
import assembly
mdb.models[name].rootAssembly.instances[name].elementFaces
mdb.models[name].rootAssembly.instances[name].elemFaces

28.11.1 getSequenceFromMask(...)
This method returns the object or objects in the MeshFaceArray identified using the specified mask.
When large number of objects are involved, this method is highly efficient.

28–78

Abaqus ID:
Printed on:
 MESH COMMANDS

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A MeshFace object.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

28.11.2 Members
The MeshFaceArray object has no members.

28.12 MeshEdgeArray object

The MeshEdgeArray can either be a repository or a sequence of MeshEdge objects depending on how
it is accessed. If accessed using elemEdges it is a repository. Instead, if elementEdges is used, it is a
sequence.
When accessing it as a repository, masked indices should be used. The masked index refers to a
combination of an element, element face and element edge. Hence, these indices may not be in order and
it may even be greater than the length of the MeshFaceArray. In addition, the length of this repository
will contain an entry for an element edge per element (i.e.,) if an element edge is shared by two elements,
there will be two entries to indicate this.
When accessing it as a sequence, regular indices can be used. If masked indices are preferred,
use the getSequenceFromMask method available on elementEdges. The length of this sequence is
unique. Shared element edges have only one entry in this sequence.

Access
import part
mdb.models[name].parts[name].elemEdges
mdb.models[name].parts[name].elementEdges
import assembly
mdb.models[name].rootAssembly.instances[name].elemEdges

28–79

Abaqus ID:
Printed on:
MESH COMMANDS

mdb.models[name].rootAssembly.instances[name].elementEdges

28.12.1 getSequenceFromMask(...)
This method returns the object or objects in the MeshEdgeArray identified using the specified mask.
When large number of objects are involved, this method is highly efficient.

Arguments
Required argument
mask
A String specifying the object or objects.
Optional arguments
None.

Return value
A MeshEdge object.

Exceptions
An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence

28.12.2 Members
The MeshEdgeArray object has no members.

28.13 MeshStats object

The MeshStats object is a query object for holding mesh statistics and is returned by the getMeshStats
command. The object does not have any methods.

Access
import mesh

28.13.1 Members
The MeshStats object has the following members:
numPointElems
An Int specifying the number of point elements.

28–80

Abaqus ID:
Printed on:
 MESH COMMANDS

numLineElems
An Int specifying the number of line elements.
numQuadElems
An Int specifying the number of quadrilateral elements.
numTriElems
An Int specifying the number of triangular elements.
numHexElems
An Int specifying the number of hexahedral elements.
numWedgeElems
An Int specifying the number of wedge elements.
numTetElems
An Int specifying the number of tetrahedral elements.
numNodes
An Int specifying the number of nodes.
numMeshedRegions
An Int specifying the number of regions that contain a mesh.

28–81

Abaqus ID:
Printed on:
 MESSAGING COMMANDS

29. Messaging commands

Messaging commands are available only if Abaqus/CAE is run interactively using the GUI.

29.1 DataObject object

An instance of the DataObject object is passed to each callback. The DataObject object has no methods.
The members of a DataObject object depend on the type of the object. All DataObject instances have
the following members, regardless of type:
• clientHost
• clientName
• phase
• processId
• threadId
• timeStamp
The possible DataObject types and the additional members for each type are as follows:
ABORTED

• message

COMPLETED

• message

END_STEP

• stepId

ERROR

• message

29–1

Abaqus ID:
Printed on:
MESSAGING COMMANDS

HEADING

• heading

MONITOR_DATA

• dof
• node
• nset
• procedure
• time
• value

ODB_FILE

• file

STARTED

• No additional members.

STATUS

• attempts
• equilibrium
• increment
• iterations
• severe
• step
• stepTime
• timeIncrement
• totalTime

29–2

Abaqus ID:
Printed on:
 MESSAGING COMMANDS

STEP

• stepId
• stepName

WARNING

• message

29.1.1 Members
The DataObject object has the following members:
phase
A SymbolicConstant specifying the phase of the analysis. Possible values are
BATCHPRE_PHASE, PACKAGER_PHASE, STANDARD_PHASE, EXPLICIT_PHASE,
CALCULATOR_PHASE, and UNKNOWN_PHASE.
processId
An Int specifying the process ID of the analysis product.
threadId
An Int specifying the thread ID of the analysis product. Threads are used for parallel or
multiprocessing; in most cases threadId is set to zero.
timeStamp
An Int specifying the time the message was sent in seconds since 00:00:00 UTC, January 1, 1970.
attempts
An Int specifying the number of attempts made to reach equilibrium during this step.
dof
An Int specifying the degree of freedom requested for monitoring the output.
equilibrium
An Int specifying the number of equilibrium iterations made during this increment.
increment
An Int specifying the increment of the analysis.
iterations
An Int specifying the number of iterations in the step.

29–3

Abaqus ID:
Printed on:
MESSAGING COMMANDS

node
An Int specifying the node number requested for monitoring output.
severe
An Int specifying the number of severe discontinuity iterations completed during this increment.
step
An Int specifying the current step number. Step number 1 corresponds to the first step.
stepId
An Int specifying the ID of the step.
stepTime
A Float specifying the step time corresponding to the current increment.
time
A Float specifying the total time corresponding to the monitor data.
timeIncrement
A Float specifying the time increment used in the current step.
totalTime
A Float specifying the total time completed in the analysis.
value
A Float specifying the current value of the degree of freedom requested for monitoring.
clientHost
A String specifying the host name of the machine that is running the analysis.
clientName
A String specifying the name of the client that responded to the callback function. Possible values
are “BatchPre”, “Packager”, “Standard”, “Explicit”, and “Calculator”.
file
A String specifying the full path of the output database.
heading
A String specifying the job heading.
message
A String specifying the job heading.
nset
A String specifying the node set specified for monitoring output.
stepName
A String specifying the name of the step.

29–4

Abaqus ID:
Printed on:
 MESSAGING COMMANDS

29.2 MonitorMgr object

An instance of the MonitorMgr object is created when you import the abaqus module. No other instance
of the MonitorMgr object is required. (This MonitorMgr object is not to be confused with the degree of
freedom (DOF) monitor that is constructed from the Step object.)

Access
monitorManager

29.2.1 addMessageCallback(...)
This method specifies a callback function that will be called when the specified message is received from
the analysis product.
For more information, see “An example of a callback function,” Section 6.8.3 of the Abaqus
Scripting User’s Manual.

Arguments
Required arguments
jobName
A String specifying the name of the job to be monitored or the SymbolicConstant ANY_JOB.
messageType
A SymbolicConstant specifying which message type will call this callback. Possible values are:
• ABORTED
• ANY_JOB
• ANY_MESSAGE_TYPE
• COMPLETED
• END_STEP
• ERROR
• HEADING
• HEALER_JOB
• HEALER_TYPE
• INTERRUPTED
• ITERATION
• JOB_ABORTED
• JOB_COMPLETED
• JOB_INTERRUPTED

29–5

Abaqus ID:
Printed on:
MESSAGING COMMANDS

• JOB_SUBMITTED
• MONITOR_DATA
• ODB_FILE
• ODB_FRAME
• SIMULATION_ABORTED
• SIMULATION_COMPLETED
• SIMULATION_INTERRUPTED
• SIMULATION_SUBMITTED
• STARTED
• STATUS
• STEP
• WARNING

callback
A Python function to be called. The interface definition of the callback function is :

def onMessage(jobName, messageType, data, userData)

• jobName is a String.
• messageType is a SymbolicConstant with possible values as listed previously for the
addMessageCallback method.
• data is a DataObject object.
• userData is the object passed as the userData argument to the addMessageCallback
method.

Optional argument
userData
Any Python object or None. This object is passed to the callback function.

Return value
None

Exceptions
None.

29–6

Abaqus ID:
Printed on:
 MESSAGING COMMANDS

29.2.2 removeMessageCallback(...)
This method removes a callback function. You specify the callback function to remove using the same
arguments you used to add the callback.

Arguments
Required arguments
jobName
A String specifying the name of the job to be monitored or the SymbolicConstant ANY_JOB.
messageType
A SymbolicConstant specifying which message type will call this callback. Possible values are:
• ABORTED
• ANY_JOB
• ANY_MESSAGE_TYPE
• COMPLETED
• END_STEP
• ERROR
• HEADING
• HEALER_JOB
• HEALER_TYPE
• INTERRUPTED
• ITERATION
• JOB_ABORTED
• JOB_COMPLETED
• JOB_INTERRUPTED
• JOB_SUBMITTED
• MONITOR_DATA
• ODB_FILE
• ODB_FRAME
• SIMULATION_ABORTED
• SIMULATION_COMPLETED
• SIMULATION_INTERRUPTED
• SIMULATION_SUBMITTED
• STARTED
• STATUS
• STEP

29–7

Abaqus ID:
Printed on:
MESSAGING COMMANDS

• WARNING

callback
A Python function to be called; it must be the same as the callback argument specified in the
original call to addMessageCallback.
userData
Any Python object or None; it must be the same as the userData argument specified in the original
call to addMessageCallback.
Optional arguments
None.

Return value
None

Exceptions
None.

29.2.3 checkMonitorStatus()
This method raises a MonitorError exception if the monitoring status is not ENABLED.

Arguments
None.

Return value
None

Exceptions
MonitorError:
Status is not ENABLED

29.2.4 Members
The MonitorMgr object has no members.

29–8

Abaqus ID:
Printed on:
 MODEL COMMANDS

30. Model commands

Model commands are used to create Abaqus/CAE models. A finished model contains all the data that
Abaqus/CAE needs to create and submit an analysis to Abaqus/Standard or Abaqus/Explicit. Models
are stored in a model database.

30.1 Model object

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

Access
mdb.models[name]

30.1.1 Model(...)
This method creates a Model object.

Path
mdb.Model

Required argument
name
A String specifying the repository key.
Optional arguments
description
A String specifying the purpose and contents of the Model object. The default value is an empty
string.
stefanBoltzmann
None or a Float specifying the Stefan-Boltzmann constant. The default value is None.
absoluteZero
None or a Float specifying the absolute zero constant. The default value is None.
waveFormulation
A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic
problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is
NOT_SET.

30–1

Abaqus ID:
Printed on:
MODEL COMMANDS

modelType
A SymbolicConstant specifying the analysis model type. Possible values are
STANDARD_EXPLICIT and CFD. The default is STANDARD_EXPLICIT.
universalGas
None or a Float specifying the universal gas constant. The default value is None.

Return value
A Model object.

Exceptions
None.

30.1.2 ModelFromInputFile(...)
This method creates a Model object by reading the keywords in an input file and creating the
corresponding Abaqus/CAE objects.

Path
mdb.ModelFromInputFile

Required arguments
name
A String specifying the repository key.
inputFileName
A String specifying the name of the input file (including the .inp extension) to be parsed into the
new model. This String can also be the full path to the input file if it is located in another directory.
Optional arguments
None.

Return value
A Model object.

Exceptions
None.

30–2

Abaqus ID:
Printed on:
 MODEL COMMANDS

30.1.3 ModelFromOdbFile(...)
This method creates a Model object by reading an output database and creating any corresponding
Abaqus/CAE objects.

Path
mdb.ModelFromOdbFile

Required arguments
name
A String specifying the repository key.
odbFileName
A String specifying the name of the output database file (including the .odb extension) to be read
into the new model. This String can also be the full path to the output database file if it is located
in another directory.
Optional arguments
None.

Return value
A Model object.

Exceptions
None.

30.1.4 ModelFromNastranFile(...)
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. The default values is discussed in following
and can be defined alternatively in the Abaqus environment file as the one used for the translator from
Nastran to Abaqus. For more information, see “Translating Nastran bulk data files to Abaqus input files,”
Section 3.2.21 of the Abaqus Analysis User’s Manual.

Path
mdb.ModelFromNastranFile

Required arguments
modelName
A String specifying the repository key.

30–3

Abaqus ID:
Printed on:
MODEL COMMANDS

inputFileName
A String specifying the name of the Nastran input file (including the .bdf, .dat, .nas,
.nastran, .blk, .bulk extension) to be read into the new model. This String can also be
the full path to the Nastran input file if it is located in another directory.
Optional arguments
sectionConsolidation
A SymbolicConstant specifying the method used to create shell section. Possible values are
PRESERVE_SECTION, GROUP_BY_MATERIAL and NONE. If PRESERVE_SECTION
is used, an Abaqus section is created corresponding to each shell property ID. If
GROUP_BY_MATERIAL is used, a single Abaqus section is created for all homogeneous
elements referencing the same material. In both cases, material orientations and offsets are created
using discrete fields. If NONE is used, a separate shell section is created for each combination of
orientation, material offset, and/or thickness. The default is PRESERVE_SECTION.
preIntegratedShell
A Boolean specifying whether the pre-integrated shell section is created in default for shell
element. The default value is OFF.
weightMassScaling
A Boolean specifying whether the value on the Nastran data line PARAM, WTMASS is used as
a multiplier for all density, mass, and rotary inertia values created in the Abaqus input file. The
default value is ON.
loadCases
A Boolean specifying whether each SUBCASE for linear static analyses is translated to a *LOAD
CASE option, and all such *LOAD CASE options are grouped in a single *STEP option. The
default value is ON.
coupleBeamOffsets
A Boolean specifying whether to translate the beam element connectivity to newly created nodes
at the offset location and rigidly coupling the new and original nodes. If not, beam element
offsets are translated to the *CENTROID and *SHEAR CENTER options, which are suboptions
of the *BEAM GENERAL SECTION option. The default value is ON. When the beam element
references a PBARL or PBEAML property or if the beam offset has a significant component in
the direction of the beam axis, the setting for this argument is always ON.
cbar
A String specifying the 2-node beam that is created from CBAR and CBEAM elements. Possible
values are B31 and B33. The default is B31.
cquad4
A String specifying the 4-node shell that is created from CQUAD4 elements. Possible values are
S4 and S4R. The default is S4. If a reduced-integration element is chosen, the enhanced hourglass
formulation is applied automatically.

30–4

Abaqus ID:
Printed on:
 MODEL COMMANDS

chexa
A String specifying the 8-node brick that is created from CHEXA elements. Possible values are
C3D8I, C3D8 and C3D8R. The default is C3D8I. If a reduced-integration element is chosen, the
enhanced hourglass formulation is applied automatically.
ctetra
A String specifying the 10-node tetrahedron that is created from CTETRA elements. Possible
values are C3D10 and C3D10M. The default is C3D10.
keepTranslatedFiles
A Boolean specifying whether to keep the generated Abaqus input file after the model is created
from the Nastran input file. The default value is ON.

Return value
A Model object.

Exceptions
None.

30.1.5 setValues(...)
This method modifies the Model object.

Arguments
Required arguments
None.
Optional arguments
description
A String specifying the purpose and contents of the Model object. The default value is an empty
string.
noPartsInputFile
A Boolean specifying whether an input file should be written without parts and assemblies. The
default value is OFF.
absoluteZero
None or a Float specifying the absolute zero constant. The default value is None.
stefanBoltzmann
None or a Float specifying the Stefan-Boltzmann constant. The default value is None.
waveFormulation
A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic
problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is
NOT_SET.

30–5

Abaqus ID:
Printed on:
MODEL COMMANDS

universalGas
None or a Float specifying the universal gas constant. The default value is None.
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.
restartIncrement
An Int specifying the increment, interval, iteration or cycle where the restart analysis will start. To
select the end of the step use the SymbolicConstant STEP_END.
endRestartStep
A Boolean specifying that the step specified by restartStep should be terminated at the increment
specified by restartIncrement.
globalJob
A String specifying the name of the job that generated the results for the global model.
shellToSolid
A Boolean specifying that a shell global model drives a solid submodel.

Return value
None

Exceptions
None.

30.1.6 Members
The Model object can have the following members:
name
A String specifying the repository key.
stefanBoltzmann
None or a Float specifying the Stefan-Boltzmann constant. The default value is None.
absoluteZero
None or a Float specifying the absolute zero constant. The default value is None.
waveFormulation
A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic
problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is
NOT_SET.
universalGas
None or a Float specifying the universal gas constant. The default value is None.

30–6

Abaqus ID:
Printed on:
 MODEL COMMANDS

noPartsInputFile
A Boolean specifying whether an input file should be written without parts and assemblies. The
default value is OFF.
restartIncrement
An Int specifying the increment, interval, iteration or cycle where the restart analysis will start. To
select the end of the step use the SymbolicConstant STEP_END.
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. The default value is an empty
string.
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.
keywordBlock
A KeywordBlock object.
rootAssembly
An Assembly object.
amplitudes
A repository of Amplitude objects.
profiles
A repository of Profile objects.
boundaryConditions
A repository of BoundaryCondition objects.
constraints
A repository of Constraint objects.
analyticalFields
A repository of AnalyticalField objects.
discreteFields
A repository of DiscreteField objects.

30–7

Abaqus ID:
Printed on:
MODEL COMMANDS

predefinedFields
A repository of PredefinedField objects.
interactions
A repository of Interaction objects.
interactionProperties
A repository of InteractionProperty objects.
contactControls
A repository of ContactControl objects.
contactInitialization
A repository of ContactInitialization 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.
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.

30–8

Abaqus ID:
Printed on:
 MODEL COMMANDS

filters
A repository of Filter objects.
integratedOutputSections
A repository of IntegratedOutputSection objects.
fieldOutputRequests
A repository of FieldOutputRequest objects.
historyOutputRequests
A repository of HistoryOutputRequest objects.

30.1.7 Corresponding analysis keywords

*PHYSICAL CONSTANTS

30.2 KeywordBlock object

The KeywordBlock object contains a representation of its model in the Abaqus input file format.
You may edit the contents of the KeywordBlock to add solver functionality that is not supported by
Abaqus/CAE. As a general rule, edits to the KeywordBlock object should be made as the last step prior
to writing the actual Abaqus input file, thus avoiding possible conflicts with changes made using other
MDB commands. The KeywordBlock object has no constructor. A KeywordBlock object is created
when you create a model object. A model object contains only one KeywordBlock object.

Access
mdb.models[name].keywordBlock

30.2.1 setValues(...)
This method modifies the KeywordBlock object.

Arguments
Required arguments
None.
Optional argument
edited
A Boolean specifying whether this objects sieBlocks member has been edited. Setting edited=False
will set the sieBlocks member to an empty tuple, thereby discarding all previous edits.

30–9

Abaqus ID:
Printed on:
MODEL COMMANDS

Return value
None

Exceptions
None.

30.2.2 insert(...)
This method inserts a String at a specified position in the sieBlocks member.

Arguments
Required arguments
position
An Int specifying the position in the sieBlocks member after which the new string will be inserted.
text
A String specifying the text to be inserted. The text represents an Abaqus input file keyword and
its associated data
Optional arguments
None.

Return value
None

Exceptions
IndexError.

30.2.3 replace(...)
This method replaces a String at a specified position in the sieBlocks member.

Arguments
Required arguments
position
An Int specifying the position of the String to be replaced in the sieBlocks member.
text
A String specifying the text to be replaced. The text represents an Abaqus input file keyword and
its associated data.

30–10

Abaqus ID:
Printed on:
 MODEL COMMANDS

Optional arguments
None.

Return value
None

Exceptions
IndexError.

30.2.4 synchVersions(...)
This method synchronizes, or merges, the edits made in this object with those made in the model using
other scripting commands or the user interface. The synchVersions method updates the sieBlocks
member. The sieBlocks member is empty prior to the first call to synchVersions. As a side effect,
synchVersions sets lastSynchCount to the current value of the counter associated with the Mdb
object, which is used to determine if synchronization is necessary.

Arguments
Required argument
storeNodesAndElements
A Boolean specifying whether the nodal coordinates and element connectivities (i.e. the data
lines for the *NODE and *ELEMENT keyword blocks) are to be stored in the sieBlocks
member. All other keywords and their data lines are always stored. The default value is True. If
storeNodesAndElements is True, the size of the keywordBlock data will be similar to that of the
input file. Since the KeywordBlock is stored in the Abaqus/CAE database, this will result in a
larger database. It will also result in a slower execution of the synchVersions command. If
storeNodesAndElements is False, the data lines are not stored in sieBlocks. Consequently, only set
storeNodesAndElements=True if you wish to make changes to the *NODE or *ELEMENT data
lines themselves. If your task is limited to reading nodal coordinates and element connectivities
(i.e. not editing this information) then it is generally better to access this information from other
parts of the Mdb
Optional arguments
None.

Return value
None

Exceptions
IndexError.

30–11

Abaqus ID:
Printed on:
MODEL COMMANDS

30.2.5 Members
The KeywordBlock object has the following members:
edited
A Boolean specifying whether the Keywords Editor has been used to change the model.
lastSynchCount
A Float specifying the value of the counter associated with the Mdb object at the most recent
synchronization.
sieBlocks
A tuple of Strings specifying a sequence of Strings that is identical to the information written to the
Abaqus input file. Each String in the sequence represents an Abaqus input file keyword along with
the parameters and data lines associated with the keyword. A String can also be a comment in the
input file. You initialize this data member by calling synchVersions. After you initialize the
data member, you use calls to replace and insert to record your edits in the correct location.
If the last call to synchVersions used the argument storeNodesAndElements=False, the entry
for the keywords *NODE and *ELEMENT will contain only the keyword and its parameters, not
the data lines.

30–12

Abaqus ID:
Printed on:
 ODB COMMANDS

31. Odb commands

The Python ODB API commands are used to read and write data from an output database (.odb) file.
The path to the Odb object can be via the session.odbs repository or via a variable. In this chapter
the Access and Path statements refer to a variable called odb that represents an existing Odb object.

31.1 Odb object

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

Access
import odbAccess
session.odbs[name]

31.1.1 Odb(...)
This method creates a new Odb object.

Path
session.Odb

Required argument
name
A String specifying the repository key.
Optional arguments
analysisTitle
A String specifying the title of the output database. The default value is an empty string.
description
A String specifying the description of the output database. The default value is an empty string.
path
A String specifying the path to the file where the new output database (.odb) file will be written.
The default value is an empty string.

Return value
An Odb object.

31–1

Abaqus ID:
Printed on:
ODB COMMANDS

Exceptions
None.

31.1.2 close()
This method closes an output database.

Arguments
None.

Return value
None

Exceptions
None.

31.1.3 getFrame(...)
This method returns the frame at the specified time, frequency, or mode. It will not interpolate values
between frames. The method is not applicable to an Odb object containing steps with different domains
or to an Odb object containing a step with load case specific data.

Arguments
Required argument
frameValue
A Double specifying the value at which the frame is required. frameValue can be the total time or
frequency.
Optional argument
match
A SymbolicConstant specifying which frame to return if there is no frame at the exact frame value.
Possible values are CLOSEST, BEFORE, AFTER, and EXACT. The default value is CLOSEST.
When match=CLOSEST, Abaqus returns the closest frame. If the frame value requested is
exactly halfway between two frames, Abaqus returns the frame after the value.
When match=EXACT, Abaqus raises an exception if the exact frame value does not exist.

Return value
An OdbFrame object.

31–2

Abaqus ID:
Printed on:
 ODB COMMANDS

Exceptions
If the exact frame is not found:
AbaqusException: Frame not found.

31.1.4 save()
This method saves output to an output database (.odb) file.

Arguments
None.

Return value
None

Exceptions
AbaqusException
Database save failed. The database was opened as read-only. Modification of data is not
permitted.

31.1.5 update()
This method is used to update an Odb object in memory while an Abaqus analysis writes data to the
associated output database. update checks if additional steps and frames have been written to the
output database since it was opened or last updated. If additional steps and frames have been written to
the output database, update adds them to the Odb object.

Arguments
None.

Return value
A Boolean specifying whether additional steps or frames were added to the Odb object.

Exceptions
None.

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

31–3

Abaqus ID:
Printed on:
ODB COMMANDS

In addition, the Odb object can have the following members:

isReadOnly
A Boolean specifying whether the output database was opened with read-only access.
interactions
A repository of Interaction objects.
interactionProperties
A repository of InteractionProperty objects.
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.
profiles
A repository of Profile objects.

31.2 AnalyticSurface object

The AnalyticSurface object is a geometric surface that can be described with straight and/or curved line
segments.

31–4

Abaqus ID:
Printed on:
 ODB COMMANDS

Access
import odbAccess
session.odbs[name].parts[name].analyticSurface
session.odbs[name].rootAssembly.instances[name].analyticSurface
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.analyticSurface

31.2.1 Members
The AnalyticSurface object has the following members:
name
A String specifying the name of the analytic surface.
type
A SymbolicConstant specifying the type of AnalyticSurface object. Possible values are
SEGMENTS, CYLINDER, and REVOLUTION.
filletRadius
A Float specifying radius of curvature to smooth discontinuities between adjoining segments. The
default value is 0.0.
segments
An OdbSequenceAnalyticSurfaceSegment object specifying the profile associated with the
surface.
localCoordData
A tuple of tuples of Floats specifying the global coordinates of points representing the local
coordinate system, if used.

31.3 AnalyticSurfaceSegment object

An individual segment of the analytic surface.

Access
import odbAccess
session.odbs[name].parts[name].analyticSurface.segments[i]
session.odbs[name].rootAssembly.instances[name].analyticSurface\
.segments[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.analyticSurface.segments[i]

31–5

Abaqus ID:
Printed on:
ODB COMMANDS

31.3.1 AnalyticSurfaceSegment(...)
This method creates a AnalyticSurfaceSegment object.

Path
odbAccess.AnalyticSurfaceSegment

Required arguments
type
A SymbolicConstant specifying the type of AnalyticSurfaceSegment. Possible values are START,
LINE, CIRCLE, and PARABOLA.
data
A sequence of sequences of Floats specifying the coordinates of point/s representing the segment
of the AnalyticSurface object. If type=CIRCLE, the first row contains coordinates of the end point
and the second row contains coordinates of the center point. If type=PARABOLA, the first row
contains coordinates of the middle point and the second row contains coordinates of the end point.
If type=START or type=LINE , a single row contains coordinates of the start/end point.
Optional arguments
None.

Return value
An AnalyticSurfaceSegment object.

Exceptions
None.

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

31.4 BeamOrientation object

The BeamOrientation object represents the direction of the first beam section axis . Specifying the
beam orientation using an additional node in the element connectivity list is not supported.

31–6

Abaqus ID:
Printed on:
 ODB COMMANDS

Access
import odbAccess
session.odbs[name].parts[name].beamOrientations[i]
session.odbs[name].rootAssembly.instances[name].beamOrientations[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.beamOrientations[i]

31.4.1 Members
The BeamOrientation object can have the following members:
method
A SymbolicConstant specifying the orientation assignment method. Possible values are
N1_COSINES, CSYS, and VECT.
region
An OdbSet object specifying a region for which the beam orientation is defined.
vector
A tuple of Floats specifying direction cosines of the -direction of the beam cross-section.

31.5 FieldLocation object

The FieldLocation object specifies locations for which data are available in the field. For example,
a displacement field will have a FieldLocation object with a position member value of NODAL. The
FieldLocation object has no constructor; it is created automatically as an element of the location member
of a FieldOutput object by the addData method of a FieldOutput object.

Access
import odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name]\
.locations[i]

31.5.1 Members
The FieldLocation object can have the following members:
position
A SymbolicConstant specifying the position of the output in the element. Possible values are:
• NODAL, specifying the values calculated at the nodes.
• INTEGRATION_POINT, specifying the values calculated at the integration points.

31–7

Abaqus ID:
Printed on:
ODB COMMANDS

• ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at

the integration points.
• ELEMENT_FACE.
• CENTROID, specifying the value at the centroid obtained by extrapolating results calculated
at the integration points.

sectionPoints
A SectionPointArray object.

31.6 FieldOutput object

A FieldOutput object contains field data for a specific output variable.

Access
import odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name]

31.6.1 FieldOutput(...)
This method creates a FieldOutput object.

Path
session.odbs[name].steps[name].frames[i].FieldOutput

Required arguments
name
A String specifying the output variable name.
description
A String specifying the output variable.
type
A SymbolicConstant specifying the output type. Possible values are SCALAR,
VECTOR, TENSOR_3D_FULL, TENSOR_3D_PLANAR, TENSOR_3D_SURFACE,
TENSOR_2D_PLANAR, and TENSOR_2D_SURFACE.
Optional arguments
componentLabels
A sequence of Strings specifying the labels for each component of the value. The length of the
sequence must match the type. If type=TENSOR, the default value is name with the suffixes (’11’,

31–8

Abaqus ID:
Printed on:
 ODB COMMANDS

’22’, ’33’, ’12’, ’13’, ’23’). If type=VECTOR, the default value is name with the suffixes (’1’, ’2’,
’3’). If type=SCALAR, the default value is an empty sequence.
validInvariants
A sequence of SymbolicConstants specifying which invariants should be calculated for this field.
An empty sequence indicates that no invariants are valid for this field. Possible values are:
• MAGNITUDE
• MISES
• TRESCA
• PRESS
• INV3
• MAX_PRINCIPAL
• MID_PRINCIPAL
• MIN_PRINCIPAL
• MAX_INPLANE_PRINCIPAL
• MIN_INPLANE_PRINCIPAL
• OUTOFPLANE_PRINCIPAL
The default value is an empty sequence.

Return value
A FieldOutput object.

Exceptions
None.

31.6.2 FieldOutput(...)
This method creates a FieldOutput object from an existing FieldOutput object.

Path
session.odbs[name].steps[name].frames[i].FieldOutput

Required argument
field
A FieldOutput object.
Optional arguments
name
A String specifying the name of the FieldOutput object.

31–9

Abaqus ID:
Printed on:
ODB COMMANDS

description
A String specifying the output variable.

Return value
A FieldOutput object.

Exceptions
None.

31.6.3 addData(...)
This method adds data to a FieldOutput object.

Arguments
Required arguments
position
A SymbolicConstant specifying the position of the output. Possible values are:
• NODAL, specifying the values calculated at the nodes.
• INTEGRATION_POINT, specifying the values calculated at the integration points.
• ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at
the integration points.
• CENTROID, specifying the value at the centroid obtained by extrapolating results calculated
at the integration points.

instance
An OdbInstance object specifying the namespace for labels.
labels
A sequence of Ints specifying the labels of the nodes or elements where the values in data are
located. The node or element labels must be sorted in ascending order and must be specified in the
same order as the values provided for the data argument.
data
A sequence of sequences of Floats specifying the data values for the specified position, instance,
and labels. The values must be given in the correct order. Element nodal data follow the order of
nodal connectivity defined in the User’s Manuals. Integration point data follow the order defined
in the User’s Manuals. Section point data for beams and shells follow the convention given in the
User’s Manuals. For more information, see Part VI, “Elements,” of the Abaqus Analysis User’s
Manual. These data create FieldValue objects internally.

31–10

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
sectionPoint
A SectionPoint object specifying the location in the section. Although sectionPoint is an optional
argument to the addData method, if you omit this argument when you are writing field output
data for a shell or a beam you cannot subsequently select the section point to display when you are
displaying the field output data using Abaqus/Viewer.
localCoordSystem
A sequence of sequences of Floats specifying the 3 x 3 matrix of direction cosines of the local
coordinate system. This argument is available only for fields with type=TENSOR.

Return value
None

Exceptions
The addData method throws many exceptions of type odbException. For example, if the local
coordinate system is specified for scalar data:
odbException: Transformation not allowed for scalar data.

31.6.4 addData(...)
This method adds data to a FieldOutput object.

Arguments
Required arguments
position
A SymbolicConstant specifying the position of the output. Possible values are:
• NODAL, specifying the values calculated at the nodes.
• INTEGRATION_POINT, specifying the values calculated at the integration points.
• ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at
the integration points.
• CENTROID, specifying the value at the centroid obtained by extrapolating results calculated
at the integration points.
instance
An OdbInstance object specifying the namespace for labels.
labels
A sequence of Ints specifying the labels of the nodes or elements where the values in data are
located.. The node or element labels must be sorted in ascending order and must be specified in
the same order as the values provided for the data argument.

31–11

Abaqus ID:
Printed on:
ODB COMMANDS

data
A sequence of sequences of Floats specifying the data values for the specified position, instance,
and labels. The values must be given in the correct order. Element nodal data follow the order of
nodal connectivity defined in the User’s Manuals. Integration point data follow the order defined
in the User’s Manuals. Section point data for beams and shells follow the convention given in the
User’s Manuals. For more information, see Part VI, “Elements,” of the Abaqus Analysis User’s
Manual. These data create FieldValue objects internally.
Optional arguments
sectionPoint
A SectionPoint object specifying the location in the section. Although sectionPoint is an optional
argument to the addData method, if you omit this argument when you are writing field output
data for a shell or a beam you cannot subsequently select the section point to display when you are
displaying the field output data using Abaqus/Viewer.
localCoordSystem
A sequence of matrices of floats specifying the direction cosines of the local coordinates systems,
where the sequence is the same length as data. If localCoordSystem is a matrix, a different local
coordinate system applies to each data value.

Return value
None

Exceptions
The addData method throws many exceptions of type odbException. For example, if the local
coordinate system is specified for scalar data:
odbException: Transformation not allowed for scalar data.

31.6.5 addData(...)
This method adds the data from a field created using the getSubset method and mathematical
operators to the database. The user must create a field to contain the new data and then use the
addData method to assign the data from the fields.

Arguments
Required argument
field
A FieldOutput object specifying the data to add.
Optional arguments
None.

31–12

Abaqus ID:
Printed on:
 ODB COMMANDS

Return value
None

Exceptions
The addData method throws many exceptions of type odbException. For example, if the local
coordinate system is specified for scalar data:
odbException: Transformation not allowed for scalar data.

31.6.6 getScalarField(...)
This method generates a scalar field containing the extracted component or calculated invariant values.
The new field will hold values for the same nodes or elements as the parent field. Abaqus will perform
this operation on only the real part of the FieldOutput object. The operation is not performed on the
conjugate data (the imaginary portion of a complex result).

Arguments
Required argument
invariant
A SymbolicConstant specifying the invariant. Possible values are MAGNITUDE,
MISES, TRESCA, PRESS, INV3, MAX_PRINCIPAL, MID_PRINCIPAL,
MIN_PRINCIPAL, MAX_INPLANE_PRINCIPAL, MIN_INPLANE_PRINCIPAL,
and OUTOFPLANE_PRINCIPAL.
Optional arguments
None.

Return value
A FieldOutput object.

Exceptions
None.

31.6.7 getScalarField(...)
This method generates a scalar field containing the extracted component or calculated invariant values.
The new field will hold values for the same nodes or elements as the parent field. Abaqus will perform
this operation on only the real part of the FieldOutput object. The operation is not performed on the
conjugate data (the imaginary portion of a complex result).

31–13

Abaqus ID:
Printed on:
ODB COMMANDS

Arguments
Required argument
componentLabel
A String specifying the component label, such as “S11”.
Optional arguments
None.

Return value
A FieldOutput object.

Exceptions
None.

31.6.8 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional arguments
position
A SymbolicConstant specifying the position of the output in the element. Possible values are:
• NODAL, specifying the values calculated at the nodes.
• INTEGRATION_POINT, specifying the values calculated at the integration points.
• ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at
the integration points.
• CENTROID, specifying the value at the centroid obtained by extrapolating results calculated
at the integration points.
If the requested field values are not found in the output database at the specified
ELEMENT_NODAL or CENTROID positions, they are extrapolated from the field data at the
INTEGRATION_POINT position.
readOnly
A Boolean specifying whether the extrapolated data returned by this call is written to the output
database. The default value is OFF.

31–14

Abaqus ID:
Printed on:
 ODB COMMANDS

Return value
A FieldOutput object.

Exceptions
None.

31.6.9 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
region
An OdbSet specifying the region for which to extract values. Nodes in the node sets must be sorted
and arranged in ascending order. Use of unsorted node sets is not supported.

Return value
A FieldOutput object.

Exceptions
None.

31.6.10 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
localCoordSystem
A sequence of sequences of Floats specifying the 3 × 3 matrix of direction cosines. Field values
associated with the supplied coordinate system will be extracted.

31–15

Abaqus ID:
Printed on:
ODB COMMANDS

Return value
A FieldOutput object.

Exceptions
None.

31.6.11 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
sectionPoint
A SectionPoint object.

Return value
A FieldOutput object.

Exceptions
None.

31.6.12 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
location
A FieldLocation object.

Return value
A FieldOutput object.

31–16

Abaqus ID:
Printed on:
 ODB COMMANDS

Exceptions
None.

31.6.13 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
region
An OdbMeshElement specifying the region for which to extract values.

Return value
A FieldOutput object.

Exceptions
None.

31.6.14 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
region
An OdbMeshNode specifying the region for which to extract values.

Return value
A FieldOutput object.

Exceptions
None.

31–17

Abaqus ID:
Printed on:
ODB COMMANDS

31.6.15 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
region
An OdbInstance specifying the region for which to extract values.

Return value
A FieldOutput object.

Exceptions
None.

31.6.16 getSubset(...)
A FieldOutput object with a subset of the field values.

Arguments
Required arguments
None.
Optional argument
elementType
A String specifying the element type for which to extract values. The string must correspond to a
valid Abaqus element type.

Return value
A FieldOutput object.

Exceptions
None.

31–18

Abaqus ID:
Printed on:
 ODB COMMANDS

31.6.17 getTransformedField(...)
This method generates a new vector or tensor field containing the transformed component values of the
parent field. The new field will hold values for the same nodes or elements as the parent field. Results
will be transformed based on the orientations specified by the input DatumCsys object. Abaqus will
perform this operation on only the real part of the FieldOutput object. The operation is not performed
on the conjugate data (the imaginary portion of a complex result).

Arguments

Required argument
datumCsys
A valid DatumCsys object designating the coordinate system. Valid systems can be fixed or
positioned with respect to nodes on the model and can be cartesian, cylindrical, or spherical.

Optional arguments
projected22Axis
An Int specifying which axis of the coordinate system will be projected as the second component
for local result orientations. Valid values are 1, 2, or 3; the default value is 2.
projectionTol
A Double specifying the minimum allowable angle (radians) between the specified projection axis
and the element normal. The next axis will be used for projection if this tolerance test fails.

Return value

A FieldOutput object.

Exceptions

None.

31.6.18 getTransformedField(...)
This method generates a new vector or tensor field containing the transformed component values of the
parent field. The new field will hold values for the same nodes or elements as the parent field. Results
will be transformed based on the orientations specified by the input DatumCsys object. Abaqus will
perform this operation on only the real part of the FieldOutput object. The operation is not performed
on the conjugate data (the imaginary portion of a complex result).

31–19

Abaqus ID:
Printed on:
ODB COMMANDS

Arguments
Required argument
datumCsys
A valid DatumCsys object designating the coordinate system. Valid systems can be fixed or
positioned with respect to nodes on the model and can be cartesian, cylindrical, or spherical.
Optional arguments
deformationField
A FieldOutput object specifying the nodal displacement vectors required by moving coordinate
systems to determine instantaneous configurations.
projected22Axis
An Int specifying which axis of the coordinate system will be projected as the second component
for local result orientations. Valid values are 1, 2, or 3; the default value is 2.
projectionTol
A Double specifying the minimum allowable angle (radians) between the specified projection axis
and the element normal. The next axis will be used for projection if this tolerance test fails.

Return value
A FieldOutput object.

Exceptions
None.

31.6.19 getTransformedField(...)
This method generates a new vector or tensor field containing the transformed component values of the
parent field. The new field will hold values for the same nodes or elements as the parent field. Results
will be transformed based on the orientations specified by the input DatumCsys object. Abaqus will
perform this operation on only the real part of the FieldOutput object. The operation is not performed
on the conjugate data (the imaginary portion of a complex result).

Arguments
Required argument
datumCsys
A valid DatumCsys object designating the coordinate system. Valid systems can be fixed or
positioned with respect to nodes on the model and can be cartesian, cylindrical, or spherical.

31–20

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
deformationField
A FieldOutput object specifying the nodal displacement vectors required by moving coordinate
systems to determine instantaneous configurations.
rotationField
A FieldOutput object specifying the nodal rotational displacement vectors required by moving
coordinate systems that follow a 6-dof node, to determine instantaneous configurations.
projected22Axis
An Int specifying which axis of the coordinate system will be projected as the second component
for local result orientations. Valid values are 1, 2, or 3; the default value is 2.
projectionTol
A Double specifying the minimum allowable angle (radians) between the specified projection axis
and the element normal. The next axis will be used for projection if this tolerance test fails.

Return value
A FieldOutput object.

Exceptions
None.

31.6.20 Members
The FieldOutput object has members with the same names and descriptions as the arguments to the
FieldOutput method.
In addition, the FieldOutput object can have the following members:
dim
An Int specifying the dimension of vector or the first dimension (number of rows) of matrix.
dim2
An Int specifying the second dimension (number of columns) of matrix.
isComplex
A Boolean specifying whether the data are complex.
locations
A FieldLocationArray object.
values
A FieldValueArray object specifying the order of the objects in the array is determined by the
Abaqus Scripting Interface; see the data argument to the addData method for a description of
the order.

31–21

Abaqus ID:
Printed on:
ODB COMMANDS

31.7 FieldValue object

The FieldValue object represents the field data at a point. The FieldValue object has no constructor; it is
created by the Odb object when data are added to the FieldOutput object using the addData method.
For faster, bulk-data access, see “Using bulk data access to an output database,” Section 10.10.7 of the
Abaqus Scripting User’s Manual.

Access
import odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]

31.7.1 Members
The FieldValue object has the following members:
position
A SymbolicConstant specifying the position of the output in the element. Possible values are:
• NODAL, specifying the values calculated at the nodes.
• INTEGRATION_POINT, specifying the values calculated at the integration points.
• ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at
the integration points.
• ELEMENT_FACE, specifying the results obtained for surface variables such as cavity
radiation that are defined for the surface facets of an element.
• CENTROID, specifying the value at the centroid obtained by extrapolating results calculated
at the integration points.

precision
A SymbolicConstant specifying the precision of the output in the element. Possible values are:
• SINGLE_PRECISION, specifying that the output values are in single precision.
• DOUBLE_PRECISION, specifying that the output values are in double precision.

elementLabel
An Int specifying the element label of the element containing the location. elementLabel is
available only if position=INTEGRATION_POINT, CENTROID, ELEMENT_NODAL, or
ELEMENT_FACE.
nodeLabel
An Int specifying the node label of the node containing the location. nodelabel is available only
if position=ELEMENT_NODAL or NODAL.

31–22

Abaqus ID:
Printed on:
 ODB COMMANDS

integrationPoint
An Int specifying the integration point in the element. integrationPoint is available only if
position=INTEGRATION_POINT.
face
A SymbolicConstant specifying the face of the element. face is available only if
position=ELEMENT_FACE.
type
A SymbolicConstant specifying the output type. Possible values are SCALAR,
VECTOR, TENSOR_3D_FULL, TENSOR_3D_PLANAR, TENSOR_3D_SURFACE,
TENSOR_2D_PLANAR, and TENSOR_2D_SURFACE.
magnitude
A Float specifying the length or magnitude of the vector. magnitude is valid only when
type=VECTOR.
mises
A Float specifying the calculated von Mises stress. The value is valid only when the
validInvariants member includes MISES; otherwise, the value is indeterminate. Conjugate data
will be ignored in invariant calculation.
tresca
A Float specifying the calculated Tresca stress. The value is valid only when the validInvariants
member includes TRESCA; otherwise, the value is indeterminate. Conjugate data will be ignored
in invariant calculation.
press
A Float specifying the calculated pressure stress. The value is valid only when the validInvariants
member includes PRESS; otherwise, the value is indeterminate. Conjugate data will be ignored
in invariant calculation.
inv3
A Float specifying the calculated third stress invariant. The value is valid only when the
validInvariants member includes INV3; otherwise, the value is indeterminate. Conjugate data
will be ignored in invariant calculation.
maxPrincipal
A Float specifying the calculated maximum principal stress. The value is valid only when the
validInvariants member includes MAX_PRINCIPAL; otherwise, the value is indeterminate.
Conjugate data will be ignored in invariant calculation.
midPrincipal
A Float specifying the calculated intermediate principal stress. The value is valid only when
the validInvariants member includes MID_PRINCIPAL; otherwise, the value is indeterminate.
Conjugate data will be ignored in invariant calculation.

31–23

Abaqus ID:
Printed on:
ODB COMMANDS

minPrincipal
A Float specifying the minimum principal stress. The value is valid only when the validInvariants
member includes MIN_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will
be ignored in invariant calculation.
maxInPlanePrincipal
A Float specifying the maximum principal in-plane stress. The value is valid only when
the validInvariants member includes MAX_INPLANE_PRINCIPAL; otherwise, the value is
indeterminate. Conjugate data will be ignored in invariant calculation.
minInPlanePrincipal
A Float specifying the calculated minimum principal in-plane stress. The value is valid only
when the validInvariants member includes MIN_INPLANE_PRINCIPAL; otherwise, the value
is indeterminate. Conjugate data will be ignored in invariant calculation.
outOfPlanePrincipal
A Float specifying the calculated principal out-of-plane stress. The value is valid only when
the validInvariants member includes OUTOFPLANE_PRINCIPAL; otherwise, the value is
indeterminate. Conjugate data will be ignored in invariant calculation.
instance
An OdbInstance object specifying the part to which the labels belong.
sectionPoint
A SectionPoint object.
localCoordSystem
A tuple of tuples of Floats specifying the 3 x 3 matrix of Floats specifying the direction cosines
of the local coordinate system. Each sequence represents a row in the direction cosine matrix.
localCoordSystem is available only for TENSOR data written in a local coordinate system. If the
underlying data are in double precision, an exception will be thrown.
localCoordSystemDouble
A tuple of tuples of Floats specifying the 3 x 3 matrix of Doubles specifying the direction cosines
of the local coordinate system. Each sequence represents a row in the direction cosine matrix.
localCoordSystemDouble is available only for TENSOR data written in a local coordinate system.
If the underlying data are in single precision, an exception will be thrown.
data
A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR,
data is a sequence containing the components. If the underlying data are in double precision an
exception will be thrown.
dataDouble
A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR,
data is a sequence containing the components. If the underlying data are in single precision, an
exception will be thrown.

31–24

Abaqus ID:
Printed on:
 ODB COMMANDS

conjugateData
A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR,
conjugateData is a sequence containing the components. If the underlying data are in double
precision, an exception will be thrown.
conjugateDataDouble
A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR,
conjugateData is a sequence containing the components. If the underlying data are in single
precision, an exception will be thrown.

31.8 HistoryOutput object

The HistoryOutput object contains the history output at a point for the specified variable.

Access
import odbAccess
session.odbs[name].steps[name].historyRegions[name]\
.historyOutputs[name]

31.8.1 HistoryOutput(...)
This method creates a HistoryOutput object.

Path
session.odbs[name].steps[name].historyRegions[name].HistoryOutput

Required arguments
name
A String specifying the output variable name.
description
A String specifying the output variable.
type
A SymbolicConstant specifying the output type. Only SCALAR is currently supported.
Optional argument
validInvariants
A sequence of SymbolicConstants specifying which invariants should be calculated for this
field. Possible values are MAGNITUDE, MISES, TRESCA, PRESS, INV3, MAX_PRINCIPAL,
MID_PRINCIPAL, and MIN_PRINCIPAL. The default value is an empty sequence.

31–25

Abaqus ID:
Printed on:
ODB COMMANDS

Return value
A HistoryOutput object.

Exceptions
None.

31.8.2 addData(...)
This method adds data to the data member of the HistoryOutput object.

Arguments
Required arguments
frame
A Double specifying the frame value. frame can be specified in step time, frequency, or mode
number.
value
A Double specifying the value of the variable at the frame value specified in frame.
Optional arguments
None.

Return value
None

Exceptions
None.

31.8.3 addData(...)
This method adds data to the data member of the HistoryOutput object.

Arguments
Required arguments
frame
A sequence of Floats specifying the frame values. frame can be specified in step time, frequency,
or mode number.
value
A sequence of Floats specifying the value of the variable at the frame values specified in frame.

31–26

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
None.

Return value
None

Exceptions
If the length of frame is not the same as the length of value a ValueError is raised.

31.8.4 addData(...)
This method adds data to the data member of the HistoryOutput object.

Arguments
Required argument
data
A sequence of pairs of Floats specifying the pairs (frameValue, value) where frameValue is either
time, frequency, or mode and value is the value of the specified variable at frameValue. (This value
depends on the type of the variable.)
Optional arguments
None.

Return value
None

Exceptions
None.

31.8.5 Members
The HistoryOutput object has members with the same names and descriptions as the arguments to the
HistoryOutput method.
In addition, the HistoryOutput object has the following members:
data
A tuple of pairs of Floats specifying the pairs (frameValue, value) where frameValue is either time,
frequency, or mode and value is the value of the specified variable at frameValue. (This value
depends on the type of the variable.)

31–27

Abaqus ID:
Printed on:
ODB COMMANDS

conjugateData
A tuple of pairs of Floats specifying the imaginary portion of a specified complex variable at each
frame value (time, frequency, or mode). The pairs have the form (frameValue, value).

31.9 HistoryPoint object

The HistoryPoint object specifies the point at which history data will be collected. The HistoryPoint
object is a temporary object used as an argument to the HistoryRegion method.

Access
import odbAccess
session.odbs[name].steps[name].historyRegions[name].point

31.9.1 HistoryPoint(...)
This method creates a HistoryPoint object for a node.

Path
odbAccess.HistoryPoint

Required argument
node
An OdbMeshNode object specifying the node for which the data are to be collected.
Optional arguments
None.

Return value
A HistoryPoint object.

Exceptions
None.

31.9.2 HistoryPoint(...)
This method creates a HistoryPoint object for an element.

31–28

Abaqus ID:
Printed on:
 ODB COMMANDS

Path
session.odbs[name].steps[name].historyRegions[name].HistoryPoint

Required argument
element
An OdbMeshElement object specifying the element for which the data are to be collected.
Optional arguments
ipNumber
An Int specifying the integration point. This argument is used to define a history output position of
INTEGRATION_POINT or ELEMENT_FACE_INTEGRATION_POINT. The default value is 0.
sectionPoint
A SectionPoint object.
face
A SymbolicConstant specifying the element face. This argument is used to define a history output
position of ELEMENT_FACE or ELEMENT_FACE_INTEGRATION_POINT. Possible values
are:
• FACE_UNKOWN, specifying this value indicates that no value has been specified.
• FACE1, specifying this value indicates that element face 1 has been specified.
• FACE2, specifying this value indicates that element face 2 has been specified.
• FACE3, specifying this value indicates that element face 3 has been specified.
• FACE4, specifying this value indicates that element face 4 has been specified.
• FACE5, specifying this value indicates that element face 5 has been specified.
• FACE6, specifying this value indicates that element face 6 has been specified.
• SIDE1, specifying this value indicates that element side 1 has been specified.
• SIDE2, specifying this value indicates element side 2 has been specified.
• END1, specifying this value indicates that element end 1 has been specified.
• END2, specifying this value indicates that element end 2 has been specified.
• END3, specifying this value indicates that element end 3 has been specified.
The default value is FACE_UNKNOWN.
node
An OdbMeshNode object specifying the node for which the data are to be collected.

Return value
A HistoryPoint object.

31–29

Abaqus ID:
Printed on:
ODB COMMANDS

Exceptions
None.

31.9.3 HistoryPoint(...)
This method creates a HistoryPoint object for a region.

Path
session.odbs[name].steps[name].historyRegions[name].HistoryPoint

Required argument
region
An OdbSet object specifying the region for which the data are to be collected.
Optional arguments
None.

Return value
A HistoryPoint object.

Exceptions
None.

31.9.4 HistoryPoint(...)
This method creates a HistoryPoint object for the OdbAssembly object.

Path
session.odbs[name].steps[name].historyRegions[name].HistoryPoint

Required argument
assembly
An OdbAssembly object specifying the assembly for which the data are to be collected.
Optional arguments
None.

Return value
A HistoryPoint object.

31–30

Abaqus ID:
Printed on:
 ODB COMMANDS

Exceptions
None.

31.9.5 HistoryPoint(...)
This method creates a HistoryPoint object for the OdbInstance object.

Path
session.odbs[name].steps[name].historyRegions[name].HistoryPoint

Required argument
instance
An OdbInstance object specifying the instance for which the data are to be collected.
Optional arguments
None.

Return value
A HistoryPoint object.

Exceptions
None.

31.9.6 Members
The HistoryPoint object has members with the same names and descriptions as the arguments to the
HistoryPoint method.
In addition, the HistoryPoint object can have the following members:
ipNumber
An Int specifying the integration point. This argument is used to define a history output position of
INTEGRATION_POINT or ELEMENT_FACE_INTEGRATION_POINT. The default value is 0.
face
A SymbolicConstant specifying the element face. This argument is used to define a history output
position of ELEMENT_FACE or ELEMENT_FACE_INTEGRATION_POINT. Possible values
are:
• FACE_UNKOWN, specifying this value indicates that no value has been specified.
• FACE1, specifying this value indicates that element face 1 has been specified.
• FACE2, specifying this value indicates that element face 2 has been specified.

31–31

Abaqus ID:
Printed on:
ODB COMMANDS

• FACE3, specifying this value indicates that element face 3 has been specified.
• FACE4, specifying this value indicates that element face 4 has been specified.
• FACE5, specifying this value indicates that element face 5 has been specified.
• FACE6, specifying this value indicates that element face 6 has been specified.
• SIDE1, specifying this value indicates that element side 1 has been specified.
• SIDE2, specifying this value indicates element side 2 has been specified.
• END1, specifying this value indicates that element end 1 has been specified.
• END2, specifying this value indicates that element end 2 has been specified.
• END3, specifying this value indicates that element end 3 has been specified.
The default value is FACE_UNKNOWN.
position
A SymbolicConstant specifying the result position of the history point. Possible values are:
• NODAL, specifying the values calculated at the nodes.
• ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at
the integration points.
• INTEGRATION_POINT, specifying the values calculated at the integration points.
• ELEMENT_FACE, specifying the results obtained for surface variables such as cavity
radiation that are defined for the surface facets of an element.
• ELEMENT_FACE_INTEGRATION_POINT, specifying the results obtained for surface
variables such as cavity radiation that are defined for the surface facets of an element when
the surface facets have integration points.
• WHOLE_ELEMENT, specifying the results obtained for whole element variables.
• WHOLE_REGION, specifying the results for an entire region of the model.
• WHOLE_PART_INSTANCE, specifying the results for an entire part instance of the model.
• WHOLE_MODEL, specifying the results for the entire model.

element
An OdbMeshElement object specifying the element for which the data are to be collected.
sectionPoint
A SectionPoint object.
region
An OdbSet object specifying the region for which the data are to be collected.
assembly
An OdbAssembly object specifying the assembly for which the data are to be collected.
instance
An OdbInstance object specifying the instance for which the data are to be collected.

31–32

Abaqus ID:
Printed on:
 ODB COMMANDS

31.10 HistoryRegion object

The HistoryRegion object contains history data for a single location in the model.

Access
import odbAccess
session.odbs[name].steps[name].historyRegions[name]

31.10.1 HistoryRegion(...)
This method creates a HistoryRegion object.

Path
session.odbs[name].steps[name].HistoryRegion

Required arguments
name
A String specifying the name of the HistoryRegion object.
description
A String specifying the description of the HistoryRegion object.
point
A HistoryPoint object specifying the point to which the history data refer.
Optional argument
loadCase
None or an OdbLoadCase object specifying the load case associated with the HistoryRegion
object. The default value is None.

Return value
A HistoryRegion object.

Exceptions
None.

31.10.2 getSubset(...)
This method returns a subset of the data in the HistoryRegion object.

31–33

Abaqus ID:
Printed on:
ODB COMMANDS

Arguments
Required argument
variableName
A String specifying the name of the output variable to return.
Optional arguments
None.

Return value
A HistoryRegion object.

Exceptions
None.

31.10.3 getSubset(...)
This method returns a subset of the data in the HistoryRegion object.

Arguments
Required argument
start
A Float specifying the start of the subset. This is the same as the first item in the data array member
of the HistoryOutput object.
Optional arguments
None.

Return value
A HistoryRegion object.

Exceptions
None.

31.10.4 getSubset(...)
This method returns a subset of the data in the HistoryRegion object.

31–34

Abaqus ID:
Printed on:
 ODB COMMANDS

Arguments
Required arguments
start
A Float specifying the start of the subset. This is the same as the first item in the data array member
of the HistoryOutput object.
end
A Float specifying the end of the subset.
Optional arguments
None.

Return value
A HistoryRegion object.

Exceptions
None.

31.10.5 Members
The HistoryRegion object has members with the same names and descriptions as the arguments to the
HistoryRegion method.
In addition, the HistoryRegion object can have the following members:
position
A SymbolicConstant specifying the position of the history output. Possible values are NODAL,
INTEGRATION_POINT, WHOLE_ELEMENT, WHOLE_REGION, and WHOLE_MODEL.
historyOutputs
A repository of HistoryOutput objects.

31.11 JobData object

The JobData object describes the context in which the analysis was run.

Access
import odbAccess
session.odbs[name].jobData

31.11.1 Members
The JobData object has the following members:

31–35

Abaqus ID:
Printed on:
ODB COMMANDS

name
A String specifying the name of the job.
analysisCode
A SymbolicConstant specifying the analysis code. Possible values are ABAQUS_STANDARD,
ABAQUS_EXPLICIT, and UNKNOWN_ANALYSIS_CODE.
precision
A SymbolicConstant specifying the precision. Only SINGLE_PRECISION is currently supported.
Possible values are DOUBLE_PRECISION and SINGLE_PRECISION.
version
A String specifying the release of the analysis code.
creationTime
A String specifying the date and time at which the analysis was run.
machineName
A String specifying the name of the machine on which the analysis was run.

31.12 NodalDofs object

The NodalDofs object represents the degrees of freedom that are retained or eliminated in a substructure
generate analysis.

Access

import odbAccess
session.odbs[name].steps[name].eliminatedNodalDofs[i]
session.odbs[name].steps[name].retainedNodalDofs[i]

31.12.1 Members
The NodalDofs object can have the following members:

nset
An OdbSet object specifying a set of nodes for which the degrees of freedom are retained or
eliminated.
dofs
A tuple of Ints specifying the degrees of freedom that are retained or eliminated.

31–36

Abaqus ID:
Printed on:
 ODB COMMANDS

31.13 OdbAssembly object

The OdbAssembly object has no constructor; it is created automatically when an Odb object is created.
Abaqus creates the rootAssembly member when an Odb object is created.

Access
import odbAccess
session.odbs[name].rootAssembly

31.13.1 ConnectorOrientation(...)
This method assigns a connector orientation to a connector region.

Arguments

Required argument
region
An OdbSet specifying a region.

Optional arguments
localCsys1
A OdbDatumCsys object specifying the first connector node local coordinate system or None,
indicating the global coordinate system.
axis1
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation of the first connector node is applied. Possible values are
AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle1
A Float specifying the angle of the additional rotation about the first connector node axis. The
default value is 0.0.
orient2sameAs1
A Boolean specifying whether the same orientation settings should be used for the second node of
the connector. The default value is OFF.
localCsys2
A OdbDatumCsys object specifying the second connector node local coordinate system or None,
indicating the global coordinate system.

31–37

Abaqus ID:
Printed on:
ODB COMMANDS

axis2
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation of the second connector node is applied. Possible values are
AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle2
A Float specifying the angle of the additional rotation about the second connector node axis. The
default value is 0.0.

Return value
None

Exceptions
If region is not an element set:
OdbError: Connector orientation assignment requires element set.

31.13.2 SectionAssignment(...)
This method is used to assign a section to a region on an instance. Only connector sections can be
assigned at the assembly level.

Arguments
Required arguments
region
An OdbSet specifying a region.
section
A Section object.
Optional arguments
None.

Return value
None

Exceptions
If region is not an element set:
OdbError: Section assignment requires element set.

31–38

Abaqus ID:
Printed on:
 ODB COMMANDS

31.13.3 addElements(...)
This method is used to define elements using nodes defined at the OdbAssembly and/or OdbInstance
level. For connector elements connected to ground, specify the lone node in the connectivity. The
position of the ground node cannot be specified. This is a limitation.

Arguments
Required arguments
labels
A sequence of Ints specifying the element labels.
connectivity
A sequence of sequences of Ints specifying the nodal connectivity.
instanceNames
A sequence of sequences of Strings specifying the instanceNames of each node in the nodal
connectivity array. If the node is defined at the assembly level, the instance name should be an
empty string
type
A String specifying the element type.
Optional arguments
elementSetName
A String specifying a name for this element set. The default value is the empty string.
sectionCategory
A SectionCategory object for this element set.

Return value
None

Exceptions
Only certain element types are permitted at the assembly level. e.g.. connector elements.
AbaqusException: Addition of this element type is not permitted at the assembly level
If length of label array does not match connectivity data length.
AbaqusException: Connectivity array must be provided for all element

31.13.4 addNodes(...)
This method adds nodes to the OdbAssembly object using node labels and coordinates.

31–39

Abaqus ID:
Printed on:
ODB COMMANDS

WARNING: Adding nodes not in ascending order of their labels may cause Abaqus/Viewer to plot
contours incorrectly.

Arguments
Required arguments
labels
A sequence of Ints specifying the node labels.
coordinates
A sequence of sequences of Floats specifying the nodal coordinates.
Optional argument
nodeSetName
A String specifying a name for this node set. The default value is None.

Return value
None

Exceptions
If length of labels does not match length of coordinates
AbaqusException: Number of node labels and coordinates does not match
If width of coordinate array does not match assembly dimension
AbaqusException: Node location specification does not correspond to part dimensions

31.13.5 RigidBody(...)
This method defines a OdbRigidBody on the assembly.

Arguments
Required argument
referenceNode
An OdbSet specifying the reference node assigned to the rigid body.
Optional arguments
position
A symbolic constant specify if the location of the reference node is to be defined by the user.
Possible values are INPUT, and CENTER_OF_MASS. The default value is INPUT.

31–40

Abaqus ID:
Printed on:
 ODB COMMANDS

isothermal
A Boolean specifying an isothermal rigid body. The default value is OFF. This parameter is used
only for a fully-coupled thermal stress analysis.
elset
An OdbSet specifying an element set assigned to the rigid body.
pinNodes
An OdbSet specifying pin-type nodes assigned to the rigid body.
tieNodes
An OdbSet specifying tie-type nodes assigned to the rigid body.

Return value
None

Exceptions
If referenceNode is not a node set:
OdbError: Rigid body definition requires a node set.

31.13.6 Members
The OdbAssembly object can have the following members:
instances
A repository of OdbInstance objects.
nodeSets
A repository of OdbSet objects specifying node sets.
elementSets
A repository of OdbSet objects specifying element sets.
surfaces
A repository of OdbSet objects specifying surfaces.
nodes
An OdbMeshNodeArray object.
elements
An OdbMeshElementArray object.
datumCsyses
A repository of OdbDatumCsys objects.
sectionAssignments
A SectionAssignmentArray object.
rigidBodies
An OdbRigidBodyArray object.

31–41

Abaqus ID:
Printed on:
ODB COMMANDS

pretensionSections
An OdbPretensionSectionArray object.
connectorOrientations
A ConnectorOrientationArray object.

31.14 OdbDatumCsys object

The OdbDatumCsys object contains a coordinate system that can be stored in an output database. You
can create the datum coordinate system in the Visualization module during an Abaqus/CAE session and
save the datum coordinate system to the output database before you exit Abaqus/CAE. Alternatively, the
analysis code can write the datum coordinate system to the output database.

Access
import odbAccess
session.odbs[name].rootAssembly.datumCsyses[name]

31.14.1 DatumCsysByThreePoints(...)
This method creates an OdbDatumCsys object using three points. A datum coordinate system created
with this method results in a fixed system.

Path
session.odbs[name].rootAssembly.DatumCsysByThreePoints

Required arguments
name
A String specifying the repository key.
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
origin
A sequence of Floats specifying the coordinates of the origin of the datum coordinate system.
point1
A sequence of Floats specifying the coordinates of a point on the local 1- or -axis.
point2
A sequence of Floats specifying the coordinates of a point in the 1–2 or – plane.
Optional arguments
None.

31–42

Abaqus ID:
Printed on:
 ODB COMMANDS

Return value
An OdbDatumCsys object.

Exceptions
None.

31.14.2 DatumCsysByThreeNodes(...)
This method creates an OdbDatumCsys object using the coordinates of three OdbMeshNode objects. A
datum coordinate system created with this method results in a system that follows the position of the three
nodes. Results, such as those for displacement, are resolved into the orientation of the datum coordinate
system without regard to the position of its origin. The last three arguments are given in the form of an
OdbMeshNode object.

Path
session.odbs[name].rootAssembly.DatumCsysByThreeNodes

Required arguments
name
A String specifying the repository key.
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
origin
An OdbMeshNode object specifying a node at the origin of the datum coordinate system.
point1
An OdbMeshNode object specifying a node on the local 1- or -axis.
point2
An OdbMeshNode object specifying a node in the 1–2 or – plane.
Optional arguments
None.

Return value
An OdbDatumCsys object.

Exceptions
None.

31–43

Abaqus ID:
Printed on:
ODB COMMANDS

31.14.3 DatumCsysByThreeCircNodes(...)
This method is convenient to use where there are no nodes along the axis of a hollow cylinder or at the
center of a hollow sphere. The three nodes that you provide as arguments determine a circle in space.
The center of the circle is the origin of the datum coordinate system. The normal to the circle is parallel
to the -axis of a cylindrical coordinate system or to the -axis of a spherical coordinate system. The
line from the origin to the first node defines the -axis.

Path
session.odbs[name].rootAssembly.DatumCsysByThreeCircNodes

Required arguments
name
A String specifying the repository key.
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
node1Arc
An OdbMeshNode object that lies on the circular arc.
node2Arc
An OdbMeshNode object that lies on the circular arc.
node3Arc
An OdbMeshNode object that lies on the circular arc.
Optional arguments
None.

Return value
An OdbDatumCsys object.

Exceptions
None.

31.14.4 DatumCsysBy6dofNode(...)
A datum coordinate system created with this method results in a system that follows the position of a
node. The node location defines the origin of the datum coordinate system. The rotational displacement
(UR1, UR2, UR3) of the node defines the orientation of the coordinate system axes. Results, such as

31–44

Abaqus ID:
Printed on:
 ODB COMMANDS

those for displacement, are resolved into the orientation of the datum coordinate system without regard
to the position of its origin. The last argument is given in the form of an OdbMeshNode object.

Path
session.odbs[name].rootAssembly.DatumCsysBy6dofNode

Required arguments
name
A String specifying the repository key.
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
origin
An OdbMeshNode object specifying the origin of the datum coordinate system.
Optional arguments
None.

Return value
An OdbDatumCsys object.

Exceptions
None.

31.14.5 DatumCsys(...)
This method copies oneOdbDatumCsys object to a new OdbDatumCsys object.

Path
session.odbs[name].rootAssembly.DatumCsys

Required arguments
name
A String specifying the repository key.
datumCsys
An OdbDatumCsys object specifying the object to be copied.
Optional arguments
None.

31–45

Abaqus ID:
Printed on:
ODB COMMANDS

Return value
An OdbDatumCsys object.

Exceptions
None.

31.14.6 Members
The OdbDatumCsys object has the following members:
name
A String specifying the repository key.
coordSysType
A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN,
CYLINDRICAL, and SPHERICAL.
origin
A tuple of Floats specifying the coordinates of the origin of the datum coordinate system.
xAxis
A tuple of Floats specifying a point on the X-axis.
yAxis
A tuple of Floats specifying a point on the Y-axis.
zAxis
A tuple of Floats specifying a point on the Z-axis.

31.15 OdbFrame object

The domain of the OdbFrame object is taken from the parent step.

Access
import odbAccess
session.odbs[name].steps[name].frames[i]

31.15.1 Frame(...)
This method creates an OdbFrame object and appends it to the frame sequence.

Path
session.odbs[name].steps[name].Frame

31–46

Abaqus ID:
Printed on:
 ODB COMMANDS

Required arguments
incrementNumber
An Int specifying the frame increment number within the step. The base frame has normally
increment number 0, and the results run from 1. In case of multiple load cases, the same increment
number is duplicated for each loadcase.
frameValue
A Float specifying the value in units determined by the domain member of the Step object. The
equivalent in the time domain is stepTime; in the frequency domain the equivalent is frequency;
and in the modal domain the equivalent is mode.
Optional argument
description
A String specifying the contents of the frame. The default value is an empty string.

Return value
An OdbFrame object.

Exceptions
None.

31.15.2 Frame(...)
This constructor creates an OdbFrame object in the frequency domain and appends it to the frame
sequence. The arguments to the constructor are valid only when domain=FREQUENCY.

Path
session.odbs[name].steps[name].Frame

Required arguments
mode
An Int specifying the eigenmode. This member is available only if domain=MODAL.
frequency
A Float specifying the frequency. This member is available only if domain=FREQUENCY or if
the procedureType member of the Step object=“FREQUENCY”. The default value is 0.0.
Optional argument
description
A String specifying the contents of the frame. The default value is an empty string.

31–47

Abaqus ID:
Printed on:
ODB COMMANDS

Return value
An OdbFrame object.

Exceptions
None.

31.15.3 Frame(...)
This constructor creates an OdbFrame object in the mode domain and appends it to the frame sequence.
The arguments to the constructor are valid only when domain=MODE.

Path
session.odbs[name].steps[name].Frame

Required arguments
mode
An Int specifying the eigenmode. This member is available only if domain=MODAL.
frequency
A Float specifying the frequency. This member is available only if domain=FREQUENCY or if
the procedureType member of the Step object=“FREQUENCY”. The default value is 0.0.
Optional argument
description
A String specifying the contents of the frame. The default value is an empty string.

Return value
An OdbFrame object.

Exceptions
None.

31.15.4 Frame(...)
This constructor creates an OdbFrame object for a specific load case and appends it to the frame sequence.

Path
session.odbs[name].steps[name].Frame

31–48

Abaqus ID:
Printed on:
 ODB COMMANDS

Required argument
loadCase
An OdbLoadCase object specifying the load case for the frame.
Optional arguments
description
A String specifying the contents of the frame. The default value is an empty string.
frequency
A Float specifying the frequency. This member is available only if domain=FREQUENCY or if
the procedureType member of the Step object=“FREQUENCY”. The default value is 0.0.

Return value
An OdbFrame object.

Exceptions
None.

31.15.5 Members
The OdbFrame object has members with the same names and descriptions as the arguments to the Frame
method.
In addition, the OdbFrame object can have the following members:
cyclicModeNumber
An Int specifying the cyclic mode number associated with the data stored on this frame. Only
frequency analyses of cyclic symmetry models possess cyclic mode numbers.
domain
A SymbolicConstant specifying the domain of the step of which the frame is a member. Possible
values are TIME, FREQUENCY, and MODAL.
frequency
A Float specifying the frequency. This member is available only if domain=FREQUENCY or if
the procedureType member of the Step object=“FREQUENCY”. The default value is 0.0.
mode
An Int specifying the eigenmode. This member is available only if domain=MODAL.
associatedFrame
An OdbFrame object specifying the real or imaginary portion of the data corresponding to this
cyclic symmetry mode.
fieldOutputs
A repository of FieldOutput objects specifying the key to the fieldOutputsrepository is a String
representing an output variable.

31–49

Abaqus ID:
Printed on:
ODB COMMANDS

loadCase
An OdbLoadCase object specifying the load case for the frame.

31.16 OdbInstance object

A part instance is the usage of a part within an assembly.

Access
import odbAccess
session.odbs[name].rootAssembly.instances[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance

31.16.1 Instance(...)
This method creates an OdbInstance object from an OdbPart object.

Path
session.odbs[name].rootAssembly.Instance

Required arguments
name
A String specifying the instance name.
object
An OdbPart object.
Optional argument
localCoordSystem
A sequence of sequences of three Floats specifying the rotation and translation of the part
instance in the global Cartesian coordinate system. The first three sequences specify the new
local coordinate system with its center at the origin.
• The first sequence specifies a point on the 1-axis.
• The second sequence specifies a point on the 2-axis.
• The third sequence specifies a point on the 3-axis.
The fourth sequence specifies the translation of the local coordinate system from the origin to its
intended location.
For example, the following sequence moves a part 10 units in the X-direction with no rotation:
localCoordSystem = ((1, 0, 0), (0, 1, 0),

31–50

Abaqus ID:
Printed on:
 ODB COMMANDS

(0, 0, 1), (10, 0, 0))

Return value
An OdbInstance object.

Exceptions
InvalidNameError.

31.16.2 assignBeamOrientation(...)
This method assigns a beam section orientation to a region of a part instance.

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
method
A SymbolicConstant specifying the assignment method. Only a value of N1_COSINES is
currently supported.
n1
A sequence of three Floats specifying the approximate local -direction of the beam cross-
section.
Optional arguments
None.

Return value
None

Exceptions
None.

31.16.3 assignMaterialOrientation(...)
This method assigns a material orientation to a region of a part instance.

31–51

Abaqus ID:
Printed on:
ODB COMMANDS

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
localCsys
A OdbDatumCsys object specifying the local coordinate system or None, indicating the global
coordinate system.
Optional arguments
axis
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation is applied. For shells this axis is also the shell normal. Possible
values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle
A Float specifying the angle of the additional rotation. The default value is 0.0.
stack
A SymbolicConstant specifying the stack or thickness direction of the material. Possible values are
STACK_1, STACK_2, STACK_3, and STACK_ORIENTATION. The default value is STACK_3.

Return value
None

Exceptions
None.

31.16.4 assignRebarOrientation(...)
This method assigns a rebar reference orientation to a region of a part instance.

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
localCsys
A OdbDatumCsys object specifying the local coordinate system or None, indicating the global
coordinate system.

31–52

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
axis
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation is applied. For shells this axis is also the shell normal. Possible
values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle
A Float specifying the angle of the additional rotation. The default value is 0.0.

Return value
None

Exceptions
None.

31.16.5 getElementFromLabel(...)
This method is used to retrieved an element with a specific label from an instance object.

Arguments
Required argument
label
An Int specifying the element label.
Optional arguments
None.

Return value
An OdbMeshElement object.

Exceptions
If no element with the specified label exists:
AbaqusException: Invalid element label

31.16.6 getNodeFromLabel(...)
This method is used to retrieved a node with a specific label from an instance object.

31–53

Abaqus ID:
Printed on:
ODB COMMANDS

Arguments
Required argument
label
An Int specifying the node label.
Optional arguments
None.

Return value
An OdbMeshNode object.

Exceptions
If no node with the specified label exists:
AbaqusException: Invalid node label

31.16.7 assignSection(...)
This method is used to assign a section to a region on an instance.

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
section
A Section object.
Optional arguments
None.

Return value
None

Exceptions
If region is not an element set:
OdbError: Section assignment requires element set.
If the element set is not from the current instance:
OdbError: Section assignment requires element set from this part instance.

31–54

Abaqus ID:
Printed on:
 ODB COMMANDS

31.16.8 AnalyticRigidSurf2DPlanar(...)
This method is used to define a two-dimensional AnalyticSurface object on the instance.

Arguments

Required arguments
name
The name of the analytic surface.
profile
A sequence of AnalyticSurfaceSegment objects or a OdbSequenceAnalyticSurfaceSegment
object.
Optional argument
filletRadius
A Double specifying the radius of curvature to smooth discontinuities between adjoining segments.
The default value is 0.0.

Return value
None

Exceptions
If OdbPart associated with the part instance is of type THREE_D:
OdbError: 2D-Planar Analytic Rigid Surface can be defined only if the instance is of type
TWO_D_PLANAR or AXISYMMETRIC.

31.16.9 AnalyticRigidSurfExtrude(...)
This method is used to define a three-dimensional cylindrical AnalyticSurface on the instance.

Arguments

Required arguments
name
The name of the analytic surface.
profile
A sequence of AnalyticSurfaceSegment objects or a OdbSequenceAnalyticSurfaceSegment
object.

31–55

Abaqus ID:
Printed on:
ODB COMMANDS

Optional arguments
filletRadius
A Double specifying the radius of curvature to smooth discontinuities between adjoining segments.
The default value is 0.0.
localCoordData
A sequence of sequences of Floats specifying the global coordinates of points used to define the
local coordinate system.

Return value
None

Exceptions
If OdbPart associated with the part instance is not of type THREE_D:
OdbError: Analytic Rigid Surface of type CYLINDER can be defined only if the instance is of
type THREE_D.

31.16.10 AnalyticRigidSurfRevolve(...)
This method is used to define a three-dimensional AnalyticSurface of revolution on the instance.

Arguments
Required arguments
name
The name of the analytic surface.
profile
A sequence of AnalyticSurfaceSegment objects or a OdbSequenceAnalyticSurfaceSegment
object.
Optional arguments
filletRadius
A Double specifying the radius of curvature to smooth discontinuities between adjoining segments.
The default value is 0.0.
localCoordData
A sequence of sequences of Floats specifying the global coordinates of points used to define the
local coordinate system.

Return value
None

31–56

Abaqus ID:
Printed on:
 ODB COMMANDS

Exceptions
If OdbPart associated with the part instance is not of type THREE_D:
OdbError: Analytic Rigid Surface of type REVOLUTION can be defined only if the instance is
of type THREE_D.

31.16.11 RigidBody(...)
This method defines a OdbRigidBody on the instance.

Arguments
Required argument
referenceNode
An OdbSet specifying the reference node assigned to the rigid body.
Optional arguments
position
A symbolic constant specify if the location of the reference node is to be defined by the user.
Possible values are INPUT, and CENTER_OF_MASS. The default value is INPUT.
isothermal
A Boolean specifying an isothermal rigid body. The default value is OFF. This parameter is used
only for a fully-coupled thermal stress analysis.
elset
An OdbSet specifying an element set assigned to the rigid body.
pinNodes
An OdbSet specifying pin-type nodes assigned to the rigid body.
tieNodes
An OdbSet specifying tie-type nodes assigned to the rigid body.

Return value
None

Exceptions
If referenceNode is not a node set:
OdbError: Rigid body definition requires a node set.

31.16.12 getNodeFromLabel(...)
This method is used to retrieved a node with a specific label from an instance object.

31–57

Abaqus ID:
Printed on:
ODB COMMANDS

Arguments
Required argument
label
An Int specifying the node label.
Optional arguments
None.

Return value
An OdbMeshNode object.

Exceptions
If no node with the specified label exists:
AbaqusException: Invalid node label

31.16.13 getNodeFromLabel(...)
This method is used to retrieved a node with a specific label from an instance object.

Arguments
Required argument
label
An Int specifying the node label.
Optional arguments
None.

Return value
An OdbMeshNode object.

Exceptions
If no node with the specified label exists:
AbaqusException: Invalid node label

31.16.14 Members
The OdbInstance object can have the following members:
name
A String specifying the instance name.

31–58

Abaqus ID:
Printed on:
 ODB COMMANDS

type
A SymbolicConstant specifying the type of the Part object. Only a value of
DEFORMABLE_BODY is currently supported.
embeddedSpace
A SymbolicConstant specifying the dimensionality of the Part object. Possible values are
THREE_D, TWO_D_PLANAR, AXISYMMETRIC, and UNKNOWN_DIMENSION.
resultState
A SymbolicConstant specifying the state of the Instance as modified by the analysis. This member
is only present if the Instance is part of the RootAssemblyState tree. Possible values are:

• PROPAGATED, specifying that the value is the same as the previous frame or the original
rootAssembly.
• MODIFIED, specifying that the geometry of the instance has been changed at this frame.
The default value is PROPAGATED.
nodes
An OdbMeshNodeArray object.
elements
An OdbMeshElementArray object.
nodeSets
A repository of OdbSet objects specifying node sets.
elementSets
A repository of OdbSet objects specifying element sets.
surfaces
A repository of OdbSet objects specifying surfaces.
sectionAssignments
A SectionAssignmentArray object.
rigidBodies
An OdbRigidBodyArray object.
beamOrientations
A BeamOrientationArray object.
materialOrientations
A MaterialOrientationArray object.
rebarOrientations
A RebarOrientationArray object.
analyticSurface
An AnalyticSurface object specifying analytic Surface defined on the instance.

31–59

Abaqus ID:
Printed on:
ODB COMMANDS

31.17 OdbLoadCase object

The OdbLoadCase object describes a load case.

Access
import odbAccess
session.odbs[name].steps[name].frames[i].loadCase
session.odbs[name].steps[name].historyRegions[name].loadCase
session.odbs[name].steps[name].loadCases[name]

31.17.1 LoadCase(...)
This method creates an OdbLoadCase object.

Path
session.odbs[name].steps[name].LoadCase

Required argument
name
A String specifying the name of the OdbLoadCase object.
Optional arguments
None.

Return value
An OdbLoadCase object.

Exceptions
None.

31.17.2 Members
The OdbLoadCase object has members with the same names and descriptions as the arguments to the
LoadCase method.

31–60

Abaqus ID:
Printed on:
 ODB COMMANDS

31.18 OdbMeshElement object

OdbMeshElement objects are created with the part.addElements or

rootAssembly.addElements methods.

Access
import odbAccess
session.odbs[name].parts[name].elements[i]
session.odbs[name].parts[name].elementSets[name].elements[i]
session.odbs[name].parts[name].nodeSets[name].elements[i]
session.odbs[name].parts[name].surfaces[name].elements[i]
session.odbs[name].rootAssembly.elements[i]
session.odbs[name].rootAssembly.elementSets[name].elements[i]
session.odbs[name].rootAssembly.instances[name].elements[i]
session.odbs[name].rootAssembly.instances[name].elementSets[name]\
.elements[i]
session.odbs[name].rootAssembly.instances[name].nodeSets[name]\
.elements[i]
session.odbs[name].rootAssembly.instances[name].surfaces[name]\
.elements[i]
session.odbs[name].rootAssembly.nodeSets[name].elements[i]
session.odbs[name].rootAssembly.surfaces[name].elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elementSets[name].elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.nodeSets[name].elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.surfaces[name].elements[i]

31.18.1 Members
The OdbMeshElement object can have the following members:
label
An Int specifying the element label.
type
A String specifying the element type.

31–61

Abaqus ID:
Printed on:
ODB COMMANDS

sectionCategory
A SectionCategory object specifying the element section properties.
connectivity
A tuple of Ints specifying the element connectivity. For connector elements connected to ground,
the other node is repeated in the connectivity data. The position of the ground node cannot be
ascertained. This is a limitation.
instanceNames
A tuple of Strings specifying the instance names for nodes in the element connectivity.

31.19 OdbMeshNode object

OdbMeshNode objects are created with the part.addNodes method.

Access
import odbAccess
session.odbs[name].parts[name].elementSets[name].nodes[i]
session.odbs[name].parts[name].nodes[i]
session.odbs[name].parts[name].nodeSets[name].nodes[i]
session.odbs[name].parts[name].surfaces[name].nodes[i]
session.odbs[name].rootAssembly.elementSets[name].nodes[i]
session.odbs[name].rootAssembly.instances[name].elementSets[name]\
.nodes[i]
session.odbs[name].rootAssembly.instances[name].nodes[i]
session.odbs[name].rootAssembly.instances[name].nodeSets[name]\
.nodes[i]
session.odbs[name].rootAssembly.instances[name].surfaces[name]\
.nodes[i]
session.odbs[name].rootAssembly.nodes[i]
session.odbs[name].rootAssembly.nodeSets[name].nodes[i]
session.odbs[name].rootAssembly.surfaces[name].nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elementSets[name].nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.nodeSets[name].nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.surfaces[name].nodes[i]

31–62

Abaqus ID:
Printed on:
 ODB COMMANDS

31.19.1 Members
The OdbMeshNode object has the following members:
label
An Int specifying the node label.
coordinates
A tuple of Floats specifying the nodal coordinates in the global Cartesian coordinate system.

31.20 OdbPart object

The OdbPart object is similar to the kernel Part object and contains nodes and elements, but not geometry.

Access
import odbAccess
session.odbs[name].parts[name]

31.20.1 Part(...)
This method creates an OdbPart object. Nodes and elements are added to this object at a later stage.

Path
session.odbs[name].Part

Required arguments
name
A String specifying the part name.
embeddedSpace
A SymbolicConstant specifying the dimensionality of the Part object. Possible values are
THREE_D, TWO_D_PLANAR, and AXISYMMETRIC.
type
A SymbolicConstant specifying the type of the Part object. Possible values are
DEFORMABLE_BODY and ANALYTIC_RIGID_SURFACE.
Optional arguments
None.

Return value
An OdbPart object.

31–63

Abaqus ID:
Printed on:
ODB COMMANDS

Exceptions
None.

31.20.2 addElements(...)
This method adds elements to an OdbPart object using element labels and nodal connectivity.

Arguments
Required arguments
labels
A sequence of Ints specifying the element labels.
connectivity
A sequence of sequences of Ints specifying the nodal connectivity.
type
A String specifying the element type.
Optional arguments
elementSetName
A String specifying a name for this element set. The default value is the empty string.
sectionCategory
A SectionCategory object for this element set.

Return value
None

Exceptions
None.

31.20.3 addElements(...)
This method adds elements to an OdbPart object using a sequence of element labels and nodal
connectivity.

Arguments
Required arguments
elementData
A sequence of sequences of Ints specifying the element labels and nodal connectivity, in the form
((label, c1, c2, c3, c4), (label, c1, c2, c3, c4), ...).

31–64

Abaqus ID:
Printed on:
 ODB COMMANDS

type
A String specifying the element type. The value can be user defined.
Optional arguments
elementSetName
A String specifying a name for this element set. The default value is None.
sectionCategory
A SectionCategory object for this element set.

Return value
None

Exceptions
None.

31.20.4 addNodes(...)
This method adds nodes to an OdbPart object using node labels and coordinates.

WARNING: Adding nodes not in ascending order of their labels may cause Abaqus/Viewer to plot
contours incorrectly.

Arguments
Required arguments
labels
A sequence of Ints specifying the node labels.
coordinates
A sequence of sequences of Floats specifying the nodal coordinates.
Optional argument
nodeSetName
A String specifying a name for this node set. The default value is None.

Return value
None

Exceptions
None.

31–65

Abaqus ID:
Printed on:
ODB COMMANDS

31.20.5 addNodes(...)
This method adds nodes to an OdbPart object using a sequence of node labels and coordinates.

WARNING: Adding nodes not in ascending order of their labels may cause Abaqus/Viewer to plot
contours incorrectly.

Arguments
Required argument
nodeData
A sequence of tuples specifying the node labels and coordinates, in the form ((label, x, y, z), (label,
x, y, z), ...).
Optional argument
nodeSetName
A String specifying a name for this node set. The default value is None.

Return value
None

Exceptions
None.

31.20.6 assignBeamOrientation(...)
This method assigns a beam section orientation to a region of a part instance.

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
method
A SymbolicConstant specifying the assignment method. Only a value of N1_COSINES is
currently supported.
n1
A sequence of three Floats specifying the approximate local -direction of the beam cross-
section.

31–66

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
None.

Return value
None

Exceptions
None.

31.20.7 assignMaterialOrientation(...)
This method assigns a material orientation to a region of a part instance.

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
localCsys
A OdbDatumCsys object specifying the local coordinate system or None, indicating the global
coordinate system.
Optional arguments
axis
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation is applied. For shells this axis is also the shell normal. Possible
values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle
A Float specifying the angle of the additional rotation. The default value is 0.0.
stack
A SymbolicConstant specifying the stack or thickness direction of the material. Possible values are
STACK_1, STACK_2, STACK_3, and STACK_ORIENTATION. The default value is STACK_3.

Return value
None

Exceptions
None.

31–67

Abaqus ID:
Printed on:
ODB COMMANDS

31.20.8 assignRebarOrientation(...)
This method assigns a rebar reference orientation to a region of a part instance.

Arguments
Required arguments
region
An OdbSet specifying a region on an instance.
localCsys
A OdbDatumCsys object specifying the local coordinate system or None, indicating the global
coordinate system.
Optional arguments
axis
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation is applied. For shells this axis is also the shell normal. Possible
values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle
A Float specifying the angle of the additional rotation. The default value is 0.0.

Return value
None

Exceptions
None.

31.20.9 getElementFromLabel(...)
This method is used to retrieved an element with a specific label from a part object.

Arguments
Required argument
label
An Int specifying the element label.
Optional arguments
None.

Return value
An OdbMeshElement object.

31–68

Abaqus ID:
Printed on:
 ODB COMMANDS

Exceptions
If no element with the specified label exists:
AbaqusException: Invalid element label

31.20.10 getNodeFromLabel(...)
This method is used to retrieved a node with a specific label from a part object.

Arguments
Required argument
label
An Int specifying the node label.
Optional arguments
None.

Return value
An OdbMeshNode object.

Exceptions
If no node with the specified label exists:
AbaqusException: Invalid node label

31.20.11 AnalyticRigidSurf2DPlanar(...)
This method is used to define a two-dimensional AnalyticSurface object on the part object.

Arguments
Required arguments
name
The name of the analytic surface.
profile
A sequence of AnalyticSurfaceSegment objects or a OdbSequenceAnalyticSurfaceSegment
object.
Optional argument
filletRadius
A Double specifying the radius of curvature to smooth discontinuities between adjoining segments.
The default value is 0.0.

31–69

Abaqus ID:
Printed on:
ODB COMMANDS

Return value
None

Exceptions
If OdbPart is of type THREE_D:
OdbError: 2D-Planar Analytic Rigid Surface can be defined only if the part is of type
TWO_D_PLANAR or AXISYMMETRIC.

31.20.12 AnalyticRigidSurfExtrude(...)
This method is used to define a three-dimensional cylindrical AnalyticSurface on the part object.

Arguments
Required arguments
name
The name of the analytic surface.
profile
A sequence of AnalyticSurfaceSegment objects or a OdbSequenceAnalyticSurfaceSegment
object.
Optional argument
filletRadius
A Double specifying the radius of curvature to smooth discontinuities between adjoining segments.
The default value is 0.0.

Return value
None

Exceptions
If OdbPart is not of type THREE_D:
OdbError: Analytic Rigid Surface of type CYLINDER can be defined only if the part is of type
THREE_D.

31.20.13 AnalyticRigidSurfRevolve(...)
This method is used to define a three-dimensional AnalyticSurface of revolution on the part object.

31–70

Abaqus ID:
Printed on:
 ODB COMMANDS

Arguments
Required arguments
name
The name of the analytic surface.
profile
A sequence of AnalyticSurfaceSegment objects or a OdbSequenceAnalyticSurfaceSegment
object.
Optional argument
filletRadius
A Double specifying the radius of curvature to smooth discontinuities between adjoining segments.
The default value is 0.0.

Return value
None

Exceptions
If OdbPart is not of type THREE_D:
OdbError: Analytic Rigid Surface of type REVOLUTION can be defined only if the part is of
type THREE_D.

31.20.14 RigidBody(...)
This method defines a OdbRigidBody on the part object.

Arguments
Required argument
referenceNode
An OdbSet specifying the reference node assigned to the rigid body.
Optional arguments
position
A symbolic constant specify if the location of the reference node is to be defined by the user.
Possible values are INPUT, and CENTER_OF_MASS. The default value is INPUT.
isothermal
A Boolean specifying an isothermal rigid body. The default value is OFF. This parameter is used
only for a fully-coupled thermal stress analysis.
elset
An OdbSet specifying an element set assigned to the rigid body.

31–71

Abaqus ID:
Printed on:
ODB COMMANDS

pinNodes
An OdbSet specifying pin-type nodes assigned to the rigid body.
tieNodes
An OdbSet specifying tie-type nodes assigned to the rigid body.

Return value
None

Exceptions
If referenceNode is not a node set:
OdbError: Rigid body definition requires a node set.

31.20.15 Members
The OdbPart object has members with the same names and descriptions as the arguments to the Part
method.
In addition, the OdbPart object can have the following members:
nodes
An OdbMeshNodeArray object.
elements
An OdbMeshElementArray object.
nodeSets
A repository of OdbSet objects specifying node sets.
elementSets
A repository of OdbSet objects specifying element sets.
surfaces
A repository of OdbSet objects specifying surfaces.
sectionAssignments
A SectionAssignmentArray object.
beamOrientations
A BeamOrientationArray object.
materialOrientations
A MaterialOrientationArray object.
rebarOrientations
A RebarOrientationArray object.
rigidBodies
An OdbRigidBodyArray object.
analyticSurface
An AnalyticSurface object specifying analytic Surface defined on the instance.

31–72

Abaqus ID:
Printed on:
 ODB COMMANDS

31.21 OdbPretensionSection object

The pretension section object is used to define an assembly load. It associates a pretension node with a
pretension section.

Access
import odbAccess
session.odbs[name].rootAssembly.pretensionSections[i]

31.21.1 Members
The OdbPretensionSection object can have the following members:
node
An OdbSet object specifying the node set containing the pretension node.
element
An OdbSet object specifying the element set that defines the pretension section.
surface
An OdbSet object specifying the surface set that defines the pretension section.
normal
A tuple of Floats specifying the components of the normal to the pretension section.

31.22 OdbRigidBody object

The Rigid body object is used to bind a set of elements and/or a set of nodes and/or an analytical surface
with a reference node.

Access
import odbAccess
session.odbs[name].parts[name].rigidBodies[i]
session.odbs[name].rootAssembly.instances[name].rigidBodies[i]
session.odbs[name].rootAssembly.rigidBodies[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.rigidBodies[i]

31.22.1 RigidBody(...)
This method creates a OdbRigidBody object.

31–73

Abaqus ID:
Printed on:
ODB COMMANDS

Path
session.odbs[name].rootAssembly.instances[name].RigidBody
session.odbs[name].rootAssembly.RigidBody

Required argument
referenceNode
An OdbSet object specifying the reference node set associated with the rigid body.
Optional arguments
position
A SymbolicConstant specifying the specific location of the OdbRigidBody reference node relative
to the rest of the rigid body. Possible values are INPUT and CENTER_OF_MASS. The default
value is INPUT.
isothermal
A Boolean specifying specify whether the OdbRigidBody can have temperature gradients or be
isothermal. This is used only for fully coupled thermal-stress analysis The default value is ON.
elements
An OdbSet object specifying the element set whose motion is governed by the motion of rigid
body reference node.
tieNodes
An OdbSet object specifying the node set which have both translational and rotational degrees of
freedom associated with the rigid body.
pinNodes
An OdbSet object specifying the node set which have only translational degrees of freedom
associated with the rigid body.
analyticSurface
An AnalyticSurface object specifying the analytic surface whose motion is governed by the motion
of rigid body reference node.

Return value
An OdbRigidBody object.

Exceptions
None.

31.22.2 Members
The OdbRigidBody object has members with the same names and descriptions as the arguments to the
RigidBody method.

31–74

Abaqus ID:
Printed on:
 ODB COMMANDS

31.23 OdbSequenceAnalyticSurfaceSegment object

A sequence of AnalyticSurfaceSegment describing an analytic surface profile.

Access
import odbAccess
session.odbs[name].parts[name].analyticSurface.segments
session.odbs[name].rootAssembly.instances[name].analyticSurface\
.segments
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.analyticSurface.segments

31.23.1 AnalyticSurfaceProfile()
This method creates a OdbSequenceAnalyticSurfaceSegment object.

Path
odbAccess.AnalyticSurfaceProfile

Arguments
None.

Return value
An OdbSequenceAnalyticSurfaceSegment object.

Exceptions
None.

31.23.2 Start(...)
This method adds a AnalyticSurfaceSegment describing the first segment of the surface profile.

Arguments
Required argument
origin
A sequence of Floats specifying the coordinates of start point.

31–75

Abaqus ID:
Printed on:
ODB COMMANDS

Optional arguments
None.

Return value
None

Exceptions
None.

31.23.3 Line(...)
This method adds a AnalyticSurfaceSegment describing the line segment of the surface profile.

Arguments
Required argument
endPoint
A sequence of Floats specifying the coordinates of end point.
Optional arguments
None.

Return value
None

Exceptions
None.

31.23.4 Circle(...)
This method adds a AnalyticSurfaceSegment describing a circular segment of the surface profile.

Arguments
Required arguments
center
A sequence of Floats specifying the coordinates of center of the circular segment.
endPoint
A sequence of Floats specifying the coordinates of end point of the circular segment.
Optional arguments
None.

31–76

Abaqus ID:
Printed on:
 ODB COMMANDS

Return value
None

Exceptions
None.

31.23.5 Parabola(...)
This method adds a AnalyticSurfaceSegment describing a parabolic segment of the surface profile.

Arguments
Required arguments
middlePoint
A sequence of Floats specifying the coordinates of middle point of the parabolic segment.
endPoint
A sequence of Floats specifying the coordinates of end point of the parabolic segment.
Optional arguments
None.

Return value
None

Exceptions
None.

31.23.6 Members
The OdbSequenceAnalyticSurfaceSegment object has no members.

31.24 OdbSet object

The set objects are used to identify regions of a model.

Access
import odbAccess
session.odbs[name].parts[name].elementSets[name]
session.odbs[name].parts[name].nodeSets[name]

31–77

Abaqus ID:
Printed on:
ODB COMMANDS

session.odbs[name].parts[name].surfaces[name]
session.odbs[name].rootAssembly.elementSets[name]
session.odbs[name].rootAssembly.instances[name].elementSets[name]
session.odbs[name].rootAssembly.instances[name].nodeSets[name]
session.odbs[name].rootAssembly.instances[name].surfaces[name]
session.odbs[name].rootAssembly.nodeSets[name]
session.odbs[name].rootAssembly.surfaces[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elementSets[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.nodeSets[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.surfaces[name]

31.24.1 NodeSet(...)
This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or
from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).

Path
session.odbs[name].parts[name].NodeSet
session.odbs[name].rootAssembly.instances[name].NodeSet
session.odbs[name].rootAssembly.NodeSet

Required arguments
name
A String specifying the name of the set and the repository key.
nodes
A sequence of OdbMeshNode objects. For example, for a part:
nodes=instance1.nodes[1:5]
For an assembly:
nodes=(instance1.nodes[6:7], instance2.nodes[1:5])

Optional arguments
None.

Return value
An OdbSet object.

31–78

Abaqus ID:
Printed on:
 ODB COMMANDS

Exceptions
InvalidNameError.

31.24.2 NodeSetFromNodeLabels(...)
This method creates a node set from a sequence of node labels.

Path
session.odbs[name].parts[name].NodeSetFromNodeLabels
session.odbs[name].rootAssembly.instances[name].NodeSetFromNodeLabels
session.odbs[name].rootAssembly.NodeSetFromNodeLabels

Required arguments
name
A String specifying the name of the set and the repository key.
nodeLabels
A sequence of node labels. A node label is a sequence of Int node identifiers. For example, for a
part:
nodeLabels=(2,3,5,7)
For an assembly:
nodeLabels=(('Instance-1', (2,3,5,7)),
('Instance-2', (1,2,3)))

Optional arguments
None.

Return value
An OdbSet object.

Exceptions
InvalidNameError.

31.24.3 ElementSet(...)
This method creates an element set from an array of OdbMeshElement objects (for part instance-level
sets) or from a sequence of arrays of OdbMeshElement objects (for assembly-level sets).

31–79

Abaqus ID:
Printed on:
ODB COMMANDS

Path
session.odbs[name].parts[name].ElementSet
session.odbs[name].rootAssembly.instances[name].ElementSet

Required arguments
name
A String specifying the name of the set and the repository key.
elements
A sequence of OdbMeshElement objects. For example, for a part:
elements=instance1.elements[1:5]
For an assembly:
elements=(instance1.elements[1:5], instance2.elements[1:5])

Optional arguments
None.

Return value
An OdbSet object.

Exceptions
InvalidNameError.

31.24.4 ElementSetFromElementLabels(...)
This method creates an element set from a sequence of element labels.

Path
session.odbs[name].parts[name].ElementSetFromElementLabels
session.odbs[name].rootAssembly.instances[name].ElementSetFromElementLabels
session.odbs[name].rootAssembly.ElementSetFromElementLabels

Required arguments
name
A String specifying the name of the set and the repository key.

31–80

Abaqus ID:
Printed on:
 ODB COMMANDS

elementLabels
A sequence of element labels. An element label is a sequence of Int element identifiers. For
example, for a part:
elementLabels=(2,3,5,7)
For an assembly:
elementLabels=(('Instance-1', (2,3,5,7)),
('Instance-2', (1,2,3)))

Optional arguments
None.

Return value
An OdbSet object.

Exceptions
InvalidNameError.

31.24.5 MeshSurface(...)
This method creates a surface from the element and side identifiers for the assembly.

Path
session.odbs[name].parts[name].MeshSurface
session.odbs[name].rootAssembly.instances[name].MeshSurface
session.odbs[name].rootAssembly.MeshSurface

Required arguments
name
A String specifying the name of the set and the repository key.
meshSurfaces
A sequence of sequences. Each sequence consists of an element sequence and a side identifier.
The possible side identifiers depend on the type of element, as described in the following table:
Sequence of elements Side identifiers
Solid elements FACE1, FACE2, FACE3, FACE4, FACE5, FACE6
Three-dimensional shell elements SIDE1, SIDE2

31–81

Abaqus ID:
Printed on:
ODB COMMANDS

Two-dimensional elements FACE1, FACE2, FACE3, FACE4

Wire elements END, END2

For example:
side1Elements=instance1.elements[217:218]
side2Elements=instance2.elements[100:105]
assembly.MeshSurface(name='Surf-1',
meshSurfaces=((side1Elems,SIDE1),
(side2Elems,SIDE2)))

Optional arguments
None.

Return value
An OdbSet object.

Exceptions
InvalidNameError.

31.24.6 MeshSurfaceFromElsets(...)
This method creates a mesh surface from a sequence of element sets.

Path
session.odbs[name].parts[name].MeshSurfaceFromElsets
session.odbs[name].rootAssembly.instances[name].MeshSurfaceFromElsets
session.odbs[name].rootAssembly.MeshSurfaceFromElsets

Required arguments
name
A String specifying the name of the set and the repository key.
elementSetSeq
A sequence of element sets. For example,
elementSetSeq=((elset1,SIDE1),(elset2,SIDE2))
where elset1=session.odbs[name].rootAssembly.elementSets['Clutch']
and SIDE1 and SIDE2 indicate the side of the element set.

31–82

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
None.

Return value
An OdbSet object.

Exceptions
InvalidNameError.

31.24.7 MeshSurfaceFromLabels(...)
This method creates a mesh surface from a sequence of surface labels.

Path
session.odbs[name].parts[name].MeshSurfaceFromLabels
session.odbs[name].rootAssembly.instances[name].MeshSurfaceFromLabels
session.odbs[name].rootAssembly.MeshSurfaceFromLabels

Required arguments
name
A String specifying the name of the set and the repository key.
surfaceLabels
A sequence of surface labels. For example,
surfaceLabels=(('Instance-1', ((10, FACE1), (11, FACE2))),
('Instance-2', ((10, FACE3), (12, FACE4))))
where 10 is an element number and FACE1 indicates the side of the element.
Optional arguments
None.

Return value
An OdbSet object.

Exceptions
InvalidNameError.

31.24.8 Members
The OdbSet object can have the following members:

31–83

Abaqus ID:
Printed on:
ODB COMMANDS

name
A String specifying the name of the set and the repository key.
instances
An OdbInstanceArray object specifying the namespaces for the nodes, elements, and faces; None
if the set is on a Part or an OdbInstance object.
nodes
An OdbMeshNodeArray object specifying if a set spans more than one part instance, this member
is a sequence of sequences for each part instance.
elements
An OdbMeshElementArray object specifying if a set spans more than one part instance, this
member is a sequence of sequences for each part instance.
faces
A tuple of SymbolicConstants specifying the element face. If a set spans more than one part
instance, this member is a sequence of sequences for each part instance.

31.25 OdbStep object

An output database contains the same steps of the model database that originated it.

Access
import odbAccess
session.odbs[name].steps[name]

31.25.1 Step(...)
This method creates an OdbStep object.

Path
session.odbs[name].Step

Required arguments
name
A String specifying the repository key.
description
A String specifying the step description.
domain
A SymbolicConstant specifying the domain of the step. Possible values are TIME, FREQUENCY,
ARC_LENGTH, and MODAL.

31–84

Abaqus ID:
Printed on:
 ODB COMMANDS

The type of OdbFrame object that can be created for this step is based on the value of the
domain argument.
Optional arguments
timePeriod
A Float specifying the time period of the step. timePeriod is required if domain=TIME; otherwise,
this argument is not applicable. The default value is 0.0.
previousStepName
A String specifying the preceding step. If previousStepName is the empty string, the last step in
the repository is used. If previousStepName is not the last step, this will result in a change to the
previousStepName member of the step that was in that position. A special value ’Initial’ refers
to the internal initial model step and may be used exclusively for inserting a new step at the first
position before any other existing steps. The default value is an empty string.
procedure
A String specifying the step procedure. The default value is an empty string.
totalTime
A Float specifying the analysis time spend in all the steps previous to this step. The default value
is −1.0.

Return value
An OdbStep object.

Exceptions
If previousStepName is invalid:
ValueError: previousStepName is invalid

31.25.2 getFrame(...)
This method retrieves an OdbFrame object associated with a given frame value.

Arguments
Required argument
frameValue
A Double specifying the value at which the frame is required. frameValue can be the step time or
frequency.
Optional argument
match
A SymbolicConstant specifying which frame to return if there is no frame at the exact frame value.
Possible values are CLOSEST, BEFORE, AFTER, and EXACT. The default value is CLOSEST.

31–85

Abaqus ID:
Printed on:
ODB COMMANDS

When match=CLOSEST, Abaqus returns the closest frame. If the frame value requested is
exactly halfway between two frames, Abaqus returns the frame after the value.
When match=EXACT, Abaqus raises an exception if the exact frame value does not exist.

Return value
An OdbFrame object.

Exceptions
If the OdbFrame object is not found:
AbaqusException: Frame not found.

31.25.3 getFrame(...)
This method retrieves an OdbFrame object associated with a given load case.

Arguments
Required argument
loadCase
An OdbLoadCase object specifying a load case in the step.
Optional arguments
None.

Return value
An OdbFrame object.

Exceptions
If the OdbFrame object is not found:
AbaqusException: Frame not found.

31.25.4 getFrame(...)
This method retrieves an OdbFrame object associated with a given load case and frame value.

Arguments
Required arguments
loadCase
An OdbLoadCase object specifying a load case in the step.

31–86

Abaqus ID:
Printed on:
 ODB COMMANDS

frameValue
A Double specifying the value at which the frame is required. frameValue can be the step time or
frequency.
Optional argument
match
A SymbolicConstant specifying which frame to return if there is no frame at the exact frame value.
Possible values are CLOSEST, BEFORE, AFTER, and EXACT. The default value is CLOSEST.
When match=CLOSEST, Abaqus returns the closest frame. If the frame value requested is
exactly halfway between two frames, Abaqus returns the frame after the value.
When match=EXACT, Abaqus raises an exception if the exact frame value does not exist.

Return value
An OdbFrame object.

Exceptions
If the OdbFrame object is not found:
AbaqusException: Frame not found.

31.25.5 getHistoryRegion(...)
This method retrieves a HistoryRegion object associated with a HistoryPoint in the model.

Arguments
Required argument
point
A HistoryPoint object specifying the point in the model.
Optional argument
loadCase
An OdbLoadCase object specifying a load case in the step.

Return value
A HistoryRegion object.

Exceptions
If a HistoryRegion object is not found:
AbaqusException: HistoryRegion not found.

31–87

Abaqus ID:
Printed on:
ODB COMMANDS

31.25.6 setDefaultDeformedField(...)
This method sets the default deformed field variable in a step.

Arguments
Required argument
field
A FieldOutput object specifying the default deformed field variable for visualization.
Optional arguments
None.

Return value
None

Exceptions
None.

31.25.7 setDefaultField(...)
This method sets the default field variable in a step.

Arguments
Required argument
field
A FieldOutput object specifying the default field variable for visualization.
Optional arguments
None.

Return value
None

Exceptions
None.

31.25.8 Members
The OdbStep object has members with the same names and descriptions as the arguments to the Step
method.

31–88

Abaqus ID:
Printed on:
 ODB COMMANDS

In addition, the OdbStep object can have the following members:

number
An Int specifying the step number.
nlgeom
A Boolean specifying whether geometric nonlinearity can occur in this step.
mass
A Float specifying the current value of the mass of the model. This does not include the mass of
the acoustic media if any present.
acousticMass
A Float specifying the current value of the mass of the acoustic media of the model.
frames
An OdbFrameArray object.
historyRegions
A repository of HistoryRegion objects.
loadCases
A repository of OdbLoadCase objects.
massCenter
A tuple of Floats specifying the coordinates of the center of mass.
inertiaAboutCenter
A tuple of Floats specifying the moments and products of inertia about the center of mass. For 3-D
models inertia quantities are written in the following order: I(XX), I(YY), I(ZZ), I(XY), I(XZ),
and I(YZ). For 2-D models only I(ZZ) and I(XY) are outputted.
inertiaAboutOrigin
A tuple of Floats specifying the moments and products of inertia about the origin of the global
coordinate system. For 3-D models inertia quantities are written in the following order: I(XX),
I(YY), I(ZZ), I(XY), I(XZ), and I(YZ). For 2-D models only I(ZZ) and I(XY) are outputted.
acousticMassCenter
A tuple of Floats specifying the coordinates of the center of mass of the acoustic media.
retainedEigenModes
A tuple of Ints specifying the retained eigenmodes in a substructure generation analysis.
retainedNodalDofs
A NodalDofsArray object specifying the retained degrees of freedom in a substructure generation
analysis.
eliminatedNodalDofs
A NodalDofsArray object specifying the eliminated degrees of freedom in a substructure
generation analysis.

31–89

Abaqus ID:
Printed on:
ODB COMMANDS

31.26 RebarOrientation object

The RebarOrientation object represents the orientation of the rebar reference.

Access
import odbAccess
session.odbs[name].parts[name].rebarOrientations[i]
session.odbs[name].rootAssembly.instances[name].rebarOrientations[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.rebarOrientations[i]

31.26.1 Members
The RebarOrientation object can have the following members:
axis
A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system
about which an additional rotation is applied. Possible values are AXIS_1, AXIS_2, and AXIS_3.
angle
A Float specifying the angle of the additional rotation.
region
An OdbSet object specifying a region for which the rebar orientation is defined.
csys
An OdbDatumCsys object specifying a datum coordinates system.

31.27 ScratchOdb object

A scratch output database is associated with an open output database and is used to store session-related,
non-persistent objects, such as Step, Frame and FieldOutput objects. Abaqus creates a scratch output
database when needed for these non-persistent objects during an Abaqus/CAE session. Abaqus deletes
the scratch output database when the associated output database is closed.

Access
import odbAccess
session.scratchOdbs[name]

31–90

Abaqus ID:
Printed on:
 ODB COMMANDS

31.27.1 ScratchOdb(...)
This method creates a new ScratchOdb object.

Path
session.ScratchOdb

Required argument
odb
An Odb object specifying the output database with which to associate.
Optional arguments
None.

Return value
A ScratchOdb object.

Exceptions
None.

31.27.2 Members
The ScratchOdb object has no members.

31.28 SectionCategory object

The SectionCategory object is used to group regions of the model with like sections. Section definitions
that contain the same number of section points or integration points are grouped together.
To access data for a particular section definition, use the individual Section objects in the output
database. For more information, see Chapter 7, “Beam Section profile commands,” and Chapter 42,
“Section commands.”

Access
import odbAccess
session.odbs[name].parts[name].elements[i].sectionCategory
session.odbs[name].parts[name].elementSets[name].elements[i]\
.sectionCategory
session.odbs[name].parts[name].nodeSets[name].elements[i]\
.sectionCategory

31–91

Abaqus ID:
Printed on:
ODB COMMANDS

session.odbs[name].parts[name].surfaces[name].elements[i]\
.sectionCategory
session.odbs[name].rootAssembly.elements[i].sectionCategory
session.odbs[name].rootAssembly.elementSets[name].elements[i]\
.sectionCategory
session.odbs[name].rootAssembly.instances[name].elements[i]\
.sectionCategory
session.odbs[name].rootAssembly.instances[name].elementSets[name]\
.elements[i].sectionCategory
session.odbs[name].rootAssembly.instances[name].nodeSets[name]\
.elements[i].sectionCategory
session.odbs[name].rootAssembly.instances[name].surfaces[name]\
.elements[i].sectionCategory
session.odbs[name].rootAssembly.nodeSets[name].elements[i]\
.sectionCategory
session.odbs[name].rootAssembly.surfaces[name].elements[i]\
.sectionCategory
session.odbs[name].sectionCategories[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elements[i].sectionCategory
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elementSets[name].elements[i].sectionCategory
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.nodeSets[name].elements[i].sectionCategory
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.surfaces[name].elements[i].sectionCategory

31.28.1 SectionCategory(...)
This method creates a SectionCategory object.

Path
session.odbs[name].SectionCategory

Required arguments
name
A String specifying the name of the category.
description
A String specifying the description of the category.

31–92

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
None.

Return value
A SectionCategory object.

Exceptions
None.

31.28.2 Members
The SectionCategory object has members with the same names and descriptions as the arguments to the
SectionCategory method.
In addition, the SectionCategory object can have the following member:
sectionPoints
A SectionPointArray object.

31.29 SectionPoint object

The SectionPoint object describes the location of a section point within a section category.

Access
import odbAccess
session.odbs[name].parts[name].elements[i].sectionCategory\
.sectionPoints[i]
session.odbs[name].parts[name].elementSets[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].parts[name].nodeSets[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].parts[name].surfaces[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.elements[i].sectionCategory\
.sectionPoints[i]
session.odbs[name].rootAssembly.elementSets[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].elementSets[name]\
.elements[i].sectionCategory.sectionPoints[i]

31–93

Abaqus ID:
Printed on:
ODB COMMANDS

session.odbs[name].rootAssembly.instances[name].nodeSets[name]\
.elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].surfaces[name]\
.elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.nodeSets[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.surfaces[name].elements[i]\
.sectionCategory.sectionPoints[i]
session.odbs[name].sectionCategories[name].sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name]\
.locations[i].sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.elementSets[name].elements[i].sectionCategory\
.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.nodeSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.instance.surfaces[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]\
.sectionPoint

31.29.1 SectionPoint(...)
This method creates a SectionPoint object.

Path
session.odbs[name].sectionCategories[name].SectionPoint

Required arguments
number
An Int specifying the number of the section point. See “Beam elements,” Section 26.3 of the
Abaqus Analysis User’s Manual, and “Shell elements,” Section 26.6 of the Abaqus Analysis User’s
Manual, for the numbering convention.
description
A String specifying the description of the section point.
Optional arguments
None.

31–94

Abaqus ID:
Printed on:
 ODB COMMANDS

Return value
A SectionPoint object.

Exceptions
None.

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

31.30 SectorDefinition object

The SectorDefinition object describes the number of symmetry sectors and axis of symmetry for a cyclic
symmetry model.

Access
import odbAccess
session.odbs[name].sectorDefinition

31.30.1 Members
The SectorDefinition object has the following members:
numSectors
An Int specifying the number of sectors in the cyclic symmetry model.
symmetryAxis
A tuple of tuples of Floats specifying the coordinates of two points on the axis of symmetry.

31.31 UserData object

The UserData object contains user-defined XY data. The UserData object has no constructor; it is created
automatically when an Odb object is created.

Access
import odbAccess
session.odbs[name].userData

31–95

Abaqus ID:
Printed on:
ODB COMMANDS

31.31.1 Members
The UserData object can have the following members:
xyDataObjects
A repository of XYData objects.
annotations
A repository of Annotation objects.

31.32 Odb commands

The Odb commands do the following:

• Determine if an output database (.odb) file needs to be upgraded to the current release.
• Determine the extreme value for an output variable over a number of fields; for example, over a
number of load cases.
• Open an existing output database file and create a new Odb object.
• Upgrade an output database file to the current release and write the upgraded output database to a
new file.

31.32.1 isUpgradeRequiredForOdb(...)
This method determines if an output database file needs to be upgraded to the current release.
You can access this method using either of the following techniques:
• From a script running outside Abaqus/CAE. For example,

import odbAccess
needsUpgrade = odbAccess.isUpgradeRequiredForOdb(
upgradeRequiredOdbPath='myOdb.odb')

• From the Visualization module in Abaqus/CAE. For example,

import visualization
needsUpgrade = session.isUpgradeRequiredForOdb(
upgradeRequiredOdbPath='myOdb.odb')

Arguments
Required argument
upgradeRequiredOdbPath
An String specifying the path to an output database file to test. The test determines if the output
database needs to be upgraded to the current release.

31–96

Abaqus ID:
Printed on:
 ODB COMMANDS

Optional arguments
None.

Return value
A Boolean indicating the result of the test. A value of True indicates that the output database needs to
be upgraded to the current release.

Exceptions
None.

31.32.2 maxEnvelope(...)
Retrieve the maximum value of an output variable over a number of fields.

Arguments
Required arguments
The maxEnvelope method does not use keyword arguments.

Argument
A list of similar fieldOutput objects from which the maximum value will be computed.
A SymbolicConstant specifying the invariant or component label to be used when comparing vectors or
tensors. Possible values are:
• MAGNITUDE
• MISES
• TRESCA
• PRESS
• INV3
• MAX_PRINCIPAL
• MID_PRINCIPAL
• MIN_PRINCIPAL
You must provide either this argument or the following argument if the field is a vector or tensor.
A String specifying the component of the tensor or vector to be used for selecting the maximum value.

Optional arguments
None.

31–97

Abaqus ID:
Printed on:
ODB COMMANDS

Return value
A sequence of two fieldOutput objects. The first fieldOutput object contains the maximum value. The
second fieldOutput object contains the index of the field containing the maximum value. The index
follows the order in which fields are positioned in the list of fieldOutput objects provided as the argument
to the function.

Exceptions
OdbError
TypeError
This function takes no keyword arguments.

31.32.3 minEnvelope(...)
Retrieve the minimum value of an output variable over a number of fields.

Arguments
Required arguments
The minEnvelope method does not use keyword arguments.
Argument
A list of similar fieldOutput objects from which the maximum value will be computed.
A SymbolicConstant specifying the invariant or component label to be used when comparing vectors or
tensors. Possible values are:
• MAGNITUDE
• MISES
• TRESCA
• PRESS
• INV3
• MAX_PRINCIPAL
• MID_PRINCIPAL
• MIN_PRINCIPAL
You must provide either this argument or the following argument if the field is a vector or tensor.
A String specifying the component of the tensor or vector to be used for selecting the minimum value.

Optional arguments
None.

31–98

Abaqus ID:
Printed on:
 ODB COMMANDS

Return value
A sequence of two fieldOutput objects. The first fieldOutput object contains the minimum value. The
second fieldOutput object contains the index of the field containing the minimum value. The index
follows the order in which fields are positioned in the list of fieldOutput objects provided as the argument
to the function.

Exceptions
OdbError
TypeError
This function takes no keyword arguments.

31.32.4 openOdb(...)
This method opens an existing output database (.odb) file and creates a new Odb object. You typically
execute this method outside of Abaqus/CAE when, in most cases, only one output database is open at
any time. For example,
import odbAccess
shockLoadOdb = odbAccess.openOdb(path='myOdb.odb')

Arguments
Required argument
path
A String specifying the path to an existing output database (.odb) file.
Optional argument
readOnly
A Boolean specifying whether the file will permit only read access or both read and write access.
The initial value is False, indicating that both read and write access will be permitted.
readInternalSets
A Boolean specifying whether the file will permit access to sets specified as Internal on the
database. The initial value is False, indicating that internal sets will not be read.

Return value
An Odb object.

Exceptions
If the output database was generated by a previous release of Abaqus and needs upgrading:

31–99

Abaqus ID:
Printed on:
ODB COMMANDS

OdbError: The database is from a previous release of Abaqus. Run abaqus upgrade -job
<newFilename> -odb <oldFileName> to upgrade it.
If the output database was generated by a newer release of Abaqus, and the installation of Abaqus needs
upgrading:
OdbError: Abaqus installation must be upgraded before this output database can be opened.

31.32.5 openOdb(...)
This method opens an existing output database (.odb) file and creates a new Odb object. This
method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the
session.odbs repository. This method allows you to open multiple output databases at the same
time and to use the repository key to specify a particular output database. For example,
import visualization
session.openOdb(name='myOdb', path='stress.odb', readOnly=True)

Arguments
Required argument
name
A String specifying the repository key. If thename is not the same as thepath to the output database
(.odb) file, the path must be specified as well. Additionally, to support backwards compatibility
of the interface, if the name parameter is omitted, the path and name will be presumed to be the
same.
Optional arguments
path
A String specifying the path to an existing output database (.odb) file.
readOnly
A Boolean specifying whether the file will permit only read access or both read and write access.
The initial value is TRUE when the output database file is opened from Abaqus/CAE, indicating
that only read access will be permitted.

Return value
An Odb object.

Exceptions
If the output database was generated by a previous release of Abaqus and needs upgrading:
OdbError: The database is from a previous release of Abaqus.
Run abaqus upgrade -job <newFilename> -odb <oldFileName> to upgrade it.
If the output database was generated by a newer release of Abaqus, and the installation of Abaqus needs
upgrading:

31–100

Abaqus ID:
Printed on:
 ODB COMMANDS

OdbError: Abaqus installation must be upgraded before this

output database can be opened.
If the file is not a valid database:
AbaqusError: Cannot open file <filename>.

31.32.6 upgradeOdb(...)
This method upgrades an existing Odb object to the current release and writes the upgraded version of
the Odb object to a file. In addition, Abaqus/CAE writes information about the status of the upgrade to
a log (*.log) file.
You can access this method using either of the following techniques:
• From a script running outside Abaqus/CAE. For example,

import odbAccess
odbAccess.upgradeOdb(existingOdbPath='oldOdb',
upgradedOdbPath='upgradedOdb')

• From the session object in Abaqus/CAE. For example,

import visualization
session.upgradeOdb(existingOdbPath='oldOdb',
upgradedOdbPath='upgradedOdb')

Arguments
Required arguments
existingOdbPath
An String specifying the path to the file containing the output database to be upgraded.
upgradedOdbPath
An String specifying the path to the file that will contain the upgraded output database.
Optional arguments
None.

Return value
None

Exceptions
If the output database upgrade fails:
OdbError: cannot convert database

31–101

Abaqus ID:
Printed on:
 ODB DISPLAY COMMANDS

32. Odb Display commands

32.1 OdbDisplay object

The OdbDisplay object stores the context of an output database for a viewport. The OdbDisplay object
has no constructor. Abaqus creates the defaultOdbDisplay member when you import the Visualization
module. Abaqus creates the odbDisplay member when a viewport is created, using the attributes
from the previous active viewport. The previous active viewport contains the attributes from the
defaultOdbDisplay object for the session. The attributes from the defaultOdbDisplay object are copied
from the previous active viewport to create the new viewport.
OdbDisplay objects are accessed in one of two ways:
• The default output database display options. These settings are used as defaults when other
odbDisplay members are created and can be set to customize user preferences.
• The output database display options associated with a particular viewport.

Access
session.viewports[name].layers[name].odbDisplay
import visualization
session.viewports[name].odbDisplay

32.1.1 moveCameraToCsys()
This method specifies a new position for the camera. It is available only when movieMode=ON (in
the View object). The new camera position is the origin of the coordinate system specified by the
cameraCsysName member of the BasicOptions object.

Arguments
None.

Return value
None

Exceptions
None.

32–1

Abaqus ID:
Printed on:
ODB DISPLAY COMMANDS

32.1.2 setDeformedVariable(...)
This method specifies the field output variable or FieldOutput object to be used when displaying the
deformed shape of the model.

Arguments
Required arguments
One of the following two mutually exclusive arguments must be provided:
variableLabel
A String specifying the field output variable.
field
A String specifying the FieldOutput object.
Optional arguments
None.

Return value
None

Exceptions
If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation cancelled.

32.1.3 setFrame(...)
This method specifies the step and frame for the OdbDisplay object.

Arguments
Required arguments
step
An Int specifying the step index. Possible values are 0 step (numSteps − 1).
frame
An Int specifying the frame in the specified step. Valid values are 0 frame (numFramesInStep
− 1). If frame (numFramesInStep − 1) the last frame will displayed.
Optional arguments
None.

Return value
None

32–2

Abaqus ID:
Printed on:
 ODB DISPLAY COMMANDS

Exceptions
If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation cancelled.
If the Odb object does not contain valid step data:
There are no valid step data on the odb. Requested operation cancelled.
If an invalid step index is passed in as argument:
Invalid step index:step. Available step indices: 0 - n

32.1.4 setFrame(...)
This method specifies the frame for the OdbDisplay object.

Arguments
Required argument
frame
An OdbFrame object.
Optional arguments
None.

Return value
None

Exceptions
None.

32.1.5 setPrimaryVariable(...)
This method specifies the field output variable for which to obtain results.

Arguments
Required arguments
variableLabel
A String specifying the field output variable. The variableLabel and field arguments are mutually
exclusive.
field
A String specifying the FieldOutput object. The variableLabel and field arguments are mutually
exclusive.

32–3

Abaqus ID:
Printed on:
ODB DISPLAY COMMANDS

outputPosition
A SymbolicConstant specifying the position from which to obtain data.
Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE,
ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION,
WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE. Data can be
obtained only from the position at which they were written to the output database during the
analysis.
Optional arguments
refinement
A sequence of a SymbolicConstant and a String. Possible values for the SymbolicConstant are
INVARIANT and COMPONENT. The String specifies an available component or invariant for
the specified variableLabel. This argument is required only if a refinement is available for the
specified variableLabel.
sectionPoint
A Dictionary with String keys and String values. Each key specifies a region in the model; the
corresponding value specifies a section point within that region. For example:
sectionPoint={'shell < MAT > < 7 section points >':'SPOS,
(fraction = 1.0)', 'shell < MAT > < 5 section points >':
'SPOS, (fraction = 1.0)', }

Return value
None

Exceptions
If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation cancelled.

32.1.6 setPrimarySectionPoint(...)
This method specifies the section point for the current primary, symbol and status variables.

Arguments
Required arguments
sectionPoint
A Dictionary with String keys and String values. Each key specifies a region in the model; the
corresponding value specifies a section point within that region. For example:
sectionPoint={'shell < MAT > < 7 section points >':'SPOS,

32–4

Abaqus ID:
Printed on:
 ODB DISPLAY COMMANDS

(fraction = 1.0)', 'shell < MAT > < 5 section points >':
'SPOS, (fraction = 1.0)', }

activePly
A String specifying the active ply name.
Optional arguments
None.

Return value
None

Exceptions
If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation cancelled.

32.1.7 setStatusVariable(...)
This method specifies the field output variable for filtering element display based on a status criteria.

Arguments
Required arguments
variableLabel
A String specifying the field output variable. The variableLabel and field arguments are mutually
exclusive.
field
A String specifying the FieldOutput object. The variableLabel and field arguments are mutually
exclusive.
outputPosition
A SymbolicConstant specifying the position from which to obtain data.
Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE,
ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION,
WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE. Data can be
obtained only from the position at which they were written to the output database during the
analysis.
Optional arguments
refinement
A sequence of a SymbolicConstant and a String. Possible values for the SymbolicConstant are
INVARIANT and COMPONENT. The String specifies an available component or invariant for

32–5

Abaqus ID:
Printed on:
ODB DISPLAY COMMANDS

the specified variableLabel. This argument is required only if a refinement is available for the
specified variableLabel.
sectionPoint
A Dictionary with String keys and String values. Each key specifies a region in the model; the
corresponding value specifies a section point within that region. For example:

sectionPoint={'shell < MAT > < 7 section points >':'SPOS,

(fraction = 1.0)', 'shell < MAT > < 5 section points >':
'SPOS, (fraction = 1.0)', }

statusMinimum
A Float specifying the minimum result value to be considered for element removal.
statusMaximum
A Float specifying the maximum result value to be considered for element removal.
statusInsideRange
A Boolean utilized when both statusMinimum and statusMaximum are given. Elements will be
removed when they contain values between the minimum and maximum, inclusive, when true.
Elements will be removed when they contain values outside of the minimum and maximum,
exclusive, when false.
useStatus
A Boolean to specify if the status variable is to be active.
applyStatusToUndeformed
A Boolean to specify if the active status variable is to remove elements from undeformed plots.
The default value is False.

Return value
None

Exceptions
If the viewport is not a